openstax_kitchen 2.0.0 → 3.0.0

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeChapterIntroductions
-
       def self.v1(book:)
         book.chapters.each do |chapter|
           outline_items_html = chapter.pages.map do |page|
@@ -10,13 +11,13 @@ module Kitchen
             <<~HTML
               <div class="os-chapter-objective">
                 <a class="os-chapter-objective" href="##{page.title[:id]}">
-                  <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)-1}</span>
+                  <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter) - 1}</span>
                   <span class="os-divider"> </span>
                   <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
                 </a>
               </div>
             HTML
-          end.join("")
+          end.join('')
 
           introduction_page = chapter.introduction_page
 
@@ -24,7 +25,7 @@ module Kitchen
           introduction_page.search("div[data-type='abstract']").trash
 
           title = introduction_page.title.cut
-          title.name = "h2"
+          title.name = 'h2'
           MoveTitleTextIntoSpan.v1(title: title)
 
           intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
@@ -33,7 +34,7 @@ module Kitchen
             <<~HTML
               <div class="intro-body">
                 <div class="os-chapter-outline">
-                  <h3 class="os-title">Chapter Outline</h3>
+                  <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
                   #{outline_items_html}
                 </div>
                 <div class="intro-text">
@@ -52,7 +53,6 @@ module Kitchen
         something_with_selectors.selectors.title_in_introduction_page =
           ".intro-text > [data-type='document-title']"
       end
-
     end
   end
 end

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
+    # Bake directions for eoc key equations
+    #
     module BakeChapterKeyEquations
-
       def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
+        metadata_elements = metadata_source.children_to_keep.copy
 
-        chapter.key_equations.search("h3").trash
+        chapter.key_equations.search('h3').trash
         key_equations = chapter.key_equations.cut
 
+        return if key_equations.none?
+
         chapter.append(child:
           <<~HTML
             <div class="os-eoc os-key-equations-container" data-type="composite-page" data-uuid-key=".key-equations">
@@ -22,9 +26,8 @@ module Kitchen
               #{key_equations.paste}
             </div>
           HTML
-        ) unless key_equations.none?
+        )
       end
-
     end
   end
 end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
+    # Bake directions for eoc summary
+    #
     module BakeChapterSummary
-
       def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
+        metadata_elements = metadata_source.children_to_keep.copy
 
         summaries = Clipboard.new
 
-        # TODO include specific page types somehow without writing it out
-        chapter.pages("$:not(.introduction)").each do |page|
+        # TODO: include specific page types somehow without writing it out
+        chapter.pages('$:not(.introduction)').each do |page|
           summary = page.summary
-          summary.first("[data-type='title']").trash # get rid of old title
+          summary.first("[data-type='title']")&.trash # get rid of old title if exists
           summary_title = page.title.copy
-          summary_title.name = "h3"
+          summary_title.name = 'h3'
           summary_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="">#{summary_title.children}</span>
-            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="">#{summary_title.children}</span>
+          HTML
           )
 
           summary.prepend(child:
@@ -31,6 +33,8 @@ module Kitchen
           summary.cut(to: summaries)
         end
 
+        return if summaries.none?
+
         chapter.append(child:
           <<~HTML
             <div class="os-eoc os-summary-container" data-type="composite-page" data-uuid-key=".summary">
@@ -44,9 +48,8 @@ module Kitchen
               #{summaries.paste}
             </div>
           HTML
-        ) unless summaries.none?
+        )
       end
