openstax_kitchen 3.2.0 → 6.0.0

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/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,13 @@
 module Kitchen
   module Directions
     module BakeNumberedExercise
-      def self.v1(exercise:, number:)
-        V1.new.bake(exercise: exercise, number: number)
+      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: '. ')
+        V1.new.bake_solution(exercise: exercise, number: number, divider: divider)
       end
     end
   end

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

@@ -2,24 +2,32 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:)
+    def bake(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
       problem = exercise.problem
       solution = exercise.solution
 
+      exercise.pantry(name: :link_text).store(
+        "#{I18n.t(:exercise_label)} #{exercise.ancestor(:chapter).count_in(:book)}.#{number}",
+        label: exercise.id
+      )
       problem_number = "<span class='os-number'>#{number}</span>"
 
-      if solution.present?
-        solution.id = "#{exercise.id}-solution"
-        exercise.add_class('os-hasSolution')
-        problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
+      suppress_solution =
+        case suppress_solution_if
+        when Symbol
+          number.send(suppress_solution_if)
+        else
+          suppress_solution_if
+        end
 
-        solution.replace_children(with:
-          <<~HTML
-            <a class='os-number' href='##{exercise.id}'>#{number}</a>
-            <span class='os-divider'>. </span>
-            <div class="os-solution-container">#{solution.children}</div>
-          HTML
-        )
+      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)
+        end
       end
 
       problem.replace_children(with:
@@ -30,5 +38,19 @@ module Kitchen::Directions::BakeNumberedExercise
         HTML
       )
     end
+
+    def bake_solution(exercise:, number:, divider: '. ')
+      solution = exercise.solution
+      solution.id = "#{exercise.id}-solution"
+      exercise.add_class('os-hasSolution')
+
+      solution.replace_children(with:
+        <<~HTML
+          <a class='os-number' href='##{exercise.id}'>#{number}</a>
+          <span class='os-divider'>#{divider}</span>
+          <div class="os-solution-container">#{solution.children}</div>
+        HTML
+      )
+    end
   end
 end

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,39 +4,19 @@ 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.document.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_summary = "#{table_label} "
       new_caption = ''
       caption_title = ''
 
       if (title = table.first("span[data-type='title']")&.cut)
-        new_summary += title.text
         caption_title = <<~HTML
           \n<span class="os-title" data-type="title">#{title.children}</span>
         HTML
       end
 
-      new_summary += ' '
-
       if (caption = table.caption&.cut)
-        new_summary += caption.text
         new_caption = <<~HTML
           \n<span class="os-caption">#{caption.children}</span>
         HTML
@@ -46,8 +26,6 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       end
 
-      table[:summary] = new_summary
-
       return if table.unnumbered?
 
       table.append(sibling:
@@ -61,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_page_abstracts.rb

@@ -19,7 +19,7 @@ module Kitchen
             li.replace_children(with:
               <<~HTML
                 <span class="os-abstract-token">#{chapter.count_in(:book)}.#{abstract.count_in(:chapter)}.#{index + 1}</span>
-                <span class="os-abstract-content">#{li.text}</span>
+                <span class="os-abstract-content">#{li.children}</span>
               HTML
             )
           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/bake_references/main.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for EOB references
+    #
+    module BakeReferences
+      def self.v1(book:, metadata_source:)
+        V1.new.bake(
+          book: book,
+          metadata_source: metadata_source
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V1
+    renderable
+
+    def bake(book:, metadata_source:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'reference'
+      @uuid_prefix = '.'
+      @title = I18n.t(:references)
+
+      book.chapters.each do |chapter|
+        chapter.search('[data-type="cite"]').each do |link|
+          link.prepend(child:
+            <<~HTML
+              <sup class="os-citation-number">#{link.count_in(:chapter)}</sup>
+            HTML
+          )
+        end
+
+        chapter.references.each do |reference|
+          reference.prepend(child:
+            <<~HTML.chomp
+              <span class="os-reference-number">#{reference.count_in(:chapter)}. </span>
+            HTML
+          )
+        end
+
+        chapter_references = chapter.pages.references.cut
+        chapter_title_no_num = chapter.title.search('.os-text')
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-chapter-area">
+              <h2 data-type="document-title">#{chapter_title_no_num}</h2>
+              #{chapter_references.paste}
+            </div>
+          HTML
+        )
+      end
+      chapter_area_references = book.chapters.search('.os-chapter-area').cut
+      @content = chapter_area_references.paste
+      book.body.append(child: render(file:
+        '../../templates/eob_section_title_template.xhtml.erb'))
+    end
+  end
+end