Merge lp:~rockstar/launchpad/ihasrecipes into lp:launchpad

[Paul Hummer]

This branch creates an IHasRecipes interface and implements it for IBranch. This is needed for the recipe listing that exist in a followup branch. It's pretty straightforward, and small for a reason.

[Brad Crittenden (bac)]

Nice branch Paul. Looks like you have one c-n-p error:

s/test_branch_implements_hasbranches/test_branch_implements_hasrecipes/

review: Approve (code)

=== added directory 'lib/canonical/launchpad/apidoc'
=== modified file 'lib/lp/code/configure.zcml'
--- lib/lp/code/configure.zcml	2010-04-06 21:21:01 +0000
+++ lib/lp/code/configure.zcml	2010-04-06 21:21:07 +0000
@@ -496,11 +496,12 @@
                     getUpgradeFormat
                     isBranchMergeable
                     visibleByUser
+                    getRecipes
                     "/>
     <require
         permission="launchpad.Edit"
-        attributes="destroySelf destroySelfBreakReferences setPrivate 
-		            setOwner setTarget requestUpgrade"
+        attributes="destroySelf destroySelfBreakReferences setPrivate
+                    setOwner setTarget requestUpgrade"
         set_attributes="name url mirror_status_message
                         description lifecycle_status
                         last_mirrored last_mirrored_id last_mirror_attempt

=== modified file 'lib/lp/code/interfaces/branch.py'
--- lib/lp/code/interfaces/branch.py	2010-03-25 02:21:15 +0000
+++ lib/lp/code/interfaces/branch.py	2010-04-06 21:21:07 +0000
@@ -70,6 +70,7 @@
 from lp.code.interfaces.branchlookup import IBranchLookup
 from lp.code.interfaces.branchtarget import IHasBranchTarget
 from lp.code.interfaces.hasbranches import IHasMergeProposals
+from lp.code.interfaces.hasrecipes import IHasRecipes
 from canonical.launchpad.interfaces.launchpad import (
     ILaunchpadCelebrities, IPrivacy)
 from lp.registry.interfaces.role import IHasOwner
@@ -309,7 +310,8 @@
     """A marker interface to indicate the need to show the branch menu."""
 
 
-class IBranch(IHasOwner, IPrivacy, IHasBranchTarget, IHasMergeProposals):
+class IBranch(IHasOwner, IPrivacy, IHasBranchTarget, IHasMergeProposals,
+              IHasRecipes):
     """A Bazaar branch."""
 
     # Mark branches as exported entries for the Launchpad API.

=== added file 'lib/lp/code/interfaces/hasrecipes.py'
--- lib/lp/code/interfaces/hasrecipes.py	1970-01-01 00:00:00 +0000
+++ lib/lp/code/interfaces/hasrecipes.py	2010-04-06 21:21:07 +0000
@@ -0,0 +1,19 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Interface definitions for IHasRecipes."""
+
+__metaclass__ = type
+__all__ = [
+    'IHasRecipes',
+    ]
+
+
+from zope.interface import Attribute, Interface
+
+
+class IHasRecipes(Interface):
+    """An object that has recipes."""
+
+    def getRecipes():
+        """Returns all recipes associated with the object."""

=== modified file 'lib/lp/code/interfaces/sourcepackagerecipe.py'
--- lib/lp/code/interfaces/sourcepackagerecipe.py	2010-04-06 21:21:01 +0000
+++ lib/lp/code/interfaces/sourcepackagerecipe.py	2010-04-06 21:21:07 +0000
@@ -3,7 +3,6 @@
 
 # pylint: disable-msg=E0211,E0213
 
-
 """Interface of the `SourcePackageRecipe` content type."""
 
 
@@ -22,7 +21,7 @@
 from lazr.restful.fields import CollectionField, Reference
 
 from zope.interface import Attribute, Interface
-from zope.schema import Bool, Datetime, Object, TextLine, Text
+from zope.schema import Bool, Datetime, Object, Text, TextLine
 
 from canonical.launchpad import _
 from canonical.launchpad.validators.name import name_validator

=== modified file 'lib/lp/code/model/branch.py'
--- lib/lp/code/model/branch.py	2010-03-11 14:29:15 +0000
+++ lib/lp/code/model/branch.py	2010-04-06 21:21:07 +0000
@@ -1065,6 +1065,18 @@
                     user, checked_branches)
         return can_access
 
+    def getRecipes(self):
+        """See `IHasRecipes`."""
+        from lp.code.model.sourcepackagerecipe import SourcePackageRecipe
+        from lp.code.model.sourcepackagerecipedata import (
+            SourcePackageRecipeData)
+        store = Store.of(self)
+        return store.find(
+            SourcePackageRecipe,
+            SourcePackageRecipe.id ==
+                SourcePackageRecipeData.sourcepackage_recipe_id,
+            SourcePackageRecipeData.base_branch == self)
+
 
 class DeletionOperation:
     """Represent an operation to perform as part of branch deletion."""

=== added file 'lib/lp/code/model/tests/test_hasrecipes.py'
--- lib/lp/code/model/tests/test_hasrecipes.py	1970-01-01 00:00:00 +0000
+++ lib/lp/code/model/tests/test_hasrecipes.py	2010-04-06 21:21:07 +0000
@@ -0,0 +1,38 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for classes that implement IHasRecipes."""
+
+__metaclass__ = type
+
+import unittest
+
+from canonical.testing import DatabaseFunctionalLayer
+from lp.code.interfaces.hasrecipes import IHasRecipes
+from lp.testing import TestCaseWithFactory
+
+
+class TestIHasRecipes(TestCaseWithFactory):
+    """Test that the correct objects implement the interface."""
+
+    layer = DatabaseFunctionalLayer
+
+    def test_branch_implements_hasrecipes(self):
+        # Branches should implement IHasRecipes.
+        branch = self.factory.makeBranch()
+        self.assertProvides(branch, IHasRecipes)
+
+    def test_branch_getRecipes(self):
+        # IBranch.recipes should provide all the SourcePackageRecipes attached
+        # to that branch.
+        base_branch = self.factory.makeBranch()
+        recipe1 = self.factory.makeSourcePackageRecipe(
+            None, None, None, None, None, None, base_branch)
+        recipe2 = self.factory.makeSourcePackageRecipe(
+            None, None, None, None, None, None, base_branch)
+        recipe_ignored = self.factory.makeSourcePackageRecipe()
+        self.assertEqual(2, base_branch.getRecipes().count())
+
+
+def test_suite():
+    return unittest.TestLoader().loadTestsFromName(__name__)