openstax_kitchen 3.2.0 → 4.0.0

data/lib/kitchen/page_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: PageElementEnumerator,
-            short_type: :page)
+            enumerator_class: PageElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :page
     end
 
     # Returns the title element.  This method is aware that the title of the
@@ -28,6 +34,14 @@ module Kitchen
       first!(is_introduction? ? selectors.title_in_introduction_page : selectors.title_in_page)
     end
 
+    # Returns the title's text regardless of whether the title has been baked
+    #
+    # @return [String]
+    #
+    def title_text
+      title.children.one? ? title.text : title.first('.os-text').text
+    end
+
     # Returns an enumerator for titles.
     #
     # @return [ElementEnumerator]
@@ -95,13 +109,12 @@ module Kitchen
       search('section.key-concepts')
     end
 
-    # Returns true if this class represents the element for the given node
+    # Returns the free response questions
     #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
+    # @return [Element]
     #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'page'
+    def free_response
+      search('section.free-response')
     end
 
   end

data/lib/kitchen/page_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "div[data-type='page']", # TODO: get from config?
+        default_css_or_xpath: Selector.named(:page),
         sub_element_class: PageElement,
         enumerator_class: self
       )

data/lib/kitchen/reference_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class ReferenceElement < ElementBase
+
+    # Creates a new +ReferenceElement+
+    #
+    # @param node [Nokogiri::XML::Node] the node this element wraps
+    # @param document [Document] this element's document
+    #
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: ReferenceElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :reference
+    end
+
+  end
+end

data/lib/kitchen/references_element_enumerator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for table elements
+  #
+  class ReferenceElementEnumerator < ElementEnumeratorBase
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:reference),
+        sub_element_class: ReferenceElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/search_query.rb

@@ -24,6 +24,7 @@ module Kitchen
       @css_or_xpath = css_or_xpath
       @only = only.is_a?(String) ? only.to_sym : only
       @except = except.is_a?(String) ? except.to_sym : except
+      @default_already_applied = false
     end
 
     # Returns true iff the element passes the `only` and `except` conditions
@@ -35,13 +36,34 @@ module Kitchen
     end
 
     # Replaces '$' in the `css_or_xpath` with the provided value; also normalizes
-    # `css_or_xpath` to an array
+    # `css_or_xpath` to an array.
     #
-    def apply_default_css_or_xpath_and_normalize(default_css_or_xpath=nil)
+    # @param default_css_or_xpath [String, Proc, Symbol] The selectors to substitute for the "$" character
+    #   when this factory is used to build an enumerator.  A string argument is used literally.  A proc
+    #   is eventually called given the document's Config object (for accessing selectors).  A symbol
+    #   is interpreted as the name of a selector and is called on the document's Config object's
+    #   selectors object.
+    #
+    def apply_default_css_or_xpath_and_normalize(default_css_or_xpath=nil, config: nil)
+      return if @default_already_applied
+
+      default_css_or_xpath = [default_css_or_xpath].flatten.map do |item|
+        case item
+        when Proc
+          item.call(config)
+        when Symbol
+          config.selectors.send(item)
+        else
+          item
+        end
+      end
+
       @as_type = nil
       @css_or_xpath = [css_or_xpath || '$'].flatten.map do |item|
-        item.gsub(/\$/, [default_css_or_xpath].flatten.join(', '))
+        item.gsub(/\$/, default_css_or_xpath.join(', '))
       end
+
+      @default_already_applied = true
     end
 
     # Returns the search query as a spaceless string suitable for use as an element type

data/lib/kitchen/selector.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # A wrapper for a selector.  Can be used as the default_css_or_xpath.
+  #
+  class Selector < Proc
+    attr_reader :name
+
+    def self.named(name)
+      new(name) { |config| config.selectors.send(name) }
+    end
+
+    def initialize(name, &block)
+      @name = name
+      super(&block)
+    end
+
+    def matches?(node, config:)
+      # This may not be incredibly efficient as it does a search of this node's
+      # ancestors to see if the node is in the results.  Watch the performance.
+      node.matches?(call(config))
+    end
+  end
+end

