Merge pull request #118 from oreillymedia/xspec

Refactored function handling and added XSpec tests for tocgen module

Author: Sanders Kleinfeld

htmlbook-xsl/chunk.xsl

@@ -20,7 +20,7 @@
               encoding="UTF-8"/>
   <xsl:preserve-space elements="*"/>
 
-  <xsl:key name="chunks" match="h:section|h:div[@data-type='part']|h:nav[@data-type='toc']" use="htmlbook:is-chunk(.)"/>
+  <xsl:key name="chunks" match="h:section|h:div[@data-type='part']|h:nav[@data-type='toc']" use="htmlbook:is-chunk(., $chunk.level)"/>
 
   <!-- Nodeset of all chunks in this document -->
   <xsl:variable name="chunks" select="key('chunks', '1')"/> <!-- All chunks have an is-chunk() value of 1 -->
@@ -76,7 +76,7 @@ sect5:s
   </xsl:template>
 
   <xsl:template match="h:section|h:div[contains(@data-type, 'part')]|h:nav[contains(@data-type, 'toc')]">
-    <xsl:variable name="is.chunk" select="htmlbook:is-chunk(.)"/>
+    <xsl:variable name="is.chunk" select="htmlbook:is-chunk(., $chunk.level)"/>
     <!-- <xsl:message>Element name: <xsl:value-of select="local-name()"/>, data-type name: <xsl:value-of select="@data-type"/>, Is chunk: <xsl:value-of select="$is.chunk"/></xsl:message> -->
     <xsl:choose>
       <xsl:when test="$is.chunk = 1">
@@ -138,7 +138,7 @@ sect5:s
 	  <!-- Root Chunk! Needs $outputdir in full file path-->
 	  <xsl:value-of select="concat($outputdir, $chars-to-append-to-outputdir)"/>
 	</xsl:when>
-	<xsl:when test="$outputdir != '' and not($generate.root.chunk = 1) and not($chunk[ancestor::*[htmlbook:is-chunk(.) = 1]])">
+	<xsl:when test="$outputdir != '' and not($generate.root.chunk = 1) and not($chunk[ancestor::*[htmlbook:is-chunk(., $chunk.level) = 1]])">
 	  <!-- $outputdir is specified and *is not* absolute filepath, 
 	       and generate.root.chunk is not specified (if it is, then previous "when" will set the outputdir properly),
 	       and chunk *is not* a nested chunk -->
@@ -286,7 +286,7 @@ sect5:s
 
       <!-- Check to see if parent is also chunk, in which case, call template recursively -->
       <xsl:variable name="parent-node" select="parent::*"/>
-      <xsl:variable name="parent-is-chunk" select="htmlbook:is-chunk($parent-node)"/>
+      <xsl:variable name="parent-is-chunk" select="htmlbook:is-chunk($parent-node, $chunk.level)"/>
       <xsl:if test="$parent-is-chunk = '1'">
 	<xsl:call-template name="output-filename-for-chunk">
 	  <xsl:with-param name="node" select="$parent-node"/>
@@ -445,7 +445,7 @@ sect5:s
   <xsl:template name="filename-for-node">
     <xsl:param name="node"/>
 
-    <xsl:variable name="chunk.node" select="htmlbook:chunk-for-node($node)"/>
+    <xsl:variable name="chunk.node" select="htmlbook:chunk-for-node($node, $chunks)"/>
 
     <!-- Now get filename for chunk -->
     <xsl:variable name="chunk-filename">
@@ -472,7 +472,7 @@ sect5:s
   <xsl:template name="generate-footnotes">
 
     <!-- Only generate footnotes if the current node is a chunk -->
-    <xsl:if test="htmlbook:is-chunk(.)">
+    <xsl:if test="htmlbook:is-chunk(., $chunk.level)">
 
       <xsl:variable name="all-footnotes" select="//h:span[@data-type='footnote']"/>
 
