openstax_kitchen 18.0.0 → 19.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4343b799c2a49cec3c179ba3af59dae109cdb4fb4839fd7993710d6a1125d322
-  data.tar.gz: 6ac5fcdb6adda5fbf080b507676156c42dfc301f8060bae4dabe1bf3561fbebf
+  metadata.gz: 8ad3abbaf8b72b698a5c8d16136f6d6ec9662c82c12291a7c7f87d02eafc0805
+  data.tar.gz: 948a85a3659dd95502113d351cbeb5a3cbc0b2c0151806974c69978818f622f2
 SHA512:
-  metadata.gz: 4dad4bfc3619807740965bc6d8f9c4332e13d2031433a5b32576d3fb66d79005ae08bebd9e25398097921ff15e1c835ebefa2b3a35d30185f194442412355f89
-  data.tar.gz: 6372b3c2860ef570dd6e0ff9011ee08759138843eef48953a2187452581edcccd96df337d1441bad5f03c32482c9058104f2ae20d4e50a905baf279a478fdb87
+  metadata.gz: 619c09628f6d62413fd07a7ee4e732cff9f52e78363a2f3414a11f9bbb3f32a008695fb4eaa25f82f0bc8cd81354ebc9e8666973904dd9f5ae2367a6183fde5c
+  data.tar.gz: f1b1198cdf3d84544fdd0af0fafa5bb17a0b15a273fb801ea5a4a345a7812da2e0de5311292e5b1e05a4d11715f6564ef817ff07ae5450a23f4397483ba45254

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [19.0.0] - 2022-1-28
+
+* Add features to `BakeScreenreaderSpans` & use translations instead of plaintext (minor)
+* Create `AnswerKeyCleaner` to remove empty chapter containers (minor)
+* Change markup to `span` with `sup` for reference link separator `BakeReferences.v1` plus remove whitespaces and new lines (patch)
+* Changes to `BakeScreenreaderSpans` behavior (major)
+* Changes to `BakeToc` to improve error messaging by including `page.id` (minor)
 
 ## [18.0.0] - 2022-01-14
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (18.0.0)
+    openstax_kitchen (19.0.0)
       activesupport
       i18n
       nokogiri
@@ -99,7 +99,7 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
-    twitter_cldr (6.11.0)
+    twitter_cldr (6.11.1)
       camertron-eprun
       cldr-plurals-runtime-rb (~> 1.1)
       tzinfo
@@ -107,7 +107,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.24)
-    zeitwerk (2.5.3)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby

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

@@ -8,7 +8,7 @@ module Kitchen::Directions::BakeReferences
       book.chapters.each do |chapter|
         chapter.search('[data-type="cite"]').each do |link|
           link.prepend(child:
-            <<~HTML
+            <<~HTML.chomp
               <sup class="os-citation-number">#{link.count_in(:chapter)}</sup>
             HTML
           )
@@ -21,10 +21,10 @@ module Kitchen::Directions::BakeReferences
           next unless link_sibling&.raw&.attr('data-type') == 'cite'
 
           link.prepend(sibling:
-            <<~HTML
-              <span class="os-reference-link-separator">, </span>
+            <<~HTML.strip.chomp
+              <span class="os-reference-link-separator"><sup>, </sup></span>
             HTML
-            )
+          )
         end
 
         chapter.references.each do |reference|

data/lib/kitchen/directions/bake_screenreader_spans.rb

@@ -6,17 +6,51 @@ module Kitchen
       # Add text for accessibility.
       # Additional screenreader spans can be added below.
       def self.v1(book:)
+        book.search('u[data-effect="underline"]').each do |element|
+          add_screenreader_text(
+            element: element,
+            begin_message: I18n.t(:'screenreader.underline'),
+            end_message: "#{I18n.t(:'screenreader.end')} #{I18n.t(:'screenreader.underline')}"
+          )
+        end
         book.search('u[data-effect="double-underline"]').each do |element|
