Add support for unit closer pages in toc (#408)

The default for unit pages will remain the same: treat them as introductions

This new unit-closer class supports specifying pages that should appear at the end of the unit

Author: TylerZeroMaster

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* Support `unit-closer` pages in TOC
 * Fix iframes links for Polish books
 * Create `number_parts` method in `ElementBase`
 * Create `os_number` method in `ElementBase` for creating `os-number` text

lib/kitchen/directions/bake_toc.rb

@@ -33,7 +33,9 @@ def self.v1(book:, options: { cases: false })
 
       def self.li_for_unit(unit, options)
         chapters = unit.element_children.only(ChapterElement)
-        pages = unit.element_children.only(PageElement)
+        pages = unit.element_children.only(PageElement).to_a
+        after_chapter = pages.filter(&:is_unit_closer?)
+        before_chapter = pages.difference(after_chapter)
 
         <<~HTML
           <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit" data-toc-type="unit">
@@ -43,8 +45,9 @@ def self.li_for_unit(unit, options)
               <span data-type="" itemprop="" class="os-text">#{unit.title_text}</span>
             </a>
             <ol class="os-unit">
-              #{pages.map { |page| li_for_page(page) }.join("\n")}
+              #{before_chapter.map { |page| li_for_page(page) }.join("\n")}
               #{chapters.map { |chapter| li_for_chapter(chapter, options) }.join("\n")}
+              #{after_chapter.map { |page| li_for_page(page) }.join("\n")}
             </ol>
           </li>
         HTML
@@ -110,7 +113,7 @@ def self.li_for_page(page)
             elsif page.has_ancestor?(:unit) && !
                   page.has_ancestor?(:chapter) && !
                   page.has_ancestor?(:composite_chapter)
-              ['os-toc-unit-page', 'intro']
+              ['os-toc-unit-page', page.is_unit_closer? ? 'numbered-section' : 'intro']
             else
               raise "could not detect which page type class to apply for page.id `#{page.id}`
                during baking the TOC. The classes on the page are: `#{page.classes}`

lib/kitchen/page_element.rb

@@ -75,6 +75,14 @@ def is_introduction?
       @is_introduction ||= has_class?('introduction')
     end
 
+    # Returns true if this page is a unit closer
+    #
+    # @return [Boolean]
+    #
+    def is_unit_closer?
+      @is_unit_closer ||= has_class?('unit-closer')
+    end
+
     # Returns  replaces generic call to page.count_in(:chapter)
     #
     # @raise [StandardError] if called on an introduction page

spec/kitchen_spec/directions/bake_toc_spec.rb

@@ -121,6 +121,13 @@
               </h2>
             </div>
           </div>
+          <div data-type="page" id="p-unit-closer" class="unit-closer">
+            <h2 data-type="document-title">
+              <span class="os-number">3</span>
+              <span class="os-divider"> </span>
+              <span data-type="" itemprop="" class="os-text">Unit Closer</span>
+            </h2>
+          </div>
         </div>
         <div data-type="page" id="p8" class="appendix">
           <h1 data-type="document-title">

spec/snapshots/Kitchen_Directions_BakeToc_supports_unit_numbering.snap

@@ -71,6 +71,7 @@
   </ol>
 </li>
 
+    
   </ol>
 </li>
 
@@ -117,6 +118,12 @@
   </ol>
 </li>
 
+    <li class="os-toc-unit-page" cnx-archive-shortid="" cnx-archive-uri="p-unit-closer" data-toc-type="book-content" data-toc-target-type="numbered-section">
+  <a href="#p-unit-closer">
+    <span class="os-number">3</span><span class="os-divider"> </span><span data-type="" itemprop="" class="os-text">Unit Closer</span>
+  </a>
+</li>
+
   </ol>
 </li>
 

spec/snapshots/Kitchen_Directions_BakeToc_works_with_unit.snap

@@ -71,6 +71,7 @@
   </ol>
 </li>
 
+    
   </ol>
 </li>
 
@@ -117,6 +118,12 @@
   </ol>
 </li>
 
+    <li class="os-toc-unit-page" cnx-archive-shortid="" cnx-archive-uri="p-unit-closer" data-toc-type="book-content" data-toc-target-type="numbered-section">
+  <a href="#p-unit-closer">
+    <span class="os-number">3</span><span class="os-divider"> </span><span data-type="" itemprop="" class="os-text">Unit Closer</span>
+  </a>
+</li>
+
   </ol>
 </li>