openstax_kitchen 2.0.0 → 4.1.0

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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')
+    end
+  end
+end

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('.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('[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/directions/move_title_text_into_span.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module MoveTitleTextIntoSpan
-
       def self.v1(title:)
         title.replace_children(with:
           <<~HTML
@@ -9,7 +10,6 @@ module Kitchen
           HTML
         )
       end
-
     end
   end
 end

data/lib/kitchen/document.rb

@@ -1,25 +1,67 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Kitchen
+  # Wrapper around a Nokogiri `Document`, adding search with Kitchen enumerators,
+  # clipboards, pantries, etc.
+  #
   class Document
     extend Forwardable
 
+    # @return [Element] the current element yielded from search results
     attr_accessor :location
+    # @return [Config] the configuration used in this document
     attr_reader :config
 
+    # @!method selectors
+    #   The document's selectors
+    #   @see Config#selectors
+    #   @return [Selectors::Base]
     def_delegators :config, :selectors
+
+    # @!method to_xhtml
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#to_xhtml-instance_method Nokogiri::XML::Node#to_xhtml
+    #   @return [String] the document as an XHTML string
+    # @!method to_s
+    #   Turn this node in to a string. If the document is HTML, this method returns html.
+    #   If the document is XML, this method returns XML.
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#to_s-instance_method Nokogiri::XML::Node#to_s
+    #   @return [String]
+    # @!method to_xml
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#to_xml-instance_method Nokogiri::XML::Node#to_xml
+    #   @return [String] the document as an XML string
+    # @!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
 
+    # Return a new instance of Document
+    #
+    # @param nokogiri_document [Nokogiri::XML::Document]
+    # @param config [Config]
     def initialize(nokogiri_document:, config: nil)
       @nokogiri_document = nokogiri_document
       @location = nil
-      @config = config || Config.new_default
+      @config = config || Config.new
       @next_paste_count_for_id = {}
-      @id_copy_suffix = "_copy_"
+      @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?
+
+        raw.root.add_namespace_definition(name, url)
+      end
     end
 
     # Returns an enumerator that iterates over all children of this document
-    # that match the provided selector or XPath arguments.
+    # that match the provided selector or XPath arguments.  Updates `location`
+    # during iteration.
     #
     # @param selector_or_xpath_args [Array<String>] CSS selectors or XPath arguments
     # @return [ElementEnumerator]
@@ -29,9 +71,11 @@ module Kitchen
 
       ElementEnumerator.new do |block|
         nokogiri_document.search(*selector_or_xpath_args).each do |inner_node|
-          element = Kitchen::Element.new(node: inner_node,
-                                         document: self,
-                                         short_type: Utils.search_path_to_type(selector_or_xpath_args))
+          element = Kitchen::Element.new(
+            node: inner_node,
+            document: self,
+            short_type: Utils.search_path_to_type(selector_or_xpath_args)
+          )
           self.location = element
           block.yield(element)
         end
@@ -92,28 +136,52 @@ module Kitchen
       )
     end
 
+    # Create a new Element from a string
+    #
+    # @param string [String] the element as a string
+    #
+    # @example
+    #   create_element_from_string("<div class='foo'>bar</div>") #=> <div class="foo">bar</div>
+    #
+    # @return [Element]
+    #
     def create_element_from_string(string)
-      Kitchen::Element.new(
-        node: @nokogiri_document.create_element("div"),
-        document: self,
-        short_type: "created_element_#{SecureRandom.hex(4)}"
-      ).element_children.first
+      children = Nokogiri::XML("<foo>#{string}</foo>").search('foo').first.element_children
+      raise('new_element must only make one top-level element') if children.many?
+
+      node = children.first
+
+      create_element(node.name, node.attributes).tap do |element|
+        element.inner_html = node.children
+      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?
+      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 == 0
+      if count.zero?
         original_id
       else
         "#{original_id}#{@id_copy_suffix}#{count}"
@@ -123,6 +191,7 @@ module Kitchen
     # Returns the underlying Nokogiri Document object
     #
     # @return [Nokogiri::XML::Document]
+    #
     def raw
       @nokogiri_document
     end
@@ -131,6 +200,7 @@ module Kitchen
 
     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
       end