openstax_kitchen 3.2.0 → 4.0.0

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

@@ -3,8 +3,12 @@
 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: 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

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

@@ -2,24 +2,23 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:)
+    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?
-        solution.id = "#{exercise.id}-solution"
-        exercise.add_class('os-hasSolution')
-        problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
-
-        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 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:
@@ -30,5 +29,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/v1.rb

@@ -7,7 +7,7 @@ module Kitchen::Directions::BakeNumberedTable
       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')

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_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_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_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")}
@@ -96,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/{bake_book_answer_key → book_answer_key_container}/main.rb

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

data/lib/kitchen/directions/{bake_book_answer_key → book_answer_key_container}/v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeBookAnswerKey
+module Kitchen::Directions::BookAnswerKeyContainer
   class V1
     renderable
 

data/lib/kitchen/directions/{bake_chapter_review → chapter_review_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeChapterReview
+    module ChapterReviewContainer
       def self.v1(chapter:, metadata_source:)
         V1.new.bake(chapter: chapter, metadata_source: metadata_source)
       end

data/lib/kitchen/directions/{bake_chapter_review → chapter_review_container}/v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReview
+module Kitchen::Directions::ChapterReviewContainer
   class V1
     renderable
 

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -10,7 +10,7 @@ module Kitchen
             <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>
+              <span class="os-text" data-type="" itemprop="">#{page.title_text}</span>
             </h3>
           </a>
         HTML

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module MoveExercisesToEOC
+      def self.v1(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          klass: klass,
+          uuid_prefix: uuid_prefix
+        )
+      end
+
+      def self.v2(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
+        V2.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          klass: klass,
+          uuid_prefix: uuid_prefix
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/directions/{bake_chapter_review_exercises → move_exercises_to_eoc}/v1.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReviewExercises
+module Kitchen::Directions::MoveExercisesToEOC
   class V1
     renderable
 
-    def bake(chapter:, metadata_source:, append_to:, klass:)
+    def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
       @klass = klass
       @metadata = metadata_source.children_to_keep.copy
       @title = I18n.t(:"eoc.#{klass}")
+      @uuid_prefix = uuid_prefix
 
       exercise_clipboard = Kitchen::Clipboard.new
 
@@ -17,13 +18,6 @@ module Kitchen::Directions::BakeChapterReviewExercises
         sections.each do |exercise_section|
           exercise_section.first("[data-type='title']")&.trash
 
-          exercise_section.exercises.each do |exercise|
-            exercise.document.pantry(name: :link_text).store(
-              "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-              label: exercise.id
-            )
-          end
-
           exercise_section.cut(to: exercise_clipboard)
         end
       end
@@ -32,7 +26,11 @@ module Kitchen::Directions::BakeChapterReviewExercises
 
       @content = exercise_clipboard.paste
 
-      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
     end
   end
 end

data/lib/kitchen/directions/{bake_chapter_review_exercises → move_exercises_to_eoc}/v2.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReviewExercises
+module Kitchen::Directions::MoveExercisesToEOC
   # Main difference from v1 is the presence of a section title
   # and some additional wrappers
   class V2
     renderable
 
-    def bake(chapter:, metadata_source:, append_to:, klass:)
+    def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
       @klass = klass
       @metadata = metadata_source.children_to_keep.copy
       @title = I18n.t(:"eoc.#{klass}")
+      @uuid_prefix = uuid_prefix
 
       exercise_clipboard = Kitchen::Clipboard.new
 
@@ -21,12 +22,6 @@ module Kitchen::Directions::BakeChapterReviewExercises
 
           # Get parent page title
           section_title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-          exercise_section.exercises.each do |exercise|
-            exercise.document.pantry(name: :link_text).store(
-              "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-              label: exercise.id
-            )
-          end
 
           # Configure section title & wrappers
           exercise_section.prepend(child: section_title)
@@ -44,7 +39,11 @@ module Kitchen::Directions::BakeChapterReviewExercises
         </div>
       HTML
 
-      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element[:'data-type'] == 'composite-chapter'
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
     end
   end
 end

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeChapterAnswerKey
+    module MoveSolutionsToAnswerKey
       def self.v1(chapter:, metadata_source:, strategy:, append_to:)
         V1.new.bake(
           chapter: chapter,

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/american_government.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class AmericanGovernment
+      def bake(chapter:, append_to:)
+        bake_section(chapter: chapter, append_to: append_to, klass: 'review-questions')
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:)
+        chapter.search(".#{klass} [data-type='solution']").each do |solution|
+          append_to.add_child(solution.cut.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/strategies/calculus.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   module Strategies
     class Calculus
       def bake(chapter:, append_to:)

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/strategies/uphysics.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   module Strategies
     class UPhysics
       def bake(chapter:, append_to:)
@@ -32,8 +32,10 @@ module Kitchen::Directions::BakeChapterAnswerKey
       def bake_from_notes(chapter:, append_to:, klass:)
         solutions = []
         chapter.notes(".#{klass}").each do |note|
-          solution = note.exercises.first.solution
-          solutions.push(solution.cut) if solution
+          note.exercises.each do |exercise|
+            solution = exercise.solution
+            solutions.push(solution.cut) if solution
+          end
         end
         return if solutions.empty?
 

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   class V1
     def bake(chapter:, metadata_source:, strategy:, append_to:)
       strategy =
@@ -9,6 +9,8 @@ module Kitchen::Directions::BakeChapterAnswerKey
           Strategies::Calculus
         when :uphysics
           Strategies::UPhysics
+        when :american_government
+          Strategies::AmericanGovernment
         else
           raise 'No such strategy'
         end