openstax_kitchen 3.2.0 → 4.0.0

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -2,33 +2,38 @@
 
 module Kitchen
   module Directions
-    # Bake directions for eoc key equations
+    # Bake directons for eoc key equations
     #
     module BakeChapterKeyEquations
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        metadata_elements = metadata_source.children_to_keep.copy
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
 
-        chapter.key_equations.search('h3').trash
-        key_equations = chapter.key_equations.cut
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = 'key-equations'
+          @title = I18n.t(:eoc_key_equations)
+          @uuid_prefix = uuid_prefix
 
-        return if key_equations.none?
+          chapter.key_equations.search('h3').trash
 
-        append_to_element = append_to || chapter
+          return if chapter.key_equations.none?
 
-        append_to_element.append(child:
-          <<~HTML
-            <div class="os-eoc os-key-equations-container" data-type="composite-page" data-uuid-key=".key-equations">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_key_equations)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_equations)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{key_equations.paste}
-            </div>
-          HTML
-        )
+          @content = chapter.key_equations.cut.paste
+
+          append_to_element = append_to || chapter
+          @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+          append_to_element.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
       end
     end
   end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -5,50 +5,56 @@ module Kitchen
     # Bake directions for eoc summary
     #
     module BakeChapterSummary
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.children_to_keep.copy
-
-        summaries = Clipboard.new
-
-        # TODO: include specific page types somehow without writing it out
-        chapter.non_introduction_pages.each do |page|
-          summary = page.summary
-          summary.first("[data-type='title']")&.trash # get rid of old title if exists
-          summary_title = page.title.copy
-          summary_title.name = 'h3'
-          summary_title.replace_children(with: <<~HTML
-            <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-            <span class="os-divider"> </span>
-            <span class="os-text" data-type="" itemprop="">#{summary_title.children}</span>
-          HTML
-          )
-
-          summary.prepend(child:
-            <<~HTML
-              <a href="##{page.title.id}">
-                #{summary_title.paste}
-              </a>
+      def self.v1(chapter:, metadata_source:, klass: 'summary', uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
+
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = klass
+          @title = I18n.t(:eoc_summary_title)
+          @uuid_prefix = uuid_prefix
+
+          summaries = Clipboard.new
+
+          # TODO: include specific page types somehow without writing it out
+          chapter.non_introduction_pages.each do |page|
+            summary = page.summary
+            summary.first("[data-type='title']")&.trash # get rid of old title if exists
+            summary_title = page.title.copy
+            summary_title.name = 'h3'
+            summary_title.replace_children(with: <<~HTML
+              <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
+              <span class="os-divider"> </span>
+              <span class="os-text" data-type="" itemprop="">#{summary_title.children}</span>
             HTML
-          )
-          summary.cut(to: summaries)
-        end
+            )
 
-        return if summaries.none?
-
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-summary-container" data-type="composite-page" data-uuid-key=".summary">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_summary_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_summary_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{summaries.paste}
-            </div>
-          HTML
-        )
+            summary.prepend(child:
+              <<~HTML
+                <a href="##{page.title.id}">
+                  #{summary_title.paste}
+                </a>
+              HTML
+            )
+            summary.cut(to: summaries)
+          end
+
+          return if summaries.none?
+
+          @content = summaries.paste
+          @in_composite_chapter = false
+
+          chapter.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
       end
     end
   end

data/lib/kitchen/directions/bake_equations.rb

@@ -10,7 +10,7 @@ module Kitchen
 
           # Store label information
           equation_label = "#{I18n.t(:equation)} #{number}"
-          book.document.pantry(name: :link_text).store equation_label, label: eq.id
+          book.pantry(name: :link_text).store equation_label, label: eq.id
 
           decorated_number =
             case number_decorator

data/lib/kitchen/directions/bake_example.rb

@@ -20,7 +20,11 @@ module Kitchen
                .pantry(name: :link_text)
                .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
-        example.titles.each { |title| title.name = 'h4' }
+        example.titles.each do |title|
+          next if title.parent.has_class?('os-caption-container')
+
+          title.name = 'h4'
+        end
 
         example.exercises.each do |exercise|
           if (problem = exercise.problem)

data/lib/kitchen/directions/bake_figure.rb

@@ -6,7 +6,7 @@ module Kitchen
       def self.v1(figure:, number:)
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
 
-        figure.document.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
+        figure.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
         title = figure.title&.cut
 
         caption = figure.caption&.cut