@@ -535,8 +535,8 @@ sect5:s
     <xsl:param name="chunk.node" select="parent::*"/>
 
     <xsl:choose>
-      <xsl:when test="htmlbook:chunk-for-node($chunk.node)">
-	<xsl:variable name="current.chunk" select="htmlbook:chunk-for-node($chunk.node)"/>
+      <xsl:when test="htmlbook:chunk-for-node($chunk.node, $chunks)">
+	<xsl:variable name="current.chunk" select="htmlbook:chunk-for-node($chunk.node, $chunks)"/>
 	<xsl:variable name="previous.chunk" select="$chunks[descendant::*[generate-id(.) = generate-id($current.chunk)]|
 						            following::*[generate-id(.) = generate-id($current.chunk)]][last()]"/>
 	<xsl:if test="$previous.chunk">
@@ -570,8 +570,8 @@ sect5:s
     <xsl:param name="chunk.node" select="parent::*"/>
 
     <xsl:choose>
-      <xsl:when test="htmlbook:chunk-for-node($chunk.node)">
-	<xsl:variable name="current.chunk" select="htmlbook:chunk-for-node($chunk.node)"/>
+      <xsl:when test="htmlbook:chunk-for-node($chunk.node, $chunks)">
+	<xsl:variable name="current.chunk" select="htmlbook:chunk-for-node($chunk.node, $chunks)"/>
 	<xsl:variable name="next.chunk" select="$chunks[ancestor::*[generate-id(.) = generate-id($current.chunk)]|
 						            preceding::*[generate-id(.) = generate-id($current.chunk)]][1]"/>
 	<xsl:if test="$next.chunk">

htmlbook-xsl/functions-exsl.xsl

@@ -11,6 +11,7 @@
 
   <func:function name="htmlbook:is-chunk">
     <xsl:param name="node"/>
+    <xsl:param name="chunk.level"/>
     <xsl:choose>
       <xsl:when test="$node[self::h:div[contains(@data-type, 'part')]]">
 	<func:result>1</func:result>
@@ -55,6 +56,7 @@
   <!-- Given a node, return the root node of the chunk it's in -->
   <func:function name="htmlbook:chunk-for-node">
     <xsl:param name="node"/>
+    <xsl:param name="chunks"/>
 
     <!-- 1. Get a nodeset of current element and all its ancestors, which could potentially be chunks -->
     <xsl:variable name="self-and-ancestors" select="$node/ancestor-or-self::*"/>

htmlbook-xsl/functions-xslt2.xsl

@@ -10,6 +10,7 @@
 
   <xsl:function name="htmlbook:is-chunk">
     <xsl:param name="node"/>
+    <xsl:param name="chunk.level"/>
     <xsl:choose>
       <xsl:when test="$node[self::h:div[contains(@data-type, 'part')]]">1</xsl:when>
       <xsl:when test="$node[self::h:section[contains(@data-type, 'acknowledgments') or
@@ -43,6 +44,7 @@
   <!-- Given a node, return the root node of the chunk it's in -->
   <xsl:function name="htmlbook:chunk-for-node">
     <xsl:param name="node"/>
+    <xsl:param name="chunks"/>
 
     <!-- 1. Get a nodeset of current element and all its ancestors, which could potentially be chunks -->
     <xsl:variable name="self-and-ancestors" select="$node/ancestor-or-self::*"/>

htmlbook-xsl/opf.xsl

@@ -604,7 +604,7 @@
     <xsl:for-each select="$element-descendants[1]">
       <xsl:choose>
 	<!-- Check if the element's nearest chunk ancestor is the chunk in question... -->
-	<xsl:when test="ancestor::*[htmlbook:is-chunk(.) = 1 and not(descendant::*[htmlbook:is-chunk(.) = 1][descendant::*[generate-id() = generate-id($element-descendants[1])]])][generate-id() = $chunk-id]">
+	<xsl:when test="ancestor::*[htmlbook:is-chunk(., $chunk.level) = 1 and not(descendant::*[htmlbook:is-chunk(., $chunk.level) = 1][descendant::*[generate-id() = generate-id($element-descendants[1])]])][generate-id() = $chunk-id]">
 	  <!--...It is: We have $element-name in this chunk! -->
 	  <xsl:text>1</xsl:text>
 	</xsl:when>

