openstax_kitchen 15.0.0 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 074dfc264ca97aab5805a3ab189b49fe1e97a1108366b592b5599a70e15f1345
-  data.tar.gz: fee3491d899d7983e55e5c6eb22010b49d23e8dd43e54ca97950a7be2fbda93f
+  metadata.gz: 7796fb964e8a6ff796d9cf84220449681a89e5501e41e0a9a956620faf022d11
+  data.tar.gz: 4b2c488ac82a05067c7353f274b9f94888125eb7f66cfa92f30db3c28e7ae29a
 SHA512:
-  metadata.gz: d9a5936f931cf6b1c3485543adf375426d71b444109c68fc80b0a06ef6f953e4ac43cd40b27941c06dec0541e02dd2b3387074aa8a956821cdca781f97607f1d
-  data.tar.gz: 13d5bf302fe8144acef670f017bc8393847292d37f4a4dae68922cbf56c52da41c18719ec586ca1b5b1a135dc0c303e168f5515903e2b667299347cba909e7d4
+  metadata.gz: cc57439823f55ee6cdec35304a2bb4413a28afc5c98ae616effadec60095cfa964a4b9faa0380178f189c55771d1a1f28813268ce001349f29c3d1b44397d4ab
+  data.tar.gz: d055f27db123b8e7441f45056e1c6f2a576ab56d1faa3bbdbb4af6a904674f1562e4403dd5e914a372fe67c5e969eb385838aab6f9ff9a5cbc8a0f5b20356df7

