Merge lp:~sinzui/launchpad/get-involved-bug-412649 into lp:launchpad

[Curtis Hovey]

[Curtis Hovey (sinzui)]

This is my branch to fix the pillar involvement portlet.

    lp:~sinzui/launchpad/get-involved-bug-412649
    Diff size: 322
    Launchpad bug: https://bugs.launchpad.net/bugs/412649
    Test command: ./bin/test -vvt "pillar-views"
    Pre-implementation: no-one
    Target release: 2.2.8

= Fix the pillar involvement portlet =

Currently, that portlet relies on attributes specific to
IProduct/IDistribution, so we can't use it for IProject.

== Rules ==

    * Add rules to use the projectgroups's products to set the link
state.
    * Series and sourcepackages need to be supported to since their
pages
      are being designed now.
    * Project's links are names differently; create a menu to avoid the
      problem.
    * The links are not always going to the correct app. Set the site in
      the link to ensure the host domain is used.

== QA ==

On edge
    * visit https://edge.launchpad.net/launchpad-project
    * Verify that the bugs, answers, translations, and blueprints links
are
      visible in the get involved menu.

== 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/icing/style-3-0.css
  lib/lp/registry/browser/configure.zcml
  lib/lp/registry/browser/pillar.py
  lib/lp/registry/browser/tests/pillar-views.txt
  lib/lp/registry/templates/pillar-involvement-portlet.pt
  lib/lp/registry/templates/project-index.pt

== Test ==

    * lib/lp/registry/browser/tests/pillar-views.txt
      * Updated the test to verify the view's official uses and the
enabled
        links
      * Added tests for project, product, distroseries, productseries,
and
        distributionsourcepackage.

== Implementation ==

    * lib/canonical/launchpad/icing/style-3-0.css
      * Fixed broken paths.
      * Renamed the class after the applications to be consistent.
    * lib/lp/registry/browser/configure.zcml
      * Configured the view to work for any object. It may indeed work
for
        for many more objects than it is designed for because the code
        uses nearest() to get the first IPillar in the the traversals.
    * lib/lp/registry/browser/pillar.py
      * Added a menu to support the links independent of the names used
        in other menus
      * Set the site in the links because
      * Added rules to build a set of official uses from an IProject's
        IProducts.
      * Used nearest() to travers to the nearest pillar to make the view
        work for series and distributionsourcepackages.
      * Used the same method to create a list of links as is used by the
        old navigation menu view.
    * lib/lp/registry/templates/pillar-involvement-portlet.pt
      * Simplified the markup to iterate over the list of links provided
        by the view.
    * lib/lp/registry/templates/project-index.pt
      * Updated the project index to use the portlet

[Eleanor Berger (intellectronica)]

review: Approve

=== modified file 'lib/canonical/launchpad/icing/style-3-0.css'
--- lib/canonical/launchpad/icing/style-3-0.css	2009-08-13 02:24:56 +0000
+++ lib/canonical/launchpad/icing/style-3-0.css	2009-08-15 04:54:01 +0000
@@ -546,21 +546,21 @@
     color: #b9413e;
     background: url(/@@/bugs-arrow-right.png) right center no-repeat;
     }
