openstax_kitchen 5.0.0 → 6.0.0

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

@@ -136,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_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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedNotes
+  class V2
+    def bake(book:, classes:)
+      classes.each do |klass|
+        book.chapters.pages.notes("$.#{klass}").each do |note|
+          note.wrap_children(class: 'os-note-body')
+          note_count = note.count_in(:page)
+          note.prepend(child:
+            <<~HTML
+              <h3 class="os-title">
+                <span class="os-title-label">#{note.autogenerated_title}</span>
+                <span class="os-number">##{note_count}</span>
+              </h3>
+            HTML
+          )
+          note.exercises.each do |exercise|
+            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise, divider: '. ')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedNotes
+  class V3
+    # for the try it notes, must be called AFTER bake_exercises
+    def bake(book:, classes:, suppress_solution: true)
+      classes.each do |klass|
+        book.chapters.notes("$.#{klass}").each do |note|
+          note.wrap_children(class: 'os-note-body')
+          previous_example = note.previous
+          os_number = previous_example&.first('.os-number')&.children&.to_s
+
+          note.prepend(child:
+            <<~HTML
+              <h3 class="os-title">
+                <span class="os-title-label">#{note.autogenerated_title}</span>
+                <span class="os-number">#{os_number}</span>
+              </h3>
+            HTML
+          )
+
+          note.title&.trash
+          note.exercises.each do |exercise|
+            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(
+              note: note, exercise: exercise, divider: '. ', suppress_solution: suppress_solution
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,9 @@
 module Kitchen
   module Directions
     module BakeNumberedExercise
-      def self.v1(exercise:, number:, suppress_solution: false)
-        V1.new.bake(exercise: exercise, number: number, suppress_solution: suppress_solution)
+      def self.v1(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
+        V1.new.bake(exercise: exercise, number: number, suppress_solution_if: suppress_solution_if,
+                    note_suppressed_solutions: note_suppressed_solutions)
       end
 
       def self.bake_solution_v1(exercise:, number:, divider: '. ')

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

@@ -2,7 +2,7 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:, suppress_solution: false)
+    def bake(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
       problem = exercise.problem
       solution = exercise.solution
 
@@ -12,9 +12,18 @@ module Kitchen::Directions::BakeNumberedExercise
       )
       problem_number = "<span class='os-number'>#{number}</span>"
 
+      suppress_solution =
+        case suppress_solution_if
+        when Symbol
+          number.send(suppress_solution_if)
+        else
+          suppress_solution_if
+        end
+
       if solution.present?
         if suppress_solution
           solution.trash
+          exercise.add_class('os-hasSolution-trashed') if note_suppressed_solutions
         else
           problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
           bake_solution(exercise: exercise, number: number)

data/lib/kitchen/directions/bake_numbered_table/bake_table_body.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for table body
+    #
+    module BakeTableBody
+      def self.v1(table:, number:)
+        table.remove_attribute('summary')
+        table.wrap(%(<div class="os-table">))
+
+        table_label = "#{I18n.t(:table_label)} #{number}"
+        table.pantry(name: :link_text).store table_label, label: table.id
+
+        if table.top_titled?
+          table.parent.add_class('os-top-titled-container')
+          table.prepend(sibling:
+            <<~HTML
+              <div class="os-table-title">#{table.title}</div>
+            HTML
+          )
+          table.title_row.trash
+        end
+
+        table.parent.add_class('os-column-header-container') if table.column_header?
+      end
+    end
+  end
+end

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

@@ -6,6 +6,10 @@ module Kitchen
       def self.v1(table:, number:, always_caption: false)
         V1.new.bake(table: table, number: number, always_caption: always_caption)
       end
+
+      def self.v2(table:, number:)
+        V2.new.bake(table: table, number: number)
+      end
     end
   end
 end

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

@@ -4,22 +4,7 @@ module Kitchen::Directions::BakeNumberedTable
   class V1
 
     def bake(table:, number:, always_caption: false)
-      table.wrap(%(<div class="os-table">))
-
-      table_label = "#{I18n.t(:table_label)} #{number}"
-      table.pantry(name: :link_text).store table_label, label: table.id
-
-      if table.top_titled?
-        table.parent.add_class('os-top-titled-container')
-        table.prepend(sibling:
-          <<~HTML
-            <div class="os-table-title">#{table.title}</div>
-          HTML
-        )
-        table.title_row.trash
-      end
-
-      table.parent.add_class('os-column-header-container') if table.column_header?
+      Kitchen::Directions::BakeTableBody.v1(table: table, number: number)
 
       # TODO: extra spaces added here to match legacy implementation, but probably not meaningful?
       new_caption = ''
@@ -54,6 +39,5 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       )
     end
