Merge lp:~sinzui/launchpad/team-membership-breadcrumbs into lp:launchpad

[Curtis Hovey]

[Curtis Hovey (sinzui)]

This is my branch to add breadcrumbs to team membership pages (+member and
+invitation). I am tempted to move TeamInvitationView from browser.person
to browser.teammembership because that is what it adapts. I decided not to
do it since it makes the diff harder to read.

    lp:~sinzui/launchpad/team-membership-breadcrumbs
    Diff size: 174
    Launchpad bug: https://bugs.launchpad.net/bugs/429663
    Test command: ./bin/test -vvt "teammembership-views"
    Pre-implementation: barry, salgado
    Target release: 3.1.10

= Add breadcrumbs to team membership pages =

After conversion to UI 3.0, ~team/+invitation/team has no breadcrumbs.
TeamMembership needs a Breadcrumb adapter. We expect to see:

    * +invitation/<team> (accept/decline invitation)
     “Launchpad Foundations” team >> “Registry Team” team invitation

Team membership is subordinate to team, so we expect to see the team
breadcrumbs first. What follows should be the member team:

    * +member/<member> (Edit membership)
      “Registry Team” team >> Members of “Registry Team” >> Guilherme Salgado

== Rules ==

    * Create a Breadcrumb adapter for ITeamMembership
      * It usesto TeamMembership.person.displayname.
      * It is appropriate for +member
    * Redefine TeamInvitationView.page_title to make a better breadcrumb
      since the membership is not accepted.

== QA ==

On Staging

    * Visit a team you are the owner of.
    * Choose the members link, then edit a member.
    * Verify that the page has breadcrumbs

    * Invite another team to be be an owner of the first team.
    * Visit the other team and choose the Invitation link
    * Choose the invitation
    * Verify that the page has breadcrumbs
    * Decline the invitation

== Lint ==

Linting changed files:
  lib/lp/registry/browser/configure.zcml
  lib/lp/registry/browser/person.py
  lib/lp/registry/browser/teammembership.py
  lib/lp/registry/doc/teammembership-views.txt

== Test ==

    * lib/lp/registry/doc/teammembership-views.txt
      * Added a test for the breadcrumb.
      * Added a test TeamMembershipEditView which did not have any
        verification for its label
      * Added a test to verify the TeamInvitationView page_title.

== Implementation ==

    * lib/lp/registry/browser/configure.zcml
      * Registered TeamMembershipBreadcrumb
    * lib/lp/registry/browser/person.py
      * Redefined TeamInvitationView page_title to make a breadcrumb that
        appropriate for a TeamMembership instance that was not accepted or
        declined.
    * lib/lp/registry/browser/teammembership.py
      * Added TeamMembershipBreadcrumb
      * Removed the page_title because the TeamMembershipBreadcrumb provides
        the text.

[Paul Hummer (rockstar)]

review: Approve (code)

=== modified file 'lib/lp/registry/browser/configure.zcml'
--- lib/lp/registry/browser/configure.zcml	2009-10-05 22:14:18 +0000
+++ lib/lp/registry/browser/configure.zcml	2009-10-09 00:13:13 +0000
@@ -23,6 +23,11 @@
         path_expression="string:+member/${person/name}"
         rootsite="mainsite"
         attribute_to_parent="team"/>
+    <adapter
+        provides="canonical.launchpad.webapp.interfaces.IBreadcrumb"
+        for="lp.registry.interfaces.teammembership.ITeamMembership"
+        factory="lp.registry.browser.teammembership.TeamMembershipBreadcrumb"
+        permission="zope.Public"/>
     <browser:defaultView
         for="lp.registry.interfaces.teammembership.ITeamMembership"
         name="+index"/>

=== modified file 'lib/lp/registry/browser/person.py'
--- lib/lp/registry/browser/person.py	2009-09-24 17:41:06 +0000
+++ lib/lp/registry/browser/person.py	2009-10-09 00:13:13 +0000
@@ -595,12 +595,10 @@
         return "Make %s a member of %s" % (
             self.context.person.displayname, self.context.team.displayname)
 
-    # XXX BarryWarsaw 2009-09-14 bug 429663.  Because this view is subordinate
-    # to the ~person in its context, no +hierarchy adapter can be found.  This
-    # means the page has no breadcrumbs and no proper page title.  For
-    # expediency during the 3.0 conversion work, we'll just set the page title
-    # to its label and move on.
-    page_title = label
+    @property
+    def page_title(self):
+        return smartquote(
+            '"%s" team invitation') % self.context.team.displayname
 
     def browserDefault(self, request):
         return self, ()