data/lib/kitchen/selectors/base.rb

@@ -17,6 +17,45 @@ module Kitchen
       # Selector for the summary in a page
       # @return [String]
       attr_accessor :page_summary
+      # Selector for a reference
+      # @return [String]
+      attr_accessor :reference
+      # Selector for a chapter
+      # @return [String]
+      attr_accessor :chapter
+      # Selector for a page
+      # @return [String]
+      attr_accessor :page
+      # Selector for a note
+      # @return [String]
+      attr_accessor :note
+      # Selector for a term
+      # @return [String]
+      attr_accessor :term
+      # Selector for a table
+      # @return [String]
+      attr_accessor :table
+      # Selector for a figure
+      # @return [String]
+      attr_accessor :figure
+      # Selector for a metadata
+      # @return [String]
+      attr_accessor :metadata
+      # Selector for a composite page
+      # @return [String]
+      attr_accessor :composite_page
+      # Selector for a composite chapter
+      # @return [String]
+      attr_accessor :composite_chapter
+      # Selector for an example
+      # @return [String]
+      attr_accessor :example
+      # Selector for an exercise
+      # @return [String]
+      attr_accessor :exercise
+      # Selector for an unit
+      # @return [String]
+      attr_accessor :unit
 
       # Override specific selectors
       #

data/lib/kitchen/selectors/standard_1.rb

@@ -13,6 +13,19 @@ module Kitchen
         self.title_in_page              = "./*[@data-type = 'document-title']"
         self.title_in_introduction_page = "./*[@data-type = 'document-title']"
         self.page_summary               = 'section.summary'
+        self.reference                  = '.reference'
+        self.chapter                    = "div[data-type='chapter']"
+        self.page                       = "div[data-type='page']"
+        self.note                       = "div[data-type='note']"
+        self.term                       = "span[data-type='term']"
+        self.table                      = 'table'
+        self.figure                     = 'figure'
+        self.metadata                   = "div[data-type='metadata']"
+        self.composite_page             = "div[data-type='composite-page']"
+        self.composite_chapter          = "div[data-type='composite-chapter']"
+        self.example                    = "div[data-type='example']"
+        self.exercise                   = "div[data-type='exercise']"
+        self.unit                       = "div[data-type='unit']"
       end
 
     end

data/lib/kitchen/table_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: TableElementEnumerator,
-            short_type: :table)
+            enumerator_class: TableElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :table
     end
 
     # Returns an element for the title row, if present
@@ -74,14 +80,5 @@ module Kitchen
       first('caption')
     end
 
-    # Returns true if this class represents the element for the given node
-    #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
-    #
-    def self.is_the_element_class_for?(node)
-      node.name == 'table'
-    end
-
   end
 end

data/lib/kitchen/table_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: 'table', # TODO: get from config?
+        default_css_or_xpath: Selector.named(:table),
         sub_element_class: TableElement,
         enumerator_class: self
       )

data/lib/kitchen/templates/eob_section_title_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eob os-<%=@klass%>-container" data-type="composite-page" data-uuid-key="<%=@uuid_prefix%><%=@klass%>">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= @title %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/templates/eoc_section_title_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eoc os-<%=@klass%>-container" data-type="composite-page" data-uuid-key="<%=@uuid_prefix%><%=@klass%>">
+  <<%= @in_composite_chapter ? 'h3' : 'h2' %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
+    <span class="os-text"><%= @title %></span>
+  </<%= @in_composite_chapter ? 'h3' : 'h2' %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @in_composite_chapter ? I18n.t(:eoc_composite_metadata_title) : @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/term_element.rb

@@ -13,17 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: TermElementEnumerator,
-            short_type: :term)
+            enumerator_class: TermElementEnumerator)
     end
 
-    # Returns true if this class represents the element for the given node
+    # Returns the short type
+    # @return [Symbol]
     #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
-    #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'term'
+    def self.short_type
+      :term
     end
 
   end