-
   end
 end

data/lib/kitchen/directions/bake_numbered_table/v2.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedTable
+  # Difference from v1: only in the caption
+  # V2 caption titles are nested within an .os-caption span
+  class V2
+
+    def bake(table:, number:)
+      Kitchen::Directions::BakeTableBody.v1(table: table, number: number)
+
+      caption = ''
+      if table&.caption&.first("span[data-type='title']")
+        caption_el = table.caption
+        caption_el.add_class('os-caption')
+        caption_el.name = 'span'
+        caption = caption_el.cut
+      end
+
+      table.append(sibling:
+        <<~HTML
+          <div class="os-caption-container">
+            <span class="os-title-label">#{I18n.t(:table_label)} </span>
+            <span class="os-number">#{number}</span>
+            <span class="os-divider"> </span>
+            #{caption}
+          </div>
+        HTML
+      )
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakePreface
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, title_element: 'h1')
+        V1.new.bake(book: book, title_element: title_element)
       end
     end
   end

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

@@ -2,15 +2,16 @@
 
 module Kitchen::Directions::BakePreface
   class V1
-    def bake(book:)
+    def bake(book:, title_element:)
       book.pages('$.preface').each do |page|
+        page.search('div[data-type="description"], div[data-type="abstract"]').each(&:trash)
         page.titles.each do |title|
           title.replace_children(with:
             <<~HTML
               <span data-type="" itemprop="" class="os-text">#{title.text}</span>
             HTML
           )
-          title.name = 'h1'
+          title.name = title_element
         end
       end
     end

data/lib/kitchen/directions/book_answer_key_container/eob_answer_key_outer_container.xhtml.erb

@@ -0,0 +1,9 @@
+<div class="os-eob os-<%= @solutions_or_solution %>-container" data-type="composite-chapter" data-uuid-key=".<%= @solutions_or_solution %>">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:answer_key_title) %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:answer_key_title) %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BookAnswerKeyContainer
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, solutions_plural: true)
+        V1.new.bake(book: book, solutions_plural: solutions_plural)
       end
     end
   end

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

@@ -4,10 +4,11 @@ module Kitchen::Directions::BookAnswerKeyContainer
   class V1
     renderable
 
-    def bake(book:)
+    def bake(book:, solutions_plural: true)
       @metadata = book.metadata.children_to_keep.copy
-      book.body.append(child: render(file: 'eob_solutions_container.xhtml.erb'))
-      book.body.first('div.os-eob.os-solutions-container')
+      @solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
+      book.body.append(child: render(file: 'eob_answer_key_outer_container.xhtml.erb'))
+      book.body.first("div.os-eob.os-#{@solutions_or_solution}-container")
     end
   end
 end

data/lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb

@@ -1,9 +1,9 @@
-<div class="os-eoc os-chapter-review-container" data-type="composite-chapter" data-uuid-key=".chapter-review">
+<div class="os-eoc os-<%= @klass %>-container" data-type="composite-chapter" data-uuid-key=".<%= @klass %>">
   <h2 data-type="document-title">
-    <span class="os-text"><%= I18n.t(:eoc_chapter_review) %></span>
+    <span class="os-text"><%= @title %></span>
   </h2>
   <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_chapter_review) %></h1>
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
     <%= @metadata.paste %>
   </div>
 </div>

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module ChapterReviewContainer
-      def self.v1(chapter:, metadata_source:)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source)
+      def self.v1(chapter:, metadata_source:, klass: 'chapter-review')
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, klass: klass)
       end
     end
   end

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

@@ -4,10 +4,12 @@ module Kitchen::Directions::ChapterReviewContainer
   class V1
     renderable
 
-    def bake(chapter:, metadata_source:)
+    def bake(chapter:, metadata_source:, klass: 'chapter-review')
       @metadata = metadata_source.children_to_keep.copy
+      @klass = klass
+      @title = I18n.t(:"eoc.#{klass}")
       chapter.append(child: render(file: 'chapter_review.xhtml.erb'))
-      chapter.first('div.os-eoc.os-chapter-review-container')
+      chapter.element_children[-1]
     end
   end
 end

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -15,6 +15,19 @@ module Kitchen
           </a>
         HTML
       end
+
+      def self.v2(page:)
+        chapter = page.ancestor(:chapter)
+        <<~HTML
+          <div>
+            <h3 data-type="document-title" id="#{page.title.copied_id}">
+              <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="">#{page.title_text}</span>
+            </h3>
+          </div>
+        HTML
+      end
     end
   end
 end