openstax_kitchen 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80bf07271b311949246bf6a63a9d10fe5f14396175f66a129debcc9e9ef15e3
-  data.tar.gz: 7a3a7050d134a0b106d3a80dc18add9209742fca1eea4873f351eb0dd4d05034
+  metadata.gz: c8e1365bab888949c899b5cb36518be9456bd23d0369ddab9a42ac81f82cc024
+  data.tar.gz: cd86a88028f0946885add3866ffad6133f84ce48a779800cb5105cc8153736d4
 SHA512:
-  metadata.gz: 7fee3b2b4dd92639af2e20520c3f65a31255d944df649e91c5c0e5c8f0a8e1e1f6d19b4477480c5cbc899f7124727c8a40b5a0759985ec94225885baf36b3287
-  data.tar.gz: ed62932aa44e597135158cc182daefd2773b89070e1d82750669d4d1f760fa8179f1197c67eddcdec73c1cdc2b1bd7537ca28c8f5603d3a2a7962457d777141f
+  metadata.gz: 16b9afc1d63a6098aad2396e114975ea35d39890c9a4c27c88dfef7710d129ddf16e3f18d775042ae919d0dff5284d41b53f668621d5cd74f2e723a670fd33d9
+  data.tar.gz: 9b93c51846a460a3e71c6a6080f53be61f1fa93ab268f954ddf3b7d447a1f9602dd789d876bc41e2997f8f44e682453c413f2f28ea7754c4d7f1015d3ecde1a6

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.0.0] - 2021-06-02
+
+* Reditributed duplicated id logic across `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, added a couple more tests for `#copy`, `#cut`, and `#paste`, created a new class `IdTracker` and moved `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, and `modified_id_to_paste` into the new class (major)
+* Moved selectors from recipe to kitchen on `BakeFirstElements` Direction (minor)
+* Auto-detect language based on document; force output encoding to UTF-8 (major)
+* Switched to using a library to sort strings in a language-specific way (patch)
+* Remove summary attribute from `BakeNumberedTable` (major)
+
 ## [4.1.1] - 2021-05-24
 
 * Adds low level Nokogiri caching, disabled by default (patch)

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (4.1.1)
+    openstax_kitchen (5.0.0)
       activesupport
       i18n
       nokogiri
       rainbow
+      twitter_cldr
 
 GEM
   remote: https://rubygems.org/
@@ -18,6 +19,8 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.2)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.1.0)
     codecov (0.2.13)
       simplecov (~> 0.18.0)
     coderay (1.1.3)
@@ -94,6 +97,10 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
+    twitter_cldr (6.6.0)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.1)
+      tzinfo
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)

data/lib/kitchen/directions/bake_first_elements.rb

@@ -3,7 +3,13 @@
 module Kitchen
   module Directions
     module BakeFirstElements
-      def self.v1(within:, selectors:)
+      def self.v1(within:)
+        selectors = [
+          'div.os-problem-container > div.os-table',
+          'div.os-problem-container > span[data-type="media"]',
+          'div.os-solution-container > div.os-table',
+          'div.os-solution-container > span[data-type="media"]'
+        ]
         selectors.each do |selector|
           within.search("#{selector}:first-child").each do |problem|
             problem.add_class('first-element')

data/lib/kitchen/directions/bake_index/v1.rb

@@ -27,13 +27,6 @@ module Kitchen::Directions::BakeIndex
       def initialize(term_text:)
         @term_text = term_text
         @terms = []
-
-        # Sort by transliterated version first to support accent marks,
-        # then by the raw text to support the same text with different capitalization
-        @sortable = [
-          ActiveSupport::Inflector.transliterate(term_text).downcase,
-          term_text
-        ]
       end
 
       def add_term(term)
@@ -49,12 +42,8 @@ module Kitchen::Directions::BakeIndex
       end
 
       def <=>(other)
-        sortable <=> other.sortable
+        I18n.sort_strings(term_text, other.term_text)
       end
-
-      protected
-
-      attr_reader :sortable
     end
 
     class IndexSection

data/lib/kitchen/directions/bake_numbered_table/v1.rb

@@ -22,21 +22,16 @@ module Kitchen::Directions::BakeNumberedTable
       table.parent.add_class('os-column-header-container') if table.column_header?
 
       # TODO: extra spaces added here to match legacy implementation, but probably not meaningful?
-      new_summary = "#{table_label} "
       new_caption = ''
       caption_title = ''
 
       if (title = table.first("span[data-type='title']")&.cut)
