openstax_kitchen 3.1.0 → 5.0.0

data/lib/kitchen/directions/bake_suggested_reading.rb

@@ -6,6 +6,7 @@ module Kitchen
     #
     module BakeSuggestedReading
       def self.v1(book:)
+        metadata_elements = book.metadata.children_to_keep.copy
         book.chapters.each do |chapter|
           suggested_reading = chapter.search('section.suggested-reading').cut
 
@@ -15,6 +16,10 @@ module Kitchen
                 <h2 data-type="document-title">
                   <span class="os-text">#{I18n.t(:eoc_suggested_reading)}</span>
                 </h2>
+                <div data-type="metadata" style="display: none;">
+                  <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_suggested_reading)}</h1>
+                  #{metadata_elements.paste}
+                </div>
                 #{suggested_reading.paste}
               </div>
             HTML

data/lib/kitchen/directions/bake_toc.rb

@@ -31,9 +31,9 @@ module Kitchen
         <<~HTML
           <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit">
             <a href="#">
-              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span> #{unit.count_in(:book)}</span>
+              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span>#{unit.count_in(:book)}</span>
               <span class="os-divider"> </span>
-              <span data-type itemprop class="os-text"> #{unit.title.children} </span>
+              <span data-type itemprop class="os-text">#{unit.title_text}</span>
             </a>
             <ol class="os-unit">
               #{chapters.map { |chapter| li_for_chapter(chapter) }.join("\n")}
@@ -96,6 +96,8 @@ module Kitchen
           when CompositePageElement
             if page.is_index?
               'os-toc-index'
+            elsif page.is_reference?
+              'os-toc-reference'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else

