openstax_kitchen 12.0.0 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc1370c1b05b52bdf0df2f0a7cd4624b1725f39aae33f57f9715e091a358f8d
-  data.tar.gz: fcd328b3dd9c091f2461e3acd22db036c02c4005bb5c8f31071096ed96461179
+  metadata.gz: fe096a5d1994a88a6a1e3d0d585bc76ff216157550eec29df3a37da3aa36f229
+  data.tar.gz: 38f20f8be2ae246005c047ea0702e0e2a266b039e534fe0b063157054609873d
 SHA512:
-  metadata.gz: fd04ee2890144c697d9ab1ff10f97b9593f594eca116856bc6f26edb51f28e6330a0daca42c23e29d7bc08f2d336e764c957dcf93d6f638a22be1572a3ab939c
-  data.tar.gz: bb270311e092585ef966c4f2ba76d8847d7fbaedaae9c102274363ac5c21bbf411a6af5ebd7689c6b8ffd02d81ea46b586cd2273eab26320f21c559d28019bcb
+  metadata.gz: 20d6729f702ada57a80cf10bf5851562e1649e10ff002f98dc56a30f438aecee2b242e7a377af49313344b73b604d690eb2c8f7acd903cddafd32a0b7505fc2f
+  data.tar.gz: bf8d77b0693a23cc1332d5c40c6eea39aeed0e1b1cb3c83017d60ad3541280c210fde867063551c52afe5e76198add5cfd5af960ab55b3f0cd617492e262658c

data/CHANGELOG.md

@@ -6,6 +6,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [14.0.0] - 2021-10-22
+
+Fix `BakeAutotitledExercise` V2 to stop breaking for exercises without solutions (patch)
+Add `BakeAutotitledExercise` V2 (minor)
+Fix `BakeChapterGlossary::V1` to stop adding an empty wrapper if there is no content (patch)
+* Create `BakeNoteExercise` and `BakeNoteInjectedQuestion` and support exercises in `BakeUnclassifiedNotes` (minor)
+* Add baking section with class `column header` to `BakeAppendix` (patch)
+* Expand `BakeAnnotationClasses` to book from chapter to bake also paragraphs from Preface (major)
+* Create separate direction `BakeUnnumberedFigure`, clean `BakeFigure` to not match unnumbered figures , rename and update `figure_to_bake?` method to `figure_to_number?` to support only numbered figures except subfigures (major)
+
+## [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)

data/Gemfile

@@ -9,3 +9,4 @@ gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 
 gem 'codecov', require: false
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (12.0.0)
+    openstax_kitchen (14.0.0)
       activesupport
       i18n
       nokogiri
@@ -107,7 +107,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.24)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

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

@@ -3,9 +3,9 @@
 module Kitchen
   module Directions
     module BakeAnnotationClasses
-      def self.v1(chapter:)
+      def self.v1(book:)
         V1.new.bake(
-          chapter: chapter)
+          book: book)
       end
     end
   end

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

@@ -2,8 +2,8 @@
 
 module Kitchen::Directions::BakeAnnotationClasses
   class V1
-    def bake(chapter:)
-      chapter.search('p.annotation').each do |annotation|
+    def bake(book:)
+      book.search('p.annotation').each do |annotation|
         annotation.wrap_children('span', class: 'os-text')
         annotation.prepend(child:
           <<~HTML
@@ -19,7 +19,7 @@ module Kitchen::Directions::BakeAnnotationClasses
                                    auditory-icon
                                    kinesthetic-icon]
       annotation_icon_classes.each do |annotation_icon_class|
