openstax_kitchen 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e855f5598f3d3a425d670a828131a25605935b01ce0de9c38cceea7bb27703f
-  data.tar.gz: 50b1a58be988e539a031390ee7387a1249a1ddcdc2734c3b9a0d9c9dfa43b426
+  metadata.gz: a6855dd0e84e96799a57645b9023db15a07400c5b6971a0ebb29edf5c87074f0
+  data.tar.gz: e7106c5faa811f73e25a829258a4aadfccad20c32dc2a0623ec8a2526e44d274
 SHA512:
-  metadata.gz: 844384ec30da9c49e15026d1e5604e7248ef3a2806bbd242be398a04d6d8bddb8924225036dc3f4cfd0a0033fa27fa0bb975768317ddae012684bcf01e5b7483
-  data.tar.gz: 3f68410be5d1f0e7b06a8f8b618f44cd022a35d6e5ab6ce76a785eb5f702cd22ef2312cba218d8d0fb0628ce13d04cffc023fc647bee16c6ebe6ab566c2f862e
+  metadata.gz: 792c85c2b914719e38cca37b798160353425a6f80074926ead34c03e5fd97e47167dbc7d3efcef30d43a459a3ad917fd2e2e354fe490053e4345775cb7eac4df
+  data.tar.gz: 95d4ec07de107850a81cec9a714e5dbe83835dd1536005587109292f503d8afa9a1bdc896dc43f3198d59f18769ef7ab4c9ae2ee312d047ab8bee9997cc4c0a6

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status
@@ -17,4 +18,3 @@ tutorial/outputs/*.html
 
 tutorials/**/actual_baked.*html
 tutorials/**/my_recipe.rb
-

data/CHANGELOG.md

@@ -6,8 +6,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.2.0] - 2021-04-19
+## [4.0.0] - 2021-05-18
 
+* Changes `default_css_or_xpath` to optionally be a proc to be evaluated w.r.t. a document's config (minor)
+* Support namespaces defined on elements other than the root (minor)
+* Non-splash figures now treated like normal intro-body content in `BakeChapterIntroductions`
+* `BakeNumberedNotes` and the uphysics strategy for `MoveSolutionsToAnswerKey` updated to accomodate multiple exercises in a note.
+* `BakeFootnotes` now looks for footnotes in composite chapters
+* Move exercise pantry label storage to `BakeNumberedExercises` to ensure consistency between exercise number and link text
+* Update `BakeIndex` term capitalization handling to be less case sensitive (minor)
+* Added a title tag variable to choose between h2 and h3 for children of chapter review (minor)
+* Added a fix for examples not to bake table captions (minor)
+* Replaced a .text with .children to include math text (minor)
+* Changed title tag on numbered notes to always be h3 (major)
+* Storing all note subtitles in the pantry for link placeholders (minor)
+* Added another xmlns string option to remove if clone (minor)
+* Add class to reference superscript & add metadata to `BakeSuggestedReading` (minor)
+* Add `BakeFreeResponse` Directions (minor)
+* Add terms from composite pages to index (minor)
+* Access `.pantry` and `.clipboard` through an element instead of just its document (minor)
+* Add `suppress_solution` option to `BakeNumberedExercise` (minor)
+* Add strategy for American Government answer key (minor)
+* Add `BakeReferences` direction (minor)
+* Fix xmlns string replacement done in PR #209 (minor)
+* Move title above metadata in `BakeSuggestedReading` direction (major)
+* Remove depreciated directions `BakeNotes` and `BakeExercises` (major)
+* Adds `eoc_composite_metadata_title` to en.yml and eoc template (major)
+* Add `template` folder to kitchen to hold templates (minor)
+* Add `eoc_section_title_template` (minor)
+* Expand specs with `append_to` to have with/without `append_to` contexts (minor)
+* Add `is?` method to `ElementBase` (minor)
+* Replaced in_composite_chapter to use `is?` (minor)
+* Add callable `short_type` to Elements (minor)
+* Add template for eob titles - `eob_section_title_template` (minor)
+
+## [3.2.0] - 2021-04-20
+
+* Adds method to allow unit and page title text to be retrieved regardless of bake status (minor)
+* Rename several directions (major)
+  * `BakeChapterReviewExercises` -> `MoveExercisesToEOC`
+  * `BakeChapterReview` -> `ChapterReviewContainer`
+  * `BakeBookAnswerKey` -> `BookAnswerKeyContainer`
+  * `BakeChapterAnswerKey` -> `MoveSolutionsToAnswerKey`
+* Refactors `BakeFirstElements` and `BakeNumberedExercise` (minor)
 * Adds a decorating option of equation numbers on `BakeEquations` (minor)
 
 ## [3.1.0] - 2021-04-19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (3.2.0)
