openstax_kitchen 9.1.0 → 11.1.0

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

@@ -3,29 +3,19 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
-      key_concepts_clipboard = Kitchen::Clipboard.new
-      chapter.non_introduction_pages.each do |page|
-        key_concepts = page.key_concepts
-        next if key_concepts.none?
-
-        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-        key_concepts.each do |key_concept|
-          Kitchen::Directions::RemoveSectionTitle.v1(section: key_concept)
-          key_concept.prepend(child: title)
-          key_concept.wrap("<div class='os-section-area'>")
-          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
-        end
-      end
-
-      content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
-
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
         container_key: 'key-concepts',
         uuid_key: "#{uuid_prefix}key-concepts",
-        metadata_source: metadata_source,
-        content: content,
-        append_to: append_to || chapter
-      )
+        section_selector: 'section.key-concepts',
+        append_to: append_to || chapter,
+        wrap_section: true, wrap_content: true
+      ) do |section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: section)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: section.ancestor(:page))
+        section.prepend(child: title)
+      end
     end
   end
 end

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

@@ -3,9 +3,7 @@
 module Kitchen::Directions::BakeChapterReferences
   class V1
     def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
-      bake_page_references(page: chapter.introduction_page)
-
-      chapter.non_introduction_pages.each do |page|
+      chapter.pages.each do |page|
         bake_page_references(page: page)
       end
 

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterSolutions
-      def self.v1(chapter:, metadata_source:, uuid_prefix: '')
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, uuid_prefix: uuid_prefix)
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          classes: classes
+        )
       end
     end
   end

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

@@ -2,20 +2,22 @@
 
 module Kitchen::Directions::BakeChapterSolutions
   class V1