data/lib/kitchen/directions/{bake_problem_first_elements.rb → bake_first_elements.rb}

@@ -2,10 +2,10 @@
 
 module Kitchen
   module Directions
-    module BakeProblemFirstElements
+    module BakeFirstElements
       def self.v1(within:, selectors:)
         selectors.each do |selector|
-          within.search(".os-problem-container > #{selector}:first-child").each do |problem|
+          within.search("#{selector}:first-child").each do |problem|
             problem.add_class('first-element')
             problem.parent.add_class('has-first-element')
           end

data/lib/kitchen/directions/bake_footnotes/v1.rb

@@ -8,7 +8,8 @@ module Kitchen::Directions::BakeFootnotes
       # appendices, etc) or within chapters. Tackle each case separately
 
       book.body.element_children.only(Kitchen::PageElement,
-                                      Kitchen::CompositePageElement).each do |page|
+                                      Kitchen::CompositePageElement,
+                                      Kitchen::CompositeChapterElement).each do |page|
         bake_footnotes_within(page)
       end
 

data/lib/kitchen/directions/bake_free_response/free_response.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eoc os-free-response-container" data-type="composite-page" data-uuid-key=".free-response">
+  <<%= @title_tag %> data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_free_response) %></span>
+  </<%= @title_tag %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_free_response) %></h1>
+    <%= @metadata_elements.paste %>
+  </div>
+    <%= @free_response_clipboard.paste %>
+</div>

data/lib/kitchen/directions/bake_free_response/main.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFreeResponse
+      def self.v1(chapter:, metadata_source:, append_to: nil)
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_free_response/v1.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeFreeResponse
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to:)
+      @metadata_elements = metadata_source.children_to_keep.copy
+
+      @free_response_clipboard = Kitchen::Clipboard.new
+      chapter.non_introduction_pages.each do |page|
+        free_response_questions = page.free_response
+        next if free_response_questions.none?
+
+        free_response_questions.search('h3').trash
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+        free_response_questions.each do |free_response_question|
+          free_response_question.prepend(child: title)
+          free_response_question.cut(to: @free_response_clipboard)
+        end
+      end
+
+      append_to_element = append_to || chapter
+      @title_tag = append_to ? 'h3' : 'h2'
+
+      append_to_element.append(child: render(file: 'free_response.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_further_research.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for further research
+    #
+    module BakeFurtherResearch
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix)
+      end
+
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, uuid_prefix: '.')
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = 'further-research'
+          @title = I18n.t(:eoc_further_research_title)
+          @uuid_prefix = uuid_prefix
+
+          further_researches = Clipboard.new
+
+          chapter.non_introduction_pages.each do |page|
+            further_research = page.first('.further-research')
+            further_research.first("[data-type='title']")&.trash # get rid of old title if exists
+            further_research_title = page.title.copy
+            further_research_title.name = 'h3'
+            further_research_title.replace_children(with: <<~HTML
+              <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
+              <span class="os-divider"> </span>
+              <span class="os-text" data-type="" itemprop="">#{further_research_title.children}</span>
+            HTML
+            )
+
+            further_research.prepend(child:
+              <<~HTML
+                <a href="##{page.title.id}">
+                  #{further_research_title.paste}
+                </a>
+              HTML
+            )
+            further_research.cut(to: further_researches)
+          end
+
+          return if further_researches.none?
+
+          @content = further_researches.paste
+
+          @in_composite_chapter = false
+
+          chapter.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_index/v1.rb

@@ -44,6 +44,10 @@ module Kitchen::Directions::BakeIndex
         @term_text = @term_text.uncapitalize
       end
 
+      def capitalize_term_text!
+        @term_text = @term_text.capitalize
+      end
+
       def <=>(other)
         sortable <=> other.sortable
       end
@@ -84,6 +88,11 @@ module Kitchen::Directions::BakeIndex
           different_caps_item = @items_by_term_text[term.text.uncapitalize]
           different_caps_item&.uncapitalize_term_text!
 
+          unless different_caps_item
+            different_caps_item = @items_by_term_text[term.text.capitalize]
+            different_caps_item&.capitalize_term_text!
+          end
+
           (different_caps_item || IndexItem.new(term_text: term.text)).tap do |item|
             @items.add(item)
           end
@@ -119,27 +128,39 @@ module Kitchen::Directions::BakeIndex
       @index = Index.new
 
       book.pages.terms.each do |term_element|