-        new_summary += title.text
         caption_title = <<~HTML
           \n<span class="os-title" data-type="title">#{title.children}</span>
         HTML
       end
 
-      new_summary += ' '
-
       if (caption = table.caption&.cut)
-        new_summary += caption.text
         new_caption = <<~HTML
           \n<span class="os-caption">#{caption.children}</span>
         HTML
@@ -46,8 +41,6 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       end
 
-      table[:summary] = new_summary
-
       return if table.unnumbered?
 
       table.append(sibling:

data/lib/kitchen/document.rb

@@ -13,6 +13,8 @@ module Kitchen
     attr_accessor :location
     # @return [Config] the configuration used in this document
     attr_reader :config
+    # @return [IdTracker] the counter for duplicate IDs
+    attr_reader :id_tracker
 
     # @!method selectors
     #   The document's selectors
@@ -34,7 +36,10 @@ module Kitchen
     # @!method to_html
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#to_html-instance_method Nokogiri::XML::Node#to_html
     #   @return [String] the document as an HTML string
-    def_delegators :@nokogiri_document, :to_xhtml, :to_s, :to_xml, :to_html
+    # @!method encoding
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Document#encoding-instance_method Nokogiri::XML::Document#encoding
+    #   @return [String] the document as an HTML string
+    def_delegators :@nokogiri_document, :to_xhtml, :to_s, :to_xml, :to_html, :encoding
 
     # Return a new instance of Document
     #
@@ -44,8 +49,7 @@ module Kitchen
       @nokogiri_document = nokogiri_document
       @location = nil
       @config = config || Config.new
-      @next_paste_count_for_id = {}
-      @id_copy_suffix = '_copy_'
+      @id_tracker = IdTracker.new
 
       # Nokogiri by default only recognizes the namespaces on the root node.  Add all others.
       raw&.add_all_namespaces! if @config.enable_all_namespaces
@@ -148,38 +152,6 @@ module Kitchen
       end
     end
 
-    # Keeps track that an element with the given ID has been copied.  When such
-    # elements are pasted, this information is used to give those elements unique
-    # IDs that don't duplicate the original element.
-    #
-    # @param id [String] the ID
-    #
-    def record_id_copied(id)
-      return if id.blank?
-
-      @next_paste_count_for_id[id] ||= 1
-    end
-
-    # Returns a unique ID given the ID of an element that was copied and is about
-    # to be pasted
-    #
-    # @param original_id [String]
-    #
-    def modified_id_to_paste(original_id)
-      return nil if original_id.nil?
-      return '' if original_id.blank?
-
-      count = next_count_for_pasted_id(original_id)
-
-      # A count of 0 means the element was cut and this is the first paste, do not
-      # modify the ID; otherwise, use the uniquified ID.
-      if count.zero?
-        original_id
-      else
-        "#{original_id}#{@id_copy_suffix}#{count}"
-      end
-    end
-
     # Returns the underlying Nokogiri Document object
     #
     # @return [Nokogiri::XML::Document]
@@ -188,16 +160,19 @@ module Kitchen
       @nokogiri_document
     end
 
-    protected
-
-    def next_count_for_pasted_id(id)
-      return if id.blank?
-
-      (@next_paste_count_for_id[id] ||= 0).tap do
-        @next_paste_count_for_id[id] += 1
+    # Returns the locale for this document, default to `:en` if no locale detected
+    #
+    # @return [Symbol]
+    #
+    def locale
+      raw.root['lang']&.to_sym || begin
+        warn 'No `lang` attribute on this document so cannot detect its locale; defaulting to `:en`'
+        :en
       end
     end
 
+    protected
+
     attr_reader :nokogiri_document
 
   end

data/lib/kitchen/element_base.rb

@@ -101,6 +101,8 @@ module Kitchen
     #   @return [Clipboard]
     def_delegators :document, :pantry, :clipboard
 
+    def_delegators :document, :id_tracker
+
     # Creates a new instance
     #
     # @param node [Nokogiri::XML::Node] the wrapped element
@@ -441,6 +443,11 @@ module Kitchen
     def cut(to: nil)
       block_error_if(block_given?)
 
+      raw.traverse do |node|
+        next if node.text? || node.document?
+
+        id_tracker.record_id_cut(node[:id])
+      end
       node.remove
       get_clipboard(to).add(self) if to.present?
       self
@@ -461,7 +468,7 @@ module Kitchen
       the_copy.raw.traverse do |node|
         next if node.text? || node.document?
 
-        document.record_id_copied(node[:id])
+        id_tracker.record_id_copied(node[:id])
       end
       get_clipboard(to).add(the_copy) if to.present?
       the_copy
@@ -472,20 +479,22 @@ module Kitchen
     def paste
       # See `clone` method for a note about namespaces
       block_error_if(block_given?)
-
       temp_copy = clone
       temp_copy.raw.traverse do |node|
         next if node.text? || node.document?
 
-        node[:id] = document.modified_id_to_paste(node[:id]) unless node[:id].blank?
+        if node[:id].present?
+          id_tracker.record_id_pasted(node[:id])
+          node[:id] = id_tracker.modified_id_to_paste(node[:id])
+        end
       end
       temp_copy.to_s
     end
 
     # Copy the element's id
     def copied_id
-      document.record_id_copied(id)
-      document.modified_id_to_paste(id)
+      id_tracker.record_id_copied(id)
+      id_tracker.modified_id_to_paste(id)
     end
 
     # Delete the element

data/lib/kitchen/id_tracker.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # A class to track and modify duplicate IDs in a document
+  #
+  class IdTracker
+
+    def initialize
+      @id_data = Hash.new { |hash, key| hash[key] = { count: 0, last_pasted: false } }
+      @id_copy_suffix = '_copy_'
+    end
+
+    # Keeps track that an element with the given ID has been copied.  When such
+    # elements are pasted, this information is used to give those elements unique
+    # IDs that don't duplicate the original element.
+    #
+    # @param id [String] the ID
+    #
+    def record_id_copied(id)
+      return if id.blank?
+
+      @id_data[id][:count] += 1
+      @id_data[id][:last_pasted] = false
+    end
+
+    # Keeps track that an element with the given ID has been cut.
+    #
+    # @param id [String]
+    #
+    def record_id_cut(id)
+      return if id.blank?
+
+      @id_data[id][:count] -= 1 if @id_data[id][:count].positive?
+      @id_data[id][:last_pasted] = false
+    end
+
+    # Keeps track that an element with the given ID has been pasted.
+    #
+    # @param id [String]
+    #
+    def record_id_pasted(id)
+      return if id.blank?
+
+      @id_data[id][:count] += 1 if @id_data[id][:last_pasted]
+      @id_data[id][:last_pasted] = true
+    end
+
+    # Returns a unique ID given the ID of an element that was copied and is about
+    # to be pasted
+    #
+    # @param original_id [String]
+    # @return [String]
+    #
+    def modified_id_to_paste(original_id)
+      return nil if original_id.nil?
+      return '' if original_id.blank?
+
+      count = @id_data[original_id][:count]
+      # A count of 0 means the element was cut and this is the first paste, do not
+      # modify the ID; otherwise, use the uniquified ID.
+      if count.zero?
+        original_id
+      else
+        "#{original_id}#{@id_copy_suffix}#{count}"
+      end
+    end
+  end
+end

data/lib/kitchen/oven.rb

@@ -28,6 +28,8 @@ module Kitchen
         config: config
       )
 
+      I18n.locale = doc.locale
+
       [recipes].flatten.each do |recipe|
         recipe.document = doc
         recipe.bake
@@ -35,7 +37,7 @@ module Kitchen
       profile.baked!
 
       File.open(output_file, 'w') do |f|
-        f.write doc.to_xhtml(indent: 2)
+        f.write doc.to_xhtml(indent: 2, encoding: doc.encoding || 'utf-8')
       end
       profile.written!
 

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/version.rb

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

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'
@@ -41,6 +40,7 @@ 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'
@@ -53,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: 4.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-24 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
@@ -311,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
@@ -320,6 +335,7 @@ 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
@@ -338,13 +354,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/lib/kitchen/transliterations.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  # These are added to every translation locale, including the `test` locale
-  # set by `stub_locales`.  When we sort strings with accent marks, we use
-  # `ActiveSupport::Inflector.transliterate` to ensure that the sorting is
-  # sensible.  This method does not know about Greek characters by default so
-  # we teach it about them by adding the rules below to the i18n configuration.
-  #
-  TRANSLITERATIONS = {
-    i18n: {
-      transliterate: {
-        rule: {
-          σ: 'σ',
-          Δ: 'Δ',
-          π: 'π'
-        }
-      }
-    }
-  }.freeze
-end