openstax_kitchen 13.0.0 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f1212b9bee542b587323cef1fa5ff8dc7437d47921736f58c9c27ef6ee11b8
-  data.tar.gz: ca01c38368dc34a0e637f431caf7873f97d5dd52b465e1ae5411d6f0861b8e58
+  metadata.gz: fe096a5d1994a88a6a1e3d0d585bc76ff216157550eec29df3a37da3aa36f229
+  data.tar.gz: 38f20f8be2ae246005c047ea0702e0e2a266b039e534fe0b063157054609873d
 SHA512:
-  metadata.gz: c877a0d30bde86ccc5d0e2191b3e0efe853916294d907c764a088e67a2011f9f3fa03fb018ff8aa9992e1fbaeebb753625b90f593d888d8e8a4473139e9e0f43
-  data.tar.gz: f96e5128a718bf1897c65b5b558d2586e6905767e355cf9119c56b536f128bbbf403c658187e6faefc0bb7e7fc3013218353a81d99c1fc8dfc30a9ffed8354db
+  metadata.gz: 20d6729f702ada57a80cf10bf5851562e1649e10ff002f98dc56a30f438aecee2b242e7a377af49313344b73b604d690eb2c8f7acd903cddafd32a0b7505fc2f
+  data.tar.gz: bf8d77b0693a23cc1332d5c40c6eea39aeed0e1b1cb3c83017d60ad3541280c210fde867063551c52afe5e76198add5cfd5af960ab55b3f0cd617492e262658c

data/CHANGELOG.md

@@ -6,6 +6,15 @@ 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
 

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 (13.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,6 +41,8 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
+      return if content.empty?
+
       Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'glossary',
         uuid_key: "#{uuid_prefix}glossary",

data/lib/kitchen/directions/bake_figure.rb

@@ -4,27 +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') && !figure.caption
-
+        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.caption || 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_notes/bake_autotitled_notes.rb

@@ -30,32 +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')
-
-          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
+        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_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/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') && !caption)
+
+    def figure_to_number?
+      return false if subfigure? || unnumbered?
 
       true
     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 = '13.0.0'
+  VERSION = '14.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 14.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-06 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
@@ -303,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
@@ -328,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