openstax_kitchen 16.0.0 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7796fb964e8a6ff796d9cf84220449681a89e5501e41e0a9a956620faf022d11
-  data.tar.gz: 4b2c488ac82a05067c7353f274b9f94888125eb7f66cfa92f30db3c28e7ae29a
+  metadata.gz: 774e5af35ed15ba87d97802b8395412003291024053c9ed11aa66eaa4ba20712
+  data.tar.gz: eb371d8b10113005b69b5864c19fe8eed43aa5b9b965329cfcfdcc8a9287b842
 SHA512:
-  metadata.gz: cc57439823f55ee6cdec35304a2bb4413a28afc5c98ae616effadec60095cfa964a4b9faa0380178f189c55771d1a1f28813268ce001349f29c3d1b44397d4ab
-  data.tar.gz: d055f27db123b8e7441f45056e1c6f2a576ab56d1faa3bbdbb4af6a904674f1562e4403dd5e914a372fe67c5e969eb385838aab6f9ff9a5cbc8a0f5b20356df7
+  metadata.gz: c4953a8d928e31cf45116cb4ac8f5eb54ab06db3c5d91af038da6acefc1e643ab19a4a585fdfb3cf19de67f24ac3778e36aa972014a3b5f9397734b1c1498829
+  data.tar.gz: ad336376346ed97f0f924ef6fde9e41f0b7735fa920245fc58d1c7c679d88be72867af5dd6722c25bd6185fcdaa0b57708650dbb0ba94d6e3fa3da2b2751e19d

data/CHANGELOG.md

@@ -6,12 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.0.0] - 2021-12-3
+
+* Create method in `Integer` class that generate roman numbers up to 100 (minor)
+* Add more roman numbers to `Integer` class (patch)
+* Create `V2` for `BakeChapterReferences` (minor)
+* Create `BakeExercisePrefixes` direction adding prefixes for exercises in selected sections (minor)
+* Add support for 'text-heavy-top-titled' tables in `BakeTableBody` (minor)
+* Remove `Nokigiri#previous` patch, `ElementBase#previous` now uses `#previous_element` (minor)
+* Modifies `BakeAnnotationClasses` for annotations wrapper to be a `span` intead of a `div` (major)
 
 ## [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)
+* Remove `Nokigiri#previous` patch, `ElementBase#previous` now uses `#previous_element` (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)

data/Gemfile.lock

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

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

@@ -20,9 +20,18 @@ module Kitchen::Directions::BakeAnnotationClasses
                                    kinesthetic-icon]
       annotation_icon_classes.each do |annotation_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:
+          annotation_with_icon_class.search('div.os-icons').first&.name = 'span'
+
+          icon_title = I18n.t(:"annotation_icons.#{annotation_icon_class}.title")
+
+          annotation_with_icon_class.search('span.os-icons').first.append(child:
             <<~HTML
-              <span class = "#{annotation_icon_class}"></span>
+              <span
+                class = "#{annotation_icon_class}"
+                role="img"
+                title="#{icon_title}"
+                aria-label="#{icon_title}"
+              ></span>
             HTML
           )
         end

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

@@ -10,6 +10,14 @@ module Kitchen
           uuid_prefix: uuid_prefix,
           klass: klass)
       end
+
+      def self.v2(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V2.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass)
+      end
     end
   end
 end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V2