data/lib/kitchen/directions/{bake_book_answer_key → book_answer_key_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeBookAnswerKey
+    module BookAnswerKeyContainer
       def self.v1(book:)
         V1.new.bake(book: book)
       end

data/lib/kitchen/directions/{bake_book_answer_key → book_answer_key_container}/v1.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeBookAnswerKey
+module Kitchen::Directions::BookAnswerKeyContainer
   class V1
     renderable
 
     def bake(book:)
       @metadata = book.metadata.children_to_keep.copy
       book.body.append(child: render(file: 'eob_solutions_container.xhtml.erb'))
-      book.body.first('.os-eob.os-solutions-container')
+      book.body.first('div.os-eob.os-solutions-container')
     end
   end
 end

data/lib/kitchen/directions/{bake_chapter_review → chapter_review_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeChapterReview
+    module ChapterReviewContainer
       def self.v1(chapter:, metadata_source:)
         V1.new.bake(chapter: chapter, metadata_source: metadata_source)
       end

data/lib/kitchen/directions/{bake_chapter_review → chapter_review_container}/v1.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReview
+module Kitchen::Directions::ChapterReviewContainer
   class V1
     renderable
 
     def bake(chapter:, metadata_source:)
       @metadata = metadata_source.children_to_keep.copy
       chapter.append(child: render(file: 'chapter_review.xhtml.erb'))
-      chapter.first('.os-eoc.os-chapter-review-container')
+      chapter.first('div.os-eoc.os-chapter-review-container')
     end
   end
 end

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -10,7 +10,7 @@ module Kitchen
             <h3 data-type="document-title" id="#{page.title.copied_id}">
               <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="">#{page.title.text}</span>
+              <span class="os-text" data-type="" itemprop="">#{page.title_text}</span>
             </h3>
           </a>
         HTML

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

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

data/lib/kitchen/directions/{bake_chapter_review_exercises → move_exercises_to_eoc}/v1.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReviewExercises
+module Kitchen::Directions::MoveExercisesToEOC
   class V1
     renderable
 
-    def bake(chapter:, metadata_source:, append_to:, klass:)
+    def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
       @klass = klass
       @metadata = metadata_source.children_to_keep.copy
       @title = I18n.t(:"eoc.#{klass}")
+      @uuid_prefix = uuid_prefix
 
       exercise_clipboard = Kitchen::Clipboard.new
 
@@ -17,13 +18,6 @@ module Kitchen::Directions::BakeChapterReviewExercises
         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
@@ -32,7 +26,11 @@ module Kitchen::Directions::BakeChapterReviewExercises
 
       @content = exercise_clipboard.paste
 
-      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+      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_review_exercises → move_exercises_to_eoc}/v2.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterReviewExercises
+module Kitchen::Directions::MoveExercisesToEOC
   # 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:)
+    def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
       @klass = klass
       @metadata = metadata_source.children_to_keep.copy
       @title = I18n.t(:"eoc.#{klass}")
+      @uuid_prefix = uuid_prefix
 
       exercise_clipboard = Kitchen::Clipboard.new
 
@@ -21,12 +22,6 @@ module Kitchen::Directions::BakeChapterReviewExercises
 
           # 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)
@@ -44,7 +39,11 @@ module Kitchen::Directions::BakeChapterReviewExercises
         </div>
       HTML
 
-      append_to.append(child: render(file: 'review_exercises.xhtml.erb'))
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element[:'data-type'] == '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_answer_key → move_solutions_to_answer_key}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module BakeChapterAnswerKey
+    module MoveSolutionsToAnswerKey
       def self.v1(chapter:, metadata_source:, strategy:, append_to:)
         V1.new.bake(
           chapter: chapter,

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/american_government.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class AmericanGovernment
+      def bake(chapter:, append_to:)
+        bake_section(chapter: chapter, append_to: append_to, klass: 'review-questions')
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:)
+        chapter.search(".#{klass} [data-type='solution']").each do |solution|
+          append_to.add_child(solution.cut.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/strategies/calculus.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   module Strategies
     class Calculus
       def bake(chapter:, append_to:)

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/strategies/uphysics.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   module Strategies
     class UPhysics
       def bake(chapter:, append_to:)
@@ -18,7 +18,7 @@ module Kitchen::Directions::BakeChapterAnswerKey
       def bake_section(chapter:, append_to:, klass:)
         section_solutions_set = []
         chapter.search(".#{klass}").each do |section|
-          section.search('[data-type="solution"]').each do |solution|
+          section.search('div[data-type="solution"]').each do |solution|
             section_solutions_set.push(solution.cut)
           end
         end
@@ -31,9 +31,11 @@ module Kitchen::Directions::BakeChapterAnswerKey
 
       def bake_from_notes(chapter:, append_to:, klass:)
         solutions = []
-        chapter.notes(".#{klass}").each do |note|
-          solution = note.exercises.first.solution
-          solutions.push(solution.cut) if solution
+        chapter.notes("$.#{klass}").each do |note|
+          note.exercises.each do |exercise|
+            solution = exercise.solution
+            solutions.push(solution.cut) if solution
+          end
         end
         return if solutions.empty?
 

data/lib/kitchen/directions/{bake_chapter_answer_key → move_solutions_to_answer_key}/v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeChapterAnswerKey
+module Kitchen::Directions::MoveSolutionsToAnswerKey
   class V1
     def bake(chapter:, metadata_source:, strategy:, append_to:)
       strategy =
@@ -9,6 +9,8 @@ module Kitchen::Directions::BakeChapterAnswerKey
           Strategies::Calculus
         when :uphysics
           Strategies::UPhysics
+        when :american_government
+          Strategies::AmericanGovernment
         else
           raise 'No such strategy'
         end

data/lib/kitchen/document.rb

@@ -13,6 +13,8 @@ module Kitchen
     attr_accessor :location
     # @return [Config] the configuration used in this document
     attr_reader :config
+    # @return [IdTracker] the counter for duplicate IDs
+    attr_reader :id_tracker
 
     # @!method selectors
     #   The document's selectors
@@ -34,7 +36,10 @@ module Kitchen
     # @!method to_html
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#to_html-instance_method Nokogiri::XML::Node#to_html
     #   @return [String] the document as an HTML string
-    def_delegators :@nokogiri_document, :to_xhtml, :to_s, :to_xml, :to_html
+    # @!method encoding
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Document#encoding-instance_method Nokogiri::XML::Document#encoding
+    #   @return [String] the document as an HTML string
+    def_delegators :@nokogiri_document, :to_xhtml, :to_s, :to_xml, :to_html, :encoding
 
     # Return a new instance of Document
     #
@@ -44,8 +49,10 @@ module Kitchen
       @nokogiri_document = nokogiri_document
       @location = nil
       @config = config || Config.new
-      @next_paste_count_for_id = {}
-      @id_copy_suffix = '_copy_'
+      @id_tracker = IdTracker.new
+
+      # Nokogiri by default only recognizes the namespaces on the root node.  Add all others.
+      raw&.add_all_namespaces! if @config.enable_all_namespaces
     end
 
     # Returns an enumerator that iterates over all children of this document
@@ -145,38 +152,6 @@ module Kitchen
       end
     end
 
-    # Keeps track that an element with the given ID has been copied.  When such
-    # elements are pasted, this information is used to give those elements unique
-    # IDs that don't duplicate the original element.
-    #
-    # @param id [String] the ID
-    #
-    def record_id_copied(id)
-      return if id.blank?
-
-      @next_paste_count_for_id[id] ||= 1
-    end
-
-    # Returns a unique ID given the ID of an element that was copied and is about
-    # to be pasted
-    #
-    # @param original_id [String]
-    #
-    def modified_id_to_paste(original_id)
-      return nil if original_id.nil?
-      return '' if original_id.blank?
-
-      count = next_count_for_pasted_id(original_id)
-
-      # A count of 0 means the element was cut and this is the first paste, do not
-      # modify the ID; otherwise, use the uniquified ID.
-      if count.zero?
-        original_id
-      else
-        "#{original_id}#{@id_copy_suffix}#{count}"
-      end
-    end
-
     # Returns the underlying Nokogiri Document object
     #
     # @return [Nokogiri::XML::Document]
@@ -185,16 +160,19 @@ module Kitchen
       @nokogiri_document
     end
 
-    protected
-
-    def next_count_for_pasted_id(id)
-      return if id.blank?
-
-      (@next_paste_count_for_id[id] ||= 0).tap do
-        @next_paste_count_for_id[id] += 1
+    # Returns the locale for this document, default to `:en` if no locale detected
+    #
+    # @return [Symbol]
+    #
+    def locale
+      raw.root['lang']&.to_sym || begin
+        warn 'No `lang` attribute on this document so cannot detect its locale; defaulting to `:en`'
+        :en
       end
     end
 
+    protected
+
     attr_reader :nokogiri_document
 
   end

data/lib/kitchen/element.rb

@@ -19,8 +19,14 @@ module Kitchen
             short_type: short_type)
     end
 
-    # # @!method pages
-    # #   Returns a pages enumerator
-    # def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples
+    # Returns true if this class represents the element for the given node; always false
+    # for this generic class
+    #
+    # @param node [Nokogiri::XML::Node] the underlying node
+    # @return [Boolean]
+    #
+    def self.is_the_element_class_for?(_node, **)
+      false
+    end
   end
 end

data/lib/kitchen/element_base.rb

@@ -3,6 +3,7 @@
 require 'forwardable'
 require 'securerandom'
 
+# rubocop:disable Metrics/ClassLength
 module Kitchen
   # Abstract base class for all elements.  If you are looking for a simple concrete
   # element class, use `Element`.
@@ -92,6 +93,16 @@ module Kitchen
     #   @return [Selectors::Base]
     def_delegators :config, :selectors
 
+    # @!method pantry
+    #   Access the pantry for this element's document
+    #   @return [Pantry]
+    # @!method :clipboard
+    #   Access the clipboard for this element's document
+    #   @return [Clipboard]
+    def_delegators :document, :pantry, :clipboard
+
+    def_delegators :document, :id_tracker
+
     # Creates a new instance
     #
     # @param node [Nokogiri::XML::Node] the wrapped element
@@ -108,7 +119,9 @@ module Kitchen
 
       @enumerator_class = enumerator_class
 
-      @short_type = short_type || "unknown_type_#{SecureRandom.hex(4)}"
+      @short_type = short_type ||
+                    self.class.try(:short_type) ||
+                    "unknown_type_#{SecureRandom.hex(4)}"
 
       @document =
         case document
@@ -121,16 +134,53 @@ module Kitchen
       @ancestors = HashWithIndifferentAccess.new
       @search_query_matches_that_have_been_counted = {}
       @is_a_clone = false
+      @search_cache = {}
+    end
+
+    # Returns ElementBase descendent type or nil if none found
+    #
+    # @param type [Symbol] the descendant type, e.g. `:page`
+    # @return [Class] the child class for the given type
+    #
+    def self.descendant(type)
+      @types_to_descendants ||=
+        descendants.each_with_object({}) do |descendant, hash|
+          next unless descendant.try(:short_type)
+
+          hash[descendant.short_type] = descendant
+        end
+
+      @types_to_descendants[type]
+    end
+
+    # Returns ElementBase descendent type or Error if none found
+    #
+    # @param type [Symbol] the descendant type, e.g. `:page`
+    # @raise if the type is unknown
+    # @return [Class] the child class for the given type
+    #
+    def self.descendant!(type)
+      descendant(type) || raise("Unknown ElementBase descendant type '#{type}'")
+    end
+
+    # Returns true if this element is the given type
+    #
+    # @param type [Symbol] the descendant type, e.g. `:page`
+    # @raise if the type is unknown
+    # @return [Boolean]
+    #
+    def is?(type)
+      ElementBase.descendant!(type).is_the_element_class_for?(raw, config: config)
     end
 
     # Returns true if this class represents the element for the given node
     #
     # @param node [Nokogiri::XML::Node] the underlying node
+    # @param config [Kitchen::Config]
     # @return [Boolean]
     #
-    def self.is_the_element_class_for?(_node)
-      # override this in subclasses
-      false
+    def self.is_the_element_class_for?(node, config:)
+      Selector.named(short_type).matches?(node, config: config)
     end
 
     # Returns true if this element has the given class
@@ -298,7 +348,7 @@ module Kitchen
     #   search results if the method or callable returns false
     # @return [ElementEnumerator]
     #
-    def search(*selector_or_xpath_args, only: nil, except: nil)
+    def search(*selector_or_xpath_args, only: nil, except: nil, reload: false)
       block_error_if(block_given?)
 
       ElementEnumerator.factory.build_within(
@@ -307,19 +357,29 @@ module Kitchen
           css_or_xpath: selector_or_xpath_args,
           only: only,
           except: except
-        )
+        ),
+        reload: reload
       )
     end
 
