Merge lp:~sinzui/launchpad/answers-portlets into lp:launchpad

[Curtis Hovey]

[Curtis Hovey (sinzui)]

This is my branch to update portlets used by pillars to UI 3.0.

    lp:~sinzui/launchpad/answers-portlets
    Diff size: 508
    Launchpad bug: https://bugs.launchpad.net/bugs/answers-portlets
    Test command: ./bin/test -vv \
      -t "faq-views|question-overview|xx-announcements|xx-karmacontext-topcontributors"
    Pre-implementation: beuno
    Target release: 2.2.8

= Update portlets used by pillars to UI 3.0 =

There are several portlets that need updating to the new project UI.
These portlets will also be used by Distributions and ProjectGroups: top
contributors, announcements, and latest questions. They also need a new
portlet to show the latest FAQs.

== Rules ==

    * Create an FAQ portlet.
    * Update the latest questions portlet.
      * Remove it from teams, they cannot ask questions.
      * Remove it from SourcePackages, the questions really belong
        to the DistributionSourcePackage.
    * Update the top contributors portlet.
    * Update the announcements portlet.

== QA ==

Describe the steps to verify that the project behaves correctly

== Lint ==

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

Linting changed files:
  lib/lp/answers/browser/configure.zcml
  lib/lp/answers/browser/faqcollection.py
  lib/lp/answers/browser/questiontarget.py
  lib/lp/answers/browser/tests/faq-views.txt
  lib/lp/answers/stories/question-overview.txt
  lib/lp/answers/templates/faqcollection-portlet-faqs.pt
  lib/lp/answers/templates/questiontarget-portlet-latestquestions.pt
  lib/lp/registry/stories/announcements/xx-announcements.txt
  lib/lp/registry/stories/standalone/xx-karmacontext-topcontributors.txt
  lib/lp/registry/templates/hasannouncements-portlet-latest.pt
  lib/lp/registry/templates/karmacontext-portlet-top-contributors.pt
  lib/lp/registry/templates/sourcepackage-index.pt
  lib/lp/registry/templates/team-index.pt

== Test ==

    * lib/lp/answers/browser/tests/faq-views.txt
      * Added a test to verify that latest faqs portlet works.
      * The original test did not make sense. There are already model
        tests for creating an FAQ. I think this was an incomplete test
        that was committed. I repurposed it to do a real view test.
    * lib/lp/answers/stories/question-overview.txt
      * Updated the test to verify the information presented in the
        latest questions portlet.
    * lib/lp/registry/stories/announcements/xx-announcements.txt
      * Revised the test to verify the layout of the links.
    * lib/lp/registry/stories/standalone/xx-karmacontext-topcontributors.txt
      * Revised the test because the headings changed for 3.0.

== Implementation ==

    * lib/lp/answers/browser/configure.zcml
      * Registered +portlet-listfaqs on the existing SearchFAQsView.
    * lib/lp/answers/browser/faqcollection.py
      * Added a create_faq link. The templates were/are making this link.
        They can be updated when they are converted to 3.0
      * Added 2 properties to SearchFAQsView to support it's reuse as a
        portlet.
    * lib/lp/answers/browser/questiontarget.py
      * Added a property to the LatestQuestio...

[Eleanor Berger (intellectronica)]

review: Approve

=== modified file 'lib/lp/answers/browser/configure.zcml'
--- lib/lp/answers/browser/configure.zcml	2009-07-13 18:15:02 +0000
+++ lib/lp/answers/browser/configure.zcml	2009-08-07 15:27:51 +0000
@@ -281,7 +281,13 @@
     permission="zope.Public"
     template="../templates/faq-listing.pt"
     />
-
+  <browser:page
+    for="lp.answers.interfaces.faqcollection.IFAQCollection"
+    class=".faqcollection.SearchFAQsView"
+    name="+portlet-listfaqs"
+    permission="zope.Public"
+    template="../templates/faqcollection-portlet-faqs.pt"
+    />
   <browser:page
     name="+createfaq"
     for="lp.answers.interfaces.faqtarget.IFAQTarget"

