openstax_kitchen 4.0.0 → 6.1.0

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

@@ -0,0 +1,49 @@
+# 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
+
+      bake_page_references(page: chapter.introduction_page)
+
+      chapter.non_introduction_pages.each do |page|
+        bake_page_references(page: page)
+      end
+
+      @content = chapter.pages.references.cut.paste
+      chapter.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+
+    def bake_page_references(page:)
+      return if page.nil?
+
+      references = page.references
+      return if references.none?
+
+      title = if page.is_introduction?
+                <<~HTML
+                  <a href="##{page.title.id}">
+                    <h3 data-type="document-title" id="#{page.title.copied_id}">
+                      <span class="os-text" data-type="" itemprop="">#{page.title_text}</span>
+                    </h3>
+                  </a>
+                HTML
+              else
+                Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+              end
+
+      references.each do |reference|
+        reference.prepend(child: title)
+      end
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeChapterSectionExercises
-      def self.v1(chapter:)
-        V1.new.bake(chapter: chapter)
+      def self.v1(chapter:, trash_title: false)
+        V1.new.bake(chapter: chapter, trash_title: trash_title)
       end
     end
   end

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

@@ -2,9 +2,10 @@
 
 module Kitchen::Directions::BakeChapterSectionExercises
   class V1
-    def bake(chapter:)
+    def bake(chapter:, trash_title:)
       chapter.pages.each do |page|
         page.search('section.section-exercises').each do |section|
+          section.first('h3[data-type="title"]')&.trash if trash_title
           section.wrap(
             %(<div class="os-eos os-section-exercises-container"
               data-uuid-key=".section-exercises">)

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

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

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

@@ -27,15 +27,22 @@ module Kitchen
           # 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'
-            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
-            )
+
+            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

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,7 +4,7 @@ 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)}"
 

data/lib/kitchen/directions/bake_example.rb

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

data/lib/kitchen/directions/bake_figure.rb

@@ -4,7 +4,20 @@ 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.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
         title = figure.title&.cut

data/lib/kitchen/directions/bake_first_elements.rb

@@ -3,7 +3,13 @@
 module Kitchen
   module Directions
     module BakeFirstElements
-      def self.v1(within:, selectors:)
+      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')

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,37 +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,
                                       Kitchen::CompositeChapterElement).each do |page|
-        bake_footnotes_within(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_further_research.rb

@@ -24,6 +24,8 @@ module Kitchen
 
           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'

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)
@@ -49,12 +42,8 @@ module Kitchen::Directions::BakeIndex
       end
 
       def <=>(other)
-        sortable <=> other.sortable
+        I18n.sort_strings(term_text, other.term_text)
       end
-
-      protected
-
-      attr_reader :sortable
     end
 
     class IndexSection
@@ -147,8 +136,8 @@ module Kitchen::Directions::BakeIndex
     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/)
+      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

data/lib/kitchen/directions/bake_inline_lists.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bakes inline lists with the desired list separator
+    # Does not separate the last list item
+    #
+    module BakeInlineLists
+      LIST_SEPARATOR = '; '
+      SEPARATOR_CLASS = '-os-inline-list-separator'
+
+      def self.v1(book:)
+        inline_lists = book.search('span[data-display="inline"][data-type="list"]')
+        inline_lists.each do |list|
+          list.search('span[data-type="item"]')[0..-2].each do |item|
+            item.append(child: "<span class=\"#{SEPARATOR_CLASS}\">#{LIST_SEPARATOR}</span>")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNumberedNotes
+      def self.v1(book:, classes:)
+        V1.new.bake(book: book, classes: classes)
+      end
+
+      def self.v2(book:, classes:)
+        V2.new.bake(book: book, classes: classes)
+      end
+
+      # V3 bakes notes tied to an example immediately previous ("Try It" notes)
+      # Must be called AFTER BakeExercises
+      #
+      def self.v3(book:, classes:, suppress_solution: true)
+        V3.new.bake(book: book, classes: classes, suppress_solution: suppress_solution)
+      end
+
+      # Used by V1, V2, V3
+      def self.bake_note_exercise(note:, exercise:, divider: ' ', suppress_solution: false)
+        exercise.add_class('unnumbered')
+        # bake problem
+        exercise.problem.wrap_children('div', class: 'os-problem-container')
+        exercise.search('[data-type="commentary"]').each(&:trash)
+        return unless exercise.solution
+
+        # bake solution in place
+        if suppress_solution
+          exercise.add_class('os-hasSolution')
+          exercise.solution.trash
+        else
+          BakeNumberedExercise.bake_solution_v1(
+            exercise: exercise,
+            number: note.first('.os-number').text.gsub(/#/, ''),
+            divider: divider
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedNotes
+
+  class V1
+    def bake(book:, classes:)
+      classes.each do |klass|
+        book.chapters.notes("$.#{klass}").each do |note|
+          bake_note(note: note)
+          note.exercises.each do |exercise|
+            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise)
+          end
+        end
+      end
+    end
+
+    def bake_note(note:)
+      note.wrap_children(class: 'os-note-body')
+
+      chapter_count = note.ancestor(:chapter).count_in(:book)
+      note_count = note.count_in(:chapter)
+      note.prepend(child:
+        <<~HTML
+          <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>
+          </h3>
+        HTML
+      )
+
+      return unless note['use-subtitle']
+
+      Kitchen::Directions::BakeNoteSubtitle.v1(note: note)
+    end
+  end
+end