openstax_kitchen 11.1.0 → 12.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4340461612470e8ddff3976af6bf342821a18f1e01c70d5c6d4dcbf08636ac24
-  data.tar.gz: 293967ff3cf8af70f6d9d5f5d20866c77608af41c279590b3abb39966813f048
+  metadata.gz: f36305ee23acfe22fc13a9c06ee76f69243f1cd2cba33fe86c28c8c90b5eb36d
+  data.tar.gz: fd501ef342ff2c7334455cc214139581dadf1619fde7841a29650b4fc10acd79
 SHA512:
-  metadata.gz: 70eedaaa535e97066b5b5b0d80e9c8916ffb6de5ecdf063f7a58d2c984253771742832278e53f5ce8bea3f0f3c7cbdd97da058258e5ace42dda0da372243ff2d
-  data.tar.gz: 72001901b5c82c46bd835521d9a815d178cc6bcea04502fd6b9b10bf36309ed42028b92714fd003e1a0042c60ce9eb4ab505dc627d8dd763f9c6892ff1fee7ea
+  metadata.gz: e3b939d8a9851db4940213aae3350f720369eb794b8551627d2a44565af36aeda5ad701b62c2c1ec98fb7dcfabafa8bd2e4531642bf40dd777a635c0117560b6
+  data.tar.gz: 5ec8d3e59faa619a3b23a84ce74514c96b6d360dc1b46d233cd1566b63815a5a7edaa73980f102b4c6656c603c43ea349fcc2eac99149cbafb8fa91d8f0e2fdc

data/CHANGELOG.md

@@ -6,6 +6,48 @@ 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)
+* Modify `BakeFigure` to bake unnumbered figures with caption (minor)
+* Fix `NoteElement#title` to be more specific about finding the title (patch)
+* Adds `data-type="slug"` to `metadata_lement` `children_to_keep` method, updates spec helper `metadata_element` and related spec files(minor)
+
+## [12.0.0] - 2021-09-21
+
+* Fixes `BakeStepwise` to skip nested lists (patch)
+* Adds an optional selector to `RemoveSectionTitles` (minor)
+* Patches `BakeFreeResponse` to only delete the first h3, not all h3s (patch)
+* Lets `BakeExample` not count titles in lists as commentary titles (minor)
+* Renames `BakePageAbstracts` to `BakeLearningObjectives` and adds optional parameter for titles in `v2` (major)
+* Gets rid of extraneous titles in `BakeAutoTitledNotes` when subtitles are off (minor)
+* Adds `BakeAutotitledExercise` direction and the option to `bake_unclassified_exercises` within `BakeAutotitledNotes`
+* Adds optional numbering for `BakeReferences.v1` (minor)
+* Patches`BakeNumberedNotes.v3` to suppress solutions outside examples when suppress_solutions is true (minor)
+
+## [11.2.0] - 2021-09-10
+
+* Adds `BakeAccessibilityFixes` direction for (minor)
+* Remove deprecation warning from `BakeChapterIntroductions.v1` and adapted to be used like `.v2` (minor)
+* Small class fix for `BakeFootnotes.v1` (patch)
+* Fix `BakeNumberedNotes` to find related example better (minor)
+* Small fix for parameter in `bake_note` definition (minor)
+* Small fixes to return when no elements are found and not add an empty wrapper in `BakeChapterReferences` and
+`BakeFreeResponse` (minor)
+* Adding class `os-timeline-table-container` to numbered tables when required (minor)
+* Fix `BakeExample` to catch the multiple solutions to one exercise (patch)
+
 ## [11.1.0] - 2021-08-30
 
 * Update injected questions to synthesize ids during baking (minor)

data/Gemfile.lock

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

data/lib/kitchen/chapter_element.rb

@@ -68,5 +68,12 @@ module Kitchen
       search('div[data-type="abstract"]')
     end
 
+    # Returns an enumerator for the learning objectives
+    #
+    # @return [ElementEnumerator]
+    #
+    def learning_objectives
+      search('section.learning-objectives')
+    end
   end
 end

