openstax_kitchen 4.0.0 → 6.1.0

data/lib/kitchen/element_enumerator_base.rb

@@ -84,7 +84,30 @@ module Kitchen
     #
     def composite_pages(css_or_xpath=nil, only: nil, except: nil)
       block_error_if(block_given?)
-      chain_to(CompositePageElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
+      chain_to(CompositePageElementEnumerator,
+               css_or_xpath: css_or_xpath,
+               only: only,
+               except: except)
+    end
+
+    # Returns an enumerator that iterates through composite chapters within the scope of this enumerator
+    #
+    # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
+    #   a "$" in this argument will be replaced with the default selector for the element being
+    #   iterated over.
+    # @param only [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will only be included in the
+    #   search results if the method or callable returns true
+    # @param except [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will not be included in the
+    #   search results if the method or callable returns false
+    #
+    def composite_chapters(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(CompositeChapterElementEnumerator,
+               css_or_xpath: css_or_xpath,
+               only: only,
+               except: except)
     end
 
     # Returns an enumerator that iterates through pages that arent the introduction page within the scope of this enumerator

data/lib/kitchen/element_enumerator_factory.rb

@@ -39,12 +39,22 @@ module Kitchen
     # @return [ElementEnumeratorBase] actually returns the concrete enumerator class
     #   given to the factory in its constructor.
     #
-    def build_within(enumerator_or_element, search_query: SearchQuery.new)
+    def build_within(enumerator_or_element, search_query: SearchQuery.new, reload: false)
       case enumerator_or_element
       when ElementBase
-        build_within_element(enumerator_or_element, search_query: search_query)
+        build_within_element(enumerator_or_element,
+                             search_query: search_query,
+                             reload: reload)
       when ElementEnumeratorBase
-        build_within_other_enumerator(enumerator_or_element, search_query: search_query)
+        if enumerator_class != ElementEnumerator && !search_query.expects_substitution?
+          raise "Query #{search_query} is missing the substitution character ('$') but " \
+                "is run with an enumerator #{enumerator_class.name} that has its own " \
+                "selectors for substitution."
+        end
+
+        build_within_other_enumerator(enumerator_or_element,
+                                      search_query: search_query,
+                                      reload: reload)
       end
     end
 
@@ -64,7 +74,7 @@ module Kitchen
 
     protected
 
-    def build_within_element(element, search_query:)
+    def build_within_element(element, search_query:, reload:)
       search_query.apply_default_css_or_xpath_and_normalize(default_css_or_xpath,
                                                             config: element.config)
 
@@ -77,7 +87,7 @@ module Kitchen
         # below, the counts are correct.
         element.uncount(search_query)
 
-        element.raw.search(*search_query.css_or_xpath).each do |sub_node|
+        element.raw_search(*search_query.css_or_xpath, reload: reload).each do |sub_node|
           sub_element = ElementFactory.build_from_node(
             node: sub_node,
             document: element.document,
@@ -105,13 +115,15 @@ module Kitchen
       end
     end
 
-    def build_within_other_enumerator(other_enumerator, search_query:)
+    def build_within_other_enumerator(other_enumerator, search_query:, reload:)
       # Return a new enumerator instance that internally iterates over `other_enumerator`
       # running a new enumerator for each element returned by that other enumerator.
       enumerator_class.new(search_query: search_query,
                            upstream_enumerator: other_enumerator) do |block|
         other_enumerator.each do |element|
-          build_within_element(element, search_query: search_query).each do |sub_element|
+          build_within_element(element,
+                               search_query: search_query,
+                               reload: reload).each do |sub_element|
             block.yield(sub_element)
           end
         end

data/lib/kitchen/exercise_element.rb

@@ -28,7 +28,7 @@ module Kitchen
     # @return ElementEnumerator
     #
     def problem
-      first("[data-type='problem']")
+      first("div[data-type='problem']")
     end
 
     # Returns the enumerator for solution.
@@ -36,7 +36,7 @@ module Kitchen
     # @return ElementEnumerator
     #
     def solution
-      first("[data-type='solution']")
+      first("div[data-type='solution']")
     end
   end
 end

data/lib/kitchen/id_tracker.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # A class to track and modify duplicate IDs in a document
+  #
+  class IdTracker
+
+    def initialize
+      @id_data = Hash.new { |hash, key| hash[key] = { count: 0, last_pasted: false } }
+      @id_copy_suffix = '_copy_'
+    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?
+
+      @id_data[id][:count] += 1
+      @id_data[id][:last_pasted] = false
+    end
+
+    # Keeps track that an element with the given ID has been cut.
+    #
+    # @param id [String]
+    #
+    def record_id_cut(id)
+      return if id.blank?
+
+      @id_data[id][:count] -= 1 if @id_data[id][:count].positive?
+      @id_data[id][:last_pasted] = false
+    end
+
+    # Keeps track that an element with the given ID has been pasted.
+    #
+    # @param id [String]
+    #
+    def record_id_pasted(id)
+      return if id.blank?
+
+      @id_data[id][:count] += 1 if @id_data[id][:last_pasted]
+      @id_data[id][:last_pasted] = true
+    end
+
+    # Returns a unique ID given the ID of an element that was copied and is about
+    # to be pasted
+    #
+    # @param original_id [String]
+    # @return [String]
+    #
+    def modified_id_to_paste(original_id)
+      return nil if original_id.nil?
+      return '' if original_id.blank?
+
+      count = @id_data[original_id][:count]
+      # 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
+  end
+end

data/lib/kitchen/oven.rb

@@ -28,6 +28,8 @@ module Kitchen
         config: config
       )
 
+      I18n.locale = doc.locale
+
       [recipes].flatten.each do |recipe|
         recipe.document = doc
         recipe.bake
@@ -35,10 +37,12 @@ module Kitchen
       profile.baked!
 
       File.open(output_file, 'w') do |f|
-        f.write doc.to_xhtml(indent: 2)
+        f.write doc.to_xhtml(indent: 2, encoding: doc.encoding || 'utf-8')
       end
       profile.written!
 
+      Nokogiri::XML.print_profile_data if ENV['PROFILE'] && !ENV['TESTING']
+
       profile
     end
 

data/lib/kitchen/page_element.rb

@@ -29,9 +29,12 @@ module Kitchen
     # @raise [ElementNotFoundError] if no matching element is found
     # @return [Element]
     #
-    def title
+    def title(reload: false)
       # The selector for intro titles changes during the baking process
-      first!(is_introduction? ? selectors.title_in_introduction_page : selectors.title_in_page)
+      @title ||= begin
+        selector = is_introduction? ? selectors.title_in_introduction_page : selectors.title_in_page
+        first!(selector, reload: reload)
+      end
     end
 
     # Returns the title's text regardless of whether the title has been baked
@@ -85,11 +88,10 @@ module Kitchen
 
     # Returns the summary element.
     #
-    # @raise [ElementNotFoundError] if no matching element is found
-    # @return [Element]
+    # @return [Element, nil] the summary or nil if no summary found
     #
     def summary
-      first!(selectors.page_summary)
+      first(selectors.page_summary)
     end
 
     # Returns the exercises element.

data/lib/kitchen/patches/i18n.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'twitter_cldr'
+
+# rubocop:disable Style/Documentation
+module I18n
+  def self.sort_strings(first, second)
+    string_sorter.compare(first, second)
+  end
+
+  def self.string_sorter
+    @string_sorter ||= begin
+      # TwitterCldr does not know about our :test locale, so substitute the English one
+      locale = I18n.locale == :test ? :en : I18n.locale
+      TwitterCldr::Collation::Collator.new(locale)
+    end
+  end
+
+  def self.clear_string_sorter
+    @string_sorter = nil
+  end
+
+  class <<self
+    alias_method :original_locale=, :locale=
+  end
+
+  def self.locale=(locale)
+    # We wrap the setting of locale so that we can clear the string sorter (so that it
+    # gets reset to the new locale the next time it is used)
+    clear_string_sorter
+    self.original_locale = locale
+  end
+end
+# rubocop:enable Style/Documentation

data/lib/kitchen/patches/integer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Monkey patches for +Integer+
+#
+class Integer
+  ROMAN_NUMERALS = %w[0 i ii iii iv v vi vii viii ix x xi xii xiii xiv xv xvi xvii xviii xix xx].freeze
+
+  # Formats as different types of integers, including roman numerals.
+  #
+  # @return [String]
+  #
+  def to_format(format)
+    case format
+    when :arabic
+      to_s
+    when :roman
+      raise 'Unknown conversion to Roman numerals' if self >= ROMAN_NUMERALS.size
+
+      ROMAN_NUMERALS[self]
+    else
+      raise 'Unknown integer format'
+    end
+  end
+end

data/lib/kitchen/patches/nokogiri.rb

@@ -31,6 +31,21 @@ module Nokogiri
           end
         end
       end
+
+      def add_all_namespaces!
+        # Nokogiri by default only recognizes the namespaces on the root node.  Collect all
+        # namespaces and add them manually.
+        return if @all_namespaces_added
+
+        collect_namespaces.each do |namespace, url|
+          prefix, name = namespace.split(':')
+          next unless prefix == 'xmlns' && name.present?
+
+          root.add_namespace_definition(name, url)
+        end
+
+        @all_namespaces_added = true
+      end
     end
 
     # Monkey patches for Nokogiri::XML::Node
@@ -43,6 +58,53 @@ module Nokogiri
       def inspect
         to_s
       end
+
+      def quick_matches?(selector)
+        self.class.selector_to_css_nodes(selector).any? { |css_node| matches_css_node?(css_node) }
+      end
+
+      def classes
+        self[:class]&.split || []
+      end
+
+      def previous
+        prev = previous_element
+        return nil if prev.nil?
+
+        prev.text? ? prev.previous : prev
+      end
+
+      def self.selector_to_css_nodes(selector)
+        # No need to parse the same selector more than once.
+        @parsed_selectors ||= {}
+        @parsed_selectors[selector] ||= Nokogiri::CSS::Parser.new.parse(selector)
+      end
+
+      protected
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def matches_css_node?(css_node)
+        case css_node.type
+        when :CONDITIONAL_SELECTOR
+          css_node.value.all? { |inner_css_node| matches_css_node?(inner_css_node) }
+        when :ELEMENT_NAME
+          css_node.value == ['*'] || css_node.value.include?(name)
+        when :CLASS_CONDITION
+          (css_node.value & classes).any?
+        when :ATTRIBUTE_CONDITION
+          attribute, operator, value = css_node.value
+
+          raise "Unknown attribute condition operator in #{css_node}" if operator != :equal
+
+          attribute_name = attribute.value
+          raise "More attribute names than expected, #{attribute_name}" if attribute_name.many?
+
+          self[attribute_name.first] == value.gsub('"', '').gsub("'", '')
+        else
+          raise "Unknown Nokogiri::CSS:Node type in #{css_node}"
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/kitchen/patches/nokogiri_profiling.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/Documentation
+
+# Make debug output more useful (dumping entire document out is not useful)
+module Nokogiri
+  module XML
+    # rubocop:disable Style/MutableConstant
+    PROFILE_DATA = {}
+    # rubocop:enable Style/MutableConstant
+
+    if ENV['PROFILE']
+      ENV['VERBOSE_PROFILE'] = 1 if ENV['PROFILE'].to_s.downcase == 'verbose'
+
+      # Patches inside Nokogiri to count, time, and print searches.  At end of baking
+      # you can `puts Nokogiri::XML::PROFILE_DATA` to see the totals.  The counts
+      # hash is defined outside of the if block so that code that prints it doesn't
+      # explode if run without the env var.  The `print_profile_data` method is also
+      # provided for a nice printout
+
+      def self.print_profile_data
+        total_duration = 0
+
+        sorted_profile_data = PROFILE_DATA.sort_by { |_, data| data[:time] / data[:count] }.reverse
+
+        puts "\nSearch Profile Data"
+        puts '-----------------------------------------------------------------'
+        puts "#{'Total Time (ms)'.ljust(17)}#{'Avg Time (ms)'.ljust(15)}#{'Count'.ljust(7)}Query"
+        puts '-----------------------------------------------------------------'
+
+        sorted_profile_data.each do |search_path, data|
+          total_time = format('%0.4f', (data[:time] * 1000))
+          avg_time = format('%0.4f', ((data[:time] / data[:count]) * 1000))
+          puts total_time.ljust(17) + avg_time.to_s.ljust(15) + data[:count].to_s.ljust(7) + \
+               search_path
+          total_duration += data[:time] * 1000
+        end
+
+        puts "\nTotal time across all searches (ms): #{total_duration}"
+      end
+
+      class XPathContext
+        alias_method :original_evaluate, :evaluate
+        def evaluate(search_path, handler=nil)
+          puts search_path if ENV['VERBOSE_PROFILE']
+
+          PROFILE_DATA[search_path] ||= Hash.new(0)
+          PROFILE_DATA[search_path][:count] += 1
+
+          start_time = Time.now
+          original_evaluate(search_path, handler).tap do
+            PROFILE_DATA[search_path][:time] += Time.now - start_time
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Style/Documentation

data/lib/kitchen/search_query.rb

@@ -82,6 +82,12 @@ module Kitchen
       as_type
     end
 
+    # Returns true if the query has the substitution character ('$')
+    #
+    def expects_substitution?
+      css_or_xpath.nil? || [css_or_xpath].flatten.all? { |item| item.include?('$') }
+    end
+
     protected
 
     def condition_passes?(method_or_callable, element, success_outcome)