-
     end
   end
 end

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

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

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterTitle
+  class V1
+    def bake(book:)
+      book.chapters.each do |chapter|
+        fix_up_chapter_title(chapter: chapter)
+      end
+    end
+
+    def fix_up_chapter_title(chapter:)
+      heading = chapter.at('h1[2]')
+      heading[:id] = "chapTitle#{chapter.count_in(:book)}"
+      heading.replace_children(with:
+        <<~HTML
+          <span class="os-part-text">#{I18n.t(:chapter)} </span>
+          <span class="os-number">#{chapter.count_in(:book)}</span>
+          <span class="os-divider"> </span>
+          <span data-type="" itemprop="" class="os-text">#{heading.text}</span>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_composite_pages.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeCompositePages
-
       def self.v1(book:)
         book.search("[data-type='composite-page']").each do |page|
           page.id = "composite-page-#{page.count_in(:book)}"
         end
       end
-
     end
   end
 end

data/lib/kitchen/directions/bake_example.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeExample
-
       def self.v1(example:, number:, title_tag:)
         example.replace_children(with:
           <<~HTML
@@ -21,11 +22,12 @@ module Kitchen
           HTML
         )
 
-        example.document.pantry(name: :link_text).store "#{I18n.t(:example_label)} #{number}", label: example.id
+        example.document
+               .pantry(name: :link_text)
+               .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
-        example.titles.each {|title| title.name = "h4"}
+        example.titles.each { |title| title.name = 'h4' }
       end
-
     end
   end
 end

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

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

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeExercises
+  class V1
+    def bake(book:)
+      metadata_elements = book.metadata.children_to_keep.copy
+
+      solutions_clipboards = []
+
+      book.chapters.each do |chapter|
+        exercise_clipboard = Kitchen::Clipboard.new
+        solution_clipboard = Kitchen::Clipboard.new
+        solutions_clipboards.push(solution_clipboard)
+
+        chapter.pages('$:not(.introduction)').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.prepend(child:
+            <<~HTML
+              <a href="##{page.title.id}">
+                #{exercise_section_title.paste}
+              </a>
+            HTML
+          )
+
+          exercise_section.search("[data-type='exercise']").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)
+          end
+
+          exercise_section.cut(to: exercise_clipboard)
+        end
+
+        next if exercise_clipboard.none?
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-eoc os-exercises-container" data-type="composite-page" data-uuid-key=".exercises">
+              <h2 data-type="document-title">
+                <span class="os-text">#{I18n.t(:eoc_exercises_title)}</span>
+              </h2>
+              <div data-type="metadata" style="display: none;">
+                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_exercises_title)}</h1>
+                #{metadata_elements.paste}
+              </div>
+              #{exercise_clipboard.paste}
+            </div>
+          HTML
+        )
+      end
+
+      # 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}">
+            <h2 data-type="document-title">
+              <span class="os-text">#{I18n.t(:chapter)} #{index + 1}</span>
+            </h2>
+            <div data-type="metadata" style="display: none;">
+              <h1 data-type="document-title" itemprop="name">#{I18n.t(:chapter)} #{index + 1}</h1>
+              #{metadata_elements.paste}
+            </div>
+            #{solution_clipboard.paste}
+          </div>
+        HTML
+      end
+
+      return if solutions.none?
+
+      book.first('body').append(child:
+        <<~HTML
+          <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>
+            <div data-type="metadata" style="display: none;">
+              <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_answer_key_title)}</h1>
+              #{eob_metadata}
+            </div>
+            #{solutions.join("\n")}
+          </div>
+        HTML
+      )
+    end
+
+    def bake_exercise_in_place(exercise:)
+      # Bake an exercise in place going from:
+      #
+      # <div data-type="exercise" id="exerciseId">
+      #   <div data-type="problem" id="problemId">
+      #     Problem Content
+      #   </div>
+      #   <div data-type="solution" id="solutionId">
+      #     Solution Content
+      #   </div>
+      # </div>
+      #
+      # to
+      #
+      # <div data-type="exercise" id="exerciseId" class="os-hasSolution">
+      #   <div data-type="problem" id="problemId">
+      #     <a class="os-number" href="#exerciseId-solution">1</a>
+      #     <span class="os-divider">. </span>
+      #     <div class="os-problem-container ">
+      #       Problem Content
+      #     </div>
+      #   </div>
+      #   <div data-type="solution" id="exerciseId-solution">
+      #     <a class="os-number" href="#exerciseId">1</a>
+      #     <span class="os-divider">. </span>
+      #     <div class="os-solution-container ">
+      #       Solution Content
+      #     </div>
+      #   </div>
+      # </div>
+      #
+      # 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>"
+
+      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>"
+
+        solution.replace_children(with:
+          <<~HTML
+            <a class="os-number" href="##{exercise.id}">#{exercise.count_in(:chapter)}</a>
+            <span class="os-divider">. </span>
+            <div class="os-solution-container ">#{solution.children}</div>
+          HTML
+        )
+      end
+
+      problem.replace_children(with:
+        <<~HTML
+          #{problem_number}
+          <span class="os-divider">. </span>
+          <div class="os-problem-container ">#{problem.children}</div>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_figure.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeFigure
-
       def self.v1(figure:, number:)
-        figure.wrap(%Q(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+        figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
 
-        figure.document.pantry(name: :link_text).store "Figure #{number}", label: figure.id
+        figure.document.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
+        title = figure.title&.cut
 
         caption = figure.caption&.cut
         figure.append(sibling:
           <<~HTML
             <div class="os-caption-container">
-              <span class="os-title-label">Figure </span>
+              <span class="os-title-label">#{I18n.t(:figure)} </span>
               <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
+              #{"<span class=\"os-title\" data-type=\"title\" id=\"#{title.id}\">#{title.children}</span>" if title}
               <span class="os-divider"> </span>
-              #{'<span class="os-caption">' + caption.children.to_s + '</span>'if caption}
+              #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
             </div>
           HTML
         )

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

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