htmlbook-xsl/tocgen.xsl

@@ -13,10 +13,12 @@
 
   <!-- Default rule for TOC generation -->
   <xsl:template match="*" mode="tocgen">
+    <xsl:param name="toc.section.depth" select="$toc.section.depth"/>
     <xsl:apply-templates select="*" mode="tocgen"/>
   </xsl:template>
 
   <xsl:template match="h:section[not(@data-type = 'dedication' or @data-type = 'titlepage' or @data-type = 'toc' or @data-type = 'colophon' or @data-type = 'copyright-page' or @data-type = 'halftitlepage')]|h:div[@data-type='part']" mode="tocgen">
+    <xsl:param name="toc.section.depth" select="$toc.section.depth"/>
     <xsl:choose>
       <!-- Don't output entry for section elements at a level that is greater than specified $toc.section.depth -->
       <xsl:when test="self::h:section[contains(@data-type, 'sect') and htmlbook:section-depth(.) != '' and htmlbook:section-depth(.) &gt; $toc.section.depth]"/>
@@ -57,6 +59,9 @@
   <xsl:template match="h:nav[@data-type='toc']" name="generate-toc">
     <xsl:param name="toc.node" select="."/>
     <xsl:param name="scope" select="/*"/>
+    <xsl:param name="autogenerate-toc" select="$autogenerate-toc"/>
+    <xsl:param name="toc-placeholder-overwrite-contents" select="$toc-placeholder-overwrite-contents"/>
+
     <!-- Just switch context to $toc.node, so we don't have to reference the variable in rest of template -->
     <xsl:for-each select="$toc.node">
       <xsl:choose>

htmlbook-xsl/xspec/skeleton.html

@@ -6,7 +6,7 @@
     <meta name="publisher" content="O'Reilly Media"/>
     <meta name="creator" content="Sanders Kleinfeld"/>
   </head>
-  <body>
+  <body data-type="book">
     <!-- cover image -->
     <figure data-type="cover">
       <img src="cover.jpg"/>
@@ -27,7 +27,7 @@ <h1>Copyright 2013 O'Reilly Media, Inc.</h1>
       <h1>Preface</h1>
       <p>This is the Preface</p>
       <p>SVG element:</p>
-      <svg xmlns="http://www.w3.org/2000/svg"/>
+      <svg xmlns="http://www.w3.org/2000/svg" width="10" height="20"/>
       <section data-type="sect1">
 	<h1>Important Prerequisite Info</h1>
 	<p>You must know&hellip;</p>
@@ -121,13 +121,16 @@ <h3>Sub-sub-subsection</h3>
 	</section>
       </section>
     </section>
-    <section data-type="glossary">
-      <h1>Glossary</h1>
-      <p>This would be a glossary, if it had any content!</p>
-    </section>
-    <section data-type="bibliography">
-      <h1>Bibliography</h1>
-      <p>This would be a bibliography, if it had any content!</p>
-    </section>
+    <div data-type="part">
+      <h1>Backmatter!!!</h1>
+      <section data-type="glossary">
+	<h1>Glossary</h1>
+	<p>This would be a glossary, if it had any content!</p>
+      </section>
+      <section data-type="bibliography">
+	<h1>Bibliography</h1>
+	<p>This would be a bibliography, if it had any content!</p>
+      </section>
+    </div>
   </body>
 </html>

htmlbook-xsl/xspec/tocgen.xspec