+    def raw_search(*selector_or_xpath_args, reload: false)
+      key = selector_or_xpath_args
+      @search_cache[key] = nil if reload || !config.enable_search_cache
+      # cache nil search results with a fake -1 value
+      @search_cache[key] ||= raw.search(*selector_or_xpath_args) || -1
+      @search_cache[key] == -1 ? nil : @search_cache[key]
+    end
+
     # Yields and returns the first child element that matches the provided
     # selector or XPath arguments.
     #
     # @param selector_or_xpath_args [Array<String>] CSS selectors or XPath arguments
+    # @param reload [Boolean] ignores cache if true
     # @yieldparam [Element] the matched XML element
     # @return [Element, nil] the matched XML element or nil if no match found
     #
-    def first(*selector_or_xpath_args)
-      search(*selector_or_xpath_args).first.tap do |element|
+    def first(*selector_or_xpath_args, reload: false)
+      search(*selector_or_xpath_args, reload: reload).first.tap do |element|
         yield(element) if block_given?
       end
     end
@@ -328,12 +388,13 @@ module Kitchen
     # selector or XPath arguments.
     #
     # @param selector_or_xpath_args [Array<String>] CSS selectors or XPath arguments
+    # @param reload [Boolean] ignores cache if true
     # @yieldparam [Element] the matched XML element
     # @raise [ElementNotFoundError] if no matching element is found
     # @return [Element] the matched XML element
     #
