Merge lp:~salgado/launchpad/real-breadcrumbs into lp:launchpad

[Guilherme Salgado]

[Guilherme Salgado (salgado)]

= Summary =

The Breadcrumb adapter doesn't honor the rootsite specified in ICanonicalUrlData

== Proposed fix ==

Change Breadcrumb.rootsite into a property that looks for a rootsite for
its given object in the ICanonicalUrlData of that object, falling back
to 'mainsite' if it's not defined for that object.

This is a fix for bug 418214

== Tests ==

./bin/test -vvt test_breadcrumbs

== Demo and Q/A ==

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/canonical/launchpad/webapp/tests/test_breadcrumbs.py
  lib/canonical/launchpad/webapp/breadcrumb.py
  lib/lp/bugs/browser/bugtask.py

== Pylint notices ==

lib/lp/bugs/browser/bugtask.py
    1232: [C0301] Line too long (79/78)
    92: [F0401] Unable to import 'lazr.uri' (No module named uri)

[Graham Binns (gmb)]

review: Approve

=== modified file 'lib/canonical/launchpad/webapp/breadcrumb.py'
--- lib/canonical/launchpad/webapp/breadcrumb.py	2009-08-24 17:47:34 +0000
+++ lib/canonical/launchpad/webapp/breadcrumb.py	2009-08-25 12:35:23 +0000
@@ -15,7 +15,8 @@
 from zope.interface import implements
 
 from canonical.launchpad.webapp import canonical_url
-from canonical.launchpad.webapp.interfaces import IBreadcrumb
+from canonical.launchpad.webapp.interfaces import (
+    IBreadcrumb, ICanonicalUrlData)
 
 
 class Breadcrumb:
@@ -25,13 +26,25 @@
     """
     implements(IBreadcrumb)
 
-    rootsite = 'mainsite'
     text = None
 
     def __init__(self, context):
         self.context = context
 
     @property
+    def rootsite(self):
+        """The rootsite of this breadcrumb's URL.
+
+        If the `ICanonicalUrlData` for our context defines a rootsite, we
+        return that, otherwise we return 'mainsite'.
+        """
+        url_data = ICanonicalUrlData(self.context)
+        if url_data.rootsite:
+            return url_data.rootsite
+        else:
+            return 'mainsite'
+
+    @property
     def url(self):
         return canonical_url(self.context, rootsite=self.rootsite)
 

=== modified file 'lib/canonical/launchpad/webapp/tests/test_breadcrumbs.py'
--- lib/canonical/launchpad/webapp/tests/test_breadcrumbs.py	2009-08-20 19:22:20 +0000
+++ lib/canonical/launchpad/webapp/tests/test_breadcrumbs.py	2009-08-25 12:35:23 +0000
@@ -5,10 +5,36 @@
 
 import unittest
 
+from zope.interface import implements
+
+from canonical.launchpad.webapp.breadcrumb import Breadcrumb
+from canonical.launchpad.webapp.interfaces import ICanonicalUrlData
 from canonical.launchpad.webapp.publisher import canonical_url
 from canonical.launchpad.webapp.tests.breadcrumbs import (
     BaseBreadcrumbTestCase)
-from lp.testing import login
+from lp.testing import login, TestCase
+
+
+class Cookbook:
+    implements(ICanonicalUrlData)
+    rootsite = None
+
+
+class TestBreadcrumb(TestCase):
+
+    def test_rootsite_defaults_to_mainsite(self):
+        # When a class' ICanonicalUrlData doesn't define a rootsite, our
+        # Breadcrumb adapter will use 'mainsite' as the rootsite.
+        cookbook = Cookbook()
+        self.assertIs(cookbook.rootsite, None)
+        self.assertEquals(Breadcrumb(cookbook).rootsite, 'mainsite')
+
+    def test_urldata_rootsite_is_honored(self):
+        # When a class' ICanonicalUrlData defines a rootsite, our Breadcrumb
+        # adapter will use it.
+        cookbook = Cookbook()
+        cookbook.rootsite = 'cooking'
+        self.assertEquals(Breadcrumb(cookbook).rootsite, 'cooking')
 
 
 class TestExtraVHostBreadcrumbsOnHierarchyView(BaseBreadcrumbTestCase):

=== modified file 'lib/lp/bugs/browser/bugtask.py'
--- lib/lp/bugs/browser/bugtask.py	2009-08-24 20:28:33 +0000
+++ lib/lp/bugs/browser/bugtask.py	2009-08-25 12:35:23 +0000
@@ -3514,8 +3514,6 @@
 class BugTaskBreadcrumb(Breadcrumb):
     """Breadcrumb for an `IBugTask`."""
 
-    rootsite = 'bugs'
-
     def __init__(self, context):
         super(BugTaskBreadcrumb, self).__init__(context)
         # If the user does not have permission to view the bug for