openstax_kitchen 3.0.0 → 4.1.1

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.0.0'
+  VERSION = '4.1.1'
 end

data/lib/locales/en.yml

@@ -2,26 +2,31 @@ 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
+  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
-  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

@@ -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'
@@ -51,7 +52,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: 4.1.1
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,6 +220,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,36 +228,74 @@ files:
 - lib/kitchen/debug/print_recipe_error.rb
 - lib/kitchen/directions/.rubocop.yml
 - lib/kitchen/directions/bake_appendix.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/main.rb
+- lib/kitchen/directions/bake_chapter_key_concepts/v1.rb
 - lib/kitchen/directions/bake_chapter_key_equations.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
 - 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
 - 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
 - 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_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_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
+- 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/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
@@ -268,6 +307,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
@@ -280,15 +321,21 @@ files:
 - lib/kitchen/page_element_enumerator.rb
 - lib/kitchen/pantry.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
@@ -298,6 +345,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

data/lib/kitchen/directions/bake_chapter_glossary.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    # Bake directons for eoc glossary
-    #
-    module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:)
-        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?
-
-        chapter.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_exercises/v1.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::BakeExercises
-  class V1
-    def bake(book:)
-      metadata_elements = book.metadata.children_to_keep.copy
-
-      solutions_clipboards = []
-
-      book.chapters.each do |chapter|
-        exercise_clipboard = Kitchen::Clipboard.new
-        solution_clipboard = Kitchen::Clipboard.new
-        solutions_clipboards.push(solution_clipboard)
-
-        chapter.pages('$:not(.introduction)').each do |page|
-          exercise_section = page.exercises
-          exercise_section.first("[data-type='title']")&.trash
-          exercise_section_title = page.title.copy
-          exercise_section_title.name = 'h3'
-          exercise_section_title.replace_children(with: <<~HTML
-            <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="">#{exercise_section_title.children}</span>
-          HTML
-          )
-
-          exercise_section.prepend(child:
-            <<~HTML
-              <a href="##{page.title.id}">
-                #{exercise_section_title.paste}
-              </a>
-            HTML
-          )
-
-          exercise_section.search("[data-type='exercise']").each do |exercise|
-            exercise.document.pantry(name: :link_text).store(
-              "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-              label: exercise.id
-            )
-
-            bake_exercise_in_place(exercise: exercise)
-            exercise.first("[data-type='solution']")&.cut(to: solution_clipboard)
-          end
-
-          exercise_section.cut(to: exercise_clipboard)
-        end
-
-        next if exercise_clipboard.none?
-
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-exercises-container" data-type="composite-page" data-uuid-key=".exercises">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_exercises_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_exercises_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{exercise_clipboard.paste}
-            </div>
-          HTML
-        )
-      end
-
-      # Store a paste here to use at end so that uniquifyied IDs match legacy baking
-      eob_metadata = metadata_elements.paste
-
-      solutions = solutions_clipboards.map.with_index do |solution_clipboard, index|
-        <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-page" data-uuid-key=".solution#{index + 1}">
-            <h2 data-type="document-title">
-              <span class="os-text">#{I18n.t(:chapter)} #{index + 1}</span>
-            </h2>
-            <div data-type="metadata" style="display: none;">
-              <h1 data-type="document-title" itemprop="name">#{I18n.t(:chapter)} #{index + 1}</h1>
-              #{metadata_elements.paste}
-            </div>
-            #{solution_clipboard.paste}
-          </div>
-        HTML
-      end
-
-      return if solutions.none?
-
-      book.first('body').append(child:
-        <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-chapter" data-uuid-key=".solution">
-            <h1 data-type="document-title" id="composite-chapter-1">
-              <span class="os-text">#{I18n.t(:eoc_answer_key_title)}</span>
-            </h1>
-            <div data-type="metadata" style="display: none;">
-              <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_answer_key_title)}</h1>
-              #{eob_metadata}
-            </div>
-            #{solutions.join("\n")}
-          </div>
-        HTML
-      )
-    end
-
-    def bake_exercise_in_place(exercise:)
-      # Bake an exercise in place going from:
-      #
-      # <div data-type="exercise" id="exerciseId">
-      #   <div data-type="problem" id="problemId">
-      #     Problem Content
-      #   </div>
-      #   <div data-type="solution" id="solutionId">
-      #     Solution Content
-      #   </div>
-      # </div>
-      #
-      # to
-      #
-      # <div data-type="exercise" id="exerciseId" class="os-hasSolution">
-      #   <div data-type="problem" id="problemId">
-      #     <a class="os-number" href="#exerciseId-solution">1</a>
-      #     <span class="os-divider">. </span>
-      #     <div class="os-problem-container ">
-      #       Problem Content
-      #     </div>
-      #   </div>
-      #   <div data-type="solution" id="exerciseId-solution">
-      #     <a class="os-number" href="#exerciseId">1</a>
-      #     <span class="os-divider">. </span>
-      #     <div class="os-solution-container ">
-      #       Solution Content
-      #     </div>
-      #   </div>
-      # </div>
-      #
-      # If there is no solution, don't add the 'os-hasSolution' class and don't
-      # link the number.
-
-      problem = exercise.first("[data-type='problem']")
-      solution = exercise.first("[data-type='solution']")
-
-      problem_number = "<span class='os-number'>#{exercise.count_in(:chapter)}</span>"
-
-      if solution.present?
-        solution.id = "#{exercise.id}-solution"
-
-        exercise.add_class('os-hasSolution')
-        problem_number =
-          "<a href='##{solution.id}' class='os-number' >#{exercise.count_in(:chapter)}</a>"
-
-        solution.replace_children(with:
-          <<~HTML
-            <a class="os-number" href="##{exercise.id}">#{exercise.count_in(:chapter)}</a>
-            <span class="os-divider">. </span>
-            <div class="os-solution-container ">#{solution.children}</div>
-          HTML
-        )
-      end
-
-      problem.replace_children(with:
-        <<~HTML
-          #{problem_number}
-          <span class="os-divider">. </span>
-          <div class="os-problem-container ">#{problem.children}</div>
-        HTML
-      )
-    end
-  end
-end