-        # Markup the term
         page = term_element.ancestor(:page)
         term_element.id = "auto_#{page.id}_term#{term_element.count_in(:book)}"
+        page_title = page.title.text
+        add_term_to_index(term_element, page_title)
+      end
 
-        group_by = term_element.text.strip[0]
-        group_by = I18n.t(:eob_index_symbols_group) unless group_by.match?(/\w/)
-        term_element['group-by'] = group_by
-
-        # Add it to our index object
-        @index.add_term(
-          Term.new(
-            text: term_element.text,
-            id: term_element.id,
-            group_by: group_by,
-            page_title: page.title.text.gsub(/\n/, '')
-          )
-        )
+      book.chapters.composite_pages.terms.each do |term_element|
+        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)
+        page_title = "#{chapter_number} #{page.title.text.strip}".strip
+        add_term_to_index(term_element, page_title)
       end
 
       book.first('body').append(child: render(file: 'v1.xhtml.erb'))
     end
 
+    def add_term_to_index(term_element, page_title)
+      group_by = term_element.text.strip[0]
+      group_by = I18n.t(:eob_index_symbols_group) unless group_by.match?(/\w/)
+      term_element['group-by'] = group_by
+
+      # Add it to our index object
+      @index.add_term(
+        Term.new(
+          text: term_element.text,
+          id: term_element.id,
+          group_by: group_by,
+          page_title: page_title.gsub(/\n/, '')
+        )
+      )
+    end
+
   end
 end

data/lib/kitchen/directions/bake_link_placeholders.rb

@@ -10,7 +10,7 @@ module Kitchen
           next unless anchor.text == '[link]'
 
           id = anchor[:href][1..-1]
-          replacement = book.document.pantry(name: :link_text).get(id)
+          replacement = book.pantry(name: :link_text).get(id)
           if replacement.present?
             anchor.replace_children(with: replacement)
           else

data/lib/kitchen/directions/bake_notes/bake_note_subtitle.rb

@@ -8,6 +8,10 @@ module Kitchen
 
         return unless title
 
+        # Store label information
+        note_label = title.children
+        note.pantry(name: :link_text).store note_label, label: note.id
+
         title.name = 'h4'
         title.add_class('os-subtitle')
         title.wrap_children('span', class: 'os-subtitle-label')

data/lib/kitchen/directions/bake_notes/bake_numbered_notes.rb

@@ -7,7 +7,9 @@ module Kitchen
         classes.each do |klass|
           book.chapters.notes("$.#{klass}").each do |note|
             bake_note(note: note)
-            bake_note_exercise(note: note)
+            note.exercises.each do |exercise|
+              bake_note_exercise(note: note, exercise: exercise)
+            end
           end
         end
       end
@@ -19,11 +21,11 @@ module Kitchen
         note_count = note.count_in(:chapter)
         note.prepend(child:
           <<~HTML
-            <div class="os-title">
+            <h3 class="os-title">
               <span class="os-title-label">#{note.autogenerated_title}</span>
               <span class="os-number">#{chapter_count}.#{note_count}</span>
               <span class="os-divider"> </span>
-            </div>
+            </h3>
           HTML
         )
 
@@ -32,31 +34,17 @@ module Kitchen
         BakeNoteSubtitle.v1(note: note)
       end
 
-      def self.bake_note_exercise(note:)
-        exercise = note.exercises.first
-        return unless exercise
-
+      def self.bake_note_exercise(note:, exercise:)
         exercise.add_class('unnumbered')
         # bake problem
         exercise.problem.wrap_children('div', class: 'os-problem-container')
         exercise.problem.first('strong')&.trash
         exercise.search('[data-type="commentary"]').each(&:trash)
-        solution = exercise.solution
-        return unless solution
+        return unless exercise.solution
 
         # bake solution in place
-        exercise.add_class('os-hasSolution')
-        solution[:id] = "#{exercise[:id]}-solution"
-        solution_number = note.first('.os-number').text
-        solution.replace_children(with:
-          <<~HTML
-            <a class="os-number" href="##{exercise[:id]}">#{solution_number}</a>
-            <span class="os-divider"> </span>
-            <div class="os-solution-container">
-              #{solution.children}
-            </div>
-          HTML
-        )
+        BakeNumberedExercise.bake_solution_v1(
+          exercise: exercise, number: note.first('.os-number').text, divider: ' ')
       end
     end
   end