data/lib/kitchen/term_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "span[data-type='term']", # TODO: get from config?
+        default_css_or_xpath: Selector.named(:term),
         sub_element_class: TermElement,
         enumerator_class: self
       )

data/lib/kitchen/unit_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: UnitElementEnumerator,
-            short_type: :unit)
+            enumerator_class: UnitElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :unit
     end
 
     # Get the title in the immediate children, not the one in the metadata.  Could use
@@ -27,13 +33,13 @@ module Kitchen
       first!("./*[@data-type = 'document-title']")
     end
 
-    # Returns true if this class represents the element for the given node
+    # Returns the title's text regardless of whether the title has been baked
     #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
+    # @return [String]
     #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'unit'
+    def title_text
+      title.children.one? ? title.text : title.first('.os-text').text
     end
+
   end
 end

data/lib/kitchen/unit_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "div[data-type='unit']",
+        default_css_or_xpath: Selector.named(:unit),
         sub_element_class: UnitElement,
         enumerator_class: self
       )

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '3.2.0'
+  VERSION = '4.0.0'
 end

data/lib/locales/en.yml

@@ -15,14 +15,17 @@ en:
   chapter_review: Chapter Review
   learning_objectives: Learning Objectives
   stepwise_step_label: Step
+  references: References
   eoc_chapter_review: Chapter Review
   eoc_key_terms_title: Key Terms
   eoc_summary_title: Summary
   eoc_exercises_title: Exercises
+  eoc_composite_metadata_title: Chapter Review
   eoc_answer_key_title: Answer Key
   eoc_key_concepts: Key Concepts
   eoc_key_equations: Key Equations
   eoc_suggested_reading: Suggestions for Further Study
+  eoc_further_research_title: Further Research
   eob_index_title: Index
   eob_index_symbols_group: Symbols
   review_exercises: Review Exercises

data/lib/openstax_kitchen.rb

@@ -40,6 +40,7 @@ require 'kitchen/oven'
 require 'kitchen/clipboard'
 require 'kitchen/pantry'
 require 'kitchen/counter'
+require 'kitchen/selector'
 
 require 'kitchen/element_enumerator_base'
 require 'kitchen/element_enumerator_factory'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -227,26 +227,12 @@ files:
 - lib/kitchen/debug/print_recipe_error.rb
 - lib/kitchen/directions/.rubocop.yml
 - lib/kitchen/directions/bake_appendix.rb
-- lib/kitchen/directions/bake_book_answer_key/eob_solutions_container.xhtml.erb
-- lib/kitchen/directions/bake_book_answer_key/main.rb
-- lib/kitchen/directions/bake_book_answer_key/v1.rb
-- lib/kitchen/directions/bake_chapter_answer_key/main.rb
-- lib/kitchen/directions/bake_chapter_answer_key/strategies/calculus.rb
-- lib/kitchen/directions/bake_chapter_answer_key/strategies/uphysics.rb
-- lib/kitchen/directions/bake_chapter_answer_key/v1.rb
-- lib/kitchen/directions/bake_chapter_glossary.rb
+- lib/kitchen/directions/bake_chapter_glossary/main.rb
+- lib/kitchen/directions/bake_chapter_glossary/v1.rb
 - lib/kitchen/directions/bake_chapter_introductions.rb
-- lib/kitchen/directions/bake_chapter_key_concepts/key_concepts.xhtml.erb
 - lib/kitchen/directions/bake_chapter_key_concepts/main.rb
 - lib/kitchen/directions/bake_chapter_key_concepts/v1.rb
 - lib/kitchen/directions/bake_chapter_key_equations.rb
-- lib/kitchen/directions/bake_chapter_review/chapter_review.xhtml.erb
-- lib/kitchen/directions/bake_chapter_review/main.rb
-- lib/kitchen/directions/bake_chapter_review/v1.rb
-- lib/kitchen/directions/bake_chapter_review_exercises/main.rb
-- lib/kitchen/directions/bake_chapter_review_exercises/review_exercises.xhtml.erb
-- lib/kitchen/directions/bake_chapter_review_exercises/v1.rb
-- lib/kitchen/directions/bake_chapter_review_exercises/v2.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/main.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/v1.rb
 - lib/kitchen/directions/bake_chapter_summary.rb
