openstax_kitchen 3.0.0 → 4.1.1

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNumberedNotes
+      def self.v1(book:, classes:)
+        classes.each do |klass|
+          book.chapters.notes("$.#{klass}").each do |note|
+            bake_note(note: note)
+            note.exercises.each do |exercise|
+              bake_note_exercise(note: note, exercise: exercise)
+            end
+          end
+        end
+      end
+
+      def self.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']
+
+        BakeNoteSubtitle.v1(note: note)
+      end
+
+      def self.bake_note_exercise(note:, exercise:)
+        exercise.add_class('unnumbered')
+        # bake problem
+        exercise.problem.wrap_children('div', class: 'os-problem-container')
+        exercise.problem.first('strong')&.trash
+        exercise.search('[data-type="commentary"]').each(&:trash)
+        return unless exercise.solution
+
+        # bake solution in place
+        BakeNumberedExercise.bake_solution_v1(
+          exercise: exercise, number: note.first('.os-number').text, divider: ' ')
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_notes/bake_unclassified_notes.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeUnclassifiedNotes
+      def self.v1(book:)
+        book.notes.each do |note|
+          next unless note.classes.empty?
+
+          bake_note(note: note)
+        end
+      end
+
+      def self.bake_note(note:)
+        note.wrap_children(class: 'os-note-body')
+
+        title = note.title&.cut
+        return unless title
+
+        note.prepend(child:
+          <<~HTML
+            <h3 class="os-title" data-type="title">
+              <span class="os-title-label" data-type="" id="#{title[:id]}">#{title.children}</span>
+            </h3>
+          HTML
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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)
+      end
+
+      def self.bake_solution_v1(exercise:, number:, divider: '. ')
+        V1.new.bake_solution(exercise: exercise, number: number, divider: divider)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedExercise
+  class V1
+    def bake(exercise:, number:, suppress_solution: 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?
+        if suppress_solution
+          solution.trash
+        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:
+        <<~HTML
+          #{problem_number}
+          <span class='os-divider'>. </span>
+          <div class="os-problem-container">#{problem.children}</div>
+        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/main.rb

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeNumberedTable
-      def self.v1(table:, number:)
-        V1.new.bake(table: table, number: number)
+      def self.v1(table:, number:, always_caption: false)
+        V1.new.bake(table: table, number: number, always_caption: always_caption)
       end
     end
   end

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

@@ -3,11 +3,11 @@
 module Kitchen::Directions::BakeNumberedTable
   class V1
 
-    def bake(table:, number:)
+    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
+      table.pantry(name: :link_text).store table_label, label: table.id
 
       if table.top_titled?
         table.parent.add_class('os-top-titled-container')
@@ -22,14 +22,28 @@ module Kitchen::Directions::BakeNumberedTable
       table.parent.add_class('os-column-header-container') if table.column_header?
 
       # TODO: extra spaces added here to match legacy implementation, but probably not meaningful?
-      new_summary = "#{table_label}  "
+      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
+      elsif always_caption
+        new_caption = <<~HTML
+          \n<span class="os-caption"></span>
+        HTML
       end
 
       table[:summary] = new_summary
@@ -41,7 +55,7 @@ module Kitchen::Directions::BakeNumberedTable
           <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>
+            <span class="os-divider"> </span>#{caption_title}
             <span class="os-divider"> </span>#{new_caption}
           </div>
         HTML

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -9,6 +9,22 @@ module Kitchen
           abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
         end
       end
+
+      def self.v2(chapter:)
+        chapter.abstracts.each do |abstract|
+          abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
+          ul = abstract.first!('ul')
+          ul.add_class('os-abstract')
+          ul.search('li').each_with_index do |li, index|
+            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.children}</span>
+              HTML
+            )
+          end
+        end
+      end
     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

data/lib/kitchen/directions/bake_stepwise.rb

@@ -9,11 +9,7 @@ module Kitchen
           ol.add_class('os-stepwise')
 
           ol.search('li').each_with_index do |li, ii|
