summaryrefslogtreecommitdiff
path: root/factory/declarations.py
blob: a4a62af890f2ca3918d413e87b3b12d2a0d5249e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# Copyright (c) 2010 Mark Sandstrom
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

import threading

global_counter_lock = threading.Lock()

class GlobalCounter(object):
    """A simple global counter."""

    _value = 0

    @classmethod
    def step(cls):
        with global_counter_lock:
            current = cls._value
            cls._value += 1
        return current


class OrderedDeclaration(object):
    '''A factory declaration.

    Ordered declarations keep track of the order in which they're defined so that later declarations
    can refer to attributes created by earlier declarations when the declarations are evaluated.'''
    _next_order = 0

    def __init__(self):
        self.order = GlobalCounter.step()

    def evaluate(self, factory, attributes):
        '''Evaluate this declaration.

        Args:
            factory: The factory this declaration was defined in.
            attributes: The attributes created by the unordered and ordered declarations up to this point.'''

        raise NotImplementedError('This is an abstract method')

class LazyAttribute(OrderedDeclaration):
    def __init__(self, function):
        super(LazyAttribute, self).__init__()
        self.function = function

    def evaluate(self, factory, attributes):
        return self.function(attributes)

class Sequence(OrderedDeclaration):
    def __init__(self, function, type=str):
        super(Sequence, self).__init__()
        self.function = function
        self.type = type

    def evaluate(self, factory, attributes):
        return self.function(self.type(factory.sequence))

class LazyAttributeSequence(Sequence):
    def evaluate(self, factory, attributes):
        return self.function(attributes, self.type(factory.sequence))

class SubFactory(OrderedDeclaration):
    """Base class for attributes based upon a sub-factory."""
    def __init__(self, factory, **kwargs):
        super(SubFactory, self).__init__()
        self.defaults = factory.declarations()
        self.defaults.update_base(kwargs)
        self.factory = factory

    def evaluate(self, factory, create, attributes):
        attrs = self.defaults.build_attributes(self.factory, create, attributes)
        if create:
            return self.factory.create(**attrs)
        else:
            return self.factory.build(**attrs)

# Decorators... in case lambdas don't cut it

def lazy_attribute(func):
    return LazyAttribute(func)

def sequence(func):
    return Sequence(func)

def lazy_attribute_sequence(func):
    return LazyAttributeSequence(func)