openstax_kitchen 11.2.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e366a482a30f5cda88fe3c76731d3f187e727447cfc9ae1c13ff5e8bb99c1daa
-  data.tar.gz: 97db8d770c708fda67c566157989b0999fe12859eb515d52da73a86136ab9c29
+  metadata.gz: b0f1212b9bee542b587323cef1fa5ff8dc7437d47921736f58c9c27ef6ee11b8
+  data.tar.gz: ca01c38368dc34a0e637f431caf7873f97d5dd52b465e1ae5411d6f0861b8e58
 SHA512:
-  metadata.gz: d1b69721238c536696a265d4419f94944746a8a934f24c2e39d8beebe27b18fbd85b1da1599cf6cf326e2d44053b0927db0ab7edae3e24c1a5bfea44839555d9
-  data.tar.gz: 2b420da729d4282fc85f7b074c2848f83d7912a5ff75365ba91d6406b245a1442f0c3dd7074cc6744b44ba96cdc8d00a0a872b092f54a3865e0fd21daff3d81d
+  metadata.gz: c877a0d30bde86ccc5d0e2191b3e0efe853916294d907c764a088e67a2011f9f3fa03fb018ff8aa9992e1fbaeebb753625b90f593d888d8e8a4473139e9e0f43
+  data.tar.gz: f96e5128a718bf1897c65b5b558d2586e6905767e355cf9119c56b536f128bbbf403c658187e6faefc0bb7e7fc3013218353a81d99c1fc8dfc30a9ffed8354db

data/CHANGELOG.md

@@ -6,6 +6,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [13.0.0] - 2021-10-6
+
+* Add `BakeLearningObjectives` v3 (minor)
+* Fix `BakeIframes` to skip already-baked iframes (patch)
+* Add `SectionElement` and `SectionElementEnumerator` classes (minor)
+* Refactor `EocCompositePageContainer` to be used by `EOB` sections as well (major)
+* Refactor `bake_references` `v1, v2 and v3` to use `CompositePageContainer` (major)
+
+## [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)

data/Gemfile.lock

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

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_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_glossary/v1.rb

@@ -41,7 +41,7 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'glossary',
         uuid_key: "#{uuid_prefix}glossary",
         metadata_source: metadata_source,

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

@@ -11,7 +11,7 @@ module Kitchen::Directions::BakeChapterReferences
 
       content = chapter.pages.references.cut.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: klass,
         uuid_key: "#{uuid_prefix}#{klass}",
         metadata_source: metadata_source,

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

@@ -23,7 +23,7 @@ module Kitchen::Directions::BakeChapterSolutions
 
       content = solutions_clipboard.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'solutions',
         uuid_key: "#{uuid_prefix}solutions",
         metadata_source: metadata_source,

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -31,7 +31,7 @@ module Kitchen
 
           return if summaries.none?
 
-          EocCompositePageContainer.v1(
+          CompositePageContainer.v1(
             container_key: klass,
             uuid_key: "#{uuid_prefix}#{klass}",
             metadata_source: metadata_source,

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

@@ -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_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)

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

@@ -7,6 +7,8 @@ module Kitchen::Directions::BakeIframes
       return unless iframes.any?
 
       iframes.each do |iframe|
+        next if iframe.has_class?('os-is-iframe')
+
         iframe.wrap('<div class="os-has-iframe" data-type="alternatives">')
         iframe.add_class('os-is-iframe')
         link_ref = iframe[:src]

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_learning_objectives.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    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:, 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|
+            li.replace_children(with:
+              <<~HTML
+                <span class="os-abstract-token">#{chapter.count_in(:book)}.#{abstract.count_in(:chapter)}.#{index + 1}</span>
+                <span class="os-abstract-content">#{li.children}</span>
+              HTML
+            )
+          end
+        end
+      end
+
+      # Wraps & moves abstract under the corresponding chapter objective in the intro page
+      def self.v3(chapter:)
+        abstracts = chapter.abstracts.map do |abstract|
+          abstract.wrap('<div class="learning-objective">')
+          abstract.parent
+        end
+
+        chapter.introduction_page.search('div.os-chapter-objective') \
+               .each_with_index do |objective, index|
+          objective.append(child: abstracts[index].cut.paste)
+        end
+      end
+    end
+  end
+end

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:)
+      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

@@ -32,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_references/main.rb

@@ -5,18 +5,16 @@ module Kitchen
     # Bake directions for EOB references
     #
     module BakeReferences
-      def self.v1(book:, metadata_source:)
-        V1.new.bake(
-          book: book,
-          metadata_source: metadata_source
-        )
+      def self.v1(book:, metadata_source:, numbered_title: false)
+        V1.new.bake(book: book, metadata_source: metadata_source, numbered_title: numbered_title)
       end
 
       def self.v2(book:, metadata_source:)
