Merge lp:~leonardr/launchpadlib/bug-286941 into lp:launchpadlib

[Leonard Richardson]

This branch improves the XSLT stylesheet to fix bug 286941 and some related bugs we didn't notice.

The XSLT stylesheet, forged in the earliest days of Launchpad, divides the web service into "top-level collections" and "entry types". However, "top-level collections" are now only part of the story. There are two top-level objects which are not collections: 'me' and 'pillars'. 'me' is a person, and 'pillars' is a special pillars object.

I changed the XSLT stylesheet to refer to top-level objects instead of top-level collections. However, there was a more serious problem: Since the display name of a top-level 'collection' was taken from the resource type instead of the link name, the 'me' object was showing up as 'person', not 'me'. I changed the XSLT to get the display names using an algorithm similar to the one used by launchpadlib (chop off '_link' or '_collection_link' from the name). Now 'me' shows up as a person-type object, which is good enough for now.

[Curtis Hovey (sinzui)]

This looks good to land.

review: Approve (code)

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2010-06-21 15:16:28 +0000
+++ src/launchpadlib/NEWS.txt	2010-07-12 15:20:58 +0000
@@ -2,6 +2,12 @@
 NEWS for launchpadlib
 =====================
 
+1.6.3 (Unreleased)
+==================
+
+- Improved the XSLT stylesheet to reflect Launchpad's more complex
+  top-level structure. [bug=286941]
+
 1.6.2 (2010-06-21)
 ==================
 

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2010-06-21 15:16:28 +0000
+++ src/launchpadlib/__init__.py	2010-07-12 15:20:58 +0000
@@ -14,4 +14,4 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '1.6.2'
+__version__ = '1.6.3'

=== modified file 'src/launchpadlib/wadl-to-refhtml.xsl'
--- src/launchpadlib/wadl-to-refhtml.xsl	2010-02-03 19:32:00 +0000
+++ src/launchpadlib/wadl-to-refhtml.xsl	2010-07-12 15:20:58 +0000
@@ -450,7 +450,7 @@
                 <xsl:apply-templates select="wadl:doc"/>
 
                 <xsl:call-template name="table-of-contents" />
-                <xsl:call-template name="top-level-collections" />
+                <xsl:call-template name="top-level-objects" />
                 <xsl:call-template name="entry-types" />
             </body>
         </html>
@@ -460,18 +460,30 @@
     <xsl:template name="table-of-contents">
         <div id="toc" title="toc">
             <h2>Table of Contents</h2>
-            <h3>Top-level collections</h3>
+            <h3>Top-level objects</h3>
             <ul>
                 <xsl:for-each
                     select="key('id', 'service-root-json')/wadl:param/wadl:link">
                     <xsl:sort select="../@name" />
-                    <xsl:variable name="collection_id"
+
+                    <xsl:variable name="object_id"
                         select="substring-after(@resource_type, '#')" />
-                    <xsl:if test="string-length($collection_id) &gt; 0">
-                        <li><a href="#{$collection_id}">
-                            <xsl:call-template name="get-title-or-id">
-                                <xsl:with-param name="element" select="key('id', $collection_id)" />
-                            </xsl:call-template>
+                    <xsl:variable name="collection_link_name"
+                        select="substring-before(
+                                ../@name, '_collection_link')" />
+                    <xsl:variable name="entry_link_name"
+                        select="substring-before(
+                                ../@name, '_link')" />
+                    <xsl:if test="string-length($object_id) &gt; 0">
+                        <li><a href="#{$object_id}">
+                    <xsl:choose>
+                        <xsl:when test="$collection_link_name">
+                          <xsl:value-of select="$collection_link_name" />
+                        </xsl:when>
+                        <xsl:otherwise>
+                          <xsl:value-of select="$entry_link_name" />
+                        </xsl:otherwise>
+                    </xsl:choose>
                         </a></li>
                     </xsl:if>
                 </xsl:for-each>
@@ -501,24 +513,24 @@
     </xsl:template>
 
     <!-- Top level collections container -->
-    <xsl:template name="top-level-collections">
-        <div id="top-level-collections" title="top-level-collections">
-            <h2>Top-level collections</h2>
+    <xsl:template name="top-level-objects">
+        <div id="top-level-objects" title="top-level-objects">
+            <h2>Top-level objects</h2>
 
             <!--
-                Top-level collections are found in the WADL by
+                Top-level objects are found in the WADL by
                 looking at the representation of the service-root resource
                 and processing all the resource-type linked from it.
             -->
             <xsl:for-each
                 select="key('id', 'service-root-json')/wadl:param/wadl:link">
                 <xsl:sort select="../@name" />
-                <xsl:variable name="collection_id"
+                <xsl:variable name="object_id"
                     select="substring-after(@resource_type, '#')" />
 
                 <xsl:apply-templates
-                    select="key('id', $collection_id)"
-                    mode="top-level-collections" />
+                    select="key('id', $object_id)"
+                    mode="top-level-objects" />
             </xsl:for-each>
         </div>
     </xsl:template>
@@ -535,9 +547,9 @@
         </xsl:choose>
     </xsl:template>
 
-    <!-- Documentation for one top-level-collection -->
-    <xsl:template match="wadl:resource_type" mode="top-level-collections">
-        <div id="{@id}" title="{@id}" class="top-level-collection">
+    <!-- Documentation for one top-level-object -->
+    <xsl:template match="wadl:resource_type" mode="top-level-objects">
+        <div id="{@id}" title="{@id}" class="top-level-object">
             <h3><xsl:call-template name="get-title-or-id"/></h3>
             <xsl:apply-templates select="wadl:doc"/>
 
@@ -566,7 +578,7 @@
                 </xsl:with-param>
             </xsl:call-template>
 
-            <!-- All top-level collections supports a GET without arguments
+            <!-- All top-level collections support a GET without arguments
             iterating over all the resources.
             The type of the resource is found by looking at the href attribute
             of the default representation. Link is in the form