openstax_kitchen 3.0.0 → 3.1.0

data/lib/kitchen/element_enumerator_base.rb

@@ -70,6 +70,37 @@ module Kitchen
       chain_to(PageElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through composite pages 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_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)
+    end
+
+    # Returns an enumerator that iterates through pages that arent the introduction page 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.
+    #
+    def non_introduction_pages(only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(PageElementEnumerator,
+               css_or_xpath: '$:not(.introduction)',
+               only: only,
+               except: except)
+    end
+
     # Returns an enumerator that iterates through chapters within the scope of this enumerator
     #
     # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
@@ -166,6 +197,44 @@ module Kitchen
       chain_to(ExampleElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through titles 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 titles(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(ElementEnumerator,
+               default_css_or_xpath: '[data-type="title"]',
+               css_or_xpath: css_or_xpath,
+               only: only,
+               except: except)
+    end
+
+    # Returns an enumerator that iterates through exercises 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 exercises(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(ExerciseElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
+    end
+
     # Returns an enumerator that iterates through metadata within the scope of this enumerator
     #
     # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
@@ -195,7 +264,12 @@ module Kitchen
     # Returns an enumerator that iterates through elements within the scope of this enumerator
     #
     # @param enumerator_class [ElementEnumeratorBase] the enumerator to use for the iteration
+    # @param default_css_or_xpath [String] the default CSS or xpath to use when iterating.  Normally,
+    #   this value is provided by the `enumerator_class`, but that isn't always the case, e.g.
+    #   when that class is a generic `ElementEnumerator`.
     # @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
@@ -203,16 +277,21 @@ module Kitchen
     #   lambda or proc that accepts an element; elements will not be included in the
     #   search results if the method or callable returns false
     #
-    def chain_to(enumerator_class, css_or_xpath: nil, only: nil, except: nil)
+    def chain_to(enumerator_class, default_css_or_xpath: nil, css_or_xpath: nil,
+                 only: nil, except: nil)
       block_error_if(block_given?)
-      enumerator_class.factory.build_within(
-        self,
-        search_query: SearchQuery.new(
-          css_or_xpath: css_or_xpath,
-          only: only,
-          except: except
-        )
+
+      search_query = SearchQuery.new(
+        css_or_xpath: css_or_xpath,
+        only: only,
+        except: except
       )
+
+      if default_css_or_xpath
+        search_query.apply_default_css_or_xpath_and_normalize(default_css_or_xpath)
+      end
+
+      enumerator_class.factory.build_within(self, search_query: search_query)
     end
 
     # Returns the first element in this enumerator

data/lib/kitchen/exercise_element.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class ExerciseElement < ElementBase
+
+    # Creates a new +ExerciseElement+
+    #
+    # @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: ExerciseElementEnumerator,
+            short_type: :exercise)
+    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['data-type'] == 'exercise'
+    end
+
+    # Returns the enumerator for problem.
+    #
+    # @return ElementEnumerator
+    #
+    def problem
+      first("[data-type='problem']")
+    end
+
+    # Returns the enumerator for solution.
+    #
+    # @return ElementEnumerator
+    #
+    def solution
+      first("[data-type='solution']")
+    end
+  end
+end

data/lib/kitchen/exercise_element_enumerator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for example elements
+  #
+  class ExerciseElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "div[data-type='exercise']", # TODO: element.document.selectors.exercise
+        sub_element_class: ExerciseElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/note_element.rb

@@ -5,13 +5,6 @@ module Kitchen
   #
   class NoteElement < ElementBase
 
-    TITLE_TRANSLATION_KEYS = %w[
-      link-to-learning
-      everyday-life
-      sciences-interconnect
-      chemist-portrait
-    ].freeze
-
     # Creates a new +NoteElement+
     #
     # @param node [Nokogiri::XML::Node] the node this element wraps
@@ -38,7 +31,7 @@ module Kitchen
     # @return [Boolean]
     #
     def indicates_autogenerated_title?
-      translation_key_in(TITLE_TRANSLATION_KEYS).present?
+      detected_note_title_key != 0 && detected_note_title_key.present?
     end
 
     # Get the autogenerated title for this note
@@ -46,9 +39,11 @@ module Kitchen
     # @return [String]
     #
     def autogenerated_title
-      translation_key = translation_key_in(TITLE_TRANSLATION_KEYS)
-      I18n.t(:"notes.#{document.short_name}.#{translation_key}",
-             default: :"notes.#{translation_key}")
+      if indicates_autogenerated_title?
+        I18n.t(:"notes.#{detected_note_title_key}")
+      else
+        "unknown title for note with classes #{classes}"
+      end
     end
 
     # Returns true if this class represents the element for the given node
@@ -62,12 +57,18 @@ module Kitchen
 
     protected
 
-    def translation_key_in(possible_translation_keys)
-      keys = possible_translation_keys & classes
-      raise("too many translation keys: #{keys.join(', ')}") if keys.many?
+    def detected_note_title_key
+      @detected_note_title_key ||= begin
+        return 0 if classes.empty? || !I18n.t('.').key?(:notes)
 
-      keys.first
-    end
+        possible_keys = I18n.t(:notes).keys.map(&:to_s)
+        keys = possible_keys & classes
 
+        raise("too many translation keys: #{keys.join(', ')}") if keys.many?
+        return 0 if keys.empty?
+
+        keys.first
+      end
+    end
   end
 end

data/lib/kitchen/page_element.rb

@@ -87,6 +87,14 @@ module Kitchen
       first!('section.exercises')
     end
 
+    # Returns the key concepts
+    #
+    # @return [Element]
+    #
+    def key_concepts
+      search('section.key-concepts')
+    end
+
     # Returns true if this class represents the element for the given node
     #
     # @param node [Nokogiri::XML::Node] the underlying node

data/lib/kitchen/recipe.rb

@@ -14,6 +14,10 @@ module Kitchen
     # @return [String]
     attr_reader :source_location
 
+    # An I18n backend specific to this recipe, may be nil
+    # @return [I18n::Backend::Simple, nil]
+    attr_reader :my_i18n_backend
+
     # Sets the document so the recipe can yield it for modification
     #
     # @param document [Document] the document to modify
@@ -31,20 +35,29 @@ module Kitchen
 
     # Make a new Recipe
     #
+    # @param locales_dir [String, nil] the absolute path to a folder containing recipe-specific
+    #   I18n translations.  If not provided, Kitchen will look for a `locales` directory in the
+    #   same directory as the recipe source.  Recipe-specific translations override those in
+    #   Kitchen.  If no recipe-specific locales directory exists, Kitchen will just use its default
+    #   translations.
     # @yield A block for defining the steps of the recipe
     # @yieldparam doc [Document] an object representing an XML document
     #
-    def initialize(&block)
+    def initialize(locales_dir: nil, &block)
       raise(RecipeError, 'Recipes must be initialized with a block') unless block_given?
 
       @source_location = block.source_location[0]
       @block = block
+
+      load_my_i18n_backend(locales_dir)
     end
 
     # Executes the block given to +Recipe.new+ on the document.  Aka, does the baking.
     #
     def bake
-      @block.to_proc.call(document)
+      with_my_locales do
+        @block.to_proc.call(document)
+      end
     rescue RecipeError, ElementNotFoundError, Nokogiri::CSS::SyntaxError => e
       print_recipe_error_and_exit(e)
     rescue ArgumentError, NoMethodError => e
@@ -67,6 +80,26 @@ module Kitchen
       error.backtrace.any? { |entry| entry.start_with?(@source_location) }
     end
 
+    def load_my_i18n_backend(locales_dir)
+      locales_dir ||= begin
+        guessed_locales_dir = "#{File.dirname(@source_location)}/locales"
+        File.directory?(guessed_locales_dir) ? guessed_locales_dir : nil
+      end
+
+      return unless locales_dir
+
+      @my_i18n_backend = I18n::Backend::Simple.new
+      @my_i18n_backend.load_translations(Dir[File.expand_path("#{locales_dir}/*.yml")])
+    end
+
+    def with_my_locales
+      original_i18n_backend = I18n.backend
+      I18n.backend = I18n::Backend::Chain.new(my_i18n_backend, original_i18n_backend)
+      yield
+    ensure
+      I18n.backend = original_i18n_backend
+    end
+
     # Print the given recipe error and do a process exit
     #
     # @param error [RecipeError] the error

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -2,26 +2,28 @@ en:
   figure: Figure
   table_label: Table
   appendix: Appendix
+  theorem: Theorem
+  solution: Solution
   chapter_outline: Chapter Outline
   toc_title: Contents
   example_label: Example
   exercise_label: Exercise
+  equation: Equation
   chapter: Chapter
   unit: Unit
+  checkpoint: Checkpoint
+  chapter_review: Chapter Review
   learning_objectives: Learning Objectives
   stepwise_step_label: Step
+  eoc_chapter_review: Chapter Review
   eoc_key_terms_title: Key Terms
   eoc_summary_title: Summary
   eoc_exercises_title: Exercises
   eoc_answer_key_title: Answer Key
+  eoc_key_concepts: Key Concepts
   eoc_key_equations: Key Equations
   eoc_suggested_reading: Suggestions for Further Study
   eob_index_title: Index
   eob_index_symbols_group: Symbols
-  notes:
-    link-to-learning: Link to Learning
-    sciences-interconnect: How Sciences Interconnect
-    chemistry:
-      link-to-learning: Link to Learning
-      everyday-life: Chemistry in Everyday Life
-      chemist-portrait: Portrait of a Chemist
+  review_exercises: Review Exercises
+  section_exercises: ! 'Section %{number} Exercises'

data/lib/locales/pl.yml

@@ -0,0 +1,24 @@
+pl:
+  figure: Rysunek
+  table_label: Tabela
+  appendix: Dodatek
+  theorem: Twierdzenie
+  solution: Rozwiązanie
+  chapter_outline: Treść rozdziału
+  toc_title: Spis treści
+  example_label: Przykład
+  exercise_label: Ćwiczenie
+  equation: Równanie
+  chapter: Rozdział
+  unit: Część
+  chapter_review: Podsumowanie rozdziału
+  learning_objectives: Cel dydaktyczny
+  stepwise_step_label: Krok
+  eoc_chapter_review: Podsumowanie rozdziału
+  eoc_key_terms_title: Kluczowe pojęcia
+  eoc_summary_title: Podsumowanie
+  eoc_answer_key_title: Rozwiązania zadań
+  eoc_key_equations: Najważniejsze wzory
+  eob_index_title: Skorowidz rzeczowy
+  eob_index_symbols_group: Symbole
+

data/lib/openstax_kitchen.rb

@@ -51,7 +51,7 @@ require 'kitchen/element_factory'
 
 require_all('kitchen/directions')
 
-I18n.load_path << file_glob('/locales/*.yml')
+I18n.backend.load_translations(file_glob('/locales/*.yml'))
 
 I18n.available_locales.each do |available_locale|
   I18n.backend.store_translations(available_locale, Kitchen::TRANSLITERATIONS)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -227,13 +227,35 @@ 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_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
 - lib/kitchen/directions/bake_chapter_title/main.rb
 - lib/kitchen/directions/bake_chapter_title/v1.rb
+- lib/kitchen/directions/bake_checkpoint.rb
+- lib/kitchen/directions/bake_composite_chapters.rb
 - 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
@@ -245,18 +267,29 @@ files:
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
 - lib/kitchen/directions/bake_link_placeholders.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
-- lib/kitchen/directions/bake_notes.rb
+- 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
+- lib/kitchen/directions/bake_numbered_exercise/v1.rb
 - lib/kitchen/directions/bake_numbered_table/main.rb
 - lib/kitchen/directions/bake_numbered_table/v1.rb
 - 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_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
+- lib/kitchen/directions/bake_theorem/main.rb
+- lib/kitchen/directions/bake_theorem/v1.rb
 - lib/kitchen/directions/bake_toc.rb
 - 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/eoc_section_title_link_snippet.rb
 - lib/kitchen/directions/move_title_text_into_span.rb
 - lib/kitchen/document.rb
 - lib/kitchen/element.rb
@@ -268,6 +301,8 @@ files:
 - lib/kitchen/errors.rb
 - lib/kitchen/example_element.rb
 - lib/kitchen/example_element_enumerator.rb
+- lib/kitchen/exercise_element.rb
+- lib/kitchen/exercise_element_enumerator.rb
 - lib/kitchen/figure_element.rb
 - lib/kitchen/figure_element_enumerator.rb
 - lib/kitchen/metadata_element.rb
@@ -298,6 +333,7 @@ files:
 - lib/kitchen/utils.rb
 - lib/kitchen/version.rb
 - lib/locales/en.yml
+- lib/locales/pl.yml
 - lib/notes.md
 - lib/openstax_kitchen.rb
 - openstax_kitchen.gemspec