=== modified file 'lib/lp/answers/browser/faqcollection.py'
--- lib/lp/answers/browser/faqcollection.py	2009-06-24 23:10:46 +0000
+++ lib/lp/answers/browser/faqcollection.py	2009-08-07 21:43:36 +0000
@@ -12,14 +12,18 @@
 
 from urllib import urlencode
 
+from canonical.cachedproperty import cachedproperty
 from canonical.launchpad import _
-from canonical.launchpad.interfaces import (
-    IFAQCollection, ISearchFAQsForm, QUESTION_STATUS_DEFAULT_SEARCH,
-    QuestionSort)
+from lp.answers.interfaces.faqcollection import (
+    IFAQCollection, ISearchFAQsForm, FAQSort)
+from lp.answers.interfaces.questionenums import QuestionSort
+from lp.answers.interfaces.questioncollection import (
+    QUESTION_STATUS_DEFAULT_SEARCH)
 from canonical.launchpad.webapp import (
     action, ApplicationMenu, canonical_url, LaunchpadFormView, Link,
     safe_action)
 from canonical.launchpad.webapp.batching import BatchNavigator
+from canonical.launchpad.webapp.menu import enabled_with_permission
 
 
 class FAQCollectionMenu(ApplicationMenu):
@@ -27,7 +31,7 @@
 
     usedfor = IFAQCollection
     facet = 'answers'
-    links = ['list_all']
+    links = ['list_all', 'create_faq']
 
     def list_all(self):
         """Return a Link to list all FAQs."""
@@ -36,7 +40,14 @@
         # which an adapter exists that gives the proper context.
         collection = IFAQCollection(self.context)
         url = canonical_url(collection, rootsite='answers') + '/+faqs'
-        return Link(url, 'List all FAQs')
+        return Link(url, 'List all FAQs', icon='info')
+
+    @enabled_with_permission('launchpad.Moderate')
+    def create_faq(self):
+        """Return a Link to create a new FAQ."""
+        collection = IFAQCollection(self.context)
+        url = canonical_url(collection, rootsite='answers') + '/+createfaq'
+        return Link(url, 'Create a new FAQ', icon='add')
 
 
 class SearchFAQsView(LaunchpadFormView):
@@ -81,6 +92,23 @@
         faqs = self.context.searchFAQs(search_text=self.search_text)
         return BatchNavigator(faqs, self.request)
 
+    @property
+    def portlet_action(self):
+        """The action URL of the portlet form."""
+        return canonical_url(
+            self.context, view_name='+faqs', rootsite='answers')
+
+    @cachedproperty
+    def latest_faqs(self):
+        """Return the latest faqs created for this target.
+
+        This is used by the +portlet-listfaqs view.
+        """
+        quantity = 5
+        faqs = self.context.searchFAQs(
+            search_text=self.search_text, sort=FAQSort.NEWEST_FIRST)
+        return faqs[:quantity]
+
     @safe_action
     @action(_('Search'), name='search')
     def search_action(self, action, data):

=== modified file 'lib/lp/answers/browser/questiontarget.py'
--- lib/lp/answers/browser/questiontarget.py	2009-06-24 23:10:46 +0000
+++ lib/lp/answers/browser/questiontarget.py	2009-08-07 15:27:51 +0000
@@ -108,6 +108,11 @@
     """View used to display the latest questions on a question target."""
 
     @cachedproperty
