openstax_kitchen 3.2.0 → 6.0.0

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/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

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

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BookAnswerKeyContainer
+  class V1
+    renderable
+
+    def bake(book:, solutions_plural: true)
+      @metadata = book.metadata.children_to_keep.copy
+      @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

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

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::ChapterReviewContainer
+  class V1
+    renderable
+
+    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.element_children[-1]
+    end
+  end
+end

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -10,11 +10,24 @@ 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
       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

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

@@ -0,0 +1,37 @@
+# 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
+
+      def self.v3(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
+        V3.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/move_exercises_to_eoc/v3.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveExercisesToEOC
+  # The difference from v1 is the presence of a section title
+  # and from v2 the lack of additional "os-section-area" and os-#{@klass} wrappers
+  class V3
+    renderable
+
+    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
+
+      chapter.non_introduction_pages.each do |page|
+        sections = page.search("section.#{@klass}")
+
+        sections.each do |exercise_section|
+          exercise_section.first("[data-type='title']")&.trash
+
+          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
+          exercise_section.prepend(child: section_title)
+          exercise_section.cut(to: exercise_clipboard)
+        end
+      end
+
+      return if exercise_clipboard.none?
+
+      @content = exercise_clipboard.paste
+
+      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_answer_key → move_solutions_to_answer_key}/main.rb

@@ -2,12 +2,16 @@
 
 module Kitchen
   module Directions
-    module BakeChapterAnswerKey
-      def self.v1(chapter:, metadata_source:, strategy:, append_to:)
+    module MoveSolutionsToAnswerKey
+      def self.v1(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
-          strategy: strategy, append_to: append_to)
+          strategy: strategy,
+          append_to: append_to,
+          strategy_options: strategy_options,
+          solutions_plural: solutions_plural
+        )
       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/move_solutions_to_answer_key/strategies/default.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Default
+      def bake(chapter:, append_to:)
+        bake_section(chapter: chapter, append_to: append_to)
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:)
+        @classes.each do |klass|
+          chapter.search(".#{klass} [data-type='solution']").each do |solution|
+            append_to.add_child(solution.cut.to_s)
+          end
+        end
+      end
+
+      # This method helps to obtain more strategy-specific params through
+      # "strategy_options: {blah1: 1, blah2: 2}"
+      def initialize(strategy_options)
+        @classes = strategy_options[:classes] || (raise 'missing classes for strategy')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Precalculus
+      def bake(chapter:, append_to:)
+        try_note_solutions(chapter: chapter, append_to: append_to)
+
+        # Bake section exercises
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+          bake_section(chapter: page, append_to: append_to, klass: 'section-exercises',
+                       number: number)
+        end
+
+        # Bake other types of exercises
+        classes = %w[review-exercises practice-test]
+        classes.each do |klass|
+          bake_section(chapter: chapter, append_to: append_to, klass: klass)
+        end
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:, number: nil)
+        section_solutions_set = Kitchen::Clipboard.new
+        chapter.search(".#{klass}").each do |section|
+          section.search('[data-type="solution"]').each do |solution|
+            solution.cut(to: section_solutions_set)
+          end
+        end
+
+        return if section_solutions_set.items.empty?
+
+        title = <<~HTML
+          <h3 data-type="title">
+            <span class="os-title-label">#{I18n.t(:"eoc.#{klass}", number: number)}</span>
+          </h3>
+        HTML
+
+        append_solution_area(title: title, solutions: section_solutions_set, append_to: append_to)
+      end
+
+      def try_note_solutions(chapter:, append_to:)
+        append_to.add_child(
+          <<~HTML
+            <div class="os-module-reset-solution-area os-try-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{I18n.t(:"notes.try")}</span>
+              </h3>
+            </div>
+          HTML
+        )
+        chapter.non_introduction_pages.each do |page|
+          solutions = Kitchen::Clipboard.new
+          page.notes('$.try').each do |note|
+            note.exercises.each do |exercise|
+              solution = exercise.solution
+              solution&.cut(to: solutions) #if solution
+            end
+          end
+          next if solutions.items.empty?
+
+          title_snippet = Kitchen::Directions::EocSectionTitleLinkSnippet.v2(page: page)
+
+          append_solution_area(title: title_snippet, solutions: solutions,
+                               append_to: append_to.search('.os-try-solution-area').first)
+        end
+      end
+
+      def append_solution_area(title:, solutions:, append_to:)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              #{title}
+            </div>
+          HTML
+        ).first
+
+        append_to.add_child(solutions.paste)
+      end
+    end
+  end
+end