openstax_kitchen 4.1.1 → 8.0.0

data/lib/kitchen/patches/array.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Monkey patches for +Array+
+#
+class Array
+
+  # Receives a string to add as prefix in each item and returns
+  # a new array with the concatenaded strings
+  #
+  # @return [Array<String>]
+  #
+  def prefix(string)
+    map { |item| "#{string}#{item}" }
+  end
+end

data/lib/kitchen/patches/i18n.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'twitter_cldr'
+
+# rubocop:disable Style/Documentation
+module I18n
+  def self.sort_strings(first, second)
+    string_sorter.compare(first, second)
+  end
+
+  def self.string_sorter
+    @string_sorter ||= begin
+      # TwitterCldr does not know about our :test locale, so substitute the English one
+      locale = I18n.locale == :test ? :en : I18n.locale
+      TwitterCldr::Collation::Collator.new(locale)
+    end
+  end
+
+  def self.clear_string_sorter
+    @string_sorter = nil
+  end
+
+  class <<self
+    alias_method :original_locale=, :locale=
+  end
+
+  def self.locale=(locale)
+    # We wrap the setting of locale so that we can clear the string sorter (so that it
+    # gets reset to the new locale the next time it is used)
+    clear_string_sorter
+    self.original_locale = locale
+  end
+end
+# rubocop:enable Style/Documentation

data/lib/kitchen/patches/integer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Monkey patches for +Integer+
+#
+class Integer
+  ROMAN_NUMERALS = %w[0 i ii iii iv v vi vii viii ix x xi xii xiii xiv xv xvi xvii xviii xix xx].freeze
+
+  # Formats as different types of integers, including roman numerals.
+  #
+  # @return [String]
+  #
+  def to_format(format)
+    case format
+    when :arabic
+      to_s
+    when :roman
+      raise 'Unknown conversion to Roman numerals' if self >= ROMAN_NUMERALS.size
+
+      ROMAN_NUMERALS[self]
+    else
+      raise 'Unknown integer format'
+    end
+  end
+end

data/lib/kitchen/patches/nokogiri.rb

@@ -67,6 +67,13 @@ module Nokogiri
         self[:class]&.split || []
       end
 
+      def previous
+        prev = previous_element
+        return nil if prev.nil?
+
+        prev.text? ? prev.previous : prev
+      end
+
       def self.selector_to_css_nodes(selector)
         # No need to parse the same selector more than once.
         @parsed_selectors ||= {}

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -16,12 +16,13 @@ en:
   learning_objectives: Learning Objectives
   stepwise_step_label: Step
   references: References
+  answer_key_title: Answer Key
   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_solutions_title: Solutions
   eoc_key_concepts: Key Concepts
   eoc_key_equations: Key Equations
   eoc_suggested_reading: Suggestions for Further Study

data/lib/locales/es.yml

@@ -0,0 +1,33 @@
+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
+  answer_key_title: Clave de Respuestas
+  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_solutions_title: Soluciones
+  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/locales/pl.yml

@@ -14,11 +14,13 @@ pl:
   chapter_review: Podsumowanie rozdziału
   learning_objectives: Cel dydaktyczny
   stepwise_step_label: Krok
+  answer_key_title: Rozwiązania zadań
   eoc_chapter_review: Podsumowanie rozdziału
   eoc_key_terms_title: Kluczowe pojęcia
+  eoc_solutions_title: Rozwiązania
   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
+  references: Bibliografia
 

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'
@@ -41,6 +40,8 @@ require 'kitchen/clipboard'
 require 'kitchen/pantry'
 require 'kitchen/counter'
 require 'kitchen/selector'
+require 'kitchen/id_tracker'
+require 'kitchen/i18n_string'
 
 require 'kitchen/element_enumerator_base'
 require 'kitchen/element_enumerator_factory'
@@ -53,7 +54,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: 4.1.1
+  version: 8.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-29 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
@@ -186,7 +200,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".devcontainer/devcontainer.json"
-- ".github/config.yml"
+- ".github/workflows/changelog.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".inch.yml"
@@ -208,6 +223,7 @@ files:
 - docker/bash
 - docker/build
 - docker/ci
+- docker/rubocop
 - docker/run
 - docker/tag_and_push_latest
 - lefthook.yml
@@ -231,6 +247,7 @@ files:
 - 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_introductions/chapter_introduction.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
@@ -238,6 +255,8 @@ files:
 - 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_solutions/main.rb
