Core 711 raise toc (#407)

* Add options to include unit numbering in ToC

Might be better to either allow external customization or centralize numbering generation

It could work with a recursive function that walks up the tree looking for units/chapters

The page only has access to ancestors that the iterator visits

* Update tests for ToC

* Add number parts and os number method to element base

Hopefully these can replace the scattered logic for numbering

* Add v2 bake_chapter_title that takes chapters as input

* Add tests for v2 bake_chapter_title

* Unit numbering in bake_non_introduction_pages

* Update tests for bake_non_introduction_pages

* Unit numbering in bake_toc

* Update tests for bake_toc

* Unit numbering in bake_chapter_section_exercises

* Unit numbering in move_solutions_from_numbered_note

* Update tests for bake_chapter_section_exercises

* Add v2 bake_equations that takes chapters as input

* Update tests for bake_equations

* Update tests for element_base; fix data-source

It should print in the format that corgi already recognizes

* Update tests for bake_chapter_section_exercises

* Unit numbering in bake_learning_objectives

* Unit numbering in bake_chapter_introductions

When unit numbering is desired, send chapters with unit ancestors and the associated numbering options

* Unit numbering in bake_index

* Update tests for bake_index

* Unit numbering to bake_references

* Update tests for bake_references

* Unit numbering in bake_folio

* Update tests for bake_folio

* Update changelog

* 👕 Lint

* Ensure full test coverage

Author: TylerZeroMaster

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 * Fix iframes links for Polish books
+* Create `number_parts` method in `ElementBase`
+* Create `os_number` method in `ElementBase` for creating `os-number` text
+* Add backward-compatible support for unit numbering where possible
+* Create `v2` of `BakeEquations` that takes chapters as input instead of book
+* Create `v2` of `BakeChapterTitle` that takes chapters as input instead of book
 * Remove `ElementBase#rex_link` in favor of generating links elsewhere
 * Update `BakeIframes` to mark iframe links as needing rex linking
 

lib/kitchen/directions/bake_chapter_introductions/bake_chapter_objectives.rb

@@ -2,12 +2,12 @@
 
 module Kitchen::Directions::BakeChapterIntroductions
   class BakeChapterObjectives
-    def bake(chapter:, strategy:)
+    def bake(chapter:, strategy:, options:)
       case strategy
       when :default
         bake_as_note(chapter: chapter)
       when :add_objectives
-        add_chapter_objectives(chapter: chapter)
+        add_chapter_objectives(chapter: chapter, options: options)
       when :none
         ''
       else
@@ -31,12 +31,14 @@ def bake_as_note(chapter:)
       chapter_objectives_note.cut.paste
     end
 
-    def add_chapter_objectives(chapter:)
+    def add_chapter_objectives(chapter:, options: {})
+      options.reverse_merge!(numbering_options: { mode: :chapter_page, separator: '.' })
       chapter.non_introduction_pages.map do |page|
+        number = page.os_number(options[:numbering_options])
         <<~HTML
           <div class="os-chapter-objective">
             <a class="os-chapter-objective" href="##{page.id}">
-              <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
+              <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
               <span data-type="" itemprop="" class="os-text">#{page.title_children}</span>
             </a>

lib/kitchen/directions/bake_chapter_introductions/main.rb

@@ -11,29 +11,34 @@ def self.v1(book:)
 
       def self.v2(
         book:,
+        chapters: nil,
         options: {
           strategy: :default, bake_chapter_outline: false, introduction_order: :v1,
           block_target_label: false,
-          cases: false
+          cases: false,
+          numbering_options: { mode: :chapter_page, separator: '.' }
         }
       )
         options.reverse_merge!(
           strategy: :default,
           bake_chapter_outline: false,
           introduction_order: :v1,
           block_target_label: false,
-          cases: false
+          cases: false,
+          numbering_options: { mode: :chapter_page, separator: '.' }
         )
         V2.new.bake(
           book: book,
+          chapters: chapters || book.chapters,
           options: options
         )
       end
 
-      def self.bake_chapter_objectives(chapter:, strategy:)
+      def self.bake_chapter_objectives(chapter:, strategy:, options:)
         BakeChapterObjectives.new.bake(
           chapter: chapter,
-          strategy: strategy
+          strategy: strategy,
+          options: options
         )
       end
 

lib/kitchen/directions/bake_chapter_introductions/v2.rb

@@ -2,10 +2,10 @@
 
 module Kitchen::Directions::BakeChapterIntroductions
   class V2
-    def bake(book:, options:)
-      book.chapters.each do |chapter|
+    def bake(book:, chapters:, options:)
+      chapters.each do |chapter|
         introduction_page = chapter.introduction_page
-        number = chapter.count_in(:book)
+        number = chapter.os_number(options[:numbering_options])
         title_label = chapter.title.search('.os-text').first&.text
         title_label = chapter.title.text if title_label.nil?
 
@@ -16,7 +16,8 @@ def bake(book:, options:)
         chapter_intro_html =
           Kitchen::Directions::BakeChapterIntroductions.bake_chapter_objectives(
             chapter: chapter,
-            strategy: options[:strategy]
+            strategy: options[:strategy],
+            options: options
           )
 
         if options[:bake_chapter_outline]

lib/kitchen/directions/bake_chapter_section_exercises/main.rb

@@ -5,11 +5,13 @@ module Directions
     module BakeChapterSectionExercises
       def self.v1(chapter:, options: {
         trash_title: false,
-        create_title: true
+        create_title: true,
+        numbering_options: { mode: :chapter_page, separator: '.' }
       })
         options.reverse_merge!(
           trash_title: false,
-          create_title: true
+          create_title: true,
+          numbering_options: { mode: :chapter_page, separator: '.' }
         )
         V1.new.bake(chapter: chapter, options: options)
       end

lib/kitchen/directions/bake_chapter_section_exercises/v1.rb

@@ -15,7 +15,7 @@ def bake(chapter:, options:)
 
           section_title = I18n.t(
             :section_exercises,
-            number: "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}")
+            number: page.os_number(options[:numbering_options]))
 
           section.prepend(sibling:
             <<~HTML

lib/kitchen/directions/bake_chapter_title/main.rb

@@ -6,6 +6,10 @@ module BakeChapterTitle
       def self.v1(book:, cases: false)
         V1.new.bake(book: book, cases: cases)
       end
+
+      def self.v2(chapters:, cases: false, numbering_options: {})
+        V2.new.bake(chapters: chapters, cases: cases, numbering_options: numbering_options)
+      end
     end
   end
 end

lib/kitchen/directions/bake_chapter_title/v1.rb

@@ -4,17 +4,23 @@ module Kitchen::Directions::BakeChapterTitle
   class V1
     def bake(book:, cases: false)
       book.chapters.each do |chapter|
-        fix_up_chapter_title(chapter: chapter, cases: cases)
+        fix_up_chapter_title(
+          chapter: chapter,
+          cases: cases,
+          numbering_options: { mode: :chapter_page, separator: '.' })
       end
     end
 
-    def fix_up_chapter_title(chapter:, cases:)
+    protected
+
+    def fix_up_chapter_title(chapter:, cases:, numbering_options:)
       heading = chapter.at('h1[2]')
       heading[:id] = "chapTitle#{chapter.count_in(:book)}"
+      number = chapter.os_number(numbering_options)
       heading.replace_children(with:
         <<~HTML
           <span class="os-part-text">#{I18n.t("chapter#{'.nominative' if cases}")} </span>
-          <span class="os-number">#{chapter.count_in(:book)}</span>
+          <span class="os-number">#{number}</span>
           <span class="os-divider"> </span>
           <span data-type="" itemprop="" class="os-text">#{heading.text}</span>
         HTML

lib/kitchen/directions/bake_chapter_title/v2.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterTitle
+  class V2 < V1
+    def bake(chapters:, cases: false, numbering_options: {})
+      chapters.each do |chapter|
+        fix_up_chapter_title(
+          chapter: chapter,
+          cases: cases,
+          numbering_options: numbering_options)
+      end
+    end
+  end
+end

lib/kitchen/directions/bake_equations.rb

@@ -4,9 +4,24 @@ module Kitchen
   module Directions
     module BakeEquations
       def self.v1(book:, number_decorator: :none, cases: false)
-        book.chapters.search('div[data-type="equation"]:not(.unnumbered)').each do |eq|
-          chapter = eq.ancestor(:chapter)
-          number = "#{chapter.count_in(:book)}.#{eq.count_in(:chapter)}"
+        _v1_bake_in_chapters(
+          chapters: book.chapters,
+          number_decorator: number_decorator,
+          cases: cases,
+          numbering_options: { mode: :chapter_page, separator: '.' })
+      end
+
+      def self.v2(chapters:, number_decorator: :none, cases: false, numbering_options: {})
+        _v1_bake_in_chapters(
+          chapters: chapters,
+          number_decorator: number_decorator,
+          cases: cases,
+          numbering_options: numbering_options)
+      end
+
+      def self._v1_bake_in_chapters(chapters:, number_decorator:, cases:, numbering_options:)
+        chapters.search('div[data-type="equation"]:not(.unnumbered)').each do |eq|
+          number = eq.os_number(numbering_options)
 
           # Store label information
           eq.target_label(label_text: 'equation', custom_content: number, cases: cases)
@@ -31,6 +46,10 @@ def self.v1(book:, number_decorator: :none, cases: false)
           )
         end
       end
+
+      class << self
+        private :_v1_bake_in_chapters
+      end
     end
   end
 end

lib/kitchen/directions/bake_folio.rb

@@ -3,9 +3,14 @@
 module Kitchen
   module Directions
     module BakeFolio
-      def self.v1(book:, options: { new_approach: false })
-        options.reverse_merge!(new_approach: false)
-        V1.new.bake(book: book, options: options)
+      def self.v1(book:, chapters: nil, options: {})
+        options.reverse_merge!(
+          new_approach: false,
+          numbering_options: { mode: :chapter_page, separator: '.' })
+        V1.new.bake(
+          book: book,
+          chapters: chapters || book.chapters,
+          options: options)
       end
 
       class V1
@@ -56,19 +61,27 @@ def create_para
           end
         end
 
-        def bake(book:, options:)
+        def bake(book:, chapters:, options:)
           book['data-pdf-folio-preface-message'] = I18n.t(:"folio.preface")
           book['data-pdf-folio-access-message'] = I18n.t(:"folio.access_for_free")
 
           return unless options[:new_approach]
 
           # TODO: apply to all books and remove an option
-
-          book.chapters.each do |chapter|
-            chapter_folio(chapter: chapter)
-            module_folio(chapter: chapter)
-            eoc_folio(chapter: chapter, klass: 'folio-eoc-left')
-            eoc_folio(chapter: chapter, klass: 'folio-eoc-right')
+          numbering_options = options[:numbering_options]
+          chapters.each do |chapter|
+            chapter_folio(chapter: chapter, numbering_options: numbering_options)
+            module_folio(chapter: chapter, numbering_options: numbering_options)
+            eoc_folio(
+              chapter: chapter,
+              klass: 'folio-eoc-left',
+              numbering_options: numbering_options
+            )
+            eoc_folio(
+              chapter: chapter,
+              klass: 'folio-eoc-right',
+              numbering_options: numbering_options
+            )
           end
 
           appendix_folio(book: book, klass: 'folio-appendix-left')
@@ -78,23 +91,23 @@ def bake(book:, options:)
           eob_folio(book: book, klass: 'folio-eob-right')
         end
 
-        def chapter_folio(chapter:)
+        def chapter_folio(chapter:, numbering_options:)
           chapter_para = FolioParaWithNumber.new(
             klass: 'folio-chapter',
             title: chapter.title,
-            title_number: chapter.count_in(:book).to_s
+            title_number: chapter.os_number(numbering_options)
           )
 
           chapter_para.create_para
         end
 
-        def module_folio(chapter:)
+        def module_folio(chapter:, numbering_options:)
           # Introduction para
           chapter.pages('$.introduction').each do |page|
             intro_para = FolioParaWithNumber.new(
               klass: 'folio-module',
               title: page.search('h2[data-type="document-title"]').first,
-              title_number: chapter.count_in(:book).to_s
+              title_number: chapter.os_number(numbering_options)
             )
 
             intro_para.create_para
@@ -105,19 +118,19 @@ def module_folio(chapter:)
             module_para = FolioParaWithNumber.new(
               klass: 'folio-module',
               title: page.title,
-              title_number: "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+              title_number: page.os_number(numbering_options)
             )
 
             module_para.create_para
           end
         end
 
-        def eoc_folio(chapter:, klass:)
+        def eoc_folio(chapter:, klass:, numbering_options:)
           chapter.search(' > .os-eoc').each do |eoc_page|
             eoc_para = FolioParaWithNumber.new(
               klass: klass,
               title: eoc_page.search('h2[data-type="document-title"]').first,
-              title_number: chapter.count_in(:book).to_s
+              title_number: chapter.os_number(numbering_options)
             )
 
             eoc_para.create_para

lib/kitchen/directions/bake_index/main.rb

@@ -3,8 +3,17 @@
 module Kitchen
   module Directions
     module BakeIndex
-      def self.v1(book:, types: %w[main], uuid_prefix: nil)
-        V1.new.bake(book: book, types: types, uuid_prefix: uuid_prefix)
+      def self.v1(book:,
+                  chapters: nil,
+                  types: %w[main],
+                  uuid_prefix: nil,
+                  numbering_options: { mode: :chapter_page, separator: '.' })
+        V1.new.bake(
+          book: book,
+          chapters: chapters || book.chapters,
+          types: types,
+          uuid_prefix: uuid_prefix,
+          numbering_options: numbering_options)
       end
     end
   end

lib/kitchen/directions/bake_index/v1.rb

@@ -118,13 +118,14 @@ def section_named(name)
       end
     end
 
-    def bake(book:, types: %w[main], uuid_prefix: '')
+    def bake(book:, chapters:, types: %w[main], uuid_prefix: '', numbering_options: {})
       @metadata_elements = book.metadata.children_to_keep.copy
       @uuid_prefix = uuid_prefix
       @indexes = types.each.with_object({}) do |type, hash|
         index_name = type == 'main' ? 'term' : type
         hash[index_name] = Index.new
       end
+      numbering_options.reverse_merge!(mode: :chapter_page, separator: '.')
 
       # Numbering of IDs doesn't depend on term type
 
@@ -137,7 +138,7 @@ def bake(book:, types: %w[main], uuid_prefix: '')
         add_term_to_index(term_element, page_title)
       end
 
-      book.chapters.search_with(
+      chapters.search_with(
         Kitchen::PageElementEnumerator, Kitchen::CompositePageElementEnumerator
       ).terms.each do |term_element|
 
@@ -149,7 +150,7 @@ def bake(book:, types: %w[main], uuid_prefix: '')
           page = term_element.ancestor(:composite_page)
           chapter = term_element.ancestor(:chapter)
           term_element.id ||= "auto_composite_page_term#{term_element.count_in(:book)}"
-          chapter_number = chapter.count_in(:book)
+          chapter_number = chapter.os_number(numbering_options)
           page_title = "#{chapter_number} #{page.title.text.strip}".strip
         end