openstax_kitchen 3.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e855f5598f3d3a425d670a828131a25605935b01ce0de9c38cceea7bb27703f
-  data.tar.gz: 50b1a58be988e539a031390ee7387a1249a1ddcdc2734c3b9a0d9c9dfa43b426
+  metadata.gz: 544eb8b780fd248111e4dc9738c32b7edfefc101fbf6abd82f25c01bada69708
+  data.tar.gz: c3f1e2658259f5d9a04dde8aa188793c3c82e8ef6a4f6c1354e2b50d5ed7982d
 SHA512:
-  metadata.gz: 844384ec30da9c49e15026d1e5604e7248ef3a2806bbd242be398a04d6d8bddb8924225036dc3f4cfd0a0033fa27fa0bb975768317ddae012684bcf01e5b7483
-  data.tar.gz: 3f68410be5d1f0e7b06a8f8b618f44cd022a35d6e5ab6ce76a785eb5f702cd22ef2312cba218d8d0fb0628ce13d04cffc023fc647bee16c6ebe6ab566c2f862e
+  metadata.gz: 1829a8193fd8d53e2eaa4d91bd00417eb439b1dce3e690b865ff7741d3aad8637282a680f7840842180bfd811cbd79d7275b1c75502fdbcb72d39ed81572b905
+  data.tar.gz: 6cf08743860774a7f7b6fa73d26d4adbc56d7e2849e2178fc020456f113774942d23f7f14f2a5f02393c43cbfa0312b787bbb8a1adbdca4943fd76cb697ff9c0

data/.github/workflows/changelog.yml

@@ -0,0 +1,27 @@
+name: CHANGELOG.md
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  exists:
+    timeout-minutes: 10
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Check for CHANGELOG.md in this PR
+        # https://dev.to/scienta/get-changed-files-in-github-actions-1p36
+        run: |
+          if [[ $(git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep CHANGELOG.md) ]]; then
+            echo "CHANGELOG.md is included in the pull request! Way to go!"
+            exit 0
+          else
+            echo "CHANGELOG.md was not modified in this pull request.  Boo!"
+            exit 1
+          fi

data/.github/workflows/rubocop.yml

@@ -0,0 +1,28 @@
+name: Rubocop
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    timeout-minutes: 10
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Build docker image and run rubocop within it
+        # See https://docs.codecov.io/docs/testing-with-docker
+        run: |
+          ./docker/build --ci
+          ./docker/rubocop ${{ github.event.pull_request.base.sha }} ${{ github.sha }}

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,101 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.2.0] - 2021-04-19
 
+## [6.0.0] - 2021-06-15
+
+* Allow `BakeChapterSummary` to skip pages where there is no summary (minor)
+* Change `PageElement#summary` to return nil instead of raise an error if no matches (major?)
+* Fix bug in `BakeNumberedNotes:::V3` when there are multiple os-numbers (minor)
+* Add Rubocop and a working CHANGELOG check to GitHub actions (patch)
+* Allow `BakeFootnotes` to number footnotes with Roman numerals (minor)
+* Create V2 for `BakeNumberedTables` (minor)
+* Remove extraneous title in `BakeChapterSectionExercises` (minor)
+* Create V2 for `BookAnswerKeyContainer` and `MoveSolutionsToEOC` with singular option for wrapper class (minor)
+* Delete `abstract` and `description` elements from preface in `BakePreface` (minor)
+* Stop deleting the first `<strong>` tag in `BakeNumberedNotes` (major)
+* Allow `BakeFigure` to bake unnumbered splash figures (minor)
+* Extend `ChapterReviewContainer` to accept other classes (major?)
+* Add a `Strategy` for Precalculus (minor)
+* Create a `BakeNumberedNotes` V2 (minor)
+* Added a version of `BakeChapterIntroductions` without a chapter outline (minor)
+* Add `BakeChapterSolutions` which bakes the free response solutions at the eoc (minor)
+* Changed locale `eoc_answer_key_title` to `answer_key_title` as it was only used in eob (major)
+* Added spec for translations (minor)
+* Remove summary attribute from numbered tables, add option to pass title element to `BakePreface` (minor)
+* Renamed `American Government` strategy to `Default` inside `move_solutions_to_answer_key` for other books to use it with a sent in classname (major)
+* Adds `#previous` method to note_elements to find the immediately previous element (minor)
+* Adds `BakeNumberedNotes` V3 (minor)
+* Added line that puts the classname `has-footnote` in the footnote ref's parent element (major)
+* Added a condition into `BakeChapterSummary` so it doesn't bake the title if it already includes the respective number in it
+* Create v3 of MoveExercisesToEOC which differs from v1 by the presence of a section title
+and from v2 the lack of additional "os-section-area" and os-#{@klass} wrapper (minor)
+* Add a condition in BakeNumberedExercise to make it possible to suppress even solutions in the Answer Key (minor)
+* Fix BakeFurtherResearch baking with main bake script error by breaking the loop if further research sections are not present (minor)
+* Fix for `BakeIndex` for words that start with a number to be grouped as symbols and for first letters with accent marks to be grouped with regular letters in alphabetic order (major)
+
+## [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

data/Gemfile.lock

@@ -1,30 +1,33 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (3.2.0)
+    openstax_kitchen (6.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)
-    codecov (0.2.13)
-      simplecov (~> 0.18.0)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.1.0)
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    docile (1.3.3)
-    i18n (1.8.5)
+    docile (1.4.0)
+    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)
@@ -83,23 +86,28 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     sparkr (0.4.1)
     sync (0.5.0)
     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/docker/rubocop

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# set -x
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+from="${1:-main}"
+to="${2:-HEAD}"
+
+echo "Checking from $from to $to"
+
+# https://dev.to/scienta/get-changed-files-in-github-actions-1p36
+changed_ruby_files=$(git diff --name-only --diff-filter=ACMRT $from $to | grep -E "(lib\/|spec\/)*.rb$" | xargs)
+
+if [[ -z "${changed_ruby_files// }" ]]; then
+  echo "No files to lint with Rubocop"
+else
+  docker run -v $DIR/..:/code \
+             -w /code \
+             openstax/kitchen.ci:latest \
+             /bin/bash -c "bundle config path vendor/bundle; bundle install; bundle exec rubocop $changed_ruby_files --disable-pending-cops"
+fi

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