Merge lp:~deryck/launchpad/hot-bugs-list-color-icons-439128 into lp:launchpad

[Deryck Hodge]

Use the correct color icons for hot bug and bugs home page listings.

[Deryck Hodge (deryck)]

= Summary =

This branch fixes Bug #439128, hot bugs list not having correct color
icons. I also did a drive-by fix for Bug #144101, color icons missing
from the top-level bugs.lp.net home page.

== Proposed fix ==

The correct fix is to use sprite classes rather than img tags.

== Pre-implementation notes ==

I discussed this with Graham and Tom during our standup call.

== Implementation details ==

The fix is pretty simple, but I spent some time on this branch getting
the test updated to check both bug lists -- recently reported and
recently fixed -- and also checking that sprite classes are used.

I also needed to add a secondary sort order to the latest_bugs method
because the test was unpredictable otherwise. Since 10 bugs are created
via the LaunchpadObjectFactory and all had the same timestamp, I needed
to have a secondary sort on ID to make the test consistent. I don't see
harm in this change otherwise, but welcome some scrutiny of this
particular change.

== Tests ==

./bin/test -cvvt xx-front-page-bug-lists.txt

== Demo and Q/A ==

To demo, visit bugs.lp.net/ANYPROJECT and confirm that the bugs icons
are color coded.

Also, visit bugs.lp.net itself and verify that bug icon use colors.
(Note: recently reported bugs can all be gray if no importance has been
set.)

= Launchpad lint =

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

Linting changed files:
  lib/lp/bugs/templates/malone-index.pt
  lib/lp/bugs/stories/bugs/xx-front-page-bug-lists.txt
  lib/canonical/launchpad/systemhomes.py
  lib/lp/bugs/templates/bugtarget-bugs.pt
  lib/lp/bugs/templates/bug-listing-detailed.pt

== Pylint notices ==

lib/canonical/launchpad/systemhomes.py
    51: [F0401] Unable to import 'lazr.restful' (No module named restful)
    52: [F0401] Unable to import 'lazr.restful.interfaces' (No module
named restful)
    378: [E1002, WebServiceApplication.toWADL] Use super on an old style
class

[Brad Crittenden (bac)]

Hi Deryck,

Thanks for the branch. It all looks good...except it's a huge regression for webkit-based browsers. We go from always having a grey icon to having NO icon at all.

As Curtis immediately saw, your <span> is wrong in that it is invalid to do a self-closing <span />. So your changes like:

<span tal:attributes="class context/default_bugtask/image:sprite_css" />

need to be:

<span tal:attributes="class context/default_bugtask/image:sprite_css"></span>

Please be a superstar and find the other places in the codebase where this happens. Your demo URL https://bugs.edge.launchpad.net/launchpad/+bugs is currently broken too.

Looking at your new test code I'm a bit confused by:
+ >>> print high_bugs[0]
61 + <span class="sprite bug-high">
62 + </span>

Because when I look at the html for bugs.launchpad.dev I see self-closing spans. Can you figure out why that is happening?

review: Needs Fixing (code)

[Brad Crittenden (bac)]

Deryck would you like to consider rolling in a fix to bug 393825 at the same time? It seems to be the same class of problem.

[Deryck Hodge (deryck)]

I've updated the branch to fix both bug 393825 and bug 397457. I fixed the tales formatter for icon to include a nbsp and updated the js generating the privacy icon to also add an nbsp. Some minor style changes were required on the bug page to make sure the privacy icon didn't get a link hover underline.

I'm running tests now to see fallout from these changes.

[Brad Crittenden (bac)]

The new changes look good Deryck and work well with webkit. Thanks for the fix.

review: Approve (code)

