openstax_kitchen 1.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4f70bbb3dd410d515f7501ed2b95635d4ca8b8369fe1b8ed5eda66e5c64c07
-  data.tar.gz: ec5151233398b0136e0494efe4b4637876ab3e318f6606ea66fe8a750c46cbf0
+  metadata.gz: a6855dd0e84e96799a57645b9023db15a07400c5b6971a0ebb29edf5c87074f0
+  data.tar.gz: e7106c5faa811f73e25a829258a4aadfccad20c32dc2a0623ec8a2526e44d274
 SHA512:
-  metadata.gz: fce19e98ac530ffd809acb5ff968dbd9b786b11eaa217faec40f7e0af7ad5e2a2f70fae5aed9eb0d2b71bce7456a4d4b9e3842d2d484b17f7da529ed02af9d3a
-  data.tar.gz: 36d66b6aa6cc8585726007f0edeff8eae49be3222dd33b367adb1b0b6554c0bfbc4f39537ad1e95fbf9bc0cf15a91049347c4940644dcf47348eb932bf42f623
+  metadata.gz: 792c85c2b914719e38cca37b798160353425a6f80074926ead34c03e5fd97e47167dbc7d3efcef30d43a459a3ad917fd2e2e354fe490053e4345775cb7eac4df
+  data.tar.gz: 95d4ec07de107850a81cec9a714e5dbe83835dd1536005587109292f503d8afa9a1bdc896dc43f3198d59f18769ef7ab4c9ae2ee312d047ab8bee9997cc4c0a6

data/.devcontainer/devcontainer.json

@@ -1,19 +1,39 @@
 {
- "name": "Kitchen Dev",
- "dockerComposeFile": ["../docker-compose.yml"],
- "service": "app",
- "workspaceFolder": "/code",
- "shutdownAction": "stopCompose",
- "extensions": [
-   "castwide.solargraph",
- ],
- "settings": {
-   "[ruby]": {
-     "editor.insertSpaces": true,
-     "editor.tabSize": 2
-   },
-   "solargraph.commandPath": "/usr/local/bundle/bin/solargraph",
-   "solargraph.bundlerPath": "/usr/local/bin/bundle",
- },
- "postCreateCommand": "bundle install"
+  "name": "Kitchen Dev",
+  "build": {
+    "dockerfile": "../docker/Dockerfile",
+    "context": "..",
+    "args": {
+      "bundler_version": "2.2.4"
+    }
+  },
+  "workspaceMount": "source=${localWorkspaceFolder},target=/code,type=bind,consistency=default",
+  "workspaceFolder": "/code",
+  "extensions": [
+    "castwide.solargraph",
+    "rebornix.Ruby",
+    "MS-vsliveshare.vsliveshare-pack"
+  ],
+  "settings": {
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "terminal.integrated.shell.linux": "/bin/bash",
+    "[ruby]": {
+      "editor.insertSpaces": true,
+      "editor.tabSize": 2,
+    },
+    "ruby.lint": {
+      "rubocop": {
+        "useBundler": true // enable rubocop via bundler
+      },
+    },
+    "ruby.format": "rubocop", // use rubocop for formatting
+    "ruby.useLanguageServer": true,
+    "solargraph.commandPath": "/usr/local/bundle/bin/solargraph",
+    "solargraph.bundlerPath": "/usr/local/bin/bundle",
+    "ruby.rubocop.executePath": "/usr/local/bundle/bin/",
+    "ruby.rubocop.onSave": true,
+    "ruby.rubocop.configFilePath": "/code/.rubocop.yml",
+    "terminal.integrated.scrollback": 100000
+  }
 }

data/.github/config.yml

@@ -0,0 +1,14 @@
+# See https://github.com/openstax/staxly#plugins for more options for this file
+changelog:
+  # See https://github.com/mikz/probot-changelog for details
+
+  # The filename of the CHANGELOG that needs to be updated in every PullRequest
+  filename: CHANGELOG.md
+
+  # (optional) when files matching these patterns are changed then disallow merging
+  # until the CHANGELOG is updated.
+  # If this pattern is not included then **all** Pull Requests require an edit to 
+  # the CHANGELOG file
+  
+  # include:
+  #   - /^src\//