+    def latest_questions_url(self):
+        """The link to the latest questions."""
+        return canonical_url(self.context, rootsite='answers')
+
+    @cachedproperty
     def getLatestQuestions(self, quantity=5):
         """Return <quantity> latest questions created for this target. This
         is used by the +portlet-latestquestions view.

=== modified file 'lib/lp/answers/browser/tests/faq-views.txt'
--- lib/lp/answers/browser/tests/faq-views.txt	2009-03-24 12:43:49 +0000
+++ lib/lp/answers/browser/tests/faq-views.txt	2009-08-07 21:43:36 +0000
@@ -1,10 +1,67 @@
-= Answer Tracker FAQ Pages =
-
-    >>> from canonical.launchpad.interfaces import ILaunchBag, IProductSet
+Answer Tracker FAQ Pages
+========================
+
+    >>> from lp.registry.interfaces.product import IProductSet
+
     >>> firefox = getUtility(IProductSet).getByName('firefox')
-
-    >>> login('[e-mail]')
-    >>> foo_bar = getUtility(ILaunchBag).user
+    >>> login_person(firefox.owner)
     >>> firefox_faq = firefox.newFAQ(
-    ...     foo_bar, 'A FAQ', 'FAQ for test purpose')
-
+    ...     firefox.owner, 'A FAQ', 'FAQ for test purpose')
+
+
+Latest FAQs portlet
+-------------------
+
+The latest FAQs portlet allows an `IFAQTarget` to show the latest FAQs.
+It's view provided latest_faqs to get the FAQs to display.
+
+    >>> from canonical.launchpad.testing.pages import (
+    ...     extract_text, find_tag_by_id)
+
+    >>> view = create_initialized_view(
+    ...     firefox, '+portlet-listfaqs', principal=firefox.owner)
+    >>> for faq in view.latest_faqs:
+    ...     print faq.title
+    A FAQ
+    What's the keyboard shortcut for [random feature]?
+    How do I install plugins (Shockwave, QuickTime, etc.)?
+    How do I troubleshoot problems with extensions/themes?
+    How do I install Extensions?
+
+    >>> content = find_tag_by_id(view.render(), 'portlet-latest-faqs')
+    >>> print content.h2
+    <h2>...FAQs for Mozilla Firefox </h2>
+
+    >>> print extract_text(content.ul)
+    A FAQ
+    What's the keyboard shortcut for [random feature]?...
+
+Each FAQ is linked.
+
+    >>> print content.find('a', {'class': 'sprite question'})
+    <a class="..." href="http://answers.../firefox/+faq/...">A FAQ</a>
+
+The portlet has a form to search FAQs. The view provides the action URL so
+that the form works from any page.
+
+    >>> print view.portlet_action
+    http://answers.launchpad.dev/firefox/+faqs
+
+    >>> print content.form['action']
+    http://answers.launchpad.dev/firefox/+faqs
+
+The portlet provides a link to create a faq when the user that has moderate
+permission such as the project owner.
+
+    >>> print content.find('a', {'class': 'menu-link-create_faq sprite add'})
+    <a href=".../firefox/+createfaq" class="...">Create a new FAQ</a>
+
+Other users do not see the link.
+
+    >>> user = factory.makePerson(name='a-user')
+    >>> login_person(user)
+    >>> view = create_initialized_view(
+    ...     firefox, '+portlet-listfaqs', principal=user)
+    >>> content = find_tag_by_id(view.render(), 'portlet-latest-faqs')
+    >>> print content.find('a', {'class': 'menu-link-create_faq sprite add'})
+    None

=== modified file 'lib/lp/answers/stories/question-overview.txt'
--- lib/lp/answers/stories/question-overview.txt	2009-06-02 08:20:49 +0000
+++ lib/lp/answers/stories/question-overview.txt	2009-08-07 18:20:14 +0000
@@ -165,14 +165,15 @@
 
     >>> user_browser.open('http://launchpad.dev/mozilla')
 
-    >>> questions = find_portlet(user_browser.contents, 'Latest questions')
-    >>> print extract_text(
-    ...     questions.find('div')).encode('ASCII', 'backslashreplace')
-    [Open] Problemas de Impress\xe3o no Firefox
-    [Answered] Newly installed plug-in doesn't seem to be used
-    [Open] Firefox loses focus and gets stuck
-    [Open] Problem showing the SVG demo on W3C site
-    [Open] Firefox cannot render Bank Site
+    >>> questions = find_tag_by_id(
+    ...     user_browser.contents, 'portlet-latest-questions')
+    >>> print extract_text(questions).encode('ASCII', 'backslashreplace')
+    Latest questions
+    Problemas de Impress\xe3o no Firefox ...
+    Newly installed plug-in doesn't seem to be used ...
+    Firefox loses focus and gets stuck ...
+    Problem showing the SVG demo on W3C site ...
+    Firefox cannot render Bank Site ...
 
     >>> user_browser.getLink('Ask a question').click()
     >>> print user_browser.title

=== added file 'lib/lp/answers/templates/faqcollection-portlet-faqs.pt'
--- lib/lp/answers/templates/faqcollection-portlet-faqs.pt	1970-01-01 00:00:00 +0000
+++ lib/lp/answers/templates/faqcollection-portlet-faqs.pt	2009-08-07 21:43:36 +0000
@@ -0,0 +1,34 @@
+<div
+  xmlns:tal="http://xml.zope.org/namespaces/tal"
+  class="portlet" id="portlet-latest-faqs"
+  tal:define="faqs view/latest_faqs"
+  tal:condition="faqs">
+  <h2>
+    <span class="see-all"><a
+      tal:replace="structure view/menu:answers/list_all/fmt:link" /></span>
+    FAQs for <tal:name replace="context/displayname" />
+  </h2>
+
+  <form id="question-search-form" method="get" accept-charset="UTF-8"
+    tal:attributes="action view/portlet_action">
+    <p>
+      <tal:searchbox replace="structure view/widgets/search_text" />
+      <input tal:replace="structure view/search_action/render" />
+    </p>
+  </form>
+
+  <ul tal:condition="faqs">
+    <li tal:repeat="faq faqs">
+      <a class="sprite question"
+        tal:attributes="href faq/fmt:url"
+        tal:content="faq/title">How do I do this?</a>
+    </li>
+  </ul>
+
+  <ul class="horizontal"
+    tal:condition="context/required:launchpad.Moderate">
+    <li>
+      <a tal:replace="structure view/menu:answers/create_faq/fmt:link" />
+    </li>
+  </ul>
+</div>

=== modified file 'lib/lp/answers/templates/questiontarget-portlet-latestquestions.pt'
--- lib/lp/answers/templates/questiontarget-portlet-latestquestions.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/answers/templates/questiontarget-portlet-latestquestions.pt	2009-08-07 22:14:06 +0000
@@ -1,15 +1,27 @@
-<div class="portlet" id="portlet-latest-questions"
-     tal:condition="view/getLatestQuestions">
-  <h2>Latest questions</h2>
-  <div class="portletBody portletContent">
-
-    <ul>
-      <li tal:repeat="question view/getLatestQuestions">
-           <span tal:attributes="class string:questionstatus${question/status/name} ${question/image:sprite_css}"
-           >[<tal:block tal:replace="structure question/status/title" />]</span>
-        <a tal:content="question/title/fmt:shorten/80"
-           tal:attributes="href question/fmt:url">question title</a>
-      </li>
-    </ul>
-  </div>
+<div
+  xmlns:tal="http://xml.zope.org/namespaces/tal"
+  class="portlet" id="portlet-latest-questions"
+  tal:define="questions view/getLatestQuestions"
+  tal:condition="questions">
+  <h2>
+    <span class="see-all" tal:condition="nothing"><a
+      tal:attributes="href view/latest_questions_url">All questions</a></span>
+    Latest questions
+  </h2>
+
+  <ul tal:condition="questions">
+    <li tal:repeat="question questions">
+      <a
+        tal:attributes="class string: ${question/image:sprite_css};
+                        href question/fmt:url;"
+        tal:content="question/title/fmt:shorten/80">question title</a>
+      <br />Posted <tal:when replace="question/datecreated/fmt:displaydate" />
+    </li>
+  </ul>
+
+  <tal:comment condition="nothing">
+    # XXX sinzui 2009-08-07 bug=410501: Remove this link and enable the
+    # see all link when the distribution source package index page is 3.0.
+  </tal:comment>
+  <a tal:attributes="href view/latest_questions_url">All questions</a>
 </div>

=== modified file 'lib/lp/registry/stories/announcements/xx-announcements.txt'
--- lib/lp/registry/stories/announcements/xx-announcements.txt	2009-08-01 02:04:55 +0000
+++ lib/lp/registry/stories/announcements/xx-announcements.txt	2009-08-07 17:29:08 +0000
@@ -90,8 +90,8 @@
     >>> print latest_news(priv_browser.contents).encode(
     ...     'ascii', 'backslashreplace')
     Announcements
-    20...: Apache announcement headline
-    ...More announcements
+    Apache announcement headline...
+    More announcements
     Make announcement
 
 Add another one, this time specifying a date in the past, which should
@@ -115,9 +115,9 @@
     >>> print latest_news(priv_browser.contents).encode(
     ...     'ascii', 'backslashreplace')
     Announcements
-    20...: Apache announcement headline
-    2007-11-24: Tomcat announcement headline
-    ...More announcements
+    Apache announcement headline ...
+    Tomcat announcement headline on 2007-11-24 ...
+    More announcements
     Make announcement
 
 Let's make sure that the announcement is presented as a link.

=== modified file 'lib/lp/registry/stories/standalone/xx-karmacontext-topcontributors.txt'
--- lib/lp/registry/stories/standalone/xx-karmacontext-topcontributors.txt	2009-04-17 10:32:16 +0000
+++ lib/lp/registry/stories/standalone/xx-karmacontext-topcontributors.txt	2009-08-07 15:47:52 +0000
@@ -56,7 +56,7 @@
     >>> print find_portlet(
     ...     anon_browser.contents, 'Top contributors').renderContents()
     <BLANKLINE>
-    <h2>Top contributors</h2>
+    <h2> Top contributors </h2>
     ...Sample Person...
     ...Mark Shuttleworth...
     ...Foo Bar...
@@ -92,7 +92,7 @@
     >>> print find_portlet(
     ...     anon_browser.contents, 'Top contributors').renderContents()
     <BLANKLINE>
-    <h2>Top contributors</h2>
+    <h2> Top contributors </h2>
     ...Sample Person...
     ...Mark Shuttleworth...
     ...Foo Bar...

=== modified file 'lib/lp/registry/templates/hasannouncements-portlet-latest.pt'
--- lib/lp/registry/templates/hasannouncements-portlet-latest.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/hasannouncements-portlet-latest.pt	2009-08-07 22:14:06 +0000
@@ -4,36 +4,43 @@
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
   omit-tag="">
 <tal:news define="announcements view/latest_announcements;
+                  has_announcements announcements/count;
                   overview_menu context/menu:overview">
-<div
-  class="portlet"
-  id="portlet-latest-announcements">
-  <h2>Announcements</h2>
-  <div class="portletBody portletContent">
-    <a title="Atom 1.0 feed"
-       tal:attributes="href view/feed_url">
-    </a>
+<div id="portlet-latest-announcements" class="portlet announcements">
+  <h2>
+    <span style="float: right;"><a title="Atom 1.0 feed"
+      tal:attributes="href view/feed_url"><img src="/@@/rss.png"/></a></span>
+    Announcements
+  </h2>
+
+  <p tal:condition="not: has_announcements">
+    <tal:name replace="context/displayname" /> has no announcements.
+  </p>
+
+  <tal:announcements condition="has_announcements">
     <ul>
-      <li tal:repeat="announcement announcements" class="news">
-        <img src="/@@/warning" alt="[Not published]"
-             title="This is not yet a public announcement"
-             tal:condition="not: announcement/published" />
-        <a tal:attributes="href announcement/fmt:url">
-          <span
+      <li tal:repeat="announcement announcements">
+        <div class="latest-announcement"
+          tal:omit-tag="not: repeat/announcement/start">
+          <img src="/@@/warning" alt="[Not published]"
+               title="This is not yet a public announcement"
+               tal:condition="not: announcement/published" />
+          <a tal:attributes="href announcement/fmt:url"
+            tal:content="announcement/title" />
+          <strong
             tal:condition="announcement/date_announced"
-            tal:replace="string:${announcement/date_announced/fmt:date}:" />
-          <span tal:replace="announcement/title" />
-        </a>
+            tal:content="announcement/date_announced/fmt:displaydate" />
+          <br /> <tal:extract replace="announcement/summary/fmt:shorten/80" />
+        </div>
       </li>
     </ul>
-    <div
-      tal:content="structure overview_menu/announcements/render"
-    />
-    <div
-      class="actions"
-      tal:content="structure overview_menu/announce/render"
-    />
-  </div>
+
+    <div class="see-all"
+      tal:content="structure overview_menu/announcements/render" />
+  </tal:announcements>
+
+  <div class="actions"
+    tal:content="structure overview_menu/announce/render" />
 </div>
 </tal:news>
 </tal:root>

=== modified file 'lib/lp/registry/templates/karmacontext-portlet-top-contributors.pt'
--- lib/lp/registry/templates/karmacontext-portlet-top-contributors.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/karmacontext-portlet-top-contributors.pt	2009-08-07 22:14:06 +0000
@@ -1,27 +1,30 @@
 <div
   xmlns:tal="http://xml.zope.org/namespaces/tal"
-  xmlns:metal="http://xml.zope.org/namespaces/metal"
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
   class="portlet" id="portlet-top-contributors"
-  tal:condition="view/getTopFiveContributors">
-  <h2>Top contributors</h2>
-
-    <table>
-      <tr tal:repeat="contributor view/getTopFiveContributors">
-        <td>
-          <a tal:replace="structure contributor/person/fmt:link">
-            Guilherme Salgado
-          </a>
-        </td>
-        <td align="right">
-          <span tal:replace="contributor/karmavalue" /> points
-        </td>
-      </tr>
-    </table>
-
-  <div
-    tal:define="link context/menu:overview/top_contributors"
-    tal:content="structure link/render"
-    class="actions"
-  />
+  tal:define="contributors view/getTopFiveContributors"
+  tal:condition="contributors">
+  <h2>
+    <span class="see-all" tal:condition="nothing"><a
+      tal:replace="structure context/menu:overview/top_contributors/fmt:link" /></span>
+    Top contributors
+  </h2>
+
+  <dl>
+    <tal:contributor tal:repeat="contributor contributors">
+      <dt>
+        <a tal:replace="structure contributor/person/fmt:link">
+          Guilherme Salgado</a>
+        <strong>
+          <tal:karma replace="contributor/karmavalue" /> points
+        </strong>
+      </dt>
+    </tal:contributor>
+  </dl>
+
+  <tal:comment condition="nothing">
+    # XXX sinzui 2009-08-07 bug=410491: Remove this link and enable the
+    # see all link when the distribution index page is 3.0.
+  </tal:comment>
+  <a tal:replace="structure context/menu:overview/top_contributors/fmt:link" />
 </div>

=== modified file 'lib/lp/registry/templates/sourcepackage-index.pt'
--- lib/lp/registry/templates/sourcepackage-index.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/sourcepackage-index.pt	2009-08-07 22:14:06 +0000
@@ -19,7 +19,6 @@
   </metal:leftportlets>
 
   <metal:rightportlets fill-slot="portlets_two">
-    <div tal:replace="structure context/@@+portlet-latestquestions" />
     <div tal:replace="structure context/@@+portlet-releases" />
     <div tal:replace="structure context/@@+portlet-upstream" />
   </metal:rightportlets>

=== modified file 'lib/lp/registry/templates/team-index.pt'
--- lib/lp/registry/templates/team-index.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/team-index.pt	2009-08-07 15:29:15 +0000
@@ -328,8 +328,6 @@
         replace="structure overview_menu/received_invitations/fmt:link" />
     </p>
   </div>
-
-  <div tal:replace="structure context/@@+portlet-latestquestions" />
   </div>
 </body>
 </html>