openstax_kitchen 3.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994e6a3d5161afbcd853fe2b432e7aeb80bf2390d4d7b7ae8463e6da8ce21f15
-  data.tar.gz: 7c276963aaa777b1e6116b98a9af0659f8b4e9c1491a3fe968bd9f15fc46f61c
+  metadata.gz: c8e1365bab888949c899b5cb36518be9456bd23d0369ddab9a42ac81f82cc024
+  data.tar.gz: cd86a88028f0946885add3866ffad6133f84ce48a779800cb5105cc8153736d4
 SHA512:
-  metadata.gz: a0041d04e8a1e39295c21ed0884db3e1b838edac90c7c317409b3499e1e2d5744450d26ccb1518a55c7cf6ec39a35b278e03781b8f9933486d789583b9c39bdd
-  data.tar.gz: f9207ee80e17ae3035d2c29cca11f4d59e10afc7193e73f751763fb27987477e7cffcc914166927d196484c0c82767d3c1302bca92a64098d4eb2674edb83843
+  metadata.gz: 16b9afc1d63a6098aad2396e114975ea35d39890c9a4c27c88dfef7710d129ddf16e3f18d775042ae919d0dff5284d41b53f668621d5cd74f2e723a670fd33d9
+  data.tar.gz: 9b93c51846a460a3e71c6a6080f53be61f1fa93ab268f954ddf3b7d447a1f9602dd789d876bc41e2997f8f44e682453c413f2f28ea7754c4d7f1015d3ecde1a6

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,6 +6,70 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.0.0] - 2021-06-02
+
+* Reditributed duplicated id logic across `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, added a couple more tests for `#copy`, `#cut`, and `#paste`, created a new class `IdTracker` and moved `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, and `modified_id_to_paste` into the new class (major)
+* Moved selectors from recipe to kitchen on `BakeFirstElements` Direction (minor)
+* Auto-detect language based on document; force output encoding to UTF-8 (major)
+* Switched to using a library to sort strings in a language-specific way (patch)
+* Remove summary attribute from `BakeNumberedTable` (major)
+
+## [4.1.1] - 2021-05-24
+
+* Adds low level Nokogiri caching, disabled by default (patch)
+* Cache Selector objects since they don't change (patch)
+* Use more specific selectors when to reduce bake time (patch)
+
+## [4.1.0] - 2021-05-18
+
+* Fixed performance problem with element class detection (patch)
+* Added `BakeChapterReferences` Directions (minor)
+
+## [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
 
 * Add the ability to copy an element's ID to `ElementBase` (minor)

data/Gemfile.lock

@@ -1,30 +1,33 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (3.1.0)
+    openstax_kitchen (5.0.0)
       activesupport
       i18n
       nokogiri
       rainbow
+      twitter_cldr
 
 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)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.1.0)
     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 +36,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 +55,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 +95,17 @@ 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)
+    twitter_cldr (6.6.0)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.1)
+      tzinfo
+    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/README.md

@@ -641,6 +641,22 @@ expect(book_1).to match_normalized_html("some string of HTML here")
 expect(book_1).to match_html_nodes("some string of HTML here")
 ```
 
+### Profiling
+
+If you set the `PROFILE` environment variable to something before you run specs or a recipe, search query profile data will be collected and printed, e.g.
+
+```bash
+%> PROFILE=1 rspec
+```
+
+### Caching
+
+There's a low-level CSS query caching tool that saves repeated queries.  In some tests, it saves 15% of query time.  It is disabled by default (because we aren't super sure that it is completely safe) but can be turned on with
+
+```ruby
+doc.config.enable_search_cache = true
+```
+
 ### VSCode
 
 1. Visit `vscode:extension/ms-vscode-remote.remote-containers` in a browser

data/codecov.yaml

@@ -25,3 +25,4 @@ ignore:
   - "bin"
   - "docker"
   - "books"
+  - "lib/kitchen/patches/nokogiri_profiling"

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_document.rb

@@ -29,7 +29,7 @@ module Kitchen
     # @return [BookElement]
     #
     def book
-      BookElement.new(node: nokogiri_document.search('html').first, document: self)
+      BookElement.new(node: nokogiri_document.root, document: self)
     end
 
   end

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)
@@ -35,7 +41,7 @@ module Kitchen
     # @return [Element, nil]
     #
     def introduction_page
-      pages('.introduction').first
+      pages('$.introduction').first
     end
 
     # Returns an enumerator for the glossaries
@@ -59,16 +65,7 @@ module Kitchen
     # @return [ElementEnumerator]
     #
     def abstracts
-      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'
+      search('div[data-type="abstract"]')
     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_chapter_element_enumerator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for composite page elements
+  #
+  class CompositeChapterElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:composite_chapter),
+        sub_element_class: CompositeChapterElement,
+        enumerator_class: self
+      )
+    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,18 @@ module Kitchen
     #
     attr_reader :selectors
 
+    # @!attribute [rw] enable_all_namespaces
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :enable_all_namespaces
+
+    # @!attribute [rw] enable_search_cache
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :enable_search_cache
+
     # Creates a new config from a file (not implemented)
     #
     def self.new_from_file(_file)
@@ -21,6 +33,8 @@ module Kitchen
     #
     def initialize(hash: {}, selectors: nil)
       @selectors = selectors || Kitchen::Selectors::Standard1.new
+      @enable_all_namespaces = hash[:enable_all_namespaces] || true
+      @enable_search_cache = hash[:enable_search_cache] || false
       @hash = hash
     end
   end