-    def bake(chapter:, metadata_source:, uuid_prefix: '')
+    def bake(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
       solutions_clipboard = Kitchen::Clipboard.new
 
-      chapter.search('section.free-response').each do |free_response_question|
-        exercises = free_response_question.exercises
-        # must run AFTER .free-response notes are baked
+      classes.each do |klass|
+        chapter.search("section.#{klass}").each do |question|
+          exercises = question.exercises
+          # must run AFTER the other sections are baked
 
-        next if exercises.none?
+          next if exercises.none?
 
-        exercises.each do |exercise|
-          solution = exercise.solution
-          next unless solution.present?
+          exercises.each do |exercise|
+            solution = exercise.solution
+            next unless solution.present?
 
-          solution.cut(to: solutions_clipboard)
+            solution.cut(to: solutions_clipboard)
+          end
         end
       end
 

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -18,7 +18,7 @@ module Kitchen
         def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
           summaries = Clipboard.new
 
-          chapter.non_introduction_pages.each do |page|
+          chapter.pages.each do |page|
             summary = page.summary
 
             next if summary.nil?
@@ -26,7 +26,6 @@ module Kitchen
             summary.first("[data-type='title']")&.trash # get rid of old title if exists
             title = EocSectionTitleLinkSnippet.v1(page: page)
             summary.prepend(child: title)
-            summary.first('h3')[:itemprop] = 'name'
             summary.cut(to: summaries)
           end
 

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

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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeCustomSections
+  class V1
+    def bake(chapter:, custom_sections_properties:)
+      custom_sections_properties.each do |_custom_section_name, property|
+        title_text = I18n.t(:"custom-sections.#{property[:class]}")
+        property_class = property[:class]
+        inject = property[:inject]
+        chapter.search(".#{property_class}").each do |custom_section|
+
+          case inject
+          when 'title'
+            custom_section_title = custom_section.first('h2')
+            custom_section_title_os_text = custom_section_title.first('.os-text')
+            custom_section_title_sibling = custom_section.first('h2 + div')
+            div_id = custom_section_title_sibling['id']
+            custom_section_title_sibling.trash
+            custom_section_title.append(sibling:
+              <<~HTML
+                <h3 class="os-subtitle" id="#{div_id}">#{custom_section_title_os_text.text}</h3>
+              HTML
+            )
+            custom_section_title_os_text.replace_children(with: title_text)
+          when 'subtitle'
+            custom_section_title = custom_section.titles.first
+            custom_section_title.name = 'h4'
+            custom_section_title.prepend(sibling:
+              <<~HTML
+                <h3 class="os-title">#{title_text}</h3>
+              HTML
+            )
+          when 'title_prefix'
+            custom_section_title = custom_section.titles.first
+            custom_section_title.replace_children(with: "#{title_text}: " +
+                                                  custom_section_title.text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_eoc_section_content/change_subsection_title_tag.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module ChangeSubsectionTitleTag
+      def self.v1(section:)
+        section.search('section').each do |subsection|
+          subsection.first('h4').name = 'h5'
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_equations.rb

@@ -3,14 +3,13 @@
 module Kitchen
   module Directions
     module BakeEquations
-      def self.v1(book:, number_decorator: :none)
+      def self.v1(book:, number_decorator: :none, cases: false)
         book.chapters.search('div[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.pantry(name: :link_text).store equation_label, label: eq.id
+          eq.target_label(label_text: 'equation', custom_content: number, cases: cases)
 
           decorated_number =
             case number_decorator

data/lib/kitchen/directions/bake_example.rb

@@ -3,35 +3,30 @@
 module Kitchen
   module Directions
     module BakeExample
-      def self.v1(example:, number:, title_tag:, numbered_solutions: false)
+      def self.v1(example:, number:, title_tag:, numbered_solutions: false, cases: false)
         example.wrap_children(class: 'body')
 
         example.prepend(child:
           <<~HTML
             <#{title_tag} class="os-title">
-              <span class="os-title-label">#{I18n.t(:example_label)} </span>
+              <span class="os-title-label">#{I18n.t("example#{'.nominative' if cases}")} </span>
               <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
             </#{title_tag}>
           HTML
         )
 
-        example.document
-               .pantry(name: :link_text)
-               .store("#{I18n.t(:example_label)} #{number}", label: example.id)
-
-        example.titles.each do |title|
-          if title.parent.has_class?('os-caption-container') || \
-             title.parent.has_class?('os-caption')
-            next
-          end
+        # Store label information
+        example.target_label(label_text: 'example', custom_content: number, cases: cases)
 
+        example.titles_to_rename.each do |title|
           title.name = 'h4'
         end
 
         example.exercises.each do |exercise|
+          next if exercise.baked?
+
           if (problem = exercise.problem)
-            problem.titles.each { |title| title.name = 'h4' }
             problem.wrap_children(class: 'os-problem-container')
           end
 
@@ -58,6 +53,8 @@ module Kitchen
           next unless commentary.present?
 
           commentary_title = commentary.titles.first
+          next unless commentary_title.present?
+
           commentary_title.name = 'h4'
           commentary_title['data-type'] = 'commentary-title'
           commentary_title.wrap_children('span', class: 'os-title-label')

data/lib/kitchen/directions/bake_figure.rb

@@ -3,7 +3,7 @@
 module Kitchen
   module Directions
     module BakeFigure
-      def self.v1(figure:, number:)
+      def self.v1(figure:, number:, cases: false)
         return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
 
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
@@ -19,14 +19,16 @@ module Kitchen
           return
         end
 
-        figure.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
+        # Store label information
+        figure.target_label(label_text: 'figure', custom_content: number, cases: cases)
+
         title = figure.title&.cut
 
         caption = figure.caption&.cut
         figure.append(sibling:
           <<~HTML
             <div class="os-caption-container">
-              <span class="os-title-label">#{I18n.t(:figure)} </span>
+              <span class="os-title-label">#{I18n.t("figure#{'.nominative' if cases}")} </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}

data/lib/kitchen/directions/bake_first_elements.rb

@@ -3,12 +3,15 @@
 module Kitchen
   module Directions
     module BakeFirstElements
-      def self.v1(within:)
+      def self.v1(within:, first_inline_list: false)
+        # add has-first-element class
         selectors = [
           'div.os-problem-container > div.os-table',
           'div.os-problem-container > span[data-type="media"]',
+          'div.os-problem-container > div.os-figure',
           'div.os-solution-container > div.os-table',
-          'div.os-solution-container > span[data-type="media"]'
+          'div.os-solution-container > span[data-type="media"]',
+          'div.os-solution-container > div.os-figure'
         ]
         selectors.each do |selector|
           within.search("#{selector}:first-child").each do |problem|
@@ -16,6 +19,16 @@ module Kitchen
             problem.parent.add_class('has-first-element')
           end
         end
+
+        return unless first_inline_list
+
+        # add first-inline-element class
+        inline_selector = 'div.os-solution-container > ol[type="1"]:first-child,' \
+                          'div.os-problem-container > ol[type="1"]:first-child'
+        within.search(inline_selector).each do |inline_list|
+          inline_list.add_class('first-inline-list-element')
+          inline_list.parent.add_class('has-first-inline-list-element')
+        end
       end
     end
   end

data/lib/kitchen/directions/bake_folio.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFolio
+      def self.v1(book:)
+        book['data-pdf-folio-preface-message'] = I18n.t(:"folio.preface")
+        book['data-pdf-folio-access-message'] = I18n.t(:"folio.access_for_free")
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Kitchen::Directions::BakeFreeResponse
       @metadata_elements = metadata_source.children_to_keep.copy
 
       @free_response_clipboard = Kitchen::Clipboard.new
-      chapter.non_introduction_pages.each do |page|
+      chapter.pages.each do |page|
         free_response_questions = page.free_response
         next if free_response_questions.none?
 

data/lib/kitchen/directions/bake_further_research.rb

@@ -20,13 +20,11 @@ module Kitchen
             container_key: 'further-research',
             uuid_key: "#{uuid_prefix}further-research",
             section_selector: 'section.further-research',
-            append_to: nil,
-            include_intro_page: false
+            append_to: nil
           ) do |further_research|
             RemoveSectionTitle.v1(section: further_research)
             title = EocSectionTitleLinkSnippet.v1(page: further_research.ancestor(:page))
             further_research.prepend(child: title)
-            further_research.first('h3')[:itemprop] = 'name'
           end
         end
       end

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

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

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeHandbook
+  class V1
+    def bake(book:, title_element:)
+      book.pages('$.handbook').each do |page|
+        page.titles.each do |title|
+          title.replace_children(with:
+            <<~HTML
+              <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+            HTML
+          )
+          title.name = title_element
+        end
+
+        # Create Outline Title
+        outline_html = <<~HTML
+          <div class="os-handbook-outline">
+            <h3 class="os-title">#{I18n.t(:handbook_outline_title)}</h3>
+          </div>
+        HTML
+        page.title.append(sibling: outline_html)
+
+        bake_first_section_title_and_objectives(page: page)
+        fix_nested_section_headers(page: page)
+      end
+    end
+
+    # Bake Handbook First Section Title
+    def bake_first_section_title_and_objectives(page:)
+      outline_items_html = []
+      page.search('> section').each do |section|
+        first_section_title = section.titles.first
+        first_section_title.replace_children(with:
+          <<~HTML
+            <span class="os-part-text">H</span>
+            <span class="os-number">#{section.count_in(:page)}</span>
+            <span class="os-divider">. </span>
+            <span class="os-text">#{first_section_title.text}</span>
+          HTML
+        )
+        first_section_title.name = 'h2'
+
+        outline_item_html = <<~HTML
+          <div class="os-handbook-objective">
+            <a class="os-handbook-objective" href="##{first_section_title[:id]}">
+              #{first_section_title.children}
+            </a>
+          </div>
+        HTML
+        outline_items_html.push(outline_item_html)
+      end
+      page.search('.os-handbook-outline').first.append(child:
+        <<~HTML
+          #{outline_items_html.join}
+        HTML
+      )
+    end
+
+    def fix_nested_section_headers(page:)
+      page.search('section').each do |section|
+        section_data_depth = section[:'data-depth']
+        case section_data_depth
+        when '2'
+          section.titles.first.name = 'h3'
+        when '3'
+          section.titles.first.name = 'h4'
+        when '4'
+          section.titles.first.name = 'h5'
+        end
+      end
+    end
+  end
+end