-        V2.new.bake(
-          book: book,
-          metadata_source: metadata_source
-        )
+        V2.new.bake(book: book, metadata_source: metadata_source)
+      end
+
+      def self.v3(book:, metadata_source:)
+        V3.new.bake(book: book, metadata_source: metadata_source)
       end
     end
   end

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

@@ -4,12 +4,7 @@ module Kitchen::Directions::BakeReferences
   class V1
     renderable
 
-    def bake(book:, metadata_source:)
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'reference'
-      @uuid_prefix = '.'
-      @title = I18n.t(:references)
-
+    def bake(book:, metadata_source:, numbered_title:)
       book.chapters.each do |chapter|
         chapter.search('[data-type="cite"]').each do |link|
           link.prepend(child:
@@ -28,21 +23,32 @@ 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
         )
       end
+
       chapter_area_references = book.chapters.search('.os-chapter-area').cut
-      @content = chapter_area_references.paste
-      book.body.append(child: render(file:
-        '../../templates/eob_section_title_template.xhtml.erb'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'reference',
+        uuid_key: '.reference',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -2,14 +2,7 @@
 
 module Kitchen::Directions::BakeReferences
   class V2
-    renderable
-
     def bake(book:, metadata_source:)
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'references'
-      @uuid_prefix = '.'
-      @title = I18n.t(:references)
-
       book.chapters.each do |chapter|
 
         chapter.references.search('h3').trash
@@ -26,10 +19,16 @@ module Kitchen::Directions::BakeReferences
           HTML
         )
       end
+
       chapter_area_references = book.chapters.search('.os-chapter-area').cut
-      @content = chapter_area_references.paste
-      book.body.append(child: render(file:
-        '../../templates/eob_section_title_template.xhtml.erb'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V3
+    def bake(book:, metadata_source:)
+      return unless book.references.any?
+
+      book.chapters.pages.each do |page|
+        page.references.each do |reference|
+          reference.titles.trash
+          reference.prepend(child:
+            Kitchen::Directions::EocSectionTitleLinkSnippet.v1(
+              page: page,
+              title_tag: 'h2',
+              wrapper: nil
+            )
+          )
+        end
+      end
+
+      chapter_area_references = book.chapters.references.cut
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
+    end
+  end
+end

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/{eoc_composite_page_container → composite_page_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module EocCompositePageContainer
+    module CompositePageContainer
       # Creates a wrapper for the given content & appends it to the given element
       #
       # @param container_key [String] Appended to 'eoc.' to form the I18n key for the container title; also used as part of a class on the container.

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::CompositePageContainer
+  class V1
+    renderable
+
+    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
+      @in_composite_chapter = append_to.is?(:composite_chapter)
+      @is_eoc = append_to.is?(:chapter) || @in_composite_chapter
+      @section = @is_eoc ? 'eoc' : 'eob'
+      @title = I18n.t(:"#{@section}.#{container_key}")
+      @uuid_key = uuid_key
+      @container_class_type = container_key
+      @metadata = metadata_source.children_to_keep.copy
+      @content = content
+      @main_title_tag = 'h1'
+
+      if @in_composite_chapter
+        @main_title_tag = 'h3'
+      elsif @is_eoc
+        @main_title_tag = 'h2'
+      end
+
+      append_to.append(child: render(file:
+        '../../templates/composite_page_template.xhtml.erb'))
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module Kitchen::Directions::MoveCustomSectionToEocContainer
           section_clipboard.paste
         end
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: container_key,
         uuid_key: uuid_key,
         metadata_source: metadata_source,

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, :sections
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -318,6 +318,24 @@ module Kitchen
                css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through sections within the scope of this enumerator
+    #
+    # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
+    #   a "$" in this argument will be replaced with the default selector for the element being
+    #   iterated over.
+    # @param only [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will only be included in the
+    #   search results if the method or callable returns true
+    # @param except [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will not be included in the
+    #   search results if the method or callable returns false
+    #
+    def sections(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(SectionElementEnumerator,
+               css_or_xpath: css_or_xpath, only: only, except: except)
+    end
+
     # Returns an enumerator that iterates within the scope of this enumerator
     #
     # @param css_or_xpath [String] additional selectors to further narrow the element iterated over
@@ -327,6 +345,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

@@ -54,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/section_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class SectionElement < ElementBase
+
+    # Creates a new +SectionElement+
+    #
+    # @param node [Nokogiri::XML::Node] the node this element wraps
+    # @param document [Document] this element's document
+    #
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: SectionElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :section
+    end
+
+  end
+end

data/lib/kitchen/section_element_enumerator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for table elements
+  #
+  class SectionElementEnumerator < ElementEnumeratorBase
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:section),
+        sub_element_class: SectionElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/selectors/base.rb

@@ -62,6 +62,9 @@ module Kitchen
       # Selector for an injected question
       # @return [String]
       attr_accessor :injected_question
+      # Selector for a section
+      # @return [String]
+      attr_accessor :section
 
       # Override specific selectors
       #

data/lib/kitchen/selectors/standard_1.rb

@@ -29,6 +29,7 @@ module Kitchen
         self.solution                   = "div[data-type='solution'], " \
                                           "div[data-type='question-solution']"
         self.injected_question          = "div[data-type='exercise-question']"
+        self.section                    = 'section'
       end
 
     end

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/templates/composite_page_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-<%= @section%> os-<%=@container_class_type%>-container" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
+  <<%= @main_title_tag %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
+    <span class="os-text"><%= @title %></span>
+  </<%= @main_title_tag %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '11.2.0'
+  VERSION = '13.0.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
@@ -39,5 +40,8 @@ en:
   folio:
     preface: Preface
     access_for_free: Access for free at openstax.org
+  eob:
+    references: References
+    reference: References
   index:
     main: Index

data/lib/locales/es.yml

@@ -35,5 +35,8 @@ es:
   folio:
     preface: Prefacio
     access_for_free: Acceso gratis en openstax.org
+  eob:
+    references: Referencias
+    reference: Referencias
   index:
     main: Índice

data/lib/locales/pl.yml

@@ -67,6 +67,9 @@ pl:
     key-equations: Najważniejsze wzory
     summary: Podsumowanie
     references: Bibliografia
+  eob:
+    references: Bibliografia
+    reference: Bibliografia
   index:
     name: Skorowidz nazwisk
     term: Skorowidz rzeczowy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 13.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -247,6 +247,8 @@ files:
 - 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
@@ -292,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
@@ -311,12 +315,12 @@ 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
 - lib/kitchen/directions/bake_references/v1.rb
 - lib/kitchen/directions/bake_references/v2.rb
+- lib/kitchen/directions/bake_references/v3.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_toc.rb
@@ -331,8 +335,8 @@ files:
 - lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb
 - lib/kitchen/directions/chapter_review_container/main.rb
 - lib/kitchen/directions/chapter_review_container/v1.rb
-- lib/kitchen/directions/eoc_composite_page_container/main.rb
-- lib/kitchen/directions/eoc_composite_page_container/v1.rb
+- lib/kitchen/directions/composite_page_container/main.rb
+- lib/kitchen/directions/composite_page_container/v1.rb
 - lib/kitchen/directions/eoc_section_title_link_snippet.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/main.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/v1.rb
@@ -390,14 +394,16 @@ files:
 - lib/kitchen/references_element_enumerator.rb
 - lib/kitchen/search_history.rb
 - lib/kitchen/search_query.rb
+- lib/kitchen/section_element.rb
+- lib/kitchen/section_element_enumerator.rb
 - lib/kitchen/selector.rb
 - lib/kitchen/selectors/base.rb
 - lib/kitchen/selectors/standard_1.rb
 - lib/kitchen/solution_element_enumerator.rb
 - lib/kitchen/table_element.rb
 - lib/kitchen/table_element_enumerator.rb
+- lib/kitchen/templates/composite_page_template.xhtml.erb
 - lib/kitchen/templates/eob_section_title_template.xhtml.erb
-- lib/kitchen/templates/eoc_section_template.xhtml.erb
 - lib/kitchen/templates/eoc_section_template_old.xhtml.erb
 - lib/kitchen/term_element.rb
 - lib/kitchen/term_element_enumerator.rb
@@ -459,7 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: OpenStax content baking library

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    # Adds learning objectives header to abstracts
-    module BakePageAbstracts
-      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>")
-          ul = abstract.first!('ul')
-          ul.add_class('os-abstract')
-          ul.search('li').each_with_index do |li, index|
-            li.replace_children(with:
-              <<~HTML
-                <span class="os-abstract-token">#{chapter.count_in(:book)}.#{abstract.count_in(:chapter)}.#{index + 1}</span>
-                <span class="os-abstract-content">#{li.children}</span>
-              HTML
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::EocCompositePageContainer
-  class V1
-    renderable
-
-    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
-      @title = I18n.t(:"eoc.#{container_key}")
-      @uuid_key = uuid_key
-      @container_class_type = container_key
-      @metadata = metadata_source.children_to_keep.copy
-      @content = content
-      @in_composite_chapter = append_to.is?(:composite_chapter)
-
-      append_to.append(child: render(file:
-        '../../templates/eoc_section_template.xhtml.erb'))
-    end
-  end
-end

data/lib/kitchen/templates/eoc_section_template.xhtml.erb

@@ -1,11 +0,0 @@
-<% main_title_tag = @in_composite_chapter ? 'h3' : 'h2' %>
-<div class="os-eoc os-<%=@container_class_type%>-container" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
-  <<%= main_title_tag %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
-    <span class="os-text"><%= @title %></span>
-  </<%= main_title_tag %>>
-  <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
-    <%= @metadata.paste %>
-  </div>
-  <%= @content %>
-</div>