+    openstax_kitchen (4.0.0)
       activesupport
       i18n
       nokogiri
@@ -10,21 +10,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.2)
     codecov (0.2.13)
       simplecov (~> 0.18.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
     docile (1.3.3)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     inch (0.8.0)
       pry
@@ -33,7 +33,7 @@ GEM
       yard (~> 0.9.12)
     method_source (1.0.0)
     mini_portile2 (2.5.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     nokogiri (1.11.1)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
@@ -52,7 +52,7 @@ GEM
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (2.0.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -92,14 +92,13 @@ GEM
     tdiff (0.3.4)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thread_safe (0.3.6)
     tins (1.26.0)
       sync
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.24)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/docker/ci

@@ -10,7 +10,6 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 docker run $CI_ENV \
            -e ENABLE_CODECOV=1 -e CI=true \
            -v $DIR/..:/code \
-           -v vendor/bundle \
            -w /code \
            openstax/kitchen.ci:latest \
            /bin/bash -c "bundle config path vendor/bundle; bundle install; bundle exec rspec"

data/lib/kitchen/book_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: BookElementEnumerator,
-            short_type: :book)
+            enumerator_class: BookElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :book
     end
 
     # Returns the "body" element
@@ -41,5 +47,13 @@ module Kitchen
       first!('nav#toc')
     end
 
+    # Returns true if this class represents the element for the given node
+    #
+    # @param node [Nokogiri::XML::Node] the underlying node
+    # @return [Boolean]
+    #
+    def self.is_the_element_class_for?(node, **)
+      node.name == 'body'
+    end
   end
 end

data/lib/kitchen/chapter_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: ChapterElementEnumerator,
-            short_type: :chapter)
+            enumerator_class: ChapterElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :chapter
     end
 
     # Returns the title element (the one in the immediate children, not the one in the metadata)
@@ -62,14 +68,5 @@ module Kitchen
       search('[data-type="abstract"]')
     end
 
-    # Returns true if this class represents the element for the given node
-    #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
-    #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'chapter'
-    end
-
   end
 end

data/lib/kitchen/chapter_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "div[data-type='chapter']", # TODO: element.document.selectors.chapter
+        default_css_or_xpath: Selector.named(:chapter),
         sub_element_class: ChapterElement,
         enumerator_class: self
       )

data/lib/kitchen/composite_chapter_element.rb

@@ -13,8 +13,13 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: ElementEnumerator,
-            short_type: :composite_chapter)
+            enumerator_class: ElementEnumerator)
+    end
+
+    # Returns short type
+    #
+    def self.short_type
+      :composite_chapter
     end
 
     # Returns the title element (the one in the immediate children, not the one in the metadata)
@@ -29,14 +34,5 @@ module Kitchen
       first!("./*[@data-type = 'document-title']")
     end
 
-    # Returns true if this class represents the element for the given node
-    #
-    # @param node [Nokogiri::XML::Node] the underlying node
-    # @return [Boolean]
-    #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'composite-chapter'
-    end
-
   end
 end

data/lib/kitchen/composite_page_element.rb

