openstax_kitchen 3.2.0 → 6.0.0

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterSolutions
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, uuid_prefix: '')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'solutions'
+      @title = I18n.t(:eoc_solutions_title)
+      @uuid_prefix = uuid_prefix
+
+      solutions_clipboard = Kitchen::Clipboard.new
+
+      chapter.search('section.free-response').each do |free_response_question|
+        exercises = free_response_question.exercises
+        # must run AFTER .free-response notes are baked
+
+        next if exercises.none?
+
+        exercises.each do |exercise|
+          solution = exercise.solution
+          next unless solution.present?
+
+          solution.cut(to: solutions_clipboard)
+        end
+      end
+
+      @content = solutions_clipboard.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,51 +5,64 @@ 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>
-            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
+      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
+
+            next if summary.nil?
+
+            summary.first("[data-type='title']")&.trash # get rid of old title if exists
+            summary_title = page.title.copy
+            summary_title.name = 'h3'
+
+            unless summary_title.children.search('span.os-number').present?
+              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
+              )
+            end
+
+            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
 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

@@ -4,13 +4,13 @@ module Kitchen
   module Directions
     module BakeEquations
       def self.v1(book:, number_decorator: :none)
-        book.chapters.search('[data-type="equation"]:not(.unnumbered)').each do |eq|
+        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

data/lib/kitchen/directions/bake_example.rb

@@ -20,7 +20,14 @@ 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|
+          if title.parent.has_class?('os-caption-container') || \
+             title.parent.has_class?('os-caption')
+            next
+          end
+
+          title.name = 'h4'
+        end
 
         example.exercises.each do |exercise|
           if (problem = exercise.problem)

data/lib/kitchen/directions/bake_figure.rb

@@ -4,9 +4,22 @@ module Kitchen
   module Directions
     module BakeFigure
       def self.v1(figure:, number:)
+        return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
+
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+        if figure.has_class?('unnumbered') && figure.has_class?('splash')
+          caption = figure.caption&.cut
+          figure.append(sibling:
+            <<~HTML
+              <div class="os-caption-container">
+                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
+              </div>
+            HTML
+          )
+          return
+        end
 
-        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/main.rb

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeFootnotes
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, number_format: :arabic)
+        V1.new.bake(book: book, number_format: number_format)
       end
     end
   end

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

@@ -3,36 +3,40 @@
 module Kitchen::Directions::BakeFootnotes
   class V1
 
-    def bake(book:)
+    def bake(book:, number_format: :arabic)
       # Footnotes are numbered either within their top-level pages (preface,
       # appendices, etc) or within chapters. Tackle each case separately
 
       book.body.element_children.only(Kitchen::PageElement,
-                                      Kitchen::CompositePageElement).each do |page|
-        bake_footnotes_within(page)
+                                      Kitchen::CompositePageElement,
+                                      Kitchen::CompositeChapterElement).each do |page|
+        bake_footnotes_within(page, number_format: number_format)
       end
 
       book.chapters.each do |chapter|
-        bake_footnotes_within(chapter)
+        bake_footnotes_within(chapter, number_format: number_format)
       end
     end
 
-    def bake_footnotes_within(container)
-      footnote_number = 0
+    def bake_footnotes_within(container, number_format:)
+      footnote_count = 0
       aside_id_to_footnote_number = {}
 
       container.search("a[role='doc-noteref']").each do |anchor|
-        footnote_number += 1
-        anchor.replace_children(with: footnote_number.to_s)
+        footnote_count += 1
+        footnote_number = footnote_count.to_format(number_format)
+        anchor.replace_children(with: footnote_number)
         aside_id = anchor[:href][1..-1]
         aside_id_to_footnote_number[aside_id] = footnote_number
+        anchor.parent.add_class('has-noteref') if anchor.parent.name == 'p'
       end
 
       container.search('aside').each do |aside|
         footnote_number = aside_id_to_footnote_number[aside.id]
         aside.prepend(child: "<div data-type='footnote-number'>#{footnote_number}</div>")
       end
-    end
 
+      footnote_count
+    end
   end
 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_chapter_review → bake_free_response}/main.rb

@@ -2,9 +2,9 @@
 
 module Kitchen
   module Directions
-    module BakeChapterReview
-      def self.v1(chapter:, metadata_source:)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source)
+    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

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,61 @@
+# 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')
+            next unless further_research.present?
+
+            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

@@ -27,13 +27,6 @@ module Kitchen::Directions::BakeIndex
       def initialize(term_text:)
         @term_text = term_text
         @terms = []
-
-        # Sort by transliterated version first to support accent marks,
-        # then by the raw text to support the same text with different capitalization
-        @sortable = [
-          ActiveSupport::Inflector.transliterate(term_text).downcase,
-          term_text
-        ]
       end
 
       def add_term(term)
@@ -44,13 +37,13 @@ module Kitchen::Directions::BakeIndex
         @term_text = @term_text.uncapitalize
       end
 
-      def <=>(other)
-        sortable <=> other.sortable
+      def capitalize_term_text!
+        @term_text = @term_text.capitalize
       end
 
-      protected
-
-      attr_reader :sortable
+      def <=>(other)
+        I18n.sort_strings(term_text, other.term_text)
+      end
     end
 
     class IndexSection
@@ -84,6 +77,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 +117,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 = I18n.transliterate(term_element.text.strip[0])
+      group_by = I18n.t(:eob_index_symbols_group) unless group_by.match?(/[[:alpha:]]/)
+      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