openstax_kitchen 12.1.0 → 12.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28254d4a9107528ff5dbebacc82e5cc3cbf20e71fcc9d8303c2f41fd90d2d4be
-  data.tar.gz: 2c71714f62fe45ea772614d5c72f6a95ce59deebc63e1259b182e25d70481400
+  metadata.gz: f36305ee23acfe22fc13a9c06ee76f69243f1cd2cba33fe86c28c8c90b5eb36d
+  data.tar.gz: fd501ef342ff2c7334455cc214139581dadf1619fde7841a29650b4fc10acd79
 SHA512:
-  metadata.gz: dfaf9123a29ef2bedddb524ed7758b1092c88c6cbc850aeee0d4530633783ab2cbec39b68f3b5fc391219f344f191c4714f779ef8efc57c7f35c47d075eb813e
-  data.tar.gz: c686d00ca4305b0f90f23c4ba2cfb3151a5c0384f7979e82fe16d5432a9e79b32705822aeae244601343d3620e053247b848edf78631c59f93a920e312d7951d
+  metadata.gz: e3b939d8a9851db4940213aae3350f720369eb794b8551627d2a44565af36aeda5ad701b62c2c1ec98fb7dcfabafa8bd2e4531642bf40dd777a635c0117560b6
+  data.tar.gz: 5ec8d3e59faa619a3b23a84ce74514c96b6d360dc1b46d233cd1566b63815a5a7edaa73980f102b4c6656c603c43ea349fcc2eac99149cbafb8fa91d8f0e2fdc

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [12.2.0] - 2021-10-1
+
+* Add `context_lead_text` to translations (minor)
+* Make `ElementBase#search_with` callable from an `ElementEnumerator` (minor)
+* Support top-titled tables in `BakeUnnumberedTables` (minor)
+* Stop `NoteElement#title` from breaking for empty notes (patch)
+* Add text heavy tables to `BakeTableBody` (minor)
+* Modify `BakeAutotitledNotes` to bake unnumbered exercises with solution (minor)
+* Create `AddInjectedExerciseId` to separate creating ids from `BakeInjectedExerciseQuestion` (minor)
+* Rework `AddInjectedExerciseId` to use loop inside module (minor)
+
 ## [12.1.0] - 2021-09-24
 
 * Fix `BakeExample#titles_to_rename` to exclude exercise titles (patch)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (12.1.0)
+    openstax_kitchen (12.2.0)
       activesupport
       i18n
       nokogiri

data/lib/kitchen/directions/bake_injected_exercise/add_injected_exercise_id.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Ids should be added before exercises are moved to EOC,
+    # since they're using part of the ancestor page id.
+    #
+    # In some books exercises are numbered after moving.
+    # That's why this step has to be separated from BakeInjectedExerciseQuestion
+    module AddInjectedExerciseId
+      def self.v1(book:)
+        book.pages.injected_questions.each(&:id)
+      end
+    end
+  end
+end

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

@@ -37,10 +37,22 @@ module Kitchen
         note.exercises.each do |exercise|
           exercise.problem.wrap_children('div', class: 'os-problem-container')
 
-          exercise.problem.prepend(child:
+          unless exercise.has_class?('unnumbered')
+            exercise.problem.prepend(child:
+              <<~HTML
+                <span class="os-title-label">#{I18n.t(:"exercises.exercise")} </span>
+                <span class="os-number">#{exercise.count_in(:note)}</span>
+              HTML
+            )
+          end
+
+          next unless exercise.solution
+
+          exercise.solution.wrap_children('div', class: 'os-solution-container')
+
+          exercise.solution.prepend(child:
             <<~HTML
-              <span class="os-title-label">#{I18n.t(:"exercises.exercise")} </span>
-              <span class="os-number">#{exercise.count_in(:note)}</span>
+              <span class="os-title-label">#{I18n.t(:"exercises.solution")}</span>
             HTML
           )
         end

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

@@ -62,6 +62,9 @@ module Kitchen
           elsif table.column_header?
             custom_table = CustomBody.new(table: table, klass: 'column-header')
             custom_table.modify_body(has_fake_title: false)
+          elsif table.text_heavy?
+            custom_table = CustomBody.new(table: table, klass: 'text-heavy')
+            custom_table.modify_body(has_fake_title: false)
           end
         end
       end

data/lib/kitchen/directions/bake_unnumbered_tables.rb

@@ -9,6 +9,7 @@ module Kitchen
           table.remove_attribute('summary')
           table.parent.add_class('os-unstyled-container') if table.unstyled?
           table.parent.add_class('os-column-header-container') if table.column_header?
+          table.parent.add_class('os-top-titled-container') if table.top_titled?
         end
       end
     end

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

@@ -38,7 +38,9 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
           </div>
         HTML
       )
