openstax_kitchen 3.0.0 → 3.1.0

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReviewExercises
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to:, klass:)
+      @klass = klass
+      @metadata = metadata_source.children_to_keep.copy
+      @title = I18n.t(:"eoc.#{klass}")
+
+      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
+
+          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
+
+      return if exercise_clipboard.none?
+
+      @content = exercise_clipboard.paste
+
+      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReviewExercises
+  # 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:)
+      @klass = klass
+      @metadata = metadata_source.children_to_keep.copy
+      @title = I18n.t(:"eoc.#{klass}")
+
+      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
+
+          # 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)
+          exercise_section.wrap('<div class="os-section-area">')
+          exercise_section = exercise_section.parent
+          exercise_section.cut(to: exercise_clipboard)
+        end
+      end
+
+      return if exercise_clipboard.none?
+
+      @content = <<~HTML
+        <div class="os-#{@klass}">
+          #{exercise_clipboard.paste}
+        </div>
+      HTML
+
+      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterSectionExercises
+  class V1
+    def bake(chapter:)
+      chapter.pages.each do |page|
+        page.search('section.section-exercises').each do |section|
+          section.wrap(
+            %(<div class="os-eos os-section-exercises-container"
+              data-uuid-key=".section-exercises">)
+          )
+
+          section_title = I18n.t(
+            :section_exercises,
+            number: "#{chapter.count_in(:book)}.#{section.count_in(:chapter)}")
+
+          section.prepend(sibling:
+            <<~HTML
+              <h3 data-type="document-title">
+                <span class="os-text">#{section_title}</span>
+              </h3>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -11,7 +11,7 @@ module Kitchen
         summaries = Clipboard.new
 
         # TODO: include specific page types somehow without writing it out
-        chapter.pages('$:not(.introduction)').each do |page|
+        chapter.non_introduction_pages.each do |page|
           summary = page.summary
           summary.first("[data-type='title']")&.trash # get rid of old title if exists
           summary_title = page.title.copy

data/lib/kitchen/directions/bake_checkpoint.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeCheckpoint
+      def self.v1(checkpoint:, number:)
+        checkpoint.wrap_children(class: 'os-note-body')
+
+        checkpoint.prepend(child:
+          <<~HTML
+            <div class="os-title">
+              <span class="os-title-label">#{I18n.t(:checkpoint)} </span>
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+            </div>
+          HTML
+        )
+
+        exercise = checkpoint.exercises.first!
+        exercise.search("[data-type='commentary']").trash
+
+        problem = exercise.problem
+        problem.wrap_children(class: 'os-problem-container')
+
+        solution = exercise.solution
+        exercise.add_class('unnumbered') unless solution.present?
+        return unless solution.present?
+
+        solution.id = "#{exercise.id}-solution"
+        exercise.add_class('os-hasSolution')
+
+        solution.replace_children(with:
+          <<~HTML
+            <span class="os-divider"> </span>
+            <a class="os-number" href="##{exercise.id}">#{number}</a>
+            <div class="os-solution-container">#{solution.children}</div>
+          HTML
+        )
+
+        exercise.add_class('unnumbered')
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_composite_chapters.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeCompositeChapters
+      def self.v1(book:)
+        book.search("[data-type='composite-chapter']").each do |chapter|
+          chapter.first("[data-type='document-title']").id =
+            "composite-chapter-#{chapter.count_in(:book)}"
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_equations.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeEquations
+      def self.v1(book:)
+        book.chapters.search('[data-type="equation"]:not(.unnumbered)').each do |eq|
+          chapter = eq.ancestor(:chapter)
+          number = "#{chapter.count_in(:book)}.#{eq.count_in(:chapter)}"
+
+          # Store label information
+          equation_label = "#{I18n.t(:equation)} #{number}"
+          book.document.pantry(name: :link_text).store equation_label, label: eq.id
+
+          # Bake the equation
+          eq.append(child:
+            <<~HTML
+              <div class="os-equation-number">
+                <span class="os-number">#{number}</span>
+              </div>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_example.rb

@@ -4,13 +4,7 @@ module Kitchen
   module Directions
     module BakeExample
       def self.v1(example:, number:, title_tag:)
-        example.replace_children(with:
-          <<~HTML
-            <div class="body">
-              #{example.children}
-            </div>
-          HTML
-        )
+        example.wrap_children(class: 'body')
 
         example.prepend(child:
           <<~HTML
@@ -27,6 +21,34 @@ module Kitchen
                .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
         example.titles.each { |title| title.name = 'h4' }
+
+        example.exercises.each do |exercise|
+          if (problem = exercise.problem)
+            problem.titles.each { |title| title.name = 'h4' }
+            problem.wrap_children(class: 'os-problem-container')
+          end
+
+          if (solution = exercise.solution)
+            solution.replace_children(with:
+              <<~HTML
+                <h4 data-type="solution-title">
+                  <span class="os-title-label">#{I18n.t(:solution)} </span>
+                </h4>
+                <div class="os-solution-container">#{solution.children}</div>
+              HTML
+            )
+          end
+
+          exercise.add_class('unnumbered')
+
+          commentary = exercise.first('[data-type="commentary"]')
+          next unless commentary.present?
+
+          commentary_title = commentary.titles.first
+          commentary_title.name = 'h4'
+          commentary_title['data-type'] = 'commentary-title'
+          commentary_title.wrap_children('span', class: 'os-title-label')
+        end
       end
     end
   end

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

@@ -4,6 +4,7 @@ module Kitchen
   module Directions
     module BakeExercises
       def self.v1(book:)
+        warn 'WARNING! deprecated direction used: BakeExecises'
         V1.new.bake(book: book)
       end
     end

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

@@ -2,6 +2,7 @@
 
 module Kitchen::Directions::BakeExercises
   class V1
+    renderable
     def bake(book:)
       metadata_elements = book.metadata.children_to_keep.copy
 
@@ -12,34 +13,20 @@ module Kitchen::Directions::BakeExercises
         solution_clipboard = Kitchen::Clipboard.new
         solutions_clipboards.push(solution_clipboard)
 
-        chapter.pages('$:not(.introduction)').each do |page|
+        chapter.non_introduction_pages.each do |page|
           exercise_section = page.exercises
-          exercise_section.first("[data-type='title']")&.trash
-          exercise_section_title = page.title.copy
-          exercise_section_title.name = 'h3'
-          exercise_section_title.replace_children(with: <<~HTML
-            <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="">#{exercise_section_title.children}</span>
-          HTML
-          )
+          exercise_section.titles.first&.trash
 
-          exercise_section.prepend(child:
-            <<~HTML
-              <a href="##{page.title.id}">
-                #{exercise_section_title.paste}
-              </a>
-            HTML
-          )
+          bake_exercise_section_title(
+            exercise_section: exercise_section, page: page, chapter: chapter)
 
-          exercise_section.search("[data-type='exercise']").each do |exercise|
+          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
             )
-
             bake_exercise_in_place(exercise: exercise)
-            exercise.first("[data-type='solution']")&.cut(to: solution_clipboard)
+            exercise.solution&.cut(to: solution_clipboard)
           end
 
           exercise_section.cut(to: exercise_clipboard)
@@ -65,10 +52,9 @@ module Kitchen::Directions::BakeExercises
 
       # Store a paste here to use at end so that uniquifyied IDs match legacy baking
       eob_metadata = metadata_elements.paste
-
       solutions = solutions_clipboards.map.with_index do |solution_clipboard, index|
         <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-page" data-uuid-key=".solution#{index + 1}">
+          <div class="os-eob os-solution-container" data-type="composite-page" data-uuid-key=".solution#{index + 1}">
             <h2 data-type="document-title">
               <span class="os-text">#{I18n.t(:chapter)} #{index + 1}</span>
             </h2>
@@ -83,9 +69,9 @@ module Kitchen::Directions::BakeExercises
 
       return if solutions.none?
 
-      book.first('body').append(child:
+      book.body.append(child:
         <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-chapter" data-uuid-key=".solution">
+          <div class="os-eob os-solution-container" data-type="composite-chapter" data-uuid-key=".solution">
             <h1 data-type="document-title" id="composite-chapter-1">
               <span class="os-text">#{I18n.t(:eoc_answer_key_title)}</span>
             </h1>
@@ -99,6 +85,24 @@ module Kitchen::Directions::BakeExercises
       )
     end
 
+    def bake_exercise_section_title(exercise_section:, chapter:, page:)
+      exercise_section_title = page.title.copy
+      exercise_section_title.name = 'h3'
+      exercise_section_title.replace_children(with: <<~HTML
+        <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="">#{exercise_section_title.children}</span>
+      HTML
+      )
+      exercise_section.prepend(child:
+        <<~HTML
+          <a href="##{page.title.id}">
+            #{exercise_section_title.paste}
+          </a>
+        HTML
+      )
+    end
+
     def bake_exercise_in_place(exercise:)
       # Bake an exercise in place going from:
       #
@@ -133,21 +137,20 @@ module Kitchen::Directions::BakeExercises
       # If there is no solution, don't add the 'os-hasSolution' class and don't
       # link the number.
 
-      problem = exercise.first("[data-type='problem']")
-      solution = exercise.first("[data-type='solution']")
-
-      problem_number = "<span class='os-number'>#{exercise.count_in(:chapter)}</span>"
+      problem = exercise.problem
+      solution = exercise.solution
+      count_in = exercise.count_in(:chapter)
+      problem_number = "<span class='os-number'>#{count_in}</span>"
 
       if solution.present?
         solution.id = "#{exercise.id}-solution"
 
         exercise.add_class('os-hasSolution')
-        problem_number =
-          "<a href='##{solution.id}' class='os-number' >#{exercise.count_in(:chapter)}</a>"
+        problem_number = "<a href='##{solution.id}' class='os-number'>#{count_in}</a>"
 
         solution.replace_children(with:
           <<~HTML
-            <a class="os-number" href="##{exercise.id}">#{exercise.count_in(:chapter)}</a>
+            <a class="os-number" href="##{exercise.id}">#{count_in}</a>
             <span class="os-divider">. </span>
             <div class="os-solution-container ">#{solution.children}</div>
           HTML

data/lib/kitchen/directions/bake_non_introduction_pages.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNonIntroductionPages
+      def self.v1(chapter:)
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+
+          page.search("div[data-type='description']").each(&:trash)
+          page.add_class('chapter-content-module')
+
+          title = page.title
+          title.name = 'h2'
+          title.replace_children(with:
+            <<~HTML
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+              <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAutotitledNotes
+      def self.v1(book:, classes:)
+        book.notes.each do |note|
+          next unless (note.classes & classes).any?
+
+          bake_note(note: note)
+        end
+      end
+
+      def self.bake_note(note:)
+        note.wrap_children(class: 'os-note-body')
+
+        BakeNoteSubtitle.v1(note: note)
+
+        note.prepend(child:
+          <<~HTML
+            <h3 class="os-title" data-type="title">
+              <span class="os-title-label">#{note.autogenerated_title}</span>
+            </h3>
+          HTML
+        )
+      end
+    end
+  end
+end