@@ -13,8 +13,14 @@ module Kitchen
     def initialize(node:, document: nil)
       super(node: node,
             document: document,
-            enumerator_class: CompositePageElementEnumerator,
-            short_type: :composite_page)
+            enumerator_class: CompositePageElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :composite_page
     end
 
     # Returns the title element (the one in the immediate children, not the one in the metadata)
@@ -26,24 +32,23 @@ module Kitchen
       # 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']")
+      first!("./*[@data-type = 'document-title' or @data-type = 'title']")
     end
 
-    # Returns true if this class represents the element for the given node
+    # Returns true if this page is a book index
     #
-    # @param node [Nokogiri::XML::Node] the underlying node
     # @return [Boolean]
     #
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == 'composite-page'
+    def is_index?
+      has_class?('os-index-container')
     end
 
-    # Returns true if this page is a book index
+    # Returns true if this page is a book reference
     #
     # @return [Boolean]
     #
-    def is_index?
-      has_class?('os-index-container')
+    def is_reference?
+      has_class?('os-reference-container')
     end
 
   end

data/lib/kitchen/composite_page_element_enumerator.rb

@@ -11,7 +11,7 @@ module Kitchen
     #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "div[data-type='composite-page']",
+        default_css_or_xpath: Selector.named(:composite_page),
         sub_element_class: CompositePageElement,
         enumerator_class: self
       )

data/lib/kitchen/config.rb

@@ -11,6 +11,12 @@ module Kitchen
     #
     attr_reader :selectors
 
+    # @!attribute [rw] enable_all_namespaces
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :enable_all_namespaces
+
     # Creates a new config from a file (not implemented)
     #
     def self.new_from_file(_file)
@@ -21,6 +27,7 @@ module Kitchen
     #
     def initialize(hash: {}, selectors: nil)
       @selectors = selectors || Kitchen::Selectors::Standard1.new
+      @enable_all_namespaces = hash[:enable_all_namespaces] || true
       @hash = hash
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directons for eoc glossary
+    #
+    module BakeChapterGlossary
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterGlossary
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'glossary'
+      @title = I18n.t(:eoc_key_terms_title)
+      @uuid_prefix = uuid_prefix
+
+      definitions = chapter.glossaries.search('dl').cut
+      return if definitions.none?
+      definitions.sort_by! do |definition|
+        [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
+      end
+
+      chapter.glossaries.trash
+
+      @content = definitions.paste
+
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -28,7 +28,7 @@ module Kitchen
           title.name = 'h2'
           MoveTitleTextIntoSpan.v1(title: title)
 
-          intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
+          intro_content = introduction_page.search("> :not([data-type='metadata']):not(.splash):not(.has-splash)").cut
 
           introduction_page.append(child:
             <<~HTML

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterKeyConcepts
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
       end
     end
   end

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

@@ -3,10 +3,12 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     renderable
-    def bake(chapter:, metadata_source:, append_to:)
-      @metadata_elements = metadata_source.children_to_keep.copy
+    def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'key-concepts'
+      @title = I18n.t(:eoc_key_concepts)
+      @uuid_prefix = uuid_prefix
 
-      @key_concepts = []
       key_concepts_clipboard = Kitchen::Clipboard.new
       chapter.non_introduction_pages.each do |page|
         key_concepts = page.key_concepts
@@ -16,15 +18,18 @@ module Kitchen::Directions::BakeChapterKeyConcepts
         title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
         key_concepts.each do |key_concept|
           key_concept.prepend(child: title)
-          key_concept&.cut(to: key_concepts_clipboard)
+          key_concept.wrap("<div class='os-section-area'>")
+          page.search('.os-section-area').first.cut(to: key_concepts_clipboard)
         end
-        @key_concepts.push(key_concepts_clipboard.paste)
-        key_concepts_clipboard.clear
       end
 
+      @content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
+
       append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
 
-      append_to_element.append(child: render(file: 'key_concepts.xhtml.erb'))
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
     end
   end
 end