openstax_kitchen 3.1.0 → 5.0.0

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.1.0'
+  VERSION = '5.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/locales/es.yml

@@ -0,0 +1,32 @@
+es:
+  figure: Figura
+  table_label: Tabla
+  appendix: Apéndice
+  theorem: Teorema
+  solution: Solución
+  chapter_outline: Esquema Del Capitulo
+  toc_title: Contenido
+  example_label: Ejemplo
+  exercise_label: Ejercicio
+  equation: Ecuación
+  chapter: Capítulo
+  unit: Unidad
+  checkpoint: Punto De Control
+  chapter_review: Revisión Del Capítulo
+  learning_objectives: Objetivos De Aprendizaje
+  stepwise_step_label: Paso
+  references: Referencias
+  eoc_chapter_review: Revisión Del Capítulo
+  eoc_key_terms_title: Términos Clave
+  eoc_summary_title: Resumen
+  eoc_exercises_title: Ejercicios
+  eoc_composite_metadata_title: Revisión Del Capítulo
+  eoc_answer_key_title: Respuestas Clave
+  eoc_key_concepts: Conceptos Clave
+  eoc_key_equations: Ecuaciones Clave
+  eoc_suggested_reading: Sugerencias Para Estudios Adicionales
+  eoc_further_research_title: Investigación Adicional
+  eob_index_title: Índice
+  eob_index_symbols_group: Símbolos
+  review_exercises: Ejercicios De Repaso
+  section_exercises: ! 'Sección %{number} Ejercicios'

data/lib/openstax_kitchen.rb

@@ -25,7 +25,6 @@ require 'kitchen/selectors/base'
 require_all('kitchen/selectors')
 
 require 'kitchen/utils'
-require 'kitchen/transliterations'
 require 'kitchen/errors'
 require 'kitchen/ancestor'
 require 'kitchen/search_query'
@@ -40,6 +39,8 @@ require 'kitchen/oven'
 require 'kitchen/clipboard'
 require 'kitchen/pantry'
 require 'kitchen/counter'
+require 'kitchen/selector'
+require 'kitchen/id_tracker'
 
 require 'kitchen/element_enumerator_base'
 require 'kitchen/element_enumerator_factory'
@@ -52,7 +53,3 @@ require 'kitchen/element_factory'
 require_all('kitchen/directions')
 
 I18n.backend.load_translations(file_glob('/locales/*.yml'))
-
-I18n.available_locales.each do |available_locale|
-  I18n.backend.store_translations(available_locale, Kitchen::TRANSLITERATIONS)
-end

data/openstax_kitchen.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'i18n'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'rainbow'
+  spec.add_dependency 'twitter_cldr'
 
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'inch'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,7 @@ files:
 - lib/kitchen/chapter_element_enumerator.rb
 - lib/kitchen/clipboard.rb
 - lib/kitchen/composite_chapter_element.rb
+- lib/kitchen/composite_chapter_element_enumerator.rb
 - lib/kitchen/composite_page_element.rb
 - lib/kitchen/composite_page_element_enumerator.rb
 - lib/kitchen/config.rb
@@ -227,26 +242,14 @@ 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_references/main.rb
+- lib/kitchen/directions/bake_chapter_references/v1.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 +260,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 +276,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 +285,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 +295,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
@@ -305,6 +325,7 @@ files:
 - lib/kitchen/exercise_element_enumerator.rb
 - lib/kitchen/figure_element.rb
 - lib/kitchen/figure_element_enumerator.rb
+- lib/kitchen/id_tracker.rb
 - lib/kitchen/metadata_element.rb
 - lib/kitchen/metadata_element_enumerator.rb
 - lib/kitchen/mixins/block_error_if.rb
@@ -314,25 +335,32 @@ files:
 - lib/kitchen/page_element.rb
 - lib/kitchen/page_element_enumerator.rb
 - lib/kitchen/pantry.rb
+- lib/kitchen/patches/i18n.rb
 - lib/kitchen/patches/nokogiri.rb
+- lib/kitchen/patches/nokogiri_profiling.rb
 - 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
 - lib/kitchen/type_casting_element_enumerator.rb
 - lib/kitchen/unit_element.rb
 - lib/kitchen/unit_element_enumerator.rb
 - lib/kitchen/utils.rb
 - lib/kitchen/version.rb
 - lib/locales/en.yml
+- lib/locales/es.yml
 - lib/locales/pl.yml
 - lib/notes.md
 - lib/openstax_kitchen.rb

data/lib/kitchen/directions/bake_chapter_glossary.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    # Bake directons for eoc glossary
-    #
-    module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        metadata_elements = metadata_source.children_to_keep.copy
-
-        definitions = chapter.glossaries.search('dl').cut
-        definitions.sort_by! do |definition|
-          [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
-        end
-
-        chapter.glossaries.trash
-
-        return if definitions.none?
-
-        append_to_element = append_to || chapter
-
-        append_to_element.append(child:
-          <<~HTML
-            <div class="os-eoc os-glossary-container" data-type="composite-page" data-uuid-key="glossary">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_key_terms_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_terms_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{definitions.paste}
-            </div>
-          HTML
-        )
-      end
-    end
-  end
-end

data/lib/kitchen/directions/bake_chapter_key_concepts/key_concepts.xhtml.erb

@@ -1,16 +0,0 @@
-<div class="os-eoc os-key-concepts-container" data-type="composite-page" data-uuid-key=".key-concepts">
-  <h2 data-type="document-title">
-    <span class="os-text"><%= I18n.t(:eoc_key_concepts) %></span>
-  </h2>
-  <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_key_concepts) %></h1>
-    <%= @metadata_elements.paste %>
-  </div>
-  <div class="os-key-concepts">
-    <% @key_concepts.each do |key_concept| %>
-      <div class="os-section-area">
-        <%= key_concept %>
-      </div>
-    <% end %>
-  </div>
-</div>

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module BakeChapterReviewExercises
-      def self.v1(chapter:, metadata_source:, append_to:, klass:)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to, klass: klass)
-      end
-
-      def self.v2(chapter:, metadata_source:, append_to:, klass:)
-        V2.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to, klass: klass)
-      end
-    end
-  end
-end