openstax_kitchen 3.1.0 → 5.0.0

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directons for eoc glossary
+    #
+    module BakeChapterGlossary
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterGlossary
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'glossary'
+      @title = I18n.t(:eoc_key_terms_title)
+      @uuid_prefix = uuid_prefix
+
+      definitions = chapter.glossaries.search('dl').cut
+      return if definitions.none?
+      definitions.sort_by! do |definition|
+        [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
+      end
+
+      chapter.glossaries.trash
+
+      @content = definitions.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

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -28,7 +28,7 @@ module Kitchen
           title.name = 'h2'
           MoveTitleTextIntoSpan.v1(title: title)
 
-          intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
+          intro_content = introduction_page.search("> :not([data-type='metadata']):not(.splash):not(.has-splash)").cut
 
           introduction_page.append(child:
             <<~HTML

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterKeyConcepts
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      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
     end
   end

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

@@ -3,10 +3,12 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     renderable
-    def bake(chapter:, metadata_source:, append_to:)
-      @metadata_elements = metadata_source.children_to_keep.copy
+    def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'key-concepts'
+      @title = I18n.t(:eoc_key_concepts)
+      @uuid_prefix = uuid_prefix
 
-      @key_concepts = []
       key_concepts_clipboard = Kitchen::Clipboard.new
       chapter.non_introduction_pages.each do |page|
         key_concepts = page.key_concepts
@@ -16,15 +18,18 @@ module Kitchen::Directions::BakeChapterKeyConcepts
         title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
         key_concepts.each do |key_concept|
           key_concept.prepend(child: title)
-          key_concept&.cut(to: key_concepts_clipboard)
+          key_concept.wrap("<div class='os-section-area'>")
+          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
         end
-        @key_concepts.push(key_concepts_clipboard.paste)
-        key_concepts_clipboard.clear
       end
 
+      @content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
+
       append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
 
-      append_to_element.append(child: render(file: 'key_concepts.xhtml.erb'))
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
     end
   end
 end

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_references/main.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReferences
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = klass
+      @title = I18n.t(:references)
+      @uuid_prefix = uuid_prefix
+
+      chapter.references.search('h3').trash
+
+      chapter.non_introduction_pages.each do |page|
+        references = page.references
+        next if references.none?
+
+        references.search('h3').trash
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+
+        references.each do |reference|
+          reference.prepend(child: title)
+        end
+      end
+
+      @content = chapter.pages.references.cut.paste
+
+      @in_composite_chapter = false
+
+      chapter.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    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_composite_chapters.rb

@@ -4,7 +4,7 @@ module Kitchen
   module Directions
     module BakeCompositeChapters
       def self.v1(book:)
-        book.search("[data-type='composite-chapter']").each do |chapter|
+        book.composite_chapters.each do |chapter|
           chapter.first("[data-type='document-title']").id =
             "composite-chapter-#{chapter.count_in(:book)}"
         end

data/lib/kitchen/directions/bake_composite_pages.rb

@@ -4,7 +4,7 @@ module Kitchen
   module Directions
     module BakeCompositePages
       def self.v1(book:)
-        book.search("[data-type='composite-page']").each do |page|
+        book.composite_pages.each do |page|
           page.id = "composite-page-#{page.count_in(:book)}"
         end
       end

data/lib/kitchen/directions/bake_equations.rb

@@ -3,20 +3,30 @@
 module Kitchen
   module Directions
     module BakeEquations
-      def self.v1(book:)
-        book.chapters.search('[data-type="equation"]:not(.unnumbered)').each do |eq|
+      def self.v1(book:, number_decorator: :none)
+        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)}"
 
           # 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
+            when :none
+              number
+            when :parentheses
+              "(#{number})"
+            else
+              raise "Unsupported number_decorator '#{number_decorator}'"
+            end
 
           # Bake the equation
           eq.append(child:
             <<~HTML
               <div class="os-equation-number">
-                <span class="os-number">#{number}</span>
+                <span class="os-number">#{decorated_number}</span>
               </div>
             HTML
           )

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_first_elements.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFirstElements
+      def self.v1(within:)
+        selectors = [
+          'div.os-problem-container > div.os-table',
+          'div.os-problem-container > span[data-type="media"]',
+          'div.os-solution-container > div.os-table',
+          'div.os-solution-container > span[data-type="media"]'
+        ]
+        selectors.each do |selector|
+          within.search("#{selector}:first-child").each do |problem|
+            problem.add_class('first-element')
+            problem.parent.add_class('has-first-element')
+          end
+        end
+      end
+    end
+  end
+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