-        chapter.search("p.#{annotation_icon_class}").each do |annotation_with_icon_class|
+        book.search("p.#{annotation_icon_class}").each do |annotation_with_icon_class|
           annotation_with_icon_class.search('div.os-icons').first.append(child:
             <<~HTML
               <span class = "#{annotation_icon_class}"></span>

data/lib/kitchen/directions/bake_appendix.rb

@@ -21,6 +21,7 @@ module Kitchen
           next unless title.present?
 
           title.name = "h#{section['data-depth'].to_i + 1}"
+          section.name = 'div' if section.has_class?('column-container')
         end
       end
     end

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

@@ -6,6 +6,10 @@ module Kitchen
       def self.v1(exercise:, number: nil)
         V1.new.bake(exercise: exercise, number: number)
       end
+
+      def self.v2(exercise:, title:)
+        V2.new.bake(exercise: exercise, title: title)
+      end
     end
   end
 end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  # Differences from V1:
+  # 1. Title is an <h3><span>, not <h4>, & above the problem instead of within it
+  # 2. Title is generated in the recipe and passed to the method
+  class V2
+    def bake(exercise:, title:)
+      exercise.add_class('unnumbered')
+      exercise.titles.first&.trash
+
+      # bake problem
+      exercise.prepend(child:
+        <<~HTML
+          <h3 class="os-title" data-type="title">
+            <span class="os-title-label">#{title}</span>
+          </h3>
+        HTML
+      )
+      exercise.problem.wrap_children(class: 'os-problem-container')
+      return unless exercise.solution
+
+      exercise.solution.wrap_children(class: 'os-solution-container')
+      exercise.solution.prepend(child:
+        <<~HTML
+          <h4 class="solution-title" data-type="title">
+            <span class="os-text">#{I18n.t(:solution)}</span>
+          </h4>
+        HTML
+      )
+    end
+  end
+end

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

@@ -41,7 +41,9 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      return if content.empty?
+
+      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_figure.rb

@@ -4,26 +4,13 @@ module Kitchen
   module Directions
     module BakeFigure
       def self.v1(figure:, number:, cases: false)
-        return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
-
+        warn 'warning! exclude unnumbered figures from `BakeFigure` loop' if figure.unnumbered?
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
-        if figure.has_class?('unnumbered') && figure.has_class?('splash')
-          caption = figure.caption&.cut
-          figure.append(sibling:
-            <<~HTML
-              <div class="os-caption-container">
-                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
-              </div>
-            HTML
-          )
-          return
-        end
 
         # Store label information
         figure.target_label(label_text: 'figure', custom_content: number, cases: cases)
 
         title = figure.title&.cut
-
         caption = figure.caption&.cut
         figure.append(sibling:
           <<~HTML

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

@@ -30,6 +30,19 @@ module Kitchen
           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

@@ -30,20 +30,7 @@ module Kitchen
           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')
-
-          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
+        BakeNoteExercise.v2(note: note) if bake_exercises
       end
     end
   end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteExercise
+      def self.v1(note:, exercise:, divider: ' ', suppress_solution: false)
+        exercise.add_class('unnumbered')
+        number = note.first('.os-number').text.gsub(/#/, '')
+
+        # bake problem
+        exercise.problem.wrap_children('div', class: 'os-problem-container')
+        exercise.search('[data-type="commentary"]').each(&:trash)
+        return unless exercise.solution
+
+        # bake solution in place
+        if suppress_solution
+          exercise.add_class('os-hasSolution')
+          exercise.solution.trash
+        else
+          BakeNumberedExercise.bake_solution_v1(
+            exercise: exercise,
+            number: number,
+            divider: divider
+          )
+        end
+      end
+
+      def self.v2(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
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteInjectedQuestion
+      def self.v1(note:, question:)
+        question.add_class('unnumbered')
+        number = note.first('.os-number').text.gsub(/#/, '')
+        Kitchen::Directions::BakeInjectedExerciseQuestion.v1(
+          question: question, number: number, only_number_solution: true
+        )
+      end
+    end
+  end
+end

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

@@ -17,37 +17,6 @@ module Kitchen
       def self.v3(book:, classes:, suppress_solution: true)
         V3.new.bake(book: book, classes: classes, suppress_solution: suppress_solution)
       end
-
-      # Used by V1, V2, V3
-      def self.bake_note_exercise(note:, exercise:, divider: ' ', suppress_solution: false)
-        exercise.add_class('unnumbered')
-        number = note.first('.os-number').text.gsub(/#/, '')
-
-        # bake problem
-        exercise.problem.wrap_children('div', class: 'os-problem-container')
-        exercise.search('[data-type="commentary"]').each(&:trash)
-        return unless exercise.solution
-
-        # bake solution in place
-        if suppress_solution
-          exercise.add_class('os-hasSolution')
-          exercise.solution.trash
-        else
-          BakeNumberedExercise.bake_solution_v1(
-            exercise: exercise,
-            number: number,
-            divider: divider
-          )
-        end
-      end
-
-      def self.bake_note_injected_question(note:, question:)
-        question.add_class('unnumbered')
-        number = note.first('.os-number').text.gsub(/#/, '')
-        Kitchen::Directions::BakeInjectedExerciseQuestion.v1(
-          question: question, number: number, only_number_solution: true
-        )
-      end
     end
   end
 end

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

@@ -8,10 +8,10 @@ module Kitchen::Directions
           book.chapters.pages.notes("$.#{klass}").each do |note|
             bake_note(note: note, cases: cases)
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise)
+              BakeNoteExercise.v1(note: note, exercise: exercise)
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
           end
         end

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

@@ -17,10 +17,10 @@ module Kitchen::Directions
               HTML
             )
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise, divider: '. ')
+              BakeNoteExercise.v1(note: note, exercise: exercise, divider: '. ')
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
           end
         end

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

@@ -25,12 +25,12 @@ module Kitchen::Directions
 
             note.title&.trash
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(
+              BakeNoteExercise.v1(
                 note: note, exercise: exercise, divider: '. ', suppress_solution: suppress_solution
               )
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
 
             note.search("div[data-type='solution']").each&.trash if suppress_solution

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

@@ -3,15 +3,15 @@
 module Kitchen
   module Directions
     module BakeUnclassifiedNotes
-      def self.v1(book:)
+      def self.v1(book:, bake_exercises: false)
         book.notes.each do |note|
           next unless note.classes.empty?
 
-          bake_note(note: note)
+          bake_note(note: note, bake_exercises: bake_exercises)
         end
       end
 
-      def self.bake_note(note:)
+      def self.bake_note(note:, bake_exercises:)
         note.wrap_children(class: 'os-note-body')
 
         title = note.title&.cut
@@ -24,6 +24,8 @@ module Kitchen
             </h3>
           HTML
         )
+
+        BakeNoteExercise.v2(note: note) if bake_exercises
       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

@@ -6,18 +6,15 @@ module Kitchen
     #
     module BakeReferences
       def self.v1(book:, metadata_source:, numbered_title: false)
-        V1.new.bake(
-          book: book,
-          metadata_source: metadata_source,
-          numbered_title: numbered_title
-        )
+        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

@@ -5,11 +5,6 @@ module Kitchen::Directions::BakeReferences
     renderable
 
     def bake(book:, metadata_source:, numbered_title:)
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'reference'
-      @uuid_prefix = '.'
-      @title = I18n.t(:references)
-
       book.chapters.each do |chapter|
         chapter.search('[data-type="cite"]').each do |link|
           link.prepend(child:
@@ -44,10 +39,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: '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_unnumbered_figure.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeUnnumberedFigure
+      def self.v1(book:)
+        book.figures(only: :unnumbered?).each do |figure|
+          next unless figure.caption || figure.title
+
+          figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+          title = figure.title&.cut
+          caption = figure.caption&.cut
+          figure.append(sibling:
+            <<~HTML
+              <div class="os-caption-container">
+                #{"<span class=\"os-title\" data-type=\"title\" id=\"#{title.id}\">#{title.children}</span>" if title}
+                #{'<span class="os-divider"> </span>' if title && caption}
+                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
+              </div>
+            HTML
+          )
+        end
+      end
+    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/{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/figure_element.rb

@@ -47,16 +47,24 @@ module Kitchen
       parent.name == 'figure'
     end
 
+    # Returns true if the figure is unnumbered
+    #
+    # @return [Boolean]
+    #
+
+    def unnumbered?
+      has_class?('unnumbered')
+    end
+
     # Returns true unless the figure is a subfigure or has the 'unnumbered' class,
     # unless the figure has both the 'unnumbered' and the 'splash' classes.
     #
     # @return [Boolean]
-    #
-    def figure_to_bake?
-      return false if subfigure? || (has_class?('unnumbered') && !has_class?('splash'))
+
+    def figure_to_number?
+      return false if subfigure? || unnumbered?
 
       true
     end
-
   end
 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 = '12.0.0'
+  VERSION = '14.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: 12.0.0
+  version: 14.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -249,6 +249,7 @@ files:
 - 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_autotitled_exercise/v2.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
@@ -294,7 +295,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
@@ -302,6 +304,8 @@ files:
 - lib/kitchen/directions/bake_math_in_paragraph.rb
 - lib/kitchen/directions/bake_non_introduction_pages.rb
 - lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
+- lib/kitchen/directions/bake_notes/bake_note_exercise.rb
+- lib/kitchen/directions/bake_notes/bake_note_injected_question.rb
 - lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/main.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/v1.rb
@@ -319,6 +323,7 @@ files:
 - 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
@@ -326,6 +331,7 @@ files:
 - lib/kitchen/directions/bake_unit_page_title/v1.rb
 - lib/kitchen/directions/bake_unit_title/main.rb
 - lib/kitchen/directions/bake_unit_title/v1.rb
+- lib/kitchen/directions/bake_unnumbered_figure.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
 - lib/kitchen/directions/book_answer_key_container/eob_answer_key_outer_container.xhtml.erb
 - lib/kitchen/directions/book_answer_key_container/main.rb
@@ -333,8 +339,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
@@ -392,14 +398,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
@@ -461,7 +469,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/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>