openstax_kitchen 3.2.0 → 6.0.0

data/lib/kitchen/composite_chapter_element_enumerator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for composite page elements
+  #
+  class CompositeChapterElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:composite_chapter),
+        sub_element_class: CompositeChapterElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/composite_page_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: CompositePageElementEnumerator,
-            short_type: :composite_page)
+            enumerator_class: CompositePageElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :composite_page
     end
 
     # Returns the title element (the one in the immediate children, not the one in the metadata)
@@ -26,24 +32,23 @@ module Kitchen
       # Get the title in the immediate children, not the one in the metadata.  Could use
       # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
       # but xpath is shorter
-      first!("./*[@data-type = 'document-title']")
+      first!("./*[@data-type = 'document-title' or @data-type = 'title']")
     end
 
-    # Returns true if this class represents the element for the given node
+    # Returns true if this page is a book index
     #
-    # @param node [Nokogiri::XML::Node] the underlying node
     # @return [Boolean]
     #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'composite-page'
+    def is_index?
+      has_class?('os-index-container')
     end
 
-    # Returns true if this page is a book index
+    # Returns true if this page is a book reference
     #
     # @return [Boolean]
     #
-    def is_index?
-      has_class?('os-index-container')
+    def is_reference?
+      has_class?('os-reference-container')
     end
 
   end

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_appendix.rb

@@ -17,7 +17,9 @@ module Kitchen
 
         # Make a section with data-depth of X have a header level of X+1
         page.search('section').each do |section|
-          title = section.first!("[data-type='title']")
+          title = section.titles.first
+          next unless title.present?
+
           title.name = "h#{section['data-depth'].to_i + 1}"
         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

@@ -3,21 +3,31 @@
 module Kitchen
   module Directions
     module BakeChapterIntroductions
-      def self.v1(book:)
+      def self.v1(book:, bake_chapter_objectives: true)
         book.chapters.each do |chapter|
-          outline_items_html = chapter.pages.map do |page|
-            next if page.is_introduction?
+          chapter_outline_html = ''
 
-            <<~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-divider"> </span>
-                  <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
-                </a>
+          if bake_chapter_objectives
+            outline_items_html = chapter.non_introduction_pages.map do |page|
+
+              <<~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)}</span>
+                    <span class="os-divider"> </span>
+                    <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
+                  </a>
+                </div>
+              HTML
+            end.join('')
+
+            chapter_outline_html = <<~HTML
+              <div class="os-chapter-outline">
+                <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
+                #{outline_items_html}
               </div>
             HTML
-          end.join('')
+          end
 
           introduction_page = chapter.introduction_page
 
@@ -28,15 +38,12 @@ 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
               <div class="intro-body">
-                <div class="os-chapter-outline">
-                  <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
-                  #{outline_items_html}
-                </div>
+                #{chapter_outline_html}
                 <div class="intro-text">
                   #{title.paste}
                   #{intro_content.paste}

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterKeyConcepts
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      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

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

@@ -3,10 +3,12 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     renderable
-    def bake(chapter:, metadata_source:, append_to:)
-      @metadata_elements = metadata_source.children_to_keep.copy
+    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 = []
       key_concepts_clipboard = Kitchen::Clipboard.new
       chapter.non_introduction_pages.each do |page|
         key_concepts = page.key_concepts
@@ -16,15 +18,18 @@ module Kitchen::Directions::BakeChapterKeyConcepts
         title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
         key_concepts.each do |key_concept|
           key_concept.prepend(child: title)
-          key_concept&.cut(to: key_concepts_clipboard)
+          key_concept.wrap("<div class='os-section-area'>")
+          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
         end
-        @key_concepts.push(key_concepts_clipboard.paste)
-        key_concepts_clipboard.clear
       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: 'key_concepts.xhtml.erb'))
+      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,33 +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:, append_to: nil)
-        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
 
-        append_to_element = append_to || chapter
+          return if chapter.key_equations.none?
 
-        append_to_element.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
-        )
+          @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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeChapterSectionExercises
-      def self.v1(chapter:)
-        V1.new.bake(chapter: chapter)
+      def self.v1(chapter:, trash_title: false)
+        V1.new.bake(chapter: chapter, trash_title: trash_title)
       end
     end
   end

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

@@ -2,9 +2,10 @@
 
 module Kitchen::Directions::BakeChapterSectionExercises
   class V1
-    def bake(chapter:)
+    def bake(chapter:, trash_title:)
       chapter.pages.each do |page|
         page.search('section.section-exercises').each do |section|
+          section.first('h3[data-type="title"]')&.trash if trash_title
           section.wrap(
             %(<div class="os-eos os-section-exercises-container"
               data-uuid-key=".section-exercises">)

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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)
+      end
+    end
+  end
+end