-      strategy.bake(chapter: chapter, append_to: append_to.first("[data-uuid-key='#{uuid_key}']"))
+      strategy.bake(
+        chapter: chapter, append_to: append_to.first("div[data-uuid-key='#{uuid_key}']")
+      )
     end
     # rubocop:enable Metrics/ParameterLists
   end

data/lib/kitchen/element_base.rb

@@ -427,23 +427,6 @@ module Kitchen
       )
     end
 
-    # Searches for elements handled by a list of enumerator classes.  All element that
-    # matches one of those enumerator classes are iterated over.
-    #
-    # @param enumerator_classes [Array<ElementEnumeratorBase>]
-    # @return [TypeCastingElementEnumerator]
-    #
-    def search_with(*enumerator_classes)
-      block_error_if(block_given?)
-      raise 'must supply at least one enumerator class' if enumerator_classes.empty?
-
-      factory = enumerator_classes[0].factory
-      enumerator_classes[1..-1].each do |enumerator_class|
-        factory = factory.or_with(enumerator_class.factory)
-      end
-      factory.build_within(self)
-    end
-
     # Removes the element from its parent and places it on the specified clipboard
     #
     # @param to [Symbol, String, Clipboard, nil] the name of the clipboard (or a Clipboard
@@ -770,7 +753,8 @@ module Kitchen
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
                    :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
-                   :composite_pages, :composite_chapters, :solutions, :injected_questions
+                   :composite_pages, :composite_chapters, :solutions, :injected_questions,
+                   :search_with
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -327,6 +327,23 @@ module Kitchen
       chain_to(ElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Searches for elements handled by a list of enumerator classes.  All element that
+    # matches one of those enumerator classes are iterated over.
+    #
+    # @param enumerator_classes [Array<ElementEnumeratorBase>]
+    # @return [TypeCastingElementEnumerator]
+    #
+    def search_with(*enumerator_classes)
+      block_error_if(block_given?)
+      raise 'must supply at least one enumerator class' if enumerator_classes.empty?
+
+      factory = enumerator_classes[0].factory
+      enumerator_classes[1..-1].each do |enumerator_class|
+        factory = factory.or_with(enumerator_class.factory)
+      end
+      factory.build_within(self)
+    end
+
     # Returns an enumerator that iterates through elements within the scope of this enumerator
     #
     # @param enumerator_class [ElementEnumeratorBase] the enumerator to use for the iteration

data/lib/kitchen/note_element.rb

@@ -33,7 +33,9 @@ module Kitchen
       # 1. it is the note body's first child
       # 2. it is the first child's first child and the first child is a paragraph
       first_child = first_note_body_child
-      first_grandchild = first_child&.element_children&.[](0) if first_child.name == 'p'
+      return unless first_child
+
+      first_grandchild = get_first_grandchild_for_title(first_child)
 
       if first_child.data_type == 'title'
         first_child
@@ -47,6 +49,10 @@ module Kitchen
       note_body ? note_body.element_children[0] : element_children[0]
     end
 
+    def get_first_grandchild_for_title(first_child)
+      first_child&.element_children&.[](0) if first_child.name == 'p'
+    end
+
     # Returns true if the note's title is autogenerated
     #
     # @return [Boolean]

data/lib/kitchen/table_element.rb

@@ -97,6 +97,14 @@ module Kitchen
       has_class?('column-header')
     end
 
+    # Returns true if the table is text heavy
+    #
+    # @return [Boolean]
+    #
+    def text_heavy?
+      has_class?('text-heavy')
+    end
+
     # Returns an element for the table caption, if present
     #
     # @return [Element, nil]

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -27,6 +27,7 @@ en:
   section_exercises: ! 'Section %{number} Exercises'
   iframe_link_text: Click to view content
   handbook_outline_title: Outline
+  context_lead_text: 'Refer to '
   eoc:
     glossary: Key Terms
     key-equations: Key Equations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 12.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -294,7 +294,8 @@ files:
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
 - lib/kitchen/directions/bake_injected_exercise.rb
-- lib/kitchen/directions/bake_injected_exercise_question.rb
+- lib/kitchen/directions/bake_injected_exercise/add_injected_exercise_id.rb
+- lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise_question.rb
 - lib/kitchen/directions/bake_inline_lists.rb
 - lib/kitchen/directions/bake_learning_objectives.rb
 - lib/kitchen/directions/bake_link_placeholders.rb