=== modified file 'lib/lp/registry/browser/teammembership.py'
--- lib/lp/registry/browser/teammembership.py	2009-09-15 18:33:47 +0000
+++ lib/lp/registry/browser/teammembership.py	2009-10-09 00:13:13 +0000
@@ -4,12 +4,12 @@
 __metaclass__ = type
 
 __all__ = [
+    'TeamMembershipBreadcrumb',
     'TeamInvitationsView',
     'TeamMembershipEditView',
     ]
 
 
-import cgi
 import pytz
 from datetime import datetime
 
@@ -22,14 +22,22 @@
 from canonical.launchpad import _
 from canonical.launchpad.interfaces.launchpad import ILaunchpadCelebrities
 from canonical.launchpad.webapp import LaunchpadView, canonical_url
+from canonical.launchpad.webapp.breadcrumb import Breadcrumb
 from canonical.launchpad.webapp.interfaces import (
     ILaunchBag, UnexpectedFormData)
-from canonical.lazr.utils import smartquote
 from canonical.widgets import DateWidget
 
 from lp.registry.interfaces.teammembership import TeamMembershipStatus
 
 
+class TeamMembershipBreadcrumb(Breadcrumb):
+    """Builds a breadcrumb for an `ITeamMembership`."""
+
+    @property
+    def text(self):
+        return "%s's membership" % self.context.person.displayname
+
+
 class TeamMembershipEditView:
 
     def __init__(self, context, request):
@@ -88,14 +96,6 @@
             raise AssertionError('status unknown')
         return '%s member %s' % (prefix, self.context.person.displayname)
 