-    def first!(*selector_or_xpath_args)
-      search(*selector_or_xpath_args).first!.tap do |element|
+    def first!(*selector_or_xpath_args, reload: false)
+      search(*selector_or_xpath_args, reload: reload).first!.tap do |element|
         yield(element) if block_given?
       end
     end
@@ -382,8 +443,13 @@ module Kitchen
     def cut(to: nil)
       block_error_if(block_given?)
 
+      raw.traverse do |node|
+        next if node.text? || node.document?
+
+        id_tracker.record_id_cut(node[:id])
+      end
       node.remove
-      clipboard(to).add(self) if to.present?
+      get_clipboard(to).add(self) if to.present?
       self
     end
 
@@ -402,9 +468,9 @@ module Kitchen
       the_copy.raw.traverse do |node|
         next if node.text? || node.document?
 
-        document.record_id_copied(node[:id])
+        id_tracker.record_id_copied(node[:id])
       end
-      clipboard(to).add(the_copy) if to.present?
+      get_clipboard(to).add(the_copy) if to.present?
       the_copy
     end
 
@@ -413,20 +479,22 @@ module Kitchen
     def paste
       # See `clone` method for a note about namespaces
       block_error_if(block_given?)
-
       temp_copy = clone
       temp_copy.raw.traverse do |node|
         next if node.text? || node.document?
 
