summaryrefslogtreecommitdiff
path: root/factory/declarations.py
blob: b9eaf04802ceb22e24d146679a150c4c7bae8c2b (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
103
104
105
106
107
108
109
110
111
112
113
114
# -*- coding: utf-8 -*-
# Copyright (c) 2010 Mark Sandstrom
# Copyright (c) 2011 Raphaël Barrois
#
# 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.

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."""
    def evaluate(self, sequence, obj):
        """Evaluate this declaration.

        Args:
            factory: The factory this declaration was defined in.
            obj: The object holding currently computed attributes
            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, sequence, obj):
        return self.function(obj)


class SelfAttribute(OrderedDeclaration):
    def __init__(self, attribute_name):
        super(SelfAttribute, self).__init__()
        self.attribute_name = attribute_name

    def evaluate(self, sequence, obj):
        return getattr(obj, self.attribute_name)


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

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


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


class SubFactory(OrderedDeclaration):
    """Base class for attributes based upon a sub-factory.

    Attributes:
        defaults: DeclarationsHolder, the declarations from the wrapped factory
        factory: Factory, the wrapped factory
    """

    def __init__(self, factory, **kwargs):
        super(SubFactory, self).__init__()
        self.defaults = kwargs
        self.factory = factory

    def evaluate(self, create, extra):
        """Evaluate the current definition and fill its attributes.

        Uses attributes definition in the following order:
        - attributes defined in the wrapped factory class
        - values defined when defining the SubFactory
        - additional values defined in attributes
        """

        defaults = dict(self.defaults)
        if extra:
            defaults.update(extra)

        attrs = self.factory.attributes(create, defaults)

        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)