@@ -257,11 +243,14 @@ files:
 - lib/kitchen/directions/bake_composite_pages.rb
 - lib/kitchen/directions/bake_equations.rb
 - lib/kitchen/directions/bake_example.rb
-- lib/kitchen/directions/bake_exercises/main.rb
-- lib/kitchen/directions/bake_exercises/v1.rb
 - lib/kitchen/directions/bake_figure.rb
+- lib/kitchen/directions/bake_first_elements.rb
 - lib/kitchen/directions/bake_footnotes/main.rb
 - lib/kitchen/directions/bake_footnotes/v1.rb
+- lib/kitchen/directions/bake_free_response/free_response.xhtml.erb
+- lib/kitchen/directions/bake_free_response/main.rb
+- lib/kitchen/directions/bake_free_response/v1.rb
+- lib/kitchen/directions/bake_further_research.rb
 - lib/kitchen/directions/bake_index/main.rb
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
@@ -270,7 +259,6 @@ files:
 - lib/kitchen/directions/bake_non_introduction_pages.rb
 - lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
 - lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
-- lib/kitchen/directions/bake_notes/bake_notes.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes.rb
 - lib/kitchen/directions/bake_notes/bake_unclassified_notes.rb
 - lib/kitchen/directions/bake_numbered_exercise/main.rb
@@ -280,7 +268,8 @@ files:
 - lib/kitchen/directions/bake_page_abstracts.rb
 - lib/kitchen/directions/bake_preface/main.rb
 - lib/kitchen/directions/bake_preface/v1.rb
-- lib/kitchen/directions/bake_problem_first_elements.rb
+- lib/kitchen/directions/bake_references/main.rb
+- lib/kitchen/directions/bake_references/v1.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_theorem/main.rb
@@ -289,7 +278,21 @@ files:
 - lib/kitchen/directions/bake_unit_title/main.rb
 - lib/kitchen/directions/bake_unit_title/v1.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
+- lib/kitchen/directions/book_answer_key_container/eob_solutions_container.xhtml.erb
+- lib/kitchen/directions/book_answer_key_container/main.rb
+- lib/kitchen/directions/book_answer_key_container/v1.rb
+- lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb
+- lib/kitchen/directions/chapter_review_container/main.rb
+- lib/kitchen/directions/chapter_review_container/v1.rb
 - lib/kitchen/directions/eoc_section_title_link_snippet.rb
+- lib/kitchen/directions/move_exercises_to_eoc/main.rb
+- lib/kitchen/directions/move_exercises_to_eoc/v1.rb
+- lib/kitchen/directions/move_exercises_to_eoc/v2.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/main.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/american_government.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/uphysics.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/v1.rb
 - lib/kitchen/directions/move_title_text_into_span.rb
 - lib/kitchen/document.rb
 - lib/kitchen/element.rb
@@ -318,12 +321,17 @@ files:
 - lib/kitchen/patches/renderable.rb
 - lib/kitchen/patches/string.rb
 - lib/kitchen/recipe.rb
+- lib/kitchen/reference_element.rb
+- lib/kitchen/references_element_enumerator.rb
 - lib/kitchen/search_history.rb
 - lib/kitchen/search_query.rb
+- lib/kitchen/selector.rb
 - lib/kitchen/selectors/base.rb
 - lib/kitchen/selectors/standard_1.rb
 - lib/kitchen/table_element.rb
 - lib/kitchen/table_element_enumerator.rb
+- lib/kitchen/templates/eob_section_title_template.xhtml.erb
+- lib/kitchen/templates/eoc_section_title_template.xhtml.erb
 - lib/kitchen/term_element.rb
 - lib/kitchen/term_element_enumerator.rb
 - lib/kitchen/transliterations.rb