-        node[:id] = document.modified_id_to_paste(node[:id]) unless node[:id].blank?
+        if node[:id].present?
+          id_tracker.record_id_pasted(node[:id])
+          node[:id] = id_tracker.modified_id_to_paste(node[:id])
+        end
       end
       temp_copy.to_s
     end
 
     # Copy the element's id
     def copied_id
-      document.record_id_copied(id)
-      document.modified_id_to_paste(id)
+      id_tracker.record_id_copied(id)
+      id_tracker.modified_id_to_paste(id)
     end
 
     # Delete the element
@@ -646,7 +714,8 @@ module Kitchen
     # @!method pages
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
-                   :metadatas, :non_introduction_pages, :units, :titles, :exercises, :composite_pages
+                   :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
+                   :composite_pages, :composite_chapters
 
     # Returns this element as an enumerator (over only one element, itself)
     #
@@ -671,10 +740,10 @@ module Kitchen
     # @param name_or_object [String, Clipboard] the name of the clipboard or the clipboard itself
     # @return [Clipboard]
     #
-    def clipboard(name_or_object)
+    def get_clipboard(name_or_object)
       case name_or_object
       when Symbol
-        document.clipboard(name: name_or_object)
+        clipboard(name: name_or_object)
       when Clipboard
         name_or_object
       else
@@ -688,7 +757,9 @@ module Kitchen
     # @param string [String] the string to clean
     def remove_default_namespaces_if_clone(string)
       if is_a_clone
-        string.gsub('xmlns:default="http://www.w3.org/1999/xhtml"', '').gsub('default:', '')
+        string.gsub('xmlns:default="http://www.w3.org/1999/xhtml"', '')
+              .gsub('xmlns="http://www.w3.org/1999/xhtml"', '')
+              .gsub('default:', '')
       else
         string
       end
@@ -701,3 +772,4 @@ module Kitchen
 
   end
 end
+# rubocop:enable Metrics/ClassLength