data/.github/workflows/tests.yml

@@ -5,32 +5,22 @@ on:
   push:
     branches:
       - main
-  schedule:
-    - cron: '0 0 * * 0' # weekly
 
 jobs:
-  tests:
+  rspec:
     timeout-minutes: 10
     runs-on: ubuntu-18.04
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6
       - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
             ${{ runner.os }}-gems-
-      - name: Test
-        env:
-          ENABLE_CODECOV: 1
+      - name: Build docker image and run specs within it
+        # See https://docs.codecov.io/docs/testing-with-docker
         run: |
-          gem install bundler --force --no-document --version 2.1.4
-          bundle config deployment true
-          bundle config path vendor/bundle
-          bundle config jobs 2
-          bundle install
-          bundle exec rake
+          ./docker/build --ci
+          CI_ENV=`bash <(curl -s https://codecov.io/env)` ./docker/ci

data/.gitignore

@@ -7,14 +7,14 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status
-.irb_history
+.irb-history
 .byebug_history
 bin/scratch
 tutorial/outputs/*.html
 
 tutorials/**/actual_baked.*html
 tutorials/**/my_recipe.rb
-

data/.inch.yml

@@ -0,0 +1,6 @@
+files:
+  # define files excluded from the analysis (defaults to [])
+  excluded:
+    - lib/kitchen/directions/**/*.rb # may want to add this in later in a limited way
+    - lib/kitchen/debug/**/*.rb
+    - lib/openstax_kitchen.rb

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  IgnoredPatterns: ['(\A|\s)#']
+
+Metrics/AbcSize:
+  Max: 50
+
+Naming/PredicateName:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 300
+  CountAsOne: ['heredoc']
+
+Metrics/MethodLength:
+  Max: 50
+  CountAsOne: ['heredoc']
+
+Metrics/BlockLength:
+  CountAsOne: ['heredoc']
+  Max: 30
+  Exclude:
+    - 'openstax_kitchen.gemspec'
+
+Metrics/ModuleLength:
+  CountAsOne: ['heredoc']
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/StringLiterals:
+  ConsistentQuotesInMultiline: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/AccessorGrouping:
+  EnforcedStyle: separated
+
+Style/SingleLineMethods:
+  Enabled: false # don't abuse it, but sometimes it is right
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/SymbolProc:
+  IgnoredMethods:
+    - respond_to
+    - define_method
+    - XML # For Nokogiri::XML
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false # when true hanging parens look weird
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,89 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.0] - 2020-10-03
+## [4.0.0] - 2021-05-18
 
-First official version.
+* 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)
+* Added support for titles in `BakeFigure` (minor)
+* Created `BakeUnitTitle` class
+* Created `UnitElement` and `UnitElementEnumerator` classes (minor)
+* Added support for Units in `BakeToc` direction (minor)
+* Added `Unit` to `en.yml` (patch)
+* Remove chapter summary titles only if they exist (minor)
+* Created `BakeSuggestedReading` direction for EOC
+* 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
+* 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
+
+* First official version.

data/Gemfile

@@ -1,9 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in kitchen.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
 
 gem 'codecov', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (1.0.0)
+    openstax_kitchen (4.0.0)
       activesupport
       i18n
       nokogiri
@@ -10,29 +10,49 @@ 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)
-    concurrent-ruby (1.1.7)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    docile (1.3.2)
-    i18n (1.8.5)
+    docile (1.3.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
     nokogiri-diff (0.2.0)
       nokogiri (~> 1.5)
       tdiff (~> 0.3, >= 0.3.2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.0.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -46,29 +66,57 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (1.6.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
+    sparkr (0.4.1)
+    sync (0.5.0)
     tdiff (0.3.4)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    tins (1.26.0)
+      sync
+    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
+  x86_64-linux
 
 DEPENDENCIES
   byebug
   codecov
+  inch
   nokogiri-diff
   openstax_kitchen!
   rainbow
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.4