openstax_kitchen 3.0.0 → 4.1.1

data/lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb

@@ -0,0 +1,9 @@
+<div class="os-eoc os-chapter-review-container" data-type="composite-chapter" data-uuid-key=".chapter-review">
+  <h2 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_chapter_review) %></span>
+  </h2>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_chapter_review) %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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('div.os-eoc.os-chapter-review-container')
+    end
+  end
+end

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module EocSectionTitleLinkSnippet
+      def self.v1(page:)
+        chapter = page.ancestor(:chapter)
+        <<~HTML
+          <a href="##{page.title.id}">
+            <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>
+            </h3>
+          </a>
+        HTML
+      end
+    end
+  end
+end

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/move_exercises_to_eoc/v1.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveExercisesToEOC
+  class V1
+    renderable
+
+    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
+
+      chapter.non_introduction_pages.each do |page|
+        sections = page.search("section.#{@klass}")
+
+        sections.each do |exercise_section|
+          exercise_section.first("[data-type='title']")&.trash
+
+          exercise_section.cut(to: exercise_clipboard)
+        end
+      end
+
+      return if exercise_clipboard.none?
+
+      @content = exercise_clipboard.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/move_exercises_to_eoc/v2.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+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:, 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
+
+      chapter.non_introduction_pages.each do |page|
+        sections = page.search("section.#{@klass}")
+
+        sections.each do |exercise_section|
+          exercise_section.first("[data-type='title']")&.trash
+
+          # Get parent page title
+          section_title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+
+          # Configure section title & wrappers
+          exercise_section.prepend(child: section_title)
+          exercise_section.wrap('<div class="os-section-area">')
+          exercise_section = exercise_section.parent
+          exercise_section.cut(to: exercise_clipboard)
+        end
+      end
+
+      return if exercise_clipboard.none?
+
+      @content = <<~HTML
+        <div class="os-#{@klass}">
+          #{exercise_clipboard.paste}
+        </div>
+      HTML
+
+      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/move_solutions_to_answer_key/main.rb

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

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/move_solutions_to_answer_key/strategies/calculus.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Calculus
+      def bake(chapter:, append_to:)
+        checkpoint_solutions = chapter.search('.checkpoint [data-type="solution"]').cut
+        append_solution_area(I18n.t(:checkpoint), checkpoint_solutions, append_to)
+
+        chapter.search('.section-exercises').each do |section|
+          section_solutions = section.search('[data-type="solution"]').cut
+          section_title = I18n.t(
+            :section_exercises,
+            number: "#{chapter.count_in(:book)}.#{section.count_in(:chapter)}"
+          )
+          append_solution_area(section_title, section_solutions, append_to)
+        end
+
+        chapter.search('.review-exercises').each do |section|
+          section_solutions = section.search('[data-type="solution"]').cut
+          append_solution_area(I18n.t(:review_exercises), section_solutions, append_to)
+        end
+      end
+
+      protected
+
+      def append_solution_area(title, clipboard, append_to)
+        append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{title}</span>
+              </h3>
+              #{clipboard.paste}
+            </div>
+          HTML
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class UPhysics
+      def bake(chapter:, append_to:)
+        bake_from_notes(chapter: chapter, append_to: append_to, klass: 'check-understanding')
+
+        classes = %w[review-conceptual-questions review-problems review-additional-problems
+                     review-challenge]
+        classes.each do |klass|
+          bake_section(chapter: chapter, append_to: append_to, klass: klass)
+        end
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:)
+        section_solutions_set = []
+        chapter.search(".#{klass}").each do |section|
+          section.search('div[data-type="solution"]').each do |solution|
+            section_solutions_set.push(solution.cut)
+          end
+        end
+
+        return if section_solutions_set.empty?
+
+        title = I18n.t(:"eoc.#{klass}")
+        append_solution_area(title, section_solutions_set, append_to)
+      end
+
+      def bake_from_notes(chapter:, append_to:, klass:)
+        solutions = []
+        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?
+
+        title = I18n.t(:"notes.#{klass}")
+        append_solution_area(title, solutions, append_to)
+      end
+
+      def append_solution_area(title, solutions, append_to)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{title}</span>
+              </h3>
+            </div>
+          HTML
+        ).first
+
+        solutions.each do |solution|
+          append_to.add_child(solution.raw)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  class V1
+    def bake(chapter:, metadata_source:, strategy:, append_to:)
+      strategy =
+        case strategy
+        when :calculus
+          Strategies::Calculus
+        when :uphysics
+          Strategies::UPhysics
+        when :american_government
+          Strategies::AmericanGovernment
+        else
+          raise 'No such strategy'
+        end
+
+      append_to.append(child:
+        <<~HTML
+          <div class="os-eob os-solutions-container" data-type="composite-page" data-uuid-key=".solutions#{chapter.count_in(:book)}">
+            <h2 data-type="document-title">
+              <span class="os-text">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</span>
+            </h2>
+            <div data-type="metadata" style="display: none;">
+              <h1 data-type="document-title" itemprop="name">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</h1>
+              #{metadata_source.children_to_keep.copy.paste}
+            </div>
+          </div>
+        HTML
+      )
+      strategy.new.bake(chapter: chapter, append_to: append_to.last_element)
+    end
+  end
+end

