openstax_kitchen 3.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f404296c40eba5dbfdeeb4c4de0d11492eb327e94d49c96689b262a03bc838de
-  data.tar.gz: b97faf532e7e098dba23ef1d1f3c42ca7c051d7fc6ad8351fa6b20209cb99ddd
+  metadata.gz: b80bf07271b311949246bf6a63a9d10fe5f14396175f66a129debcc9e9ef15e3
+  data.tar.gz: 7a3a7050d134a0b106d3a80dc18add9209742fca1eea4873f351eb0dd4d05034
 SHA512:
-  metadata.gz: 7f8e774352355cc44b01765b101e97db3128e19e7416a6d5138d0a83db4378e7910d196e42849237e2130c6f7463db6f13679d53ac666b6a0abf6f867ecf6a36
-  data.tar.gz: 84fece5f5d36f16324022d3ca34b6827f6549bed21551caedbb2845ff41d5b7b1f4b47c8e07a6fac6b14ed2e5f092435b63618a3b9e0f925a40cda21b04babfb
+  metadata.gz: 7fee3b2b4dd92639af2e20520c3f65a31255d944df649e91c5c0e5c8f0a8e1e1f6d19b4477480c5cbc899f7124727c8a40b5a0759985ec94225885baf36b3287
+  data.tar.gz: ed62932aa44e597135158cc182daefd2773b89070e1d82750669d4d1f760fa8179f1197c67eddcdec73c1cdc2b1bd7537ca28c8f5603d3a2a7962457d777141f

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,80 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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)
+* Create `pl.yml` and add pl to available locals in `StubHelpers` module (minor)
+* Add to `BakeNumberedNotes` directions for baking exercises in a note (with this comes removing bake checkpoints and theorems)
+* Add `BakeEquations` direction (minor)
+* Remove `NoteElement` logging (minor)
+* Adds `BakeChapterReviewExercises` v2 and a u-physics `Strategy` to `BakeChapterAnswerKey` to support baking exercises in u-physics (minor)
+* Have deprecated directions log a warning (minor)
+* Added `wrap_children` method on elements (minor)
+* Refactored `NoteElement` to infer the note title from book-specific locales (minor)
+* Added support for a recipe to infer or be given a book-specific locale file (minor)
+* Added `NumberedTable` support for titles and always captions (minor)
+* Added titles method to `ElementEnumeratorBase` and `ElementBase` (minor)
+* Added a file for baking composite chapters called (`bake_composite_chapters`) and the respective spec.
+(minor change)
+* Added `BakeProblemFirstElements` direction (minor)
+
 ## [3.0.0] - 2021-03-17
 
 * Added a subfigure? method to `FigureElements`(minor)
@@ -19,11 +93,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added ability to filter searches based on `only` and `except` conditions, which can be names of element methods or blocks of code (minor)
 * Changed from tracking and using `css_or_xpath` strings and arrays to `search_query` objects that
   wrap `css_or_xpath` variables along with `only` and `except` conditions. (major?)
+* Refactored bake_exercises to better support parallel work on multiple versions. (minor)
 
 ## [2.0.0] - 2020-12-18
-
-* Refactored bake_exercises to better support parallel work on multiple versions.
-(minor change) Does not affect existing recipes.
+* Added a file for baking key concepts called (`bake_chapter_key_concepts`) and the respective specs.
+(minor change) only affects the book if called from the recipe
 * Changed the main gem source file to have the same name as the gem (`openstax_kitchen`) so that you don't have to `require` a different name than you use in your `gem` call.
 
 ## [1.0.0] - 2020-12-15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (3.0.0)
+    openstax_kitchen (4.1.1)
       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/README.md

@@ -210,6 +210,13 @@ And we can wrap an element with another element:
 doc.search("span").first.wrap("<span class='other'>")
 ```
 
+or wrap an element's children:
+
+```ruby
+# <div><span>Hi</span></div> => <div><span><span class="other" data-type="foo">Hi</span></span></div>
+doc.search("span").first.wrap_children('span', class: 'other', data_type: 'foo')
+```
+
 ### Checking for elements
 
 You can see if an element contains an element matching a selector:
@@ -634,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