=== modified file 'lib/canonical/launchpad/javascript/bugs/bugtask-index.js'
--- lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2010-01-04 17:15:00 +0000
+++ lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2010-01-19 20:55:38 +0000
@@ -202,7 +202,7 @@
             var privacy_text = Y.one('#privacy-text');
             privacy_link = Y.Node.create(
                 '<a id="privacy-link" class="sprite edit" title="[edit]">' +
-                '<span class="invisible-link">edit</span></a>');
+                '<span class="invisible-link">edit</span>&nbsp;</a>');
             privacy_link.set('href', privacy_link_url);
             privacy_text.appendChild(privacy_link);
             privacy_spinner = Y.Node.create(

=== modified file 'lib/canonical/launchpad/systemhomes.py'
--- lib/canonical/launchpad/systemhomes.py	2009-07-17 00:26:05 +0000
+++ lib/canonical/launchpad/systemhomes.py	2010-01-19 20:55:38 +0000
@@ -159,7 +159,7 @@
     def latest_bugs(self):
         user = getUtility(ILaunchBag).user
         return getUtility(IBugSet).searchAsUser(
-            user=user, orderBy='-datecreated', limit=5)
+            user=user, orderBy=['-datecreated', '-id'], limit=5)
 
     def default_bug_list(self, user=None):
         return getUtility(IBugSet).searchAsUser(user)

=== modified file 'lib/canonical/launchpad/templates/bugs-listing-table-without-navlinks.pt'
--- lib/canonical/launchpad/templates/bugs-listing-table-without-navlinks.pt	2009-07-17 17:59:07 +0000
+++ lib/canonical/launchpad/templates/bugs-listing-table-without-navlinks.pt	2010-01-19 20:55:38 +0000
@@ -28,7 +28,7 @@
     <tbody>
       <tr tal:repeat="bugtask context/getBugListingItems">
         <td class="icon right">
-          <span tal:attributes="class bugtask/image:sprite_css" />
+          <span tal:replace="structure bugtask/image:icon" />
         </td>
         <td
           class="amount"

=== modified file 'lib/canonical/launchpad/webapp/tales.py'
--- lib/canonical/launchpad/webapp/tales.py	2009-11-23 03:10:04 +0000
+++ lib/canonical/launchpad/webapp/tales.py	2010-01-19 20:55:38 +0000
@@ -778,7 +778,7 @@
         ])
 
     icon_template = (
-        '<span alt="%s" title="%s" class="%s" />')
+        '<span alt="%s" title="%s" class="%s">&nbsp;</span>')
 
     linked_icon_template = (
         '<a href="%s" alt="%s" title="%s" class="%s"></a>')

=== renamed file 'lib/lp/bugs/stories/bugs/xx-front-page-recently-fixed-bugs.txt' => 'lib/lp/bugs/stories/bugs/xx-front-page-bug-lists.txt'
--- lib/lp/bugs/stories/bugs/xx-front-page-recently-fixed-bugs.txt	2009-06-12 16:36:02 +0000
+++ lib/lp/bugs/stories/bugs/xx-front-page-bug-lists.txt	2010-01-19 20:55:38 +0000
@@ -1,16 +1,105 @@
-= Recently Fixed Bugs on the Front Page =
-
-On the bugs front page there is a list of the most recently fixed bugs,
-across all products and distributions.
+Bug Lists on the Front Page
+===========================
+
+On the bugs front page there is a list of the most recently reported
+and recently fixed bugs, across all products and distributions.
+
+To demonstrate this, a few fixed bugs must be created.
+
+    >>> from zope.component import getUtility
+    >>> from canonical.launchpad.ftests import login, logout
+    >>> import transaction
+    >>> from canonical.launchpad.interfaces import (
+    ...     BugTaskImportance, BugTaskStatus, ILaunchBag)
+    >>> login('[e-mail]')
+    >>> bigfixer = factory.makeProduct(name='bigfixer')
+    >>> for bug_x in range(1, 11):
+    ...     summary = 'Summary for new bug %d' % bug_x
+    ...     bug = factory.makeBug(title=summary, product=bigfixer)
+    ...     bug.default_bugtask.transitionToStatus(
+    ...         BugTaskStatus.FIXRELEASED, getUtility(ILaunchBag).user)
+    ...     bug.default_bugtask.transitionToImportance(
+    ...         BugTaskImportance.HIGH, getUtility(ILaunchBag).user)
+    >>> transaction.commit()
+    >>> logout()
+
+
+Reported bugs
+-------------
+
+The bugs front page can be consulted now for the list of reported bugs.
 
     >>> anon_browser.open('http://bugs.launchpad.dev/')
