summaryrefslogtreecommitdiff
path: root/morphlib/source.py
blob: 22676f02030feba827d0a4c870a4ee999a8bd089 (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
# Copyright (C) 2012  Codethink Limited
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


import morphlib


class Source(object):

    '''Represent the source to be built.
    
    Has the following properties:
    
    * ``repo`` -- the git repository which contains the source
    * ``original_ref`` -- the git ref provided by the user or a morphology
    * ``sha1`` -- the absolute git commit id for the revision we use
    * ``morphology`` -- the in-memory representation of the morphology we use
    * ``filename`` -- basename of the morphology filename
    * ``dependencies`` -- list of Sources for build dependencies for us
    * ``dependents`` -- list of Source for whom we are a build dependency
    
    The ``dependencies`` and ``dependents`` lists MUST be modified by
    the ``add_dependencies`` and ``add_dependent`` methods only.
    
    '''
    
    def __init__(self, repo, original_ref, sha1, morphology, filename):
        assert isinstance(morphology, morphlib.morph2.Morphology)
        self.repo = repo
        self.original_ref = original_ref
        self.sha1 = sha1
        self.morphology = morphology
        self.filename = filename
        self.dependencies = []
        self.dependents = []

    def add_dependency(self, source):
        '''Add ``source`` to the dependency list.'''
        if source not in self.dependencies:
            self.dependencies.append(source)
            source.dependents.append(self)

    def depends_on(self, source):
        '''Do we depend on ``source``?'''
        return source in self.dependencies

    def __str__(self): # pragma: no cover
        return '%s|%s|%s' % (self.repo, self.original_ref, self.filename)