-          element.add_previous_sibling(
-            '<span data-screenreader-only="true">double underline</span>'
+          add_screenreader_text(
+            element: element,
+            begin_message: I18n.t(:'screenreader.double-underline'),
+            end_message: "#{I18n.t(:'screenreader.end')} #{I18n.t(:'screenreader.double-underline')}"
           )
         end
-        book.search('u[data-effect="underline"]').each do |element|
-          element.add_previous_sibling(
-            '<span data-screenreader-only="true">underline</span>'
+        book.search('p.public-domain').each do |element|
+          add_screenreader_text(
+            element: element,
+            begin_message: I18n.t(:'screenreader.public-domain'),
+            end_message: "#{I18n.t(:'screenreader.end')} #{I18n.t(:'screenreader.public-domain')}"
+          )
+        end
+        book.search('p.student-sample').each do |element|
+          add_screenreader_text(
+            element: element,
+            begin_message: I18n.t(:'screenreader.student-sample'),
+            end_message: "#{I18n.t(:'screenreader.end')} #{I18n.t(:'screenreader.student-sample')}"
+          )
+        end
+        book.search('p.annotation-text').each do |element|
+          add_screenreader_text(
+            element: element,
+            begin_message: I18n.t(:'screenreader.annotation-text'),
+            end_message: "#{I18n.t(:'screenreader.end')} #{I18n.t(:'screenreader.annotation-text')}"
           )
         end
       end
+
+      def self.add_screenreader_text(element:, begin_message:, end_message:)
+        element.prepend(child:
+          "<span data-screenreader-only=\"true\">#{begin_message}</span>"
+        )
+        element.append(child:
+          "<span data-screenreader-only=\"true\">#{end_message}</span>"
+        )
+      end
     end
   end
 end

data/lib/kitchen/directions/bake_toc.rb

@@ -100,7 +100,8 @@ module Kitchen
                   page.has_ancestor?(:composite_chapter)
               'os-toc-unit-page'
             else
-              raise "do not know what TOC class to use for page with classes #{page.classes}"
+              raise "could not detect which page type class to apply for page.id `#{page.id}`
+               during baking the TOC. The classes on the page are: `#{page.classes}`"
             end
           when CompositePageElement
             if page.is_index? || page.is_index_of_type?
@@ -112,10 +113,12 @@ module Kitchen
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else
-              raise "do not know what TOC class to use for page with classes #{page.classes}"
+              raise "could not detect which composite page type class to apply to TOC for page id \
+              `#{page.id}` during baking the TOC. The classes on the page are: `#{page.classes}`"
             end
           else
-            raise(ArgumentError, "don't know how to put `#{page.class}` into the TOC")
+            raise(ArgumentError, "could not detect any page type class to apply for `#{page.id}` \
+            during baking TOC")
           end
 
         title = page.title.copy

data/lib/kitchen/directions/move_solutions_to_answer_key/answer_key_cleaner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::AnswerKeyCleaner
+  def self.v1(book:)
+    V1.new.bake(book: book)
+  end
+
+  class V1
+    renderable
+
+    def bake(book:)
+      answer_key_chapters = book.search(
+        '.os-eob[data-type="composite-chapter"] > [data-type="composite-page"]')
+      answer_key_chapters.each do |container|
+        container.trash unless container.contains?('[data-type="solution"]')
+      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 = '18.0.0'
+  VERSION = '19.0.0'
 end

data/lib/locales/en.yml

@@ -61,3 +61,10 @@ en:
       title: Auditory learning style icon
     kinesthetic-icon:
       title: Kinesthetic learning style icon
+  screenreader:
+    end: end
+    underline: underline
+    double-underline: double underline
+    public-domain: public domain text
+    student-sample: student sample text
+    annotation-text: annotated text

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 18.0.0
+  version: 19.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -359,6 +359,7 @@ files:
 - lib/kitchen/directions/move_exercises_to_eoc/v1.rb
 - lib/kitchen/directions/move_exercises_to_eoc/v2.rb
 - lib/kitchen/directions/move_exercises_to_eoc/v3.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/answer_key_cleaner.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/answer_key_inner_container.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_exercise_section.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_numbered_note.rb