openstax_kitchen 4.1.1 → 8.0.0

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:)
+        @selectors.each do |selector|
+          chapter.search("#{selector} div[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)
+        @selectors = strategy_options[:selectors] || (raise 'missing selectors 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/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,8 +49,7 @@ 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
@@ -148,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]
@@ -188,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
@@ -441,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
@@ -461,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
@@ -472,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
@@ -499,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.
@@ -578,9 +602,9 @@ module Kitchen
         attributes.each do |k, v|
           new_node[k.to_s.gsub(/([^_])_([^_])/, '\1-\2').gsub('__', '_')] = v
         end
-        new_node.children = children.to_s
+        new_node.children = children
         yield Element.new(node: new_node, document: document, short_type: nil) if block_given?
-      end.to_s
+      end
 
       self
     end

data/lib/kitchen/i18n_string.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # Compare one string with another
+  #
+  # Returns 0 if first string equals second,
+  # 1 if first string is greater than the second
+  # and -1 if first string is less than the second.
+  #
+  class I18nString < String
+
+    def <=>(other)
+      I18n.sort_strings(self, other)
+    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,7 +37,7 @@ 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!
 

data/lib/kitchen/page_element.rb

@@ -88,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.