openstax_kitchen 11.2.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e366a482a30f5cda88fe3c76731d3f187e727447cfc9ae1c13ff5e8bb99c1daa
-  data.tar.gz: 97db8d770c708fda67c566157989b0999fe12859eb515d52da73a86136ab9c29
+  metadata.gz: ddc1370c1b05b52bdf0df2f0a7cd4624b1725f39aae33f57f9715e091a358f8d
+  data.tar.gz: fcd328b3dd9c091f2461e3acd22db036c02c4005bb5c8f31071096ed96461179
 SHA512:
-  metadata.gz: d1b69721238c536696a265d4419f94944746a8a934f24c2e39d8beebe27b18fbd85b1da1599cf6cf326e2d44053b0927db0ab7edae3e24c1a5bfea44839555d9
-  data.tar.gz: 2b420da729d4282fc85f7b074c2848f83d7912a5ff75365ba91d6406b245a1442f0c3dd7074cc6744b44ba96cdc8d00a0a872b092f54a3865e0fd21daff3d81d
+  metadata.gz: fd04ee2890144c697d9ab1ff10f97b9593f594eca116856bc6f26edb51f28e6330a0daca42c23e29d7bc08f2d336e764c957dcf93d6f638a22be1572a3ab939c
+  data.tar.gz: bb270311e092585ef966c4f2ba76d8847d7fbaedaae9c102274363ac5c21bbf411a6af5ebd7689c6b8ffd02d81ea46b586cd2273eab26320f21c559d28019bcb

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 (12.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_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_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_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:)
+      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,21 @@ 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')
+
+          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
       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_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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 12.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-09-21 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
@@ -294,6 +296,7 @@ files:
 - lib/kitchen/directions/bake_injected_exercise.rb
 - lib/kitchen/directions/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,7 +314,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