-    # XXX BarryWarsaw 2009-09-14 bug 429729.  This should really go away, but
-    # since there is no +hierarchy adapter for this view, there is no
-    # breadcrumbs, and thus no default reverse-breadcrumb page title.
-    @property
-    def page_title(self):
-        return smartquote("%s's membership status in %s") % (
-            self.context.person.displayname, self.context.team.displayname)
-
     # Boolean helpers
     def userIsTeamOwnerOrLPAdmin(self):
         return (self.user.inTeam(self.context.team.teamowner) or

=== modified file 'lib/lp/registry/doc/teammembership-views.txt'
--- lib/lp/registry/doc/teammembership-views.txt	2009-09-14 19:53:46 +0000
+++ lib/lp/registry/doc/teammembership-views.txt	2009-10-09 00:13:13 +0000
@@ -2,6 +2,47 @@
 Team membership views
 =====================
 
+
+Breadcrumbs
+-----------
+
+Team membership breadcrumbs uses the member's displayname to create
+"<displayname>'s membership".
+
+    >>> from canonical.lazr.testing.menus import make_fake_request
+    >>> from lp.registry.interfaces.teammembership import ITeamMembershipSet
+
+    >>> team_owner = factory.makePerson(name='team-owner')
+    >>> super_team = factory.makeTeam(name='us', owner=team_owner)
+    >>> membership_set = getUtility(ITeamMembershipSet)
+    >>> membership = membership_set.getByPersonAndTeam(
+    ...     team_owner, super_team)
+    >>> view = create_view(membership, '+index')
+
+    >>> request = make_fake_request(
+    ...     'http://launchpad.dev/~us/+member/team-owner',
+    ...     [super_team, membership, view])
+    >>> hierarchy = create_initialized_view(
+    ...     membership, '+hierarchy', request=request)
+    >>> hierarchy.items
+    [<TeamBreadcrumb ... text='\u201cUs\u201d team'>,
+     <TeamMembershipBreadcrumb ... text='Team-owner's membership'>]
+
+
++member view
+------------
+
+The TeamMembershipEditView provides a label that described the membership
+state of the IPerson.
+
+    >>> view = create_view(membership, '+index')
+    >>> print view.label
+    Active member Team-owner
+
+
++invitations view
+-----------------
+
 When a team is invited to join another team, the TeamInvitationsView controls
 the ~team/+invitations page.
 
@@ -9,3 +50,27 @@
     >>> view = create_initialized_view(team, '+invitations')
     >>> print view.label
     Invitations for Bassists
+
+
++invitation/<team> view
+-----------------------
+
+The TeamInvitationView allows a team admin to accept or decline an invitation
+to join another team. The invitation is a TeamMembership instance. The view
+is applied during the stepto traversal--it is not a named view in ZCML.
+
+    >>> from lp.registry.browser.person import TeamInvitationView
+
+    >>> login_person(team_owner)
+    >>> super_team.addMember(team, team_owner)
+    >>> membership = membership_set.getByPersonAndTeam(team, super_team)
+    >>> login_person(team.teamowner)
+    >>> view = TeamInvitationView(membership, request)
+    >>> print view.label
+    Make Bassists a member of Us
+
+The view provides page_title to create a breadcrumb that describes this
+use the TeamMembership.
+
+    >>> print view.page_title.encode('ascii', 'backslashreplace')
+    \u201cUs\u201d team invitation

=== modified file 'lib/lp/registry/stories/foaf/xx-team-membership.txt'
--- lib/lp/registry/stories/foaf/xx-team-membership.txt	2009-09-16 18:36:46 +0000
+++ lib/lp/registry/stories/foaf/xx-team-membership.txt	2009-10-09 00:13:13 +0000
@@ -12,8 +12,8 @@
     >>> url = '/~ubuntu-team/+member/kamion'
     >>> browser.getLink(url=url).click()
 
-    >>> "Colin Watson's membership status in Ubuntu Team" in browser.contents
-    True
+    >>> print browser.title
+    Colin Watson's membership : ...Ubuntu Team... team
     >>> "Active member" in browser.contents
     True
     >>> browser.getControl(name='admin').value
@@ -109,8 +109,8 @@
     >>> url = '/~ubuntu-team/+member/jdub'
     >>> jdub_browser.getLink(url=url).click()
 
-    >>> "Jeff Waugh's membership status in Ubuntu Team" in jdub_browser.contents
-    True
+    >>> print jdub_browser.title
+    Jeff Waugh's membership : ...Ubuntu Team... team
     >>> "Active member" in jdub_browser.contents
     True
 

=== modified file 'lib/lp/registry/stories/teammembership/xx-add-member.txt'
--- lib/lp/registry/stories/teammembership/xx-add-member.txt	2009-09-14 23:03:49 +0000
+++ lib/lp/registry/stories/teammembership/xx-add-member.txt	2009-10-09 00:13:13 +0000
@@ -99,8 +99,7 @@
     >>> browser.open(
     ...     'http://launchpad.dev/~landscape-developers/+member/launchpad')
 
-    >>> print extract_text(find_tag_by_id(browser.contents, 'maincontent'))
-    Invited member Launchpad Developers
+    >>> print extract_text(find_tag_by_id(browser.contents, 'not-responded'))
     Launchpad Developers (launchpad) has been invited to join this team, but
     hasn't responded to the invitation yet.
 

=== modified file 'lib/lp/registry/stories/teammembership/xx-renew-subscription.txt'
--- lib/lp/registry/stories/teammembership/xx-renew-subscription.txt	2009-09-18 15:24:30 +0000
+++ lib/lp/registry/stories/teammembership/xx-renew-subscription.txt	2009-10-09 00:13:13 +0000
@@ -6,8 +6,8 @@
 
     >>> browser = setupBrowser(auth='Basic [e-mail]:test')
     >>> browser.open('http://launchpad.dev/~name18/+member/mark')
-    >>> browser.title
-    "Mark Shuttleworth's membership status in Ubuntu Gnome Team"
+    >>> print browser.title
+    Mark Shuttleworth's membership : ...Ubuntu Gnome Team... team
     >>> content = find_main_content(browser.contents)
     >>> print extract_text(content.p)
     Mark Shuttleworth (mark) is an Expired Member of Ubuntu Gnome Team.

=== modified file 'lib/lp/registry/templates/teammembership-index.pt'
--- lib/lp/registry/templates/teammembership-index.pt	2009-09-16 18:36:46 +0000
+++ lib/lp/registry/templates/teammembership-index.pt	2009-10-09 00:13:13 +0000
@@ -289,7 +289,7 @@
       </div>
 
       <div tal:condition="view/isInvited">
-        <p>
+        <p id="not-responded">
           <metal:person use-macro="template/macros/person" />
           has been invited to join this team, but hasn't responded to the
           invitation yet.