-            li.replace_children(with:
-              <<~HTML
-                <span class="os-stepwise-content">#{li.children}</span>
-              HTML
-            )
+            li.wrap_children('span', class: 'os-stepwise-content')
             li.prepend(child:
               <<~HTML
                 <span class="os-stepwise-token">#{I18n.t(:stepwise_step_label)} #{ii + 1}. </span>

data/lib/kitchen/directions/bake_suggested_reading.rb

@@ -6,6 +6,7 @@ module Kitchen
     #
     module BakeSuggestedReading
       def self.v1(book:)
+        metadata_elements = book.metadata.children_to_keep.copy
         book.chapters.each do |chapter|
           suggested_reading = chapter.search('section.suggested-reading').cut
 
@@ -15,6 +16,10 @@ module Kitchen
                 <h2 data-type="document-title">
                   <span class="os-text">#{I18n.t(:eoc_suggested_reading)}</span>
                 </h2>
+                <div data-type="metadata" style="display: none;">
+                  <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_suggested_reading)}</h1>
+                  #{metadata_elements.paste}
+                </div>
                 #{suggested_reading.paste}
               </div>
             HTML

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeTheorem
+      def self.v1(theorem:, number:)
+        V1.new.bake(theorem: theorem, number: number)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeTheorem
+  class V1
+    def bake(theorem:, number:)
+      theorem['use-subtitle'] = true
+      new_subtitle = theorem.title.cut
+
+      theorem.wrap_children(class: 'os-note-body')
+      note_body = theorem.first('.os-note-body')
+
+      note_body.prepend(sibling:
+        <<~HTML
+          <div class="os-title">
+            <span class="os-title-label">#{I18n.t(:theorem)} </span>
+            <span class="os-number">#{number}</span>
+            <span class="os-divider"> </span>
+          </div>
+        HTML
+      )
+
+      new_subtitle.name = 'h4'
+      new_subtitle.add_class('os-subtitle')
+      new_subtitle.children.wrap('<span class="os-subtitle-label">')
+      note_body.prepend(child: new_subtitle.paste)
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -31,9 +31,9 @@ module Kitchen
         <<~HTML
           <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit">
             <a href="#">
-              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span> #{unit.count_in(:book)}</span>
+              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span>#{unit.count_in(:book)}</span>
               <span class="os-divider"> </span>
-              <span data-type itemprop class="os-text"> #{unit.title.children} </span>
+              <span data-type itemprop class="os-text">#{unit.title_text}</span>
             </a>
             <ol class="os-unit">
               #{chapters.map { |chapter| li_for_chapter(chapter) }.join("\n")}
@@ -59,6 +59,7 @@ module Kitchen
 
       def self.li_for_chapter(chapter)
         pages = chapter.element_children.only(PageElement, CompositePageElement)
+        inner_composite_chapters = chapter.element_children.only(CompositeChapterElement)
 
         <<~HTML
           <li class="os-toc-chapter" cnx-archive-shortid="" cnx-archive-uri="">
@@ -69,6 +70,11 @@ module Kitchen
             </a>
             <ol class="os-chapter">
               #{pages.map { |page| li_for_page(page) }.join("\n")}
+              #{
+                inner_composite_chapters.map do |composite_chapter|
+                  li_for_composite_chapter(composite_chapter)
+                end.join("\n")
+              }
             </ol>
           </li>
         HTML
@@ -90,6 +96,8 @@ module Kitchen
           when CompositePageElement
             if page.is_index?
               'os-toc-index'
+            elsif page.is_reference?
+              'os-toc-reference'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else

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

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

data/lib/kitchen/directions/{bake_exercises → book_answer_key_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeExercises
+    module BookAnswerKeyContainer
       def self.v1(book:)
         V1.new.bake(book: book)
       end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BookAnswerKeyContainer
+  class V1
+    renderable
+
+    def bake(book:)
+      @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')
+    end
+  end
+end