data/lib/kitchen/directions/bake_accessibility_fixes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAccessibilityFixes
+      def self.v1(section:)
+        section.search('ol[data-number-style="lower-alpha"]').each { |ol| ol['type'] = 'a' }
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_autotitled_exercise/main.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAutotitledExercise
+      def self.v1(exercise:, number: nil)
+        V1.new.bake(exercise: exercise, number: number)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  class V1
+    def bake(exercise:, number:)
+      exercise.add_class('unnumbered') unless number
+
+      # bake problem
+      exercise.problem.wrap_children('div', class: 'os-problem-container')
+      exercise.problem.prepend(child:
+        <<~HTML
+          <h4 class="exercise-title" data-type="title">#{exercise.autogenerated_title}</h4>
+        HTML
+      )
+      return unless exercise.solution
+
+      # bake solution in place
+      exercise.solution.wrap_children('div', class: 'os-solution-container')
+      exercise.solution.prepend(child:
+        <<~HTML
+          <h4 class="solution-title" data-type="title">
+            <span class="os-text">#{I18n.t(:"exercises.solution")}</span>
+          </h4>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_introductions/bake_chapter_objectives.rb

@@ -18,6 +18,8 @@ module Kitchen::Directions::BakeChapterIntroductions
     def bake_as_note(chapter:)
       chapter_objectives_note = chapter.notes('$.chapter-objectives').first
 
+      return unless chapter_objectives_note.present?
+
       # trash existing title
       chapter_objectives_note.titles.first&.trash
       Kitchen::Directions::BakeAutotitledNotes.v1(

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

@@ -3,54 +3,14 @@
 module Kitchen::Directions::BakeChapterIntroductions
   class V1
     def bake(book:)
-      # <b>DEPRECATED:</b> Please use <tt>v2</tt> instead.
-      warn '[DEPRECATION] `BakeChapterIntroductions.v1` is deprecated. Please use `v2` instead.'
-
-      book.chapters.each do |chapter|
-        introduction_page = chapter.introduction_page
-
-        introduction_page.search("div[data-type='description']").trash
-        introduction_page.search("div[data-type='abstract']").trash
-
-        title = introduction_page.title.cut
-        title.name = 'h2'
-        Kitchen::Directions::MoveTitleTextIntoSpan.v1(title: title)
-
-        intro_content = introduction_page.search(
-          "> :not([data-type='metadata']):not(.splash):not(.has-splash)"
-        ).cut
-
-        chapter_objectives_html = chapter.non_introduction_pages.map do |page|
-          <<~HTML
-            <div class="os-chapter-objective">
-              <a class="os-chapter-objective" href="##{page.title[:id]}">
-                <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-                <span class="os-divider"> </span>
-                <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
-              </a>
-            </div>
-          HTML
-        end.join('')
-
-        chapter_outline =
-          Kitchen::Directions::BakeChapterIntroductions.bake_chapter_outline(
-            chapter_objectives_html: chapter_objectives_html
-          )
-
-        introduction_page.append(child:
-          <<~HTML
-            <div class="intro-body">
-              #{chapter_outline}
-              <div class="intro-text">
-                #{title.paste}
-                #{intro_content.paste}
-              </div>
-            </div>
-          HTML
-        )
-      end
-
-      Kitchen::Directions::BakeChapterIntroductions.v1_update_selectors(book)
+      Kitchen::Directions::BakeChapterIntroductions.v2(
+        book: book,
+        strategy_options: {
+          strategy: :add_objectives,
+          bake_chapter_outline: true,
+          introduction_order: :v1
+        }
+      )
     end
   end
 end

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

@@ -7,6 +7,8 @@ module Kitchen::Directions::BakeChapterReferences
         bake_page_references(page: page)
       end
 
+      return if chapter.pages.references.none?
+
       content = chapter.pages.references.cut.paste
 
       Kitchen::Directions::EocCompositePageContainer.v1(

data/lib/kitchen/directions/bake_eoc_section_content/remove_section_title.rb

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module RemoveSectionTitle
-      def self.v1(section:)
-        section.first('[data-type="title"]')&.trash
+      def self.v1(section:, selector: '')
+        section.first("#{selector}[data-type=\"title\"]")&.trash
       end
     end
   end

data/lib/kitchen/directions/bake_example.rb

@@ -30,9 +30,9 @@ module Kitchen
             problem.wrap_children(class: 'os-problem-container')
           end
 
-          if (solution = exercise.solution)
+          exercise.solutions.each do |solution|
             solution_number = if numbered_solutions
-                                "<span class=\"os-number\">#{exercise.count_in(:example)}</span>"
+                                "<span class=\"os-number\">#{solution.count_in(:example)}</span>"
                               else
                                 ''
                               end
@@ -53,7 +53,7 @@ module Kitchen
           next unless commentary.present?
 
           commentary_title = commentary.titles.first
-          next unless commentary_title.present?
+          next unless commentary_title.present? && commentary_title.parent['data-type'] != 'list'
 
           commentary_title.name = 'h4'
           commentary_title['data-type'] = 'commentary-title'

data/lib/kitchen/directions/bake_figure.rb

@@ -4,10 +4,11 @@ module Kitchen
   module Directions
     module BakeFigure
       def self.v1(figure:, number:, cases: false)
-        return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
+        return if figure.has_class?('unnumbered') && !figure.has_class?('splash') && !figure.caption
 
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
-        if figure.has_class?('unnumbered') && figure.has_class?('splash')
+
+        if figure.has_class?('unnumbered') && (figure.caption || figure.has_class?('splash'))
           caption = figure.caption&.cut
           figure.append(sibling:
             <<~HTML

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

@@ -28,7 +28,11 @@ module Kitchen::Directions::BakeFootnotes
         anchor.replace_children(with: footnote_number)
         aside_id = anchor[:href][1..-1]
         aside_id_to_footnote_number[aside_id] = footnote_number
-        anchor.parent.add_class('has-noteref') if anchor.parent.name == 'p'
+        if anchor.parent.name == 'p'
+          anchor.parent.add_class('has-noteref')
+        elsif anchor.parent.name == 'em' && anchor.parent.parent.name == 'p'
+          anchor.parent.parent.add_class('has-noteref')
+        end
       end
 
       container.search('aside').each do |aside|

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

@@ -12,7 +12,7 @@ module Kitchen::Directions::BakeFreeResponse
         free_response_questions = page.free_response
         next if free_response_questions.none?
 
-        free_response_questions.search('h3').trash
+        free_response_questions.search('h3')&.first&.trash
         title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
         free_response_questions.each do |free_response_question|
           free_response_question.prepend(child: title)
@@ -20,6 +20,8 @@ module Kitchen::Directions::BakeFreeResponse
         end
       end
 
+      return if @free_response_clipboard.none?
+
       append_to_element = append_to || chapter
       @title_tag = append_to ? 'h3' : 'h2'
 

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_page_abstracts.rb → bake_learning_objectives.rb}

@@ -2,17 +2,22 @@
 
 module Kitchen
   module Directions
-    # Adds learning objectives header to abstracts
-    module BakePageAbstracts
+    module BakeLearningObjectives
       def self.v1(chapter:)
         chapter.abstracts.each do |abstract|
           abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
         end
       end
 
-      def self.v2(chapter:)
-        chapter.abstracts.each do |abstract|
-          abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
+      def self.v2(chapter:, add_title: true)
+        learning_objectives =
+          chapter.abstracts.any? ? chapter.abstracts : chapter.learning_objectives
+
+        learning_objectives.each do |abstract|
+          if add_title
+            abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
+          end
+
           ul = abstract.first!('ul')
           ul.add_class('os-abstract')
           ul.search('li').each_with_index do |li, index|

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

@@ -3,19 +3,24 @@
 module Kitchen
   module Directions
     module BakeAutotitledNotes
-      def self.v1(book:, classes:, bake_subtitle: true, cases: false)
+      def self.v1(book:, classes:, bake_subtitle: true, cases: false, bake_exercises: false)
         book.notes.each do |note|
           next unless (note.classes & classes).any?
 
-          bake_note(note: note, bake_subtitle: bake_subtitle, cases: cases)
+          bake_note(
+            note: note, bake_subtitle: bake_subtitle, cases: cases, bake_exercises: bake_exercises)
         end
       end
 
-      def self.bake_note(note:, bake_subtitle:, cases: false)
+      def self.bake_note(note:, bake_subtitle:, cases:, bake_exercises:)
         Kitchen::Directions::BakeIframes.v1(outer_element: note)
         note.wrap_children(class: 'os-note-body')
 
-        BakeNoteSubtitle.v1(note: note, cases: cases) if bake_subtitle
+        if bake_subtitle
+          BakeNoteSubtitle.v1(note: note, cases: cases)
+        else
+          note.title&.trash
+        end
 
         note.prepend(child:
           <<~HTML
@@ -24,6 +29,33 @@ module Kitchen
             </h3>
           HTML
         )
+
+        bake_unclassified_exercises(note: note) if bake_exercises
+      end
+
+      def self.bake_unclassified_exercises(note:)
+        note.exercises.each do |exercise|
+          exercise.problem.wrap_children('div', class: 'os-problem-container')
+
+          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.solution")}</span>
+            HTML
+          )
+        end
       end
     end
   end

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

@@ -9,6 +9,9 @@ module Kitchen::Directions
           book.chapters.pages.notes("$.#{klass}").each do |note|
             note.wrap_children(class: 'os-note-body')
             previous_example = note.previous
+            until previous_example.nil? || previous_example[:'data-type'] == 'example'
+              previous_example = previous_example.previous
+            end
             os_number = previous_example&.first('.os-number')&.children&.to_s
 
             note.prepend(child:
@@ -29,6 +32,8 @@ module Kitchen::Directions
             note.injected_questions.each do |question|
               BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
             end
+
+            note.search("div[data-type='solution']").each&.trash if suppress_solution
           end
         end
       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_numbered_table/v1.rb

@@ -38,6 +38,8 @@ module Kitchen::Directions::BakeNumberedTable
           </div>
         HTML
       )
+
+      table.parent.add_class('os-timeline-table-container') if table.has_class?('timeline-table')
     end
   end
 end

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

@@ -26,6 +26,8 @@ module Kitchen::Directions::BakeNumberedTable
           </div>
         HTML
       )
+
+      table.parent.add_class('os-timeline-table-container') if table.has_class?('timeline-table')
     end
   end
 end

data/lib/kitchen/directions/bake_references/main.rb

@@ -5,10 +5,11 @@ module Kitchen
     # Bake directions for EOB references
     #
     module BakeReferences
-      def self.v1(book:, metadata_source:)
+      def self.v1(book:, metadata_source:, numbered_title: false)
         V1.new.bake(
           book: book,
-          metadata_source: metadata_source
+          metadata_source: metadata_source,
+          numbered_title: numbered_title
         )
       end
 

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

@@ -4,7 +4,7 @@ module Kitchen::Directions::BakeReferences
   class V1
     renderable
 
-    def bake(book:, metadata_source:)
+    def bake(book:, metadata_source:, numbered_title:)
       @metadata = metadata_source.children_to_keep.copy
       @klass = 'reference'
       @uuid_prefix = '.'
@@ -28,12 +28,17 @@ module Kitchen::Directions::BakeReferences
         end
 
         chapter_references = chapter.pages.references.cut
-        chapter_title_no_num = chapter.title.search('.os-text')
+
+        chapter_title = if numbered_title
+                          chapter.title.search('.os-number, .os-divider, .os-text')
+                        else
+                          chapter.title.search('.os-text')
+                        end
 
         chapter.append(child:
           <<~HTML
             <div class="os-chapter-area">
-              <h2 data-type="document-title">#{chapter_title_no_num}</h2>
+              <h2 data-type="document-title">#{chapter_title}</h2>
               #{chapter_references.paste}
             </div>
           HTML

data/lib/kitchen/directions/bake_stepwise.rb

@@ -8,7 +8,7 @@ module Kitchen
           ol.remove_class('stepwise')
           ol.add_class('os-stepwise')
 
-          ol.search('li').each_with_index do |li, ii|
+          ol.search('> li').each_with_index do |li, ii|
             li.wrap_children('span', class: 'os-stepwise-content')
             li.prepend(child:
               <<~HTML

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

@@ -211,6 +211,14 @@ module Kitchen
       self[:id] = value
     end
 
+    # Returns the element's data-type
+    #
+    # @return [String]
+    #
+    def data_type
+      self[:'data-type']
+    end
+
     # A way to set values and chain them
     #
     # @param property [String, Symbol] the name of the property to set
@@ -419,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
@@ -762,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/example_element.rb

@@ -33,7 +33,8 @@ module Kitchen
           title.parent.has_class?('os-caption-container') || \
           title.parent.has_class?('os-caption') || \
           title.parent.name == 'caption' || \
-          title.parent[:'data-type'] == 'note'
+          title.parent.data_type == 'note' || \
+          title.parent.data_type == 'exercise'
         end
       )
     end

data/lib/kitchen/exercise_element.rb

@@ -39,6 +39,14 @@ module Kitchen
       first("div[data-type='solution']")
     end
 
+    # Returns the enumerator for solutions
+    #
+    # @return [ElementEnumerator]
+    #
+    def solutions
+      search("div[data-type='solution']")
+    end
+
     # Returns whether the exercise has been baked
     #
     # @return [Boolean]
@@ -46,5 +54,39 @@ module Kitchen
     def baked?
       search('div.os-problem-container').any?
     end
+
+    # Returns true if the exercise's title is autogenerated
+    #
+    # @return [Boolean]
+    #
+    def indicates_autogenerated_title?
+      detected_exercise_title_key != 0 && detected_exercise_title_key.present?
+    end
+
+    # Get the autogenerated title for this note
+    #
+    # @return [String]
+    #
+    def autogenerated_title
+      if indicates_autogenerated_title?
+        I18n.t(:"exercises.#{detected_exercise_title_key}")
+      else
+        "unknown title for exercise with classes #{classes}"
+      end
+    end
+
+    def detected_exercise_title_key
+      @detected_exercise_title_key ||= begin
+        return 0 if classes.empty? || !I18n.t('.').key?(:exercises)
+
+        possible_keys = I18n.t(:exercises).keys.map(&:to_s)
+        keys = possible_keys & classes
+
+        raise("too many translation keys: #{keys.join(', ')}") if keys.many?
+        return 0 if keys.empty?
+
+        keys.first
+      end
+    end
   end
 end

data/lib/kitchen/figure_element.rb

@@ -53,7 +53,7 @@ module Kitchen
     # @return [Boolean]
     #
     def figure_to_bake?
-      return false if subfigure? || (has_class?('unnumbered') && !has_class?('splash'))
+      return false if subfigure? || (has_class?('unnumbered') && !has_class?('splash') && !caption)
 
       true
     end

data/lib/kitchen/metadata_element.rb

@@ -27,7 +27,12 @@ module Kitchen
     # @return [ElementEnumerator]
     #
     def children_to_keep
-      search(%w(span[data-type='revised'] div.authors div.publishers div.print-style div.permissions
+      search(%w(span[data-type='revised']
+                span[data-type='slug']
+                div.authors
+                div.publishers
+                div.print-style
+                div.permissions
                 div[data-type='subject']))
     end
   end

data/lib/kitchen/note_element.rb

@@ -29,16 +29,30 @@ module Kitchen
     #
     def title
       block_error_if(block_given?)
-      note_body = first('div.os-note-body')
-      first_child = note_body ? note_body.element_children[0] : element_children[0]
+      # An element with data-type="title" is ambiguous; it is only the note's title if:
+      # 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
+      return unless first_child
+
+      first_grandchild = get_first_grandchild_for_title(first_child)
 
-      if first_child[:'data-type'] == 'title'
+      if first_child.data_type == 'title'
         first_child
-      elsif first_child&.element_children&.[](0)&.[](:'data-type') == 'title'
-        first_child.element_children[0]
+      elsif first_grandchild&.data_type == 'title'
+        first_grandchild
       end
     end
 
+    def first_note_body_child
+      note_body = first('div.os-note-body')
+      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 = '11.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: 11.1.0
+  version: 12.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,9 +243,12 @@ files:
 - lib/kitchen/counter.rb
 - lib/kitchen/debug/print_recipe_error.rb
 - lib/kitchen/directions/.rubocop.yml
+- lib/kitchen/directions/bake_accessibility_fixes.rb
 - lib/kitchen/directions/bake_annotation_classes/main.rb
 - lib/kitchen/directions/bake_annotation_classes/v1.rb
 - lib/kitchen/directions/bake_appendix.rb
+- lib/kitchen/directions/bake_autotitled_exercise/main.rb
+- lib/kitchen/directions/bake_autotitled_exercise/v1.rb
 - lib/kitchen/directions/bake_chapter_glossary/main.rb
 - lib/kitchen/directions/bake_chapter_glossary/v1.rb
 - lib/kitchen/directions/bake_chapter_introductions/bake_chapter_objectives.rb
@@ -291,8 +294,10 @@ 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
 - lib/kitchen/directions/bake_lists_with_para.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
@@ -310,7 +315,6 @@ files:
 - 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