+- lib/kitchen/directions/bake_chapter_solutions/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
@@ -257,22 +276,29 @@ files:
 - 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_inline_lists.rb
 - lib/kitchen/directions/bake_link_placeholders.rb
 - lib/kitchen/directions/bake_math_in_paragraph.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_numbered_notes/main.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v1.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v2.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v3.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/bake_table_body.rb
 - lib/kitchen/directions/bake_numbered_table/main.rb
 - lib/kitchen/directions/bake_numbered_table/v1.rb
+- lib/kitchen/directions/bake_numbered_table/v2.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_references/v2.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_theorem/main.rb
@@ -281,7 +307,7 @@ 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/eob_answer_key_outer_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
@@ -291,9 +317,11 @@ files:
 - 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_exercises_to_eoc/v3.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/default.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/precalculus.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
@@ -311,6 +339,8 @@ files:
 - lib/kitchen/exercise_element_enumerator.rb
 - lib/kitchen/figure_element.rb
 - lib/kitchen/figure_element_enumerator.rb
+- lib/kitchen/i18n_string.rb
+- lib/kitchen/id_tracker.rb
 - lib/kitchen/metadata_element.rb
 - lib/kitchen/metadata_element_enumerator.rb
 - lib/kitchen/mixins/block_error_if.rb
@@ -320,6 +350,9 @@ files:
 - lib/kitchen/page_element.rb
 - lib/kitchen/page_element_enumerator.rb
 - lib/kitchen/pantry.rb
+- lib/kitchen/patches/array.rb
+- lib/kitchen/patches/i18n.rb
+- lib/kitchen/patches/integer.rb
 - lib/kitchen/patches/nokogiri.rb
 - lib/kitchen/patches/nokogiri_profiling.rb
 - lib/kitchen/patches/renderable.rb
@@ -338,13 +371,13 @@ files:
 - 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/.github/config.yml

@@ -1,14 +0,0 @@
-# See https://github.com/openstax/staxly#plugins for more options for this file
-changelog:
-  # See https://github.com/mikz/probot-changelog for details
-
-  # The filename of the CHANGELOG that needs to be updated in every PullRequest
-  filename: CHANGELOG.md
-
-  # (optional) when files matching these patterns are changed then disallow merging
-  # until the CHANGELOG is updated.
-  # If this pattern is not included then **all** Pull Requests require an edit to 
-  # the CHANGELOG file
-  
-  # include:
-  #   - /^src\//

data/lib/kitchen/directions/bake_notes/bake_numbered_notes.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module BakeNumberedNotes
-      def self.v1(book:, classes:)
-        classes.each do |klass|
-          book.chapters.notes("$.#{klass}").each do |note|
-            bake_note(note: note)
-            note.exercises.each do |exercise|
-              bake_note_exercise(note: note, exercise: exercise)
-            end
-          end
-        end
-      end
-
-      def self.bake_note(note:)
-        note.wrap_children(class: 'os-note-body')
-
-        chapter_count = note.ancestor(:chapter).count_in(:book)
-        note_count = note.count_in(:chapter)
-        note.prepend(child:
-          <<~HTML
-            <h3 class="os-title">
-              <span class="os-title-label">#{note.autogenerated_title}</span>
-              <span class="os-number">#{chapter_count}.#{note_count}</span>
-              <span class="os-divider"> </span>
-            </h3>
-          HTML
-        )
-
-        return unless note['use-subtitle']
-
-        BakeNoteSubtitle.v1(note: note)
-      end
-
-      def self.bake_note_exercise(note:, exercise:)
-        exercise.add_class('unnumbered')
-        # bake problem
-        exercise.problem.wrap_children('div', class: 'os-problem-container')
-        exercise.problem.first('strong')&.trash
-        exercise.search('[data-type="commentary"]').each(&:trash)
-        return unless exercise.solution
-
-        # bake solution in place
-        BakeNumberedExercise.bake_solution_v1(
-          exercise: exercise, number: note.first('.os-number').text, divider: ' ')
-      end
-    end
-  end
-end

data/lib/kitchen/directions/book_answer_key_container/eob_solutions_container.xhtml.erb

@@ -1,9 +0,0 @@
-<div class="os-eob os-solutions-container" data-type="composite-chapter" data-uuid-key=".solutions">
-  <h1 data-type="document-title">
-    <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>
-    <%= @metadata.paste %>
-  </div>
-</div>

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/american_government.rb

@@ -1,19 +0,0 @@
-# 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