openstax_kitchen 3.0.0 → 4.1.1

data/lib/kitchen/composite_page_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "div[data-type='composite-page']",
+        default_css_or_xpath: Selector.named(:composite_page),
         sub_element_class: CompositePageElement,
         enumerator_class: self
       )

data/lib/kitchen/config.rb

@@ -11,6 +11,18 @@ module Kitchen
     #
     attr_reader :selectors
 
+    # @!attribute [rw] enable_all_namespaces
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :enable_all_namespaces
+
+    # @!attribute [rw] enable_search_cache
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :enable_search_cache
+
     # Creates a new config from a file (not implemented)
     #
     def self.new_from_file(_file)
@@ -21,6 +33,8 @@ module Kitchen
     #
     def initialize(hash: {}, selectors: nil)
       @selectors = selectors || Kitchen::Selectors::Standard1.new
+      @enable_all_namespaces = hash[:enable_all_namespaces] || true
+      @enable_search_cache = hash[:enable_search_cache] || false
       @hash = hash
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directons for eoc glossary
+    #
+    module BakeChapterGlossary
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterGlossary
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'glossary'
+      @title = I18n.t(:eoc_key_terms_title)
+      @uuid_prefix = uuid_prefix
+
+      definitions = chapter.glossaries.search('dl').cut
+      return if definitions.none?
+      definitions.sort_by! do |definition|
+        [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
+      end
+
+      chapter.glossaries.trash
+
+      @content = definitions.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_introductions.rb

@@ -28,7 +28,7 @@ module Kitchen
           title.name = 'h2'
           MoveTitleTextIntoSpan.v1(title: title)
 
-          intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
+          intro_content = introduction_page.search("> :not([data-type='metadata']):not(.splash):not(.has-splash)").cut
 
           introduction_page.append(child:
             <<~HTML

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

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterKeyConcepts
+  class V1
+    renderable
+    def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'key-concepts'
+      @title = I18n.t(:eoc_key_concepts)
+      @uuid_prefix = 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?
+
+        key_concepts.search('h3').trash
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+        key_concepts.each do |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>"
+
+      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_key_equations.rb

@@ -2,31 +2,38 @@
 
 module Kitchen
   module Directions
-    # Bake directions for eoc key equations
+    # Bake directons for eoc key equations
     #
     module BakeChapterKeyEquations
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.children_to_keep.copy
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
 
-        chapter.key_equations.search('h3').trash
-        key_equations = chapter.key_equations.cut
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = 'key-equations'
+          @title = I18n.t(:eoc_key_equations)
+          @uuid_prefix = uuid_prefix
 
-        return if key_equations.none?
+          chapter.key_equations.search('h3').trash
 
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-key-equations-container" data-type="composite-page" data-uuid-key=".key-equations">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_key_equations)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_equations)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{key_equations.paste}
-            </div>
-          HTML
-        )
+          return if chapter.key_equations.none?
+
+          @content = chapter.key_equations.cut.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
   end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReferences
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = klass
+      @title = I18n.t(:references)
+      @uuid_prefix = uuid_prefix
+
+      chapter.references.search('h3').trash
+
+      chapter.non_introduction_pages.each do |page|
+        references = page.references
+        next if references.none?
+
+        references.search('h3').trash
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+
+        references.each do |reference|
+          reference.prepend(child: title)
+        end
+      end
+
+      @content = chapter.pages.references.cut.paste
+
+      @in_composite_chapter = false
+
+      chapter.append(child: render(file:
+        '../../templates/eoc_section_title_template.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

@@ -5,50 +5,56 @@ module Kitchen
     # Bake directions for eoc summary
     #
     module BakeChapterSummary
-      def self.v1(chapter:, metadata_source:)
-        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|
-          summary = page.summary
-          summary.first("[data-type='title']")&.trash # get rid of old title if exists
-          summary_title = page.title.copy
-          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
-          )
-
-          summary.prepend(child:
-            <<~HTML
-              <a href="##{page.title.id}">
-                #{summary_title.paste}
-              </a>
+      def self.v1(chapter:, metadata_source:, klass: 'summary', uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
+
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = klass
+          @title = I18n.t(:eoc_summary_title)
+          @uuid_prefix = uuid_prefix
+
+          summaries = Clipboard.new
+
+          # TODO: include specific page types somehow without writing it out
+          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
+            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
-          )
-          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">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_summary_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_summary_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{summaries.paste}
-            </div>
-          HTML
-        )
+            summary.prepend(child:
+              <<~HTML
+                <a href="##{page.title.id}">
+                  #{summary_title.paste}
+                </a>
+              HTML
+            )
+            summary.cut(to: summaries)
+          end
+
+          return if summaries.none?
+
+          @content = summaries.paste
+          @in_composite_chapter = false
+
+          chapter.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
       end
     end
   end

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