@@ -0,0 +1,185 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<x:description xmlns:x="http://www.jenitennison.com/xslt/xspec"
+               xmlns:functx="http://www.functx.com"
+	       xmlns="http://www.w3.org/1999/xhtml"
+	       xmlns:ncx="http://www.daisy.org/z3986/2005/ncx/"
+	       xmlns:h="http://www.w3.org/1999/xhtml"
+	       xmlns:e="http://github.com/oreillymedia/epubrenderer"
+               stylesheet="../htmlbook.xsl">
+
+  <x:param name="autogenerate-toc" select="0"/>
+  <x:param name="toc-placeholder-overwrite-contents" select="0"/>
+
+  <x:scenario label="When *empty* TOC nav element is matched">
+    <x:context select="(//h:nav)[1]">
+      <body>
+	<nav data-type="toc"/>
+	<section id="chapter" data-type="chapter">
+	  <h1>This chapter head should be in TOC</h1>
+	  <p>Go TOC!</p>
+	</section>
+      </body>
+    </x:context>
+   
+    <x:scenario label="And autogenerate-toc param is *disabled*">
+      <x:context>
+	<x:param name="autogenerate-toc" select="0"/>
+      </x:context>
+      <x:expect label="TOC content *should not* be generated (nav should stay empty)">
+	<nav data-type="toc" id="..."/>
+      </x:expect>
+    </x:scenario>
+ 
+    <x:scenario label="And autogenerate-toc param is *enabled*">
+      <x:context>
+	<x:param name="autogenerate-toc" select="1"/>
+      </x:context>
+      <x:expect label="TOC content should be generated"
+		test="count(h:nav[.//h:li[contains(., 'This chapter head should be in TOC')]]) = 1"/>
+    </x:scenario>
+   
+  </x:scenario>
+  
+  <x:scenario label="When *nonempty* TOC nav element is matched">
+    <x:context select="(//h:nav)[1]">
+      <body>
+	<nav data-type="toc">
+	  <h1>Manual TOC</h1>
+	  <ol>
+	    <li>Entry 1</li>
+	    <li>Entry 2</li>
+	    <li>Entry 3</li>
+	  </ol>
+	</nav>
+	<section data-type="chapter">
+	  <h1>This chapter head should be in TOC</h1>
+	  <p>Go TOC!</p>
+	</section>
+      </body>
+    </x:context>
+    
+    <x:scenario label="And autogenerate-toc param is *disabled*">
+      <x:context>
+	<x:param name="autogenerate-toc" select="0"/>
+      </x:context>
+      <!-- Same as in context above, plus autogenerated id -->
+      <x:expect label="TOC content *should not* be generated (nav content left as is)">
+	<nav id="..." data-type="toc">
+	  <h1>Manual TOC</h1>
+	  <ol>
+	    <li>Entry 1</li>
+	    <li>Entry 2</li>
+	    <li>Entry 3</li>
+	  </ol>
+	</nav>
+      </x:expect>
+    </x:scenario>
+    
+    <x:scenario label="And autogenerate-toc param is *enabled*, but toc-placeholder-overwrite-contents is *disabled*">
+      <x:context>
+	<x:param name="autogenerate-toc" select="1"/>
+	<x:param name="toc-placeholder-overwrite-contents" select="0"/>
+      </x:context>
+      <!-- Same as in context above, plus autogenerated id -->
+      <x:expect label="TOC content *should not* be generated (nav content left as is)">
+	<nav id="..." data-type="toc">
+	  <h1>Manual TOC</h1>
+	  <ol>
+	    <li>Entry 1</li>
+	    <li>Entry 2</li>
+	    <li>Entry 3</li>
+	  </ol>
+	</nav>
+      </x:expect>
+    </x:scenario>
+
+    <x:scenario label="And autogenerate-toc param is *enabled*, and toc-placeholder-overwrite-contents is *enabled*">
+      <x:context>
+	<x:param name="autogenerate-toc" select="1"/>
+	<x:param name="toc-placeholder-overwrite-contents" select="1"/>
+      </x:context>
+      <x:expect label="TOC content *should* be generated (nav content overwritten)"
+		test="count(h:nav[.//h:li[contains(., 'This chapter head should be in TOC')]]) = 1 and
+		      not(exists(h:nav//h:h1[contains(., 'Manual TOC')]))"/>
+    </x:scenario>
+  </x:scenario>
+    
+  <x:scenario label="When there are multiple empty TOC nav elements">
+    <x:context select="//h:nav">
+      <body>
+	<nav data-type="toc"/>
+	<nav data-type="toc"/>
+      </body>
+      <section data-type="chapter">
+	<h1>This chapter head should be in TOC</h1>
+	<p>Go TOC!</p>
+      </section>
+      <x:param name="autogenerate-toc" select="1"/>
+    </x:context>
+    <x:expect label="Process them all the same way"
+	      test="deep-equal(//h:nav[@data-type='toc'][1]/node(), //h:nav[@data-type='toc'][2]/node())"/>
+  </x:scenario>
+
+  <x:scenario label="When a TOC is generated with a scope specified">
+    <x:context href="skeleton.html" select="(//h:nav[@data-type='toc'])[1]">
+      <x:param name="autogenerate-toc" select="1"/>
+      <x:param name="scope" select="(document('../skeleton.html')//h:section[@data-type='sect1'])[1]"/>
+    </x:context>
+    <x:expect label="Root of TOC list should be the scope root">
+      <nav data-type="toc" id="...">
+	<ol>
+	  <li data-type="sect1">...</li>
+	</ol>
+      </nav>
+    </x:expect>
+  </x:scenario>
+  
+  <x:scenario label="When a standard book-level section (chapter) is matched in tocgen mode">
+    <x:context href="skeleton.html" select="(//h:section[@data-type='chapter'])[1]" mode="tocgen"/>
+    <x:expect label="An entry 'li' should be generated">
+      <li data-type="chapter"><a href="...">...</a>...</li>
+    </x:expect>
+  </x:scenario>
+
+  <x:scenario label="When a standard book-level section (part) is matched in tocgen mode">
+    <x:context href="skeleton.html" select="(//h:div[@data-type='part'])[1]" mode="tocgen"/>
+    <x:expect label="An entry 'li' should be generated">
+      <li data-type="part"><a href="...">...</a>...</li>
+    </x:expect>
+  </x:scenario>
+  
+ <x:scenario label="When a subsection within the toc.section.depth is matched in tocgen mode">
+    <x:context href="skeleton.html" select="(//h:section[@data-type='sect1'])[1]" mode="tocgen">
+      <x:param name="toc.section.depth" select="1"/>
+    </x:context>
+    <x:expect label="An entry 'li' should be generated">
+      <li data-type="sect1"><a href="...">...</a></li>
+    </x:expect>
+  </x:scenario>
+
+  <x:scenario label="When a subsection at greater depth than the toc.section.depth is matched in tocgen mode">
+    <x:context href="skeleton.html" select="(//h:section[@data-type='sect2'])[1]" mode="tocgen">
+      <x:param name="toc.section.depth" select="1"/>
+    </x:context>
+    <x:expect label="An entry 'li' *should not* be generated" select="()"/>
+  </x:scenario>
+  
+  <x:scenario label="When a nonsection is matched in tocgen mode">
+    <x:context href="skeleton.html" select="(//h:p)[1]" mode="tocgen"/>
+    <x:expect label="An entry 'li' *should not* be generated" select="()"/>
+  </x:scenario>
+
+  <x:scenario label="When toc-title is called for English-language content (default)">
+    <x:call template="toc-title"/>
+    <x:expect label="it should return the proper TOC title">Table of Contents</x:expect>
+  </x:scenario>
+
+  <x:pending>
+    <x:scenario label="When toc-title is called for non-English-language content">
+      <!-- For this test, would need to further parameterize get-localization-value so that you could grab a different localization for the test -->
+      <x:call template="toc-title"/>
+      <x:expect label="it should return the proper TOC title"/>
+    </x:scenario>
+  </x:pending>
+</x:description>