openstax_kitchen 11.1.0 → 11.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4340461612470e8ddff3976af6bf342821a18f1e01c70d5c6d4dcbf08636ac24
-  data.tar.gz: 293967ff3cf8af70f6d9d5f5d20866c77608af41c279590b3abb39966813f048
+  metadata.gz: e366a482a30f5cda88fe3c76731d3f187e727447cfc9ae1c13ff5e8bb99c1daa
+  data.tar.gz: 97db8d770c708fda67c566157989b0999fe12859eb515d52da73a86136ab9c29
 SHA512:
-  metadata.gz: 70eedaaa535e97066b5b5b0d80e9c8916ffb6de5ecdf063f7a58d2c984253771742832278e53f5ce8bea3f0f3c7cbdd97da058258e5ace42dda0da372243ff2d
-  data.tar.gz: 72001901b5c82c46bd835521d9a815d178cc6bcea04502fd6b9b10bf36309ed42028b92714fd003e1a0042c60ce9eb4ab505dc627d8dd763f9c6892ff1fee7ea
+  metadata.gz: d1b69721238c536696a265d4419f94944746a8a934f24c2e39d8beebe27b18fbd85b1da1599cf6cf326e2d44053b0927db0ab7edae3e24c1a5bfea44839555d9
+  data.tar.gz: 2b420da729d4282fc85f7b074c2848f83d7912a5ff75365ba91d6406b245a1442f0c3dd7074cc6744b44ba96cdc8d00a0a872b092f54a3865e0fd21daff3d81d

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [11.2.0] - 2021-09-10
+
+* Adds `BakeAccessibilityFixes` direction for (minor)
+* Remove deprecation warning from `BakeChapterIntroductions.v1` and adapted to be used like `.v2` (minor)
+* Small class fix for `BakeFootnotes.v1` (patch)
+* Fix `BakeNumberedNotes` to find related example better (minor)
+* Small fix for parameter in `bake_note` definition (minor)
+* Small fixes to return when no elements are found and not add an empty wrapper in `BakeChapterReferences` and
+`BakeFreeResponse` (minor)
+* Adding class `os-timeline-table-container` to numbered tables when required (minor)
+* Fix `BakeExample` to catch the multiple solutions to one exercise (patch)
+
 ## [11.1.0] - 2021-08-30
 
 * Update injected questions to synthesize ids during baking (minor)

data/Gemfile.lock

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

data/lib/kitchen/directions/bake_accessibility_fixes.rb

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

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

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

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

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

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

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

data/lib/kitchen/directions/bake_example.rb

@@ -30,9 +30,9 @@ module Kitchen
             problem.wrap_children(class: 'os-problem-container')
           end
 
-          if (solution = exercise.solution)
+          exercise.solutions.each do |solution|
             solution_number = if numbered_solutions
-                                "<span class=\"os-number\">#{exercise.count_in(:example)}</span>"
+                                "<span class=\"os-number\">#{solution.count_in(:example)}</span>"
                               else
                                 ''
                               end

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

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

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

@@ -20,6 +20,8 @@ module Kitchen::Directions::BakeFreeResponse
         end
       end
 
+      return if @free_response_clipboard.none?
+
       append_to_element = append_to || chapter
       @title_tag = append_to ? 'h3' : 'h2'
 

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

@@ -11,7 +11,7 @@ module Kitchen
         end
       end
 
-      def self.bake_note(note:, bake_subtitle:, cases: false)
+      def self.bake_note(note:, bake_subtitle:, cases:)
         Kitchen::Directions::BakeIframes.v1(outer_element: note)
         note.wrap_children(class: 'os-note-body')
 

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

@@ -9,6 +9,9 @@ module Kitchen::Directions
           book.chapters.pages.notes("$.#{klass}").each do |note|
             note.wrap_children(class: 'os-note-body')
             previous_example = note.previous
+            until previous_example.nil? || previous_example[:'data-type'] == 'example'
+              previous_example = previous_example.previous
+            end
             os_number = previous_example&.first('.os-number')&.children&.to_s
 
             note.prepend(child:

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

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

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

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

data/lib/kitchen/exercise_element.rb

@@ -39,6 +39,14 @@ module Kitchen
       first("div[data-type='solution']")
     end
 
+    # Returns the enumerator for solutions
+    #
+    # @return [ElementEnumerator]
+    #
+    def solutions
+      search("div[data-type='solution']")
+    end
+
     # Returns whether the exercise has been baked
     #
     # @return [Boolean]

data/lib/kitchen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 11.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,6 +243,7 @@ files:
 - lib/kitchen/counter.rb
 - lib/kitchen/debug/print_recipe_error.rb
 - lib/kitchen/directions/.rubocop.yml
+- lib/kitchen/directions/bake_accessibility_fixes.rb
 - lib/kitchen/directions/bake_annotation_classes/main.rb
 - lib/kitchen/directions/bake_annotation_classes/v1.rb
 - lib/kitchen/directions/bake_appendix.rb
@@ -458,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: OpenStax content baking library