openstax_kitchen 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca2eb47435f5ff74342d7de2afc02e2c55eed224f1ae669b440d52a1c50b1b0
-  data.tar.gz: f22d42bc7618868d1890e149d9e0bf5134945b8fccce5c7742827e6c53589d81
+  metadata.gz: df33d6b0ba524fe49e9e5310bcdb730406576a3b88f0462e2eedd932d08fc0cf
+  data.tar.gz: 6a23406fdebb4676c22424d14ab805304789814e84302a685aa245e2bf87f846
 SHA512:
-  metadata.gz: a457781d0bcb61533c5b96ca0b2ffcde74a69743a54c09f4b901b7e769056d1d616afa736df40067e7472a479c8526505d72fe5d7e9ecf3eca6789581d92c380
-  data.tar.gz: 9f517fbc86ae32e0fd2bbc108774a9f4b94a63df01675530c7f26d7f9bf9522654f4ddb5d7e1c9d141b1a67a0ccc6a98ac2f8c0cf94719ccf04b67cfbf69f240
+  metadata.gz: 3af05295d5045ec827b6e817443a4648591d138bc9d3cf697221187e26088badc6c76048f8b3902a167c073c1e9ee94b4c4f48934171428b649c879e23abd95f
+  data.tar.gz: 35ce7b8d16222c5f338d2eb6e9749158980e075b2d09bfa82e034e74bcfad13b748b80bceb1941fc0a8b4d26cf834474a0e7699a7327b55c6e6e42bc1e122024

data/CHANGELOG.md

@@ -6,9 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.1.0] - 2021-07-16
+
+* Add `BakeNoteIFrames` direction (minor)
+* Selector optimization in precalculus `Strategy` & elsewhere (patch)
+* Tweaks inline list seperators to only target labeled items (major?)
+* Add definition of handbook page selector needed for BakeToc, create a link class for this page (minor)
+
 ## [9.0.0] - 2021-07-12
 
