openstax_kitchen 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43191e77a90ff1979ef567be7b5ab17d0eeac503ead1294d8d329e18d6740c75
-  data.tar.gz: ae55a2aa093d942166c41502c2019b327ccaf4eab1fd383773acd94827122524
+  metadata.gz: 46fe1771e5853e9149dc1df841fafeaba3d3b157ab850d66f94745406867d901
+  data.tar.gz: 1f97e7a288fb5a9c7c96c3f9352238736ac9854a8b0a06379328253f89e9552f
 SHA512:
-  metadata.gz: 6bcc9edf90d94f61582668e6bae0c39a42dd6d4535f944d7566eb4d17cd85ed1e5712b9e51b6ed5cf71d5928d90b211c26ac6134a356246a41ea379c4a3af73b
-  data.tar.gz: ea31d5248fec4947d06d53f2555c71ff36274c9a174976b6751dd9894a41eb949601e77c2116227374573cbdf823e9c7fc94142ce9d3341d9159d8d7d03074a2
+  metadata.gz: d5a8b103ba036bd0db84ad87857873ff3f6c048c03951e6e5543577330df875025a97338c62b96f6278ca751be81a04be3e95ef6468458fed086e3bdad7adcc3
+  data.tar.gz: ff6c97185d2c264019fe041e17b83678c12f1f894bef9c0d11d01eab304b6a9c3200c2c9e03405267dc462a52775d78b44daa0050a9002ac1ea6bfef1998f111

data/CHANGELOG.md

@@ -7,11 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
+## [8.0.0] - 2021-06-29
+
+* Sort terms in `BakeChapterGlossary` in language specific way (major)
+* Spanish translation change (minor)
+* Fixed the implementation of `Element#wrap_children` to reuse existing document elements (major).
+
 ## [7.0.0] - 2021-06-21
 
 * Changed selector expected by `default strategy` in `move_solutions_to_answer_key` to optimize search (major)
 * Fix Rubocop GitHub Action's regular expression used to select files to lint (patch)
+* Add optional numbering to multiple solutions inside examples (minor)
 * Added monkey patch for array to be able to add a prefix: `%w[multiple-choice true-false].prefix('section.')` (minor)
+* Add more specific book part selector (`os-eob`) for References in `is_citation_reference?`, `is_section_reference?` methods in `Element Base` to fix toc selector for References which are moved to EoC (major)
 
 ## [6.1.0] - 2021-06-21
 
@@ -45,10 +53,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Adds `BakeNumberedNotes` V3 (minor)
 * Added line that puts the classname `has-footnote` in the footnote ref's parent element (major)
 * Added a condition into `BakeChapterSummary` so it doesn't bake the title if it already includes the respective number in it
-* Create v3 of MoveExercisesToEOC which differs from v1 by the presence of a section title
-and from v2 the lack of additional "os-section-area" and os-#{@klass} wrapper (minor)
-* Add a condition in BakeNumberedExercise to make it possible to suppress even solutions in the Answer Key (minor)
-* Fix BakeFurtherResearch baking with main bake script error by breaking the loop if further research sections are not present (minor)
+* Create v3 of `MoveExercisesToEOC` which differs from v1 by the presence of a section title
+and from v2 the lack of additional `os-section-area` and `os-#{@klass} wrapper` (minor)
+* Add a condition in `BakeNumberedExercise` to make it possible to suppress even solutions in the Answer Key (minor)
+* Fix `BakeFurtherResearch` baking with main bake script error by breaking the loop if further research sections are not present (minor)
 * Rework v1 of `BakeChapterReferences` to bake references also from introduction pages (major)
 * Fix for `BakeIndex` for words that start with a number to be grouped as symbols and for first letters with accent marks to be grouped with regular letters in alphabetic order (major)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (7.0.0)
+    openstax_kitchen (8.0.0)
       activesupport
       i18n
       nokogiri
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/lib/kitchen/composite_page_element.rb

@@ -57,7 +57,7 @@ module Kitchen
     # @return [Boolean]
     #
     def is_citation_reference?
-      has_class?('os-reference-container')
+      has_class?('os-eob os-reference-container')
     end
 
     # Returns true if this page is a book section reference