+    >>> reported_bugs = find_tag_by_id(anon_browser.contents, 'reported-bugs')
+
+These bugs use a color-coded icon, via a sprite class, as an
+indication of the importance assigned to the bug.
+
+    >>> high_bugs = find_tags_by_class(str(reported_bugs), 'sprite bug-high')
+    >>> print high_bugs[0]
+    <span class="sprite bug-high">
+    </span>
+
+The list of recently reported bugs contains up to the last 5 bugs reported
+across Launchpad.
+
+    >>> for tr in reported_bugs('tr'):
+    ...     icon_td, summary_td, = tr('td')
+    ...     print "%s: %s" % (
+    ...         summary_td.b.renderContents().strip(),
+    ...         summary_td.a.renderContents())
+    Bigfixer:
+             Summary for new bug 10
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 9
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 8
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 7
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 6
+    <BLANKLINE>
+
+
+Fixed bugs
+----------
+
+The bugs front page also can be consulted for the list of fixed bugs.
+
     >>> fixed_bugs = find_tag_by_id(anon_browser.contents, 'fixed-bugs')
+
+These bugs also use a color-coded icon as an indication of the
+importance assigned to the bug.
+
+    >>> high_bugs = find_tags_by_class(str(fixed_bugs), 'sprite bug-high')
+    >>> print high_bugs[0]
+    <span class="sprite bug-high">
+    </span>
+
+The list of recently fixed bugs contains up to the last 5 bugs fixed
+across Launchpad.
+
     >>> for tr in fixed_bugs('tr'):
     ...     icon_td, summary_td, = tr('td')
     ...     print "%s: %s" % (
     ...         summary_td.b.renderContents().strip(),
     ...         summary_td.a.renderContents())
-    Debian: 
-            Printing doesn't work
-    <BLANKLINE>
-
+    Bigfixer:
+             Summary for new bug 10
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 9
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 8
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 7
+    <BLANKLINE>
+    Bigfixer:
+             Summary for new bug 6
+    <BLANKLINE>

=== modified file 'lib/lp/bugs/templates/bug-listing-detailed.pt'
--- lib/lp/bugs/templates/bug-listing-detailed.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/bugs/templates/bug-listing-detailed.pt	2010-01-19 20:55:38 +0000
@@ -1,6 +1,6 @@
 <tr xmlns:tal="http://xml.zope.org/namespaces/tal">
   <td class="icon left">
-    <img alt="" src="/@@/bug" />
+    <span tal:attributes="class context/default_bugtask/image:sprite_css" />
   </td>
   <td>
     <div>

=== modified file 'lib/lp/bugs/templates/bugtarget-bugs.pt'
--- lib/lp/bugs/templates/bugtarget-bugs.pt	2009-12-19 19:12:34 +0000
+++ lib/lp/bugs/templates/bugtarget-bugs.pt	2010-01-19 20:55:38 +0000
@@ -115,7 +115,7 @@
         <tbody>
           <tr tal:repeat="bugtask view/hot_bugtasks">
             <td class="icon left">
-              <img alt="" src="/@@/bug" />
+              <span tal:replace="structure bugtask/image:icon" />
             </td>
             <td style="text-align: right">
               #<span tal:replace="bugtask/bug/id" />

=== modified file 'lib/lp/bugs/templates/bugtask-index.pt'
--- lib/lp/bugs/templates/bugtask-index.pt	2009-12-27 09:08:31 +0000
+++ lib/lp/bugs/templates/bugtask-index.pt	2010-01-19 20:55:38 +0000
@@ -53,6 +53,7 @@
         #add-comment-form { max-width: 60em; padding-bottom: 4em; }
         #add-comment-form .actions {float: right;}
         .bug-branch-summary dd { font-size: 85% }
+        a#privacy-link:link:hover, a#privacy-link:visited:hover {text-decoration:none;}
       </style>
     </metal:block>
 

=== modified file 'lib/lp/bugs/templates/malone-index.pt'
--- lib/lp/bugs/templates/malone-index.pt	2009-09-04 15:06:34 +0000
+++ lib/lp/bugs/templates/malone-index.pt	2010-01-19 20:55:38 +0000
@@ -69,7 +69,7 @@
       <div class="first yui-u">
         <div class="portlet">
           <h2>Recently reported</h2>
-          <table>
+          <table id="reported-bugs">
             <tbody>
               <tr tal:repeat="bug context/latest_bugs"
                   tal:replace="structure bug/@@+listing-detailed" />