openstax_kitchen 4.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6855dd0e84e96799a57645b9023db15a07400c5b6971a0ebb29edf5c87074f0
-  data.tar.gz: e7106c5faa811f73e25a829258a4aadfccad20c32dc2a0623ec8a2526e44d274
+  metadata.gz: 68b22024e79d8b530195dafc0dba4b939f7c5503023ae1fbc1ee876a038595d9
+  data.tar.gz: 4a35e7fdbae28ecadd234c1aff6596ef61ec4aaffd4adf2a29bc401ed54b7576
 SHA512:
-  metadata.gz: 792c85c2b914719e38cca37b798160353425a6f80074926ead34c03e5fd97e47167dbc7d3efcef30d43a459a3ad917fd2e2e354fe490053e4345775cb7eac4df
-  data.tar.gz: 95d4ec07de107850a81cec9a714e5dbe83835dd1536005587109292f503d8afa9a1bdc896dc43f3198d59f18769ef7ab4c9ae2ee312d047ab8bee9997cc4c0a6
+  metadata.gz: 34d9856998c75fee77bc41b734399ffc3045a93082cba273b636b10411b852ee71f4e9bda86a38108e9293f53136194d3c85cb12ea5c92159d571c64d2b85044
+  data.tar.gz: d29fd215321a1ab877c16083b73bb0b872ee67c68a636425e6ef5ded5d8fd9ff7ae77599ec1d9a500e69ad627f175ac7c5fb1194310b8e0979d0cc7160403b55

data/.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: CHANGELOG.md
+
+on:
+  pull_request:
+
+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/CHANGELOG.md

@@ -6,6 +6,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.1.0] - 2021-06-21
+
+* Create a `BakeReferences` V2 for unnumbered section references (minor)
+* Don't check for CHANGELOG when merge a PR to main (patch)
+* Added `BakeInlineLists` (minor)
+
+## [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)
+* Rework v1 of `BakeChapterReferences` to bake references also from introduction pages (major)
+* 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)

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (4.0.0)
+    openstax_kitchen (6.1.0)
       activesupport
       i18n
       nokogiri
       rainbow
+      twitter_cldr
 
 GEM
   remote: https://rubygems.org/
@@ -18,12 +19,14 @@ GEM
       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.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    docile (1.3.3)
+    docile (1.4.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     inch (0.8.0)
@@ -83,10 +86,12 @@ 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)
@@ -94,6 +99,10 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
+    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)

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/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/chapter_element.rb

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

@@ -43,13 +43,30 @@ module Kitchen
       has_class?('os-index-container')
     end
 
-    # Returns true if this page is a book reference
+    # In books we can find two types of EOB References.
+    #
+    # One of them has form similar to footnotes. There are citation links in the text that provides
+    # to the reference note at the end of the book.
+    #
+    # Second one is a section with references on the Introduction page that is moved to the EOB.
+    #
+    # Difference in classes is important.
+
+    # Returns true if this page is a book citation reference
     #
     # @return [Boolean]
     #
-    def is_reference?
+    def is_citation_reference?
       has_class?('os-reference-container')
     end
 
+    # Returns true if this page is a book section reference
+    #
+    # @return [Boolean]
+    #
+    def is_section_reference?
+      has_class?('os-references-container')
+    end
+
   end
 end

data/lib/kitchen/config.rb

@@ -17,6 +17,12 @@ module Kitchen
     #
     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)
@@ -28,6 +34,7 @@ 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

data/lib/kitchen/directions/bake_appendix.rb

@@ -17,7 +17,9 @@ module Kitchen
 
         # Make a section with data-depth of X have a header level of X+1
         page.search('section').each do |section|
-          title = section.first!("[data-type='title']")
+          title = section.titles.first
+          next unless title.present?
+
           title.name = "h#{section['data-depth'].to_i + 1}"
         end
       end

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -3,21 +3,31 @@
 module Kitchen
   module Directions
     module BakeChapterIntroductions
-      def self.v1(book:)
+      def self.v1(book:, bake_chapter_objectives: true)
         book.chapters.each do |chapter|
-          outline_items_html = chapter.pages.map do |page|
-            next if page.is_introduction?
+          chapter_outline_html = ''
 
-            <<~HTML
-              <div class="os-chapter-objective">
-                <a class="os-chapter-objective" href="##{page.title[:id]}">
-                  <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter) - 1}</span>
-                  <span class="os-divider"> </span>
-                  <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
-                </a>
+          if bake_chapter_objectives
+            outline_items_html = chapter.non_introduction_pages.map do |page|
+
+              <<~HTML
+                <div class="os-chapter-objective">
+                  <a class="os-chapter-objective" href="##{page.title[:id]}">
+                    <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
+                    <span class="os-divider"> </span>
+                    <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
+                  </a>
+                </div>
+              HTML
+            end.join('')
+
+            chapter_outline_html = <<~HTML
+              <div class="os-chapter-outline">
+                <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
+                #{outline_items_html}
               </div>
             HTML
-          end.join('')
+          end
 
           introduction_page = chapter.introduction_page
 
@@ -33,10 +43,7 @@ module Kitchen
           introduction_page.append(child:
             <<~HTML
               <div class="intro-body">
-                <div class="os-chapter-outline">
-                  <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
-                  #{outline_items_html}
-                </div>
+                #{chapter_outline_html}
                 <div class="intro-text">
                   #{title.paste}
                   #{intro_content.paste}

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

@@ -19,7 +19,7 @@ module Kitchen::Directions::BakeChapterKeyConcepts
         key_concepts.each do |key_concept|
           key_concept.prepend(child: title)
           key_concept.wrap("<div class='os-section-area'>")
-          page.search('.os-section-area').first.cut(to: key_concepts_clipboard)
+          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
         end
       end
 

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReferences
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass)
+      end
+    end
+  end
+end