-* Refactor `BakeChapterKeyConcepts`, `BakeChapterReferences`, `BakeChapterSolutions`, and `MoveExercisesToEoc` versions 1-3 to use new general eoc directions (major?)
+* Refactor `BakeChapterKeyConcepts`, `BakeChapterReferences`, `BakeChapterSolutions`, and `MoveExercisesToEoc` versions 1-3 to use new general eoc directions (major)
 * Fixed `BakeExample.v1` to also search inside `.body` for titles (minor)
 * Add documentation to `MoveCustomSectionToEocContainer` & `EocCompositePageContainer` (minor)
 * Add a `MoveCustomSectionToEocContainer` to allow for custom sections (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (9.0.0)
+    openstax_kitchen (9.1.0)
       activesupport
       i18n
       nokogiri

data/lib/kitchen/composite_page_element.rb

@@ -29,10 +29,8 @@ module Kitchen
     # @return [Element]
     #
     def title
-      # Get the title in the immediate children, not the one in the metadata.  Could use
-      # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
-      # but xpath is shorter
-      first!("./*[@data-type = 'document-title' or @data-type = 'title']")
+      first!('h3[data-type="title"], h2[data-type="document-title"],' \
+             'h1[data-type="document-title"]')
     end
 
     # Returns true if this page is a book index

data/lib/kitchen/directions/bake_example.rb

@@ -54,7 +54,7 @@ module Kitchen
 
           exercise.add_class('unnumbered')
 
-          commentary = exercise.first('[data-type="commentary"]')
+          commentary = exercise.first('div[data-type="commentary"]')
           next unless commentary.present?
 
           commentary_title = commentary.titles.first

data/lib/kitchen/directions/bake_inline_lists.rb

@@ -10,7 +10,7 @@ module Kitchen
       SEPARATOR_CLASS = '-os-inline-list-separator'
 
       def self.v1(book:)
-        inline_lists = book.search('span[data-display="inline"][data-type="list"]')
+        inline_lists = book.search('span[data-display="inline"][data-list-type="labeled-item"]')
         inline_lists.each do |list|
           list.search('span[data-type="item"]')[0..-2].each do |item|
             item.append(child: "<span class=\"#{SEPARATOR_CLASS}\">#{LIST_SEPARATOR}</span>")

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

@@ -12,6 +12,7 @@ module Kitchen
       end
 
       def self.bake_note(note:)
+        BakeNoteIFrames.v1(note: note)
         note.wrap_children(class: 'os-note-body')
 
         BakeNoteSubtitle.v1(note: note)

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteIFrames
+      def self.v1(note:)
+        iframes = note.search('iframe')
+        return unless iframes.any?
+
+        iframes.each do |iframe|
+          iframe.wrap('<div class="os-has-iframe" data-type="alternatives">')
+          iframe.add_class('os-is-iframe')
+          link_ref = iframe[:src]
+          next unless link_ref
+
+          iframe = iframe.parent
+          iframe.add_class('os-has-link')
+          iframe.prepend(child:
+            <<~HTML
+              <a class="os-is-link" href="#{link_ref}" target="_window">#{I18n.t(:iframe_link_text)}</a>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -90,6 +90,8 @@ module Kitchen
               'os-toc-appendix'
             elsif page.is_preface?
               'os-toc-preface'
+            elsif page.is_handbook?
+              'os-toc-handbook'
             else
               raise "do not know what TOC class to use for page with classes #{page.classes}"
             end

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/precalculus.rb

@@ -24,8 +24,8 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
 
       def bake_section(chapter:, append_to:, klass:, number: nil)
         section_solutions_set = Kitchen::Clipboard.new
-        chapter.search(".#{klass}").each do |section|
-          section.search('[data-type="solution"]').each do |solution|
+        chapter.search("section.#{klass}").each do |section|
+          section.search('div[data-type="solution"]').each do |solution|
             solution.cut(to: section_solutions_set)
           end
         end
@@ -56,7 +56,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
           page.notes('$.try').each do |note|
             note.exercises.each do |exercise|
               solution = exercise.solution
-              solution&.cut(to: solutions) #if solution
+              solution&.cut(to: solutions)
             end
           end
           next if solutions.items.empty?
@@ -64,7 +64,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
           title_snippet = Kitchen::Directions::EocSectionTitleLinkSnippet.v2(page: page)
 
           append_solution_area(title: title_snippet, solutions: solutions,
-                               append_to: append_to.search('.os-try-solution-area').first)
+                               append_to: append_to.search('div.os-try-solution-area').first)
         end
       end
 

data/lib/kitchen/metadata_element.rb

@@ -27,8 +27,8 @@ module Kitchen
     # @return [ElementEnumerator]
     #
     def children_to_keep
-      search(%w([data-type='revised'] .authors .publishers .print-style .permissions
-                [data-type='subject']))
+      search(%w(span[data-type='revised'] div.authors div.publishers div.print-style div.permissions
+                div[data-type='subject']))
     end
   end
 end

data/lib/kitchen/page_element.rb

@@ -119,5 +119,13 @@ module Kitchen
       search('section.free-response')
     end
 
+    # Returns true if this page is a handbook
+    #
+    # @return [Boolean]
+    #
+    def is_handbook?
+      has_class?('handbook')
+    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 = '9.0.0'
+  VERSION = '9.1.0'
 end

data/lib/locales/en.yml

@@ -26,6 +26,7 @@ en:
   eob_index_symbols_group: Symbols
   review_exercises: Review Exercises
   section_exercises: ! 'Section %{number} Exercises'
+  iframe_link_text: Click to view content
   eoc:
     glossary: Key Terms
     key-equations: Key Equations
@@ -33,3 +34,4 @@ en:
     further-research: Further Research
     key-concepts: Key Concepts
     references: References
+    solutions: Solutions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -282,6 +282,7 @@ files:
 - 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
+- lib/kitchen/directions/bake_notes/bake_note_iframes.rb
 - lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/main.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/v1.rb