@@ -65,7 +65,7 @@ module Kitchen
     # @return [Boolean]
     #
     def is_section_reference?
-      has_class?('os-references-container')
+      has_class?('os-eob os-references-container')
     end
 
   end

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

@@ -4,21 +4,39 @@ module Kitchen::Directions::BakeChapterGlossary
   class V1
     renderable
 
+    class Definition
+      attr_reader :element
+
+      def initialize(element)
+        term = Kitchen::I18nString.new(element.first('dt').text.downcase)
+        description = Kitchen::I18nString.new(element.first('dd').text.downcase)
+        @sortable = [term, description]
+        @element = element
+      end
+
+      def <=>(other)
+        sortable <=> other.sortable
+      end
+
+      protected
+
+      attr_reader :sortable
+    end
+
     def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
       @metadata = metadata_source.children_to_keep.copy
       @klass = 'glossary'
       @title = I18n.t(:eoc_key_terms_title)
       @uuid_prefix = uuid_prefix
+      @glossary = []
 
-      definitions = chapter.glossaries.search('dl').cut
-      return if definitions.none?
-      definitions.sort_by! do |definition|
-        [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
+      chapter.glossaries.search('dl').each do |definition_element|
+        @glossary.push(Definition.new(definition_element.cut))
       end
 
       chapter.glossaries.trash
 
-      @content = definitions.paste
+      @content = @glossary.sort.map { |definition| definition.element.paste }.join
 
       append_to_element = append_to || chapter
       @in_composite_chapter = append_to_element.is?(:composite_chapter)

data/lib/kitchen/directions/bake_example.rb

@@ -3,7 +3,7 @@
 module Kitchen
   module Directions
     module BakeExample
-      def self.v1(example:, number:, title_tag:)
+      def self.v1(example:, number:, title_tag:, numbered_solutions: false)
         example.wrap_children(class: 'body')
 
         example.prepend(child:
@@ -36,10 +36,16 @@ module Kitchen
           end
 
           if (solution = exercise.solution)
+            solution_number = if numbered_solutions
+                                "<span class=\"os-number\">#{exercise.count_in(:example)}</span>"
+                              else
+                                ''
+                              end
             solution.replace_children(with:
               <<~HTML
                 <h4 data-type="solution-title">
                   <span class="os-title-label">#{I18n.t(:solution)} </span>
+                  #{solution_number}
                 </h4>
                 <div class="os-solution-container">#{solution.children}</div>
               HTML

data/lib/kitchen/element_base.rb

@@ -602,9 +602,9 @@ module Kitchen
         attributes.each do |k, v|
           new_node[k.to_s.gsub(/([^_])_([^_])/, '\1-\2').gsub('__', '_')] = v
         end
-        new_node.children = children.to_s
+        new_node.children = children
         yield Element.new(node: new_node, document: document, short_type: nil) if block_given?
-      end.to_s
+      end
 
       self
     end

data/lib/kitchen/i18n_string.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # Compare one string with another
+  #
+  # Returns 0 if first string equals second,
+  # 1 if first string is greater than the second
+  # and -1 if first string is less than the second.
+  #
+  class I18nString < String
+
+    def <=>(other)
+      I18n.sort_strings(self, other)
+    end
+  end
+end

data/lib/kitchen/version.rb

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

data/lib/locales/es.yml

@@ -16,7 +16,7 @@ es:
   learning_objectives: Objetivos De Aprendizaje
   stepwise_step_label: Paso
   references: Referencias
-  answer_key_title: Respuestas Clave
+  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

data/lib/locales/pl.yml

@@ -16,7 +16,7 @@ pl:
   stepwise_step_label: Krok
   answer_key_title: Rozwiązania zadań
   eoc_chapter_review: Podsumowanie rozdziału
-  key_terms_title: Kluczowe pojęcia
+  eoc_key_terms_title: Kluczowe pojęcia
   eoc_solutions_title: Rozwiązania
   eoc_summary_title: Podsumowanie
   eoc_key_equations: Najważniejsze wzory

data/lib/openstax_kitchen.rb

@@ -41,6 +41,7 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -339,6 +339,7 @@ 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