data/lib/kitchen/document.rb

@@ -46,6 +46,9 @@ module Kitchen
       @config = config || Config.new
       @next_paste_count_for_id = {}
       @id_copy_suffix = '_copy_'
+
+      # 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

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,14 @@ 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
+
     # Creates a new instance
     #
     # @param node [Nokogiri::XML::Node] the wrapped element
@@ -108,7 +117,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 +132,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 +346,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 +355,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 +386,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
@@ -383,7 +442,7 @@ module Kitchen
       block_error_if(block_given?)
 
       node.remove
-      clipboard(to).add(self) if to.present?
+      get_clipboard(to).add(self) if to.present?
       self
     end
 
@@ -404,7 +463,7 @@ module Kitchen
 
         document.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
 
@@ -423,6 +482,12 @@ module Kitchen
       temp_copy.to_s
     end
 
+    # Copy the element's id
+    def copied_id
+      document.record_id_copied(id)
+      document.modified_id_to_paste(id)
+    end
+
     # Delete the element
     #
     def trash
@@ -491,6 +556,35 @@ module Kitchen
       self
     end
 
+    # Wraps the element's children in a new element.  Yields the new wrapper element
+    # to a block, if provided.
+    #
+    # @param name [String] the wrapper's tag name, defaults to 'div'.
+    # @param attributes [Hash] the wrapper's attributes.  XML attributes often use hyphens
+    #   (e.g. 'data-type') which are hard to put into symbols.  Therefore underscores in
+    #   keys passed to this method will be converted to hyphens.  If you really want an
+    #   underscore you can use a double underscore.
+    # @yieldparam [Element] the wrapper Element
+    # @return [Element] self
+    #
+    def wrap_children(name='div', attributes={})
+      if name.is_a?(Hash)
+        attributes = name
+        name = 'div'
+      end
+
+      node.children = node.document.create_element(name) do |new_node|
+        # For some reason passing attributes to create_element doesn't work, so doing here
+        attributes.each do |k, v|
+          new_node[k.to_s.gsub(/([^_])_([^_])/, '\1-\2').gsub('__', '_')] = v
+        end
+        new_node.children = children.to_s
+        yield Element.new(node: new_node, document: document, short_type: nil) if block_given?
+      end.to_s
+
+      self
+    end
+
     # TODO: methods like replace_children that take string, either forbid or handle Element/Node args
 
     # Get the content of children matching the provided selector.  Mostly
@@ -604,10 +698,15 @@ module Kitchen
       end
     end
 
+    def last_element
+      node.last_element_child
+    end
+
     # @!method pages
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
-                   :metadatas, :units
+                   :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
+                   :composite_pages, :composite_chapters
 
     # Returns this element as an enumerator (over only one element, itself)
     #
@@ -632,10 +731,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
@@ -649,7 +748,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
@@ -662,3 +763,4 @@ module Kitchen
 
   end
 end
+# rubocop:enable Metrics/ClassLength