data/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [16.0.0] - 2021-11-19
+
+* Add reference link separator to `BakeReferences.v1` (patch)
+* Modify `BakeFootnotes` to be more general (minor)
+* Add `#preceded_by_text` method to element_base and the nokigiri patch (minor)
+* Broaden caption selection for `BakeNumberedTable#v2` (patch)
+* Add details of question count to injected exercises in `BakeInjectedExercise` (major)
+* Add target labels to chapter content module pages option in `BakeNonIntroductionPages`, create a separate directory `BakeLOLinkLabels` to add `.label-text`, `.label-counter` spans wrappers for links with `.lo-reference` class (minor)
+* Add `BakeScreenreaderSpans` direction (minor)
+* Fix `BakeIndex` to group terms by character in polish books and transliterate it for others (minor)
+* Add optional bake `exercies-context` figure_reference if there is one present in singular part exercises to `BakeInjectedExercise`,`BakeInjectedQuestion` to move it down from exercise to question problem container. (major)
+* Create v3 for autotitled exercises with os-hasSolution class
+
 ## [15.0.0] - 2021-11-05
 
 * Add unstyled tables to `BakeTableBody` (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (15.0.0)
+    openstax_kitchen (16.0.0)
       activesupport
       i18n
       nokogiri
@@ -99,7 +99,7 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
-    twitter_cldr (6.7.0)
+    twitter_cldr (6.8.0)
       camertron-eprun
       cldr-plurals-runtime-rb (~> 1.1)
       tzinfo

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

@@ -10,6 +10,10 @@ module Kitchen
       def self.v2(exercise:, title:)
         V2.new.bake(exercise: exercise, title: title)
       end
+
+      def self.v3(exercise:, title:)
+        V3.new.bake(exercise: exercise, title: title)
+      end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  # Differences from V2:
+  # 1. Exercise with solution has class os-hasSolution
+  # 2. Solution id is based on exercise id
+  class V3
+    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.add_class('os-hasSolution')
+      exercise.solution.id = "#{exercise.id}-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_footnotes/v1.rb

@@ -30,7 +30,7 @@ module Kitchen::Directions::BakeFootnotes
         aside_id_to_footnote_number[aside_id] = footnote_number
         if anchor.parent.name == 'p'
           anchor.parent.add_class('has-noteref')
-        elsif anchor.parent.name == 'em' && anchor.parent.parent.name == 'p'
+        elsif anchor.parent.name != 'p' && anchor.parent.parent.name == 'p'
           anchor.parent.parent.add_class('has-noteref')
         end
       end

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

@@ -165,7 +165,7 @@ module Kitchen::Directions::BakeIndex
         group_by = term_reference[0]
         content = term_reference
       else
-        group_by = I18n.transliterate(term_element.text.strip[0])
+        group_by = I18n.character_to_group(term_element.text.strip[0])
         content = term_element.text
       end
 

data/lib/kitchen/directions/{bake_injected_exercise.rb → bake_injected_exercise/bake_injected_exercise.rb}

@@ -7,12 +7,21 @@ module Kitchen::Directions::BakeInjectedExercise
 
   class V1
     def bake(exercise:)
-      context = exercise.search('div[data-type="exercise-context"]')&.first
+      question_count = exercise.injected_questions.count
+      exercise[:'data-question-count'] = question_count
+      exercise[:'data-is-multipart'] = question_count > 1 ? 'True' : 'False'
+
+      context = exercise&.exercise_context
+
       return unless context
 
       # link replacement is done by BakeLinkPlaceholders
       link = context.first('a').cut
       context.replace_children(with: "#{I18n.t(:context_lead_text)}#{link.paste}")
+      return unless question_count == 1
+
+      question = exercise.exercise_question
+      question.prepend(child: context.cut.paste)
     end
   end
 end

data/lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise_question.rb

@@ -41,11 +41,15 @@ module Kitchen::Directions::BakeInjectedExerciseQuestion
         end
       end
 
+      context = question.exercise_context_in_question&.cut&.paste
+
       question.prepend(child:
         <<~HTML
           #{problem_number unless only_number_solution}
           #{"<span class='os-divider'>. </span>" unless only_number_solution}
           <div class="os-problem-container">
+            #{context if context.present?}
+            #{"<span class='os-divider'>. </span>" if context.present?}
             #{question.stimulus&.cut&.paste}
             #{question.stem.cut.paste}
             #{question.answers&.cut&.paste}

data/lib/kitchen/directions/bake_lo_link_labels.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for LO link labels
+    module BakeLOLinkLabels
+      def self.v1(book:)
+        book.search('a.lo-reference').each do |anchor|
+          anchor.wrap_children('span', class: 'label-counter')
+          anchor.prepend(child:
+            <<~HTML
+              <span class="label-text">#{I18n.t(:lo_label_text)}</span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_non_introduction_pages.rb

@@ -3,13 +3,15 @@
 module Kitchen
   module Directions
     module BakeNonIntroductionPages
-      def self.v1(chapter:)
+      def self.v1(chapter:, add_target_label: false)
         chapter.non_introduction_pages.each do |page|
           number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
 
           page.search("div[data-type='description']").each(&:trash)
           page.add_class('chapter-content-module')
 
+          page.target_label(custom_content: number) if add_target_label
+
           title = page.title
           title.name = 'h2'
           title.replace_children(with:

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

@@ -9,7 +9,8 @@ module Kitchen::Directions::BakeNumberedTable
       Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number, cases: cases)
 
       caption = ''
-      if table&.caption&.first("span[data-type='title']") && !table.top_captioned?
+      if (table&.caption&.first("span[data-type='title']") || table&.caption) \
+        && !table.top_captioned?
         caption_el = table.caption
         caption_el.add_class('os-caption')
         caption_el.name = 'span'

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

@@ -12,6 +12,19 @@ module Kitchen::Directions::BakeReferences
               <sup class="os-citation-number">#{link.count_in(:chapter)}</sup>
             HTML
           )
+
+          next if link.nil?
+
+          link_sibling = link.previous unless link.preceded_by_text?
+          next if link_sibling.nil?
+
+          next unless link_sibling&.raw&.attr('data-type') == 'cite'
+
+          link.prepend(sibling:
+            <<~HTML
+              <span class="os-reference-link-separator">, </span>
+            HTML
+            )
         end
 
         chapter.references.each do |reference|

data/lib/kitchen/directions/bake_screenreader_spans.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeScreenreaderSpans
+      # Add text for accessibility.
+      # Additional screenreader spans can be added below.
+      def self.v1(book:)
+        book.search('u[data-effect="double-underline"]').each do |element|
+          element.add_previous_sibling(
+            '<span data-screenreader-only="true">double underline</span>'
+          )
+        end
+        book.search('u[data-effect="underline"]').each do |element|
+          element.add_previous_sibling(
+            '<span data-screenreader-only="true">underline</span>'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/element_base.rb

@@ -82,9 +82,13 @@ module Kitchen
     #   Set the inner HTML for this element
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#inner_html=-instance_method Nokogiri::XML::Node#inner_html=
     #   @return Object
+    # @!method preceded_by_text
+    #   Returns true if the immediately preceding sibling is text
+    #   @return Boolean
     def_delegators :@node, :name=, :name, :[], :[]=, :add_class, :remove_class,
                    :text, :wrap, :children, :to_html, :remove_attribute,
-                   :key?, :classes, :path, :inner_html=
+                   :key?, :classes, :path, :inner_html=, :add_previous_sibling,
+                   :preceded_by_text?
 
     # @!method config
     #   Get the config for this element's document
@@ -502,8 +506,8 @@ module Kitchen
       Element.new(node: raw.parent, document: document, short_type: "parent(#{short_type})")
     end
 
-    # returns previous element
-    # skips double indentations that the nokigiri sometimes picks up
+    # returns previous element sibling
+    # (only returns elements or nil)
     # nil if there's no previous sibling
     #
     def previous
@@ -754,7 +758,7 @@ module Kitchen
     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,
-                   :search_with, :sections
+                   :search_with, :sections, :injected_exercises
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -336,6 +336,24 @@ module Kitchen
                css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through injected exercises 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 injected_exercises(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(InjectedExerciseElementEnumerator,
+               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

data/lib/kitchen/injected_exercise_element.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class InjectedExerciseElement < ElementBase
+
+    # Creates a new +InjectedQuestionElement+
+    #
+    # @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: InjectedExerciseElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :injected_exercise
+    end
+
+    # Returns the exercise context element.
+    # @return [Element]
+    #
+    def exercise_context
+      first("div[data-type='exercise-context']")
+    end
+
+    # Returns the exercise question element.
+    # @return [Element]
+    #
+    def exercise_question
+      first("div[data-type='exercise-question']")
+    end
+
+  end
+end

data/lib/kitchen/injected_exercise_element_enumerator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for example elements
+  #
+  class InjectedExerciseElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:injected_exercise),
+        sub_element_class: InjectedExerciseElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/injected_question_element.rb

@@ -55,6 +55,13 @@ module Kitchen
       first("div[data-type='question-solution']")
     end
 
+    # Returns the exercise context element.
+    # @return [Element]
+    #
+    def exercise_context_in_question
+      first("div[data-type='exercise-context']")
+    end
+
     # Returns the answer correctness given an alphabet
     #
     # @return [Array]

data/lib/kitchen/patches/i18n.rb

@@ -4,6 +4,10 @@ require 'twitter_cldr'
 
 # rubocop:disable Style/Documentation
 module I18n
+  def self.character_to_group(character)
+    I18n.locale == :pl ? character : I18n.transliterate(character)
+  end
+
   def self.sort_strings(first, second)
     string_sorter.compare(first, second)
   end

data/lib/kitchen/patches/nokogiri.rb

@@ -74,6 +74,14 @@ module Nokogiri
         prev.text? ? prev.previous : prev
       end
 
+      def preceded_by_text?
+        prev = previous_sibling
+        while !prev.nil? && prev.blank? do prev = prev.previous_sibling end
+        return false if prev.nil?
+
+        prev.text?
+      end
+
       def self.selector_to_css_nodes(selector)
         # No need to parse the same selector more than once.
         @parsed_selectors ||= {}

data/lib/kitchen/selectors/base.rb

@@ -65,6 +65,9 @@ module Kitchen
       # Selector for a section
       # @return [String]
       attr_accessor :section
+      # Selector for an injected exercise
+      # @return [String]
+      attr_accessor :injected_exercise
 
       # Override specific selectors
       #

data/lib/kitchen/selectors/standard_1.rb

@@ -30,6 +30,7 @@ module Kitchen
                                           "div[data-type='question-solution']"
         self.injected_question          = "div[data-type='exercise-question']"
         self.section                    = 'section'
+        self.injected_exercise          = "div[data-type='injected-exercise']"
       end
 
     end

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -28,6 +28,7 @@ en:
   iframe_link_text: Click to view content
   handbook_outline_title: Outline
   context_lead_text: 'Refer to '
+  lo_label_text: 'LO '
   eoc:
     glossary: Key Terms
     key-equations: Key Equations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 15.0.0
+  version: 16.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -252,6 +252,7 @@ files:
 - 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_autotitled_exercise/v3.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
@@ -296,13 +297,14 @@ files:
 - lib/kitchen/directions/bake_index/main.rb
 - 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/add_injected_exercise_id.rb
+- lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise.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
 - lib/kitchen/directions/bake_lists_with_para.rb
+- lib/kitchen/directions/bake_lo_link_labels.rb
 - 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
@@ -326,6 +328,7 @@ files:
 - 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_screenreader_spans.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_toc.rb
@@ -373,6 +376,8 @@ files:
 - lib/kitchen/figure_element_enumerator.rb
 - lib/kitchen/i18n_string.rb
 - lib/kitchen/id_tracker.rb
+- lib/kitchen/injected_exercise_element.rb
+- lib/kitchen/injected_exercise_element_enumerator.rb
 - lib/kitchen/injected_question_element.rb
 - lib/kitchen/injected_question_element_enumerator.rb
 - lib/kitchen/metadata_element.rb