-.involvement a.question {
+.involvement a.answers {
     color: #5265b2;
     background: url(/@@/answers-arrow-right.png) right center no-repeat;
     }
-.involvement a.translate {
+.involvement a.translations {
     color: #c5458e;
     background: url(/@@/translations-arrow-right.png) right center no-repeat;
     }
 .involvement a.code {
     color: #d39f57;
-    background: url(/@@/images/code-arrow-right.png) right center no-repeat;
+    background: url(/@@/code-arrow-right.png) right center no-repeat;
     }
-.involvement a.blueprint {
+.involvement a.blueprints {
     color: #5ba4c6;
-    background: url(/@@/images/blueprints-arrow-right.png) right center no-repeat;
+    background: url(/@@/blueprints-arrow-right.png) right center no-repeat;
     }
 
 .announcements li {

=== modified file 'lib/lp/registry/browser/configure.zcml'
--- lib/lp/registry/browser/configure.zcml	2009-08-14 00:52:28 +0000
+++ lib/lp/registry/browser/configure.zcml	2009-08-15 04:31:42 +0000
@@ -561,7 +561,7 @@
         template="../templates/pillar-listing-simple.pt"/>
     <browser:page
         name="+get-involved"
-        for="lp.registry.interfaces.pillar.IPillar"
+        for="*"
         class="lp.registry.browser.pillar.PillarView"
         facet="overview"
         permission="zope.Public"

=== modified file 'lib/lp/registry/browser/pillar.py'
--- lib/lp/registry/browser/pillar.py	2009-08-06 18:17:49 +0000
+++ lib/lp/registry/browser/pillar.py	2009-08-15 04:31:42 +0000
@@ -10,17 +10,108 @@
     ]
 
 
-from canonical.launchpad.webapp.publisher import LaunchpadView
+from operator import attrgetter
+
+from zope.component import provideAdapter
+from zope.interface import implements, Interface
+
+from canonical.launchpad.webapp.interfaces import INavigationMenu
+from canonical.launchpad.webapp.menu import Link, NavigationMenu
+from canonical.launchpad.webapp.publisher import LaunchpadView, nearest
+from canonical.launchpad.webapp.tales import MenuAPI
+
+from lp.registry.interfaces.pillar import IPillar
+from lp.registry.interfaces.project import IProject
+
+
+class IInvolved(Interface):
+    """A marker interface for getting involved."""
+
+
+class InvolvedMenu(NavigationMenu):
+    """The get involved menu."""
+    usedfor = IInvolved
+    links = [
+        'report_bug', 'ask_question', 'help_translate', 'submit_code',
+        'register_blueprint']
+
+    def report_bug(self):
+        return Link(
+            '+filebug', 'Report a bug', site='bugs', icon='bugs',
+            enabled=self.context.official_malone)
+
+    def ask_question(self):
+        return Link(
+            '+addquestion', 'Ask a question', site='answers', icon='answers',
+            enabled=self.context.official_answers)
+
+    def help_translate(self):
+        return Link(
+            '/', 'Help translate', site='translations', icon='translations',
+            enabled=self.context.official_rosetta)
+
+    def submit_code(self):
+        return Link(
+            '+filebug', 'Submit code', site='code', icon='code',
+            enabled=self.context.official_codehosting)
+
+    def register_blueprint(self):
+        return Link(
+            '+addbranch', 'Register a blueprint', site='blueprints',
+            icon='blueprints', enabled=self.context.official_blueprints)
 
 
 class PillarView(LaunchpadView):
     """A view for any `IPillar`."""
+    implements(IInvolved)
+
+    def __init__(self, context, request):
+        super(PillarView, self).__init__(context, request)
+        self.official_malone = False
+        self.official_answers = False
+        self.official_blueprints = False
+        self.official_rosetta = False
+        self.official_codehosting = False
+        pillar = nearest(self.context, IPillar)
+        if IProject.providedBy(pillar):
+            for product in pillar.products:
+                self._set_official_launchpad(product)
+            # Projectgroups do not support submit code.
+            self.official_codehosting = False
+        else:
+            self._set_official_launchpad(pillar)
+
+    def _set_official_launchpad(self, pillar):
+        """Does the pillar officially use launchpad."""
+        # This if structure is required because it may be called many
+        # times to build the complete set of official applications.
+        if pillar.official_malone:
+            self.official_malone = True
+        if pillar.official_answers:
+            self.official_answers = True
+        if pillar.official_blueprints:
+            self.official_blueprints = True
+        if pillar.official_rosetta:
+            self.official_rosetta = True
+        if pillar.official_codehosting:
+            self.official_codehosting = True
 
     @property
     def has_involvement(self):
         """This `IPillar` uses Launchpad."""
-        pillar = self.context
         return (
-            pillar.official_codehosting or pillar.official_malone
-            or pillar.official_answers or pillar.official_blueprints
-            or pillar.official_rosetta)
+            self.official_malone or self.official_answers
+            or self.official_blueprints or self.official_rosetta
+            or self.official_codehosting)
+
+    @property
+    def enabled_links(self):
+        """The enabled involvement links."""
+        menuapi = MenuAPI(self)
+        return sorted([
+            link for link in menuapi.navigation.values() if link.enabled],
+            key=attrgetter('sort_key'))
+
+
+provideAdapter(
+    InvolvedMenu, [IInvolved], INavigationMenu, name="overview")

=== modified file 'lib/lp/registry/browser/tests/pillar-views.txt'
--- lib/lp/registry/browser/tests/pillar-views.txt	2009-08-06 18:17:49 +0000
+++ lib/lp/registry/browser/tests/pillar-views.txt	2009-08-15 04:31:42 +0000
@@ -31,15 +31,89 @@
     >>> view.has_involvement
     True
 
+    >>> view.official_malone
+    True
+    >>> view.official_answers
+    True
+    >>> view.official_rosetta
+    False
+    >>> view.official_blueprints
+    False
+    >>> view.official_codehosting
+    False
+
+The view provides a list of enabled links that is rendered by the template.
+
+    >>> for link in view.enabled_links:
+    ...     print link.name
+    report_bug ask_question
+
     >>> print view.render()
     <div id="involvement" class="portlet involvement">
       <h2>Get Involved</h2>
       <ul>
         <li>
-          <a class="bugs" href="...">Report a Bug</a>
+          <a href="..." class="...bugs">Report a bug</a>
         </li>
         <li>
-          <a class="question" href="...">Ask a question</a>
+          <a href="..." class="...answers">Ask a question</a>
         </li>
       </ul>
     </div>
+
+Products are are supported.
+
+    >>> product = factory.makeProduct(name='bread')
+    >>> login_person(product.owner)
+    >>> product.official_blueprints = True
+    >>> view = create_view(product, '+get-involved')
+    >>> view.official_blueprints
+    True
+
+Project are supported too, but they only display the applications used by
+their products.
+
+    >>> project_group = factory.makeProject(name='box', owner=product.owner)
+    >>> product.project = project_group
+
+    >>> view = create_view(project_group, '+get-involved')
+    >>> view.official_blueprints
+    True
+
+Projects cannot make links to register a branch, so official_code is always
+false.
+
+    >>> product.official_codehosting = True
+    >>> view = create_view(product, '+get-involved')
+    >>> view.official_codehosting
+    True
+
+    >>> view = create_view(project_group, '+get-involved')
+    >>> view.official_codehosting
+    False
+
+DistroSeries can use this view. The distribution is used to set the links.
+
+    >>> series = factory.makeDistroRelease(distribution=distribution)
+    >>> view = create_view(series, '+get-involved')
+    >>> for link in view.enabled_links:
+    ...     print link.name
+    report_bug ask_question
+
+ProductSeries can use this view. The product is used to set the links.
+
+    >>> series = factory.makeProductSeries(product=product)
+    >>> view = create_view(series, '+get-involved')
+    >>> for link in view.enabled_links:
+    ...     print link.name
+    submit_code register_blueprint
+
+DistributionSourcePackages can use this view. The distribution is used to
+set the links.
+
+    >>> package = factory.makeDistributionSourcePackage(
+    ...     distribution=distribution)
+    >>> view = create_view(package, '+get-involved')
+    >>> for link in view.enabled_links:
+    ...     print link.name
+    report_bug ask_question

=== modified file 'lib/lp/registry/templates/pillar-involvement-portlet.pt'
--- lib/lp/registry/templates/pillar-involvement-portlet.pt	2009-08-06 19:14:40 +0000
+++ lib/lp/registry/templates/pillar-involvement-portlet.pt	2009-08-15 04:31:42 +0000
@@ -6,25 +6,8 @@
   <h2>Get Involved</h2>
 
   <ul>
-    <li tal:condition="context/official_malone">
-      <a class="bugs"
-        tal:attributes="href context/menu:bugs/filebug/url">Report a Bug</a>
-    </li>
-    <li tal:condition="context/official_answers">
-      <a class="question"
-        tal:attributes="href context/menu:answers/new/url">Ask a question</a>
-    </li>
-    <li tal:condition="context/official_rosetta">
-      <a class="translate"
-        tal:attributes="href context/menu:translations/overview/url">Help translate</a>
-    </li>
-    <li tal:condition="context/official_codehosting">
-      <a class="code"
-        tal:attributes="href context/menu:branches/branch_add/url">Submit code</a>
-    </li>
-    <li tal:condition="context/official_blueprints">
-      <a class="blueprint"
-        tal:attributes="href context/menu:specications/new/url">Register a Blueprint</a>
+    <li tal:repeat="link view/enabled_links">
+      <a tal:replace="structure link/fmt:link" />
     </li>
   </ul>
 </div>

=== modified file 'lib/lp/registry/templates/project-index.pt'
--- lib/lp/registry/templates/project-index.pt	2009-08-13 18:10:15 +0000
+++ lib/lp/registry/templates/project-index.pt	2009-08-15 04:31:42 +0000
@@ -122,24 +122,9 @@
       <div id="object-actions" class="top-portlet">
         <tal:menu replace="structure view/@@+global-actions" />
       </div>
-      <div id="involvement" class="portlet involvement"
-           tal:condition="context/products">
-        <h2>Get Involved</h2>
-        <ul>
-          <li>
-            <a class="bugs"
-              tal:attributes="href context/menu:bugs/new/url">Report a Bug</a>
-          </li>
-          <li>
-            <a class="question"
-              tal:attributes="href context/menu:answers/new/url">Ask a question</a>
-          </li>
-          <li>
-            <a class="translate"
-              tal:attributes="href context/menu:translations/overview/url">Help translate</a>
-          </li>
-        </ul>
-      </div>
+
+      <div tal:replace="structure context/@@+get-involved" />
+
       <tal:portlet tal:replace="structure context/@@+portlet-latestannouncements" />
     </tal:side>