+    def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+      chapter.pages.each do |page|
+        bake_page_cite(page: page)
+        bake_page_references(page: page)
+      end
+
+      return if chapter.pages.references.none?
+
+      content = chapter.pages.references.cut.paste
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: chapter
+      )
+    end
+
+    def bake_page_cite(page:)
+      page.search('[data-type="cite"]').each do |link|
+        link.id = "#{page.id}-endNote#{link.count_in(:chapter)}"
+
+        link.prepend(child:
+          <<~HTML
+            <sup class="os-end-note-number">#{link.count_in(:chapter)}</sup>
+          HTML
+        )
+
+        link.search('.delete-me').trash
+      end
+    end
+
+    def bake_page_references(page:)
+      page.references.each do |reference|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: reference)
+
+        reference.search('a').each do |ref_link|
+          ref_link.replace_children(with:
+            <<~HTML
+              <span>#{ref_link.count_in(:chapter)}.</span>
+            HTML
+          )
+          ref_link.href = "##{page.id}-endNote#{ref_link.count_in(:chapter)}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeExercisePrefixes
+      def self.v1(chapter:, sections_prefixed:)
+        V1.new.bake(
+          chapter: chapter,
+          sections_prefixed: sections_prefixed
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeExercisePrefixes
+  class V1
+    def bake(chapter:, sections_prefixed:)
+      sections_prefixed.each do |section_key|
+        chapter.composite_pages.each do |composite_page|
+          composite_page.search("section.#{section_key}").exercises.each do |exercise|
+            problem = exercise.problem
+            exercise_prefix =
+              "<span class='os-text'>#{I18n.t(:"sections_prefixed.#{section_key}")}</span>"
+            problem.prepend(child:
+              <<~HTML
+                #{exercise_prefix}
+              HTML
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -44,8 +44,9 @@ module Kitchen
           table.target_label(label_text: 'table', custom_content: number, cases: cases)
 
           if table.top_titled?
+            klass = table.text_heavy? ? 'text-heavy-top-titled' : 'top-titled'
             custom_table = CustomBody.new(table: table,
-                                          klass: 'top-titled',
+                                          klass: klass,
                                           fake_title_class: 'os-table-title',
                                           fake_title: table.title,
                                           to_trash: table.title_row)

data/lib/kitchen/element_base.rb

@@ -223,6 +223,22 @@ module Kitchen
       self[:'data-type']
     end
 
+    # Returns the element's href
+    #
+    # @return [String]
+    #
+    def href
+      self[:href]
+    end
+
+    # Sets the element's href
+    #
+    # @param value [String] the new value for the href
+    #
+    def href=(value)
+      self[:href] = value
+    end
+
     # A way to set values and chain them
     #
     # @param property [String, Symbol] the name of the property to set
@@ -511,7 +527,7 @@ module Kitchen
     # nil if there's no previous sibling
     #
     def previous
-      prev = raw.previous
+      prev = raw.previous_element
       return prev if prev.nil?
 
       Element.new(

data/lib/kitchen/patches/integer.rb

@@ -3,7 +3,22 @@
 # Monkey patches for +Integer+
 #
 class Integer
-  ROMAN_NUMERALS = %w[0 i ii iii iv v vi vii viii ix x xi xii xiii xiv xv xvi xvii xviii xix xx].freeze
+
+  @roman_numerals = {
+    100 => 'c',
+    90 => 'xc',
+    50 => 'l',
+    40 => 'xl',
+    10 => 'x',
+    9 => 'ix',
+    5 => 'v',
+    4 => 'iv',
+    1 => 'i'
+  }
+
+  class << self
+    attr_accessor :roman_numerals
+  end
 
   # Formats as different types of integers, including roman numerals.
   #
@@ -14,11 +29,25 @@ class Integer
     when :arabic
       to_s
     when :roman
-      raise 'Unknown conversion to Roman numerals' if self >= ROMAN_NUMERALS.size
+      raise 'Unknown conversion to Roman numerals' if self > self.class.roman_numerals.keys.first
 
-      ROMAN_NUMERALS[self]
+      to_roman
     else
       raise 'Unknown integer format'
     end
   end
+
+  def to_roman
+    return 0 if zero?
+
+    roman = ''
+    integer = self
+    self.class.roman_numerals.each do |number, letter|
+      until integer < number
+        roman += letter
+        integer -= number
+      end
+    end
+    roman
+  end
 end

data/lib/kitchen/patches/nokogiri.rb

@@ -67,13 +67,6 @@ module Nokogiri
         self[:class]&.split || []
       end
 
-      def previous
-        prev = previous_element
-        return nil if prev.nil?
-
-        prev.text? ? prev.previous : prev
-      end
-
       def preceded_by_text?
         prev = previous_sibling
         while !prev.nil? && prev.blank? do prev = prev.previous_sibling end

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -46,3 +46,18 @@ en:
     reference: References
   index:
     main: Index
+  annotation_icons:
+    linguistic-icon:
+      title: Language lens icon
+    culture-icon:
+      title: Culture lens icon
+    dreaming-icon:
+      title: Generating and capturing ideas icon
+    visual-icon:
+      title: Visual learning style icon
+    speech-icon:
+      title: Voice to text icon
+    auditory-icon:
+      title: Auditory learning style icon
+    kinesthetic-icon:
+      title: Kinesthetic learning style icon

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 16.0.0
+  version: 17.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,6 +265,7 @@ files:
 - lib/kitchen/directions/bake_chapter_key_equations.rb
 - lib/kitchen/directions/bake_chapter_references/main.rb
 - lib/kitchen/directions/bake_chapter_references/v1.rb
+- lib/kitchen/directions/bake_chapter_references/v2.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/main.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/v1.rb
 - lib/kitchen/directions/bake_chapter_solutions/main.rb
@@ -281,6 +282,8 @@ files:
 - lib/kitchen/directions/bake_eoc_section_content/remove_section_title.rb
 - lib/kitchen/directions/bake_equations.rb
 - lib/kitchen/directions/bake_example.rb
+- lib/kitchen/directions/bake_exercise_prefixes/main.rb
+- lib/kitchen/directions/bake_exercise_prefixes/v1.rb
 - lib/kitchen/directions/bake_figure.rb
 - lib/kitchen/directions/bake_first_elements.rb
 - lib/kitchen/directions/bake_folio.rb