openstax_kitchen 17.0.0 → 17.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 774e5af35ed15ba87d97802b8395412003291024053c9ed11aa66eaa4ba20712
-  data.tar.gz: eb371d8b10113005b69b5864c19fe8eed43aa5b9b965329cfcfdcc8a9287b842
+  metadata.gz: 23c782f23dfd67f38174ddb5f51c28955ae7929854e17a6f9163f41bb644485e
+  data.tar.gz: 4fafd85f2c59373ebe321e0ddc1b86f5b61e7453bbfe1ca66b94b9ec59c75a59
 SHA512:
-  metadata.gz: c4953a8d928e31cf45116cb4ac8f5eb54ab06db3c5d91af038da6acefc1e643ab19a4a585fdfb3cf19de67f24ac3778e36aa972014a3b5f9397734b1c1498829
-  data.tar.gz: ad336376346ed97f0f924ef6fde9e41f0b7735fa920245fc58d1c7c679d88be72867af5dd6722c25bd6185fcdaa0b57708650dbb0ba94d6e3fa3da2b2751e19d
+  metadata.gz: 9cf25e0c145ec59512e2e53b52b7dc8e0146568153c04482f8832341389716d7f7682982b273ffebafebb9a0f0b579ac72cc8fee2141415f96ca652946c2f8be
+  data.tar.gz: 15d806949cb3f91884cd09b3aa13bf9de30f0264e6ad2ab6a059531394e1d5016752ff1c01ab1fd19d4d82e513e4b465412ba685cef8cad646903baa9953a7ca

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.1.0] - 2021-12-17
+
+* Add append_to support to `BakeChapterSummary` (minor)
+* Add support for italicized terms in index (minor)
+* Fix problem with namespaces in `BakeLinkPlaceholders` and `BakeIndex` (minor)
+* Create `V3` for `BakeChapterReferences`  which sorts references alphabetically (minor)
+
 ## [17.0.0] - 2021-12-3
 
 * Create method in `Integer` class that generate roman numbers up to 100 (minor)

data/Gemfile.lock

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

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

@@ -18,6 +18,13 @@ module Kitchen
           uuid_prefix: uuid_prefix,
           klass: klass)
       end
+
+      def self.v3(chapter:, metadata_source:, uuid_prefix: '.')
+        V3.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix)
+      end
     end
   end
 end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V3
+    class Reference
+      attr_reader :element
+
+      def initialize(element)
+        reference_item = Kitchen::I18nString.new(element.text.downcase)
+        @sortable = [reference_item]
+        @element = element
+      end
+
+      def <=>(other)
+        sortable <=> other.sortable
+      end
+
+      protected
+
+      attr_reader :sortable
+    end
+
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '.')
+      @references = []
+
+      chapter.references.search('p').each do |reference_element|
+        @references.push(Reference.new(reference_element.cut))
+      end
+
+      chapter.references.trash
+
+      content = @references.sort.map { |reference| reference.element.paste }.join
+
+      return if content.empty?
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: "#{uuid_prefix}references",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: append_to || chapter
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -5,17 +5,18 @@ module Kitchen
     # Bake directions for eoc summary
     #
     module BakeChapterSummary
-      def self.v1(chapter:, metadata_source:, klass: 'summary', uuid_prefix: '.')
+      def self.v1(chapter:, metadata_source:, klass: 'summary', uuid_prefix: '.', append_to: nil)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
           uuid_prefix: uuid_prefix,
-          klass: klass
+          klass: klass,
+          append_to: append_to
         )
       end
 
       class V1
-        def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
+        def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary', append_to: nil)
           summaries = Clipboard.new
 
           chapter.pages.each do |page|
@@ -36,7 +37,7 @@ module Kitchen
             uuid_key: "#{uuid_prefix}#{klass}",
             metadata_source: metadata_source,
             content: summaries.paste,
-            append_to: chapter
+            append_to: append_to || chapter
           )
         end
       end

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

@@ -11,12 +11,14 @@ module Kitchen::Directions::BakeIndex
       attr_reader :id
       attr_reader :group_by
       attr_reader :page_title
+      attr_reader :italicized
 
-      def initialize(text:, id:, group_by:, page_title:)
+      def initialize(text:, id:, group_by:, page_title:, italicized:)
         @text = text.strip
         @id = id
         @group_by = group_by
         @page_title = page_title
+        @italicized = italicized
       end
     end
 
@@ -126,7 +128,8 @@ module Kitchen::Directions::BakeIndex
         page = term_element.ancestor(:page)
         term_element.id = "auto_#{page.id}_term#{term_element.count_in(:book)}"
         page_title = page.title.text
-        add_term_to_index(term_element, page_title)
+        term_italicized = term_element&.first("em[data-effect='italics']")
+        add_term_to_index(term_element, page_title, term_italicized)
       end
 
       book.chapters.composite_pages.terms.each do |term_element|
@@ -135,7 +138,8 @@ module Kitchen::Directions::BakeIndex
         term_element.id = "auto_composite_page_term#{term_element.count_in(:book)}"
         chapter_number = chapter.count_in(:book)
         page_title = "#{chapter_number} #{page.title.text.strip}".strip
-        add_term_to_index(term_element, page_title)
+        term_italicized = term_element&.first("em[data-effect='italics']")
+        add_term_to_index(term_element, page_title, term_italicized)
       end
 
       types.each do |type|
@@ -150,18 +154,18 @@ module Kitchen::Directions::BakeIndex
       end
     end
 
-    def add_term_to_index(term_element, page_title)
+    def add_term_to_index(term_element, page_title, term_italicized)
       type =
         if !term_element.key?('index')
           'term'
-        elsif term_element['cxlxt:index'] == 'name'
+        elsif term_element['cxlxt:index'] == 'name' || term_element['index'] == 'name'
           'name'
-        elsif term_element['cxlxt:index'] == 'foreign'
+        elsif term_element['cxlxt:index'] == 'foreign' || term_element['index'] == 'foreign'
           'foreign'
         end
 
       if term_element.key?('reference')
-        term_reference = term_element['cmlnle:reference']
+        term_reference = term_element['cmlnle:reference'] || term_element['reference']
         group_by = term_reference[0]
         content = term_reference
       else
@@ -175,6 +179,7 @@ module Kitchen::Directions::BakeIndex
       # Add it to our index object
       @indexes[type].add_term(
         Term.new(
+          italicized: term_italicized,
           text: content,
           id: term_element.id,
           group_by: group_by,

data/lib/kitchen/directions/bake_index/v1.xhtml.erb

@@ -13,7 +13,7 @@
         <div class="os-index-item">
           <%- item.terms.each_with_index do |term, ii| -%>
             <%- if ii == 0 -%>
-              <span class="os-term" group-by="<%= term.group_by %>"><%= term.text %></span>
+              <span class="os-term" group-by="<%= term.group_by %>"><%- if term.italicized -%><em data-effect="italics"><%= term.text %></em><%- else -%><%= term.text %><% end %></span>
             <%- else -%><span class="os-index-link-separator">, </span><% end %>
             <a class="os-term-section-link" href="#<%= term.id %>"><span class="os-term-section"><%= term.page_title %></span></a><!--
           --><%- end %>

data/lib/kitchen/directions/bake_link_placeholders.rb

@@ -9,7 +9,7 @@ module Kitchen
         book.search('a').each do |anchor|
           next unless anchor.text == '[link]'
 
-          label_case = anchor['cmlnle:case']
+          label_case = anchor['cmlnle:case'] || anchor['case']
           id = anchor[:href][1..-1]
 
           if cases

data/lib/kitchen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 17.0.0
+  version: 17.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -266,6 +266,7 @@ files:
 - 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_references/v3.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