Changeset 854:b98ce3951f0a

Timestamp:

03/09/10 19:14:55 (6 months ago)

Author:

dread

Branch:

default

Message:

[wui][model]: (ticket:255) Display package relationships on package read.

Location:

ckan

Files:

• lib/package_saver.py (modified) (4 diffs)
• model/core.py (modified) (2 diffs)
• model/package_relationship.py (modified) (3 diffs)
• templates/package/read_core.html (modified) (1 diff)
• tests/functional/test_package_relationships.py (added)

ckan/lib/package_saver.py

@@ -17 +17 @@
                        log_message=None,
                        author=None):
-        'Renders a package on the basis of a fieldset - perfect for preview'
+        '''Renders a package on the basis of a fieldset - perfect for
+        preview of form data.
+        Note that the actual calling of render('package/read') is left
+        to the caller.'''
         pkg = cls._preview_pkg(fs, original_name, record_id,
                                log_message, author)
@@ -25 +28 @@
     @classmethod
     def render_package(cls, pkg):
-        'Renders a package'
+        '''Prepares for rendering a package. Takes a Package object and
+        formats it for the various context variables required to call
+        render. 
+        Note that the actual calling of render('package/read') is left
+        to the caller.'''
         c.pkg = pkg
         notes_formatted = ckan.misc.MarkdownFormat().to_html(pkg.notes)
@@ -33 +40 @@
         c.pkg_author_link = cls._person_email_link(c.pkg.author, c.pkg.author_email, "Author")
         c.pkg_maintainer_link = cls._person_email_link(c.pkg.maintainer, c.pkg.maintainer_email, "Maintainer")
+        c.package_relationships = pkg.relationships_printable()
         # c.auth_for_change_state and c.auth_for_edit may also used
         # return render('package/read')
@@ -57 +65 @@
             fs.model.groups
             fs.model.ratings
+            fs.model.relationships_as_subject
+            fs.model.relationships_as_object
         except ValidationException, e:
             # remove everything from session so nothing can get saved accidentally

ckan/model/core.py

@@ -207 +207 @@
         else:
             raise NotImplementedError, 'Package relationship type: %r' % type_
-            
-            
+
         rel = package_relationship.PackageRelationship(
             subject=subject,
@@ -219 +218 @@
     def relationships(self):
         return self.relationships_as_subject + self.relationships_as_object
+
+    def relationships_printable(self):
+        '''Returns a list of tuples describing related packages, including
+        non-direct relationships (such as siblings).
+        @return: e.g. [(annakarenina, u"is a parent"), ...]
+        '''
+        from package_relationship import PackageRelationship
+        rel_list = []
+        # forward types
+        for rel_as_subject in self.relationships_as_subject:
+            type_printable = PackageRelationship.make_type_printable(rel_as_subject.type)
+            rel_list.append((rel_as_subject.object, type_printable))
+        # reverse types
+        for rel_as_object in self.relationships_as_object:
+            type_printable = PackageRelationship.make_type_printable(\
+                PackageRelationship.forward_to_reverse_type(
+                    rel_as_object.type)
+                )
+            rel_list.append((rel_as_object.subject, type_printable))
+        # sibling types
+        # e.g. 'gary' is a child of 'mum', looking for 'bert' is a child of 'mum'
+        # i.e. for each 'child_of' type relationship ...
+        for rel_as_subject in self.relationships_as_subject:
+            # ... parent is the object
+            parent_pkg = rel_as_subject.object
+            # Now look for the parent's other relationships as object ...
+            for parent_rel_as_object in parent_pkg.relationships_as_object:
+                # and check children
+                child_pkg = parent_rel_as_object.subject
+                if child_pkg != self and \
+                       parent_rel_as_object.type == rel_as_subject.type:
+                    type_printable = PackageRelationship.inferred_types_printable['sibling']
+                    rel_list.append((child_pkg, type_printable))
+        return rel_list
 
 class Tag(DomainObject):

ckan/model/package_relationship.py

@@ -4 +4 @@
 from core import DomainObject, Package
 from types import make_uuid
+
+# i18n only works when this is run as part of pylons,
+# which isn't the case for paster commands.
+try:
+    from pylons.i18n import _
+    _('')
+except:
+    def _(txt):
+        return txt
+
 
 package_relationship_table = Table('package_relationship', metadata,
@@ -17 +27 @@
 class PackageRelationship(vdm.sqlalchemy.RevisionedObjectMixin,
                           DomainObject):
+    # List of (type, corresponding_reverse_type)
+    # e.g. (A "depends_on" B, B has a "dependency_of" A)
     types = [(u'depends_on', u'dependency_of'),
              (u'derives_from', u'has_derivation'),
              (u'child_of', u'parent_of'),
              ]
+
+    types_printable = \
+            [(_(u'depends on %s'), _(u'is a dependency of %s')),
+             (_(u'derives from %s'), _(u'has derivation %s')),
+             (_(u'is a child of %s'), _(u'is a parent of %s')),
+             ]
+
+    inferred_types_printable = \
+            {'sibling':_('has sibling %s')}
 
     @classmethod
@@ -43 +64 @@
             if rev == reverse_type:
                 return fwd        
-                 
+
+    @classmethod
+    def forward_to_reverse_type(self, forward_type):
+        for fwd, rev in self.types:
+            if fwd == forward_type:
+                return rev
+
+    @classmethod
+    def make_type_printable(self, type_):
+        for i, types in enumerate(self.types):
+            for j in range(2):
+                if type_ == types[j]:
+                    return self.types_printable[i][j]
+        raise TypeError, type_
+
 mapper(PackageRelationship, package_relationship_table, properties={
     'subject':relation(Package, primaryjoin=\

ckan/templates/package/read_core.html

@@ -29 +29 @@
         <dd>${"Resources available for download" if c.pkg.resources else "No resources given"}</dd>
       </dl>
+        <py:if test="c.package_relationships">
+          <h3>Related packages</h3>
+          <ul>
+            <py:for each="pkg, relationship_str in c.package_relationships">
+              <li>${h.literal(relationship_str % (h.link_to(pkg.name, h.url_for(controller="package", action="read", id=pkg.name))))}</li>
+            </py:for>
+          </ul>
+        </py:if>
     </div>