openstax_kitchen 4.0.0 → 6.1.0

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveExercisesToEOC
+  # The difference from v1 is the presence of a section title
+  # and from v2 the lack of additional "os-section-area" and os-#{@klass} wrappers
+  class V3
+    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
+
+          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
+          exercise_section.prepend(child: section_title)
+          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_solutions_to_answer_key/main.rb

@@ -3,11 +3,15 @@
 module Kitchen
   module Directions
     module MoveSolutionsToAnswerKey
-      def self.v1(chapter:, metadata_source:, strategy:, append_to:)
+      def self.v1(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
-          strategy: strategy, append_to: append_to)
+          strategy: strategy,
+          append_to: append_to,
+          strategy_options: strategy_options,
+          solutions_plural: solutions_plural
+        )
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Default
+      def bake(chapter:, append_to:)
+        bake_section(chapter: chapter, append_to: append_to)
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:)
+        @classes.each do |klass|
+          chapter.search(".#{klass} [data-type='solution']").each do |solution|
+            append_to.add_child(solution.cut.to_s)
+          end
+        end
+      end
+
+      # This method helps to obtain more strategy-specific params through
+      # "strategy_options: {blah1: 1, blah2: 2}"
+      def initialize(strategy_options)
+        @classes = strategy_options[:classes] || (raise 'missing classes for strategy')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Precalculus
+      def bake(chapter:, append_to:)
+        try_note_solutions(chapter: chapter, append_to: append_to)
+
+        # Bake section exercises
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+          bake_section(chapter: page, append_to: append_to, klass: 'section-exercises',
+                       number: number)
+        end
+
+        # Bake other types of exercises
+        classes = %w[review-exercises practice-test]
+        classes.each do |klass|
+          bake_section(chapter: chapter, append_to: append_to, klass: klass)
+        end
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:, number: nil)
+        section_solutions_set = Kitchen::Clipboard.new
+        chapter.search(".#{klass}").each do |section|
+          section.search('[data-type="solution"]').each do |solution|
+            solution.cut(to: section_solutions_set)
+          end
+        end
+
+        return if section_solutions_set.items.empty?
+
+        title = <<~HTML
+          <h3 data-type="title">
+            <span class="os-title-label">#{I18n.t(:"eoc.#{klass}", number: number)}</span>
+          </h3>
+        HTML
+
+        append_solution_area(title: title, solutions: section_solutions_set, append_to: append_to)
+      end
+
+      def try_note_solutions(chapter:, append_to:)
+        append_to.add_child(
+          <<~HTML
+            <div class="os-module-reset-solution-area os-try-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{I18n.t(:"notes.try")}</span>
+              </h3>
+            </div>
+          HTML
+        )
+        chapter.non_introduction_pages.each do |page|
+          solutions = Kitchen::Clipboard.new
+          page.notes('$.try').each do |note|
+            note.exercises.each do |exercise|
+              solution = exercise.solution
+              solution&.cut(to: solutions) #if solution
+            end
+          end
+          next if solutions.items.empty?
+
+          title_snippet = Kitchen::Directions::EocSectionTitleLinkSnippet.v2(page: page)
+
+          append_solution_area(title: title_snippet, solutions: solutions,
+                               append_to: append_to.search('.os-try-solution-area').first)
+        end
+      end
+
+      def append_solution_area(title:, solutions:, append_to:)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              #{title}
+            </div>
+          HTML
+        ).first
+
+        append_to.add_child(solutions.paste)
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
       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,7 +31,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
 
       def bake_from_notes(chapter:, append_to:, klass:)
         solutions = []
-        chapter.notes(".#{klass}").each do |note|
+        chapter.notes("$.#{klass}").each do |note|
           note.exercises.each do |exercise|
             solution = exercise.solution
             solutions.push(solution.cut) if solution

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

@@ -2,22 +2,26 @@
 
 module Kitchen::Directions::MoveSolutionsToAnswerKey
   class V1
-    def bake(chapter:, metadata_source:, strategy:, append_to:)
+    def bake(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
       strategy =
         case strategy
         when :calculus
-          Strategies::Calculus
+          Strategies::Calculus.new
         when :uphysics
-          Strategies::UPhysics
-        when :american_government
-          Strategies::AmericanGovernment
+          Strategies::UPhysics.new
+        when :precalculus
+          Strategies::Precalculus.new
+        when :default
+          Strategies::Default.new(strategy_options)
         else
           raise 'No such strategy'
         end
 
+      solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
       append_to.append(child:
         <<~HTML
-          <div class="os-eob os-solutions-container" data-type="composite-page" data-uuid-key=".solutions#{chapter.count_in(:book)}">
+          <div class="os-eob os-#{solutions_or_solution}-container" data-type="composite-page" \
+          data-uuid-key=".#{solutions_or_solution}#{chapter.count_in(:book)}">
             <h2 data-type="document-title">
               <span class="os-text">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</span>
             </h2>
@@ -28,7 +32,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
           </div>
         HTML
       )
-      strategy.new.bake(chapter: chapter, append_to: append_to.last_element)
+      strategy.bake(chapter: chapter, append_to: append_to.last_element)
     end
   end
 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,19 +49,10 @@ module Kitchen
       @nokogiri_document = nokogiri_document
       @location = nil
       @config = config || Config.new
-      @next_paste_count_for_id = {}
-      @id_copy_suffix = '_copy_'
-
-      # Nokogiri by default only recognizes the namespaces on the root node.  Collect all
-      # namespaces and add them manually.
-      return unless @config.enable_all_namespaces && raw.present?
-
-      raw.collect_namespaces.each do |namespace, url|
-        prefix, name = namespace.split(':')
-        next unless prefix == 'xmlns' && name.present?
+      @id_tracker = IdTracker.new
 
-        raw.root.add_namespace_definition(name, url)
-      end
+      # 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
@@ -156,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]
@@ -196,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_base.rb

@@ -101,6 +101,8 @@ module Kitchen
     #   @return [Clipboard]
     def_delegators :document, :pantry, :clipboard
 
+    def_delegators :document, :id_tracker
+
     # Creates a new instance
     #
     # @param node [Nokogiri::XML::Node] the wrapped element
@@ -132,6 +134,7 @@ 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
@@ -345,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(
@@ -354,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
@@ -375,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
@@ -429,6 +443,11 @@ 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
       get_clipboard(to).add(self) if to.present?
       self
@@ -449,7 +468,7 @@ 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
       get_clipboard(to).add(the_copy) if to.present?
       the_copy
@@ -460,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
@@ -487,6 +508,21 @@ module Kitchen
       Element.new(node: raw.parent, document: document, short_type: "parent(#{short_type})")
     end
 
+    # returns previous element
+    # skips double indentations that the nokigiri sometimes picks up
+    # nil if there's no previous sibling
+    #
+    def previous
+      prev = raw.previous
+      return prev if prev.nil?
+
+      Element.new(
+        node: prev,
+        document: document,
+        short_type: "previous(#{short_type})"
+      )
+    end
+
     # TODO: make it clear if all of these methods take Element, Node, or String
 
     # If child argument given, prepends it before the element's current children.
@@ -694,7 +730,7 @@ module Kitchen
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
                    :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
-                   :composite_pages
+                   :composite_pages, :composite_chapters
 
     # Returns this element as an enumerator (over only one element, itself)
     #