openstax_kitchen 2.0.0 → 4.1.0

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +122,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: OpenStax content baking library
 email:
 - jpslav@gmail.com
@@ -130,13 +186,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".devcontainer/devcontainer.json"
+- ".github/config.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
+- ".inch.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".solargraph.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -145,9 +203,14 @@ files:
 - bin/console
 - bin/setup
 - codecov.yaml
-- docker-compose.yml
+- docker/Dockerfile
+- docker/Dockerfile.ci
 - docker/bash
-- docker/entrypoint
+- docker/build
+- docker/ci
+- docker/run
+- docker/tag_and_push_latest
+- lefthook.yml
 - lib/kitchen/ancestor.rb
 - lib/kitchen/book_document.rb
 - lib/kitchen/book_element.rb
@@ -162,27 +225,76 @@ files:
 - lib/kitchen/config.rb
 - lib/kitchen/counter.rb
 - lib/kitchen/debug/print_recipe_error.rb
+- lib/kitchen/directions/.rubocop.yml
 - lib/kitchen/directions/bake_appendix.rb
-- lib/kitchen/directions/bake_chapter_glossary.rb
+- lib/kitchen/directions/bake_chapter_glossary/main.rb
+- lib/kitchen/directions/bake_chapter_glossary/v1.rb
 - lib/kitchen/directions/bake_chapter_introductions.rb
+- lib/kitchen/directions/bake_chapter_key_concepts/main.rb
+- lib/kitchen/directions/bake_chapter_key_concepts/v1.rb
 - lib/kitchen/directions/bake_chapter_key_equations.rb
+- lib/kitchen/directions/bake_chapter_references/main.rb
+- lib/kitchen/directions/bake_chapter_references/v1.rb
+- lib/kitchen/directions/bake_chapter_section_exercises/main.rb
+- lib/kitchen/directions/bake_chapter_section_exercises/v1.rb
 - lib/kitchen/directions/bake_chapter_summary.rb
+- lib/kitchen/directions/bake_chapter_title/main.rb
+- lib/kitchen/directions/bake_chapter_title/v1.rb
+- lib/kitchen/directions/bake_checkpoint.rb
+- lib/kitchen/directions/bake_composite_chapters.rb
 - lib/kitchen/directions/bake_composite_pages.rb
+- lib/kitchen/directions/bake_equations.rb
 - lib/kitchen/directions/bake_example.rb
-- lib/kitchen/directions/bake_exercises.rb
 - lib/kitchen/directions/bake_figure.rb
+- lib/kitchen/directions/bake_first_elements.rb
 - lib/kitchen/directions/bake_footnotes/main.rb
 - lib/kitchen/directions/bake_footnotes/v1.rb
+- lib/kitchen/directions/bake_free_response/free_response.xhtml.erb
+- lib/kitchen/directions/bake_free_response/main.rb
+- lib/kitchen/directions/bake_free_response/v1.rb
+- lib/kitchen/directions/bake_further_research.rb
 - lib/kitchen/directions/bake_index/main.rb
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
+- lib/kitchen/directions/bake_link_placeholders.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
-- lib/kitchen/directions/bake_notes.rb
+- lib/kitchen/directions/bake_non_introduction_pages.rb
+- lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
+- lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes.rb
+- lib/kitchen/directions/bake_notes/bake_unclassified_notes.rb
+- lib/kitchen/directions/bake_numbered_exercise/main.rb
+- lib/kitchen/directions/bake_numbered_exercise/v1.rb
 - lib/kitchen/directions/bake_numbered_table/main.rb
 - lib/kitchen/directions/bake_numbered_table/v1.rb
+- lib/kitchen/directions/bake_page_abstracts.rb
+- lib/kitchen/directions/bake_preface/main.rb
+- lib/kitchen/directions/bake_preface/v1.rb
+- lib/kitchen/directions/bake_references/main.rb
+- lib/kitchen/directions/bake_references/v1.rb
 - lib/kitchen/directions/bake_stepwise.rb
+- lib/kitchen/directions/bake_suggested_reading.rb
+- lib/kitchen/directions/bake_theorem/main.rb
+- lib/kitchen/directions/bake_theorem/v1.rb
 - lib/kitchen/directions/bake_toc.rb
+- lib/kitchen/directions/bake_unit_title/main.rb
+- lib/kitchen/directions/bake_unit_title/v1.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
+- lib/kitchen/directions/book_answer_key_container/eob_solutions_container.xhtml.erb
+- lib/kitchen/directions/book_answer_key_container/main.rb
+- lib/kitchen/directions/book_answer_key_container/v1.rb
+- lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb
+- lib/kitchen/directions/chapter_review_container/main.rb
+- lib/kitchen/directions/chapter_review_container/v1.rb
+- lib/kitchen/directions/eoc_section_title_link_snippet.rb
+- lib/kitchen/directions/move_exercises_to_eoc/main.rb
+- lib/kitchen/directions/move_exercises_to_eoc/v1.rb
+- lib/kitchen/directions/move_exercises_to_eoc/v2.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/main.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/american_government.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/uphysics.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/v1.rb
 - lib/kitchen/directions/move_title_text_into_span.rb
 - lib/kitchen/document.rb
 - lib/kitchen/element.rb
@@ -194,8 +306,12 @@ files:
 - lib/kitchen/errors.rb
 - lib/kitchen/example_element.rb
 - lib/kitchen/example_element_enumerator.rb
+- lib/kitchen/exercise_element.rb
+- lib/kitchen/exercise_element_enumerator.rb
 - lib/kitchen/figure_element.rb
 - lib/kitchen/figure_element_enumerator.rb
+- lib/kitchen/metadata_element.rb
+- lib/kitchen/metadata_element_enumerator.rb
 - lib/kitchen/mixins/block_error_if.rb
 - lib/kitchen/note_element.rb
 - lib/kitchen/note_element_enumerator.rb
@@ -207,43 +323,52 @@ files:
 - lib/kitchen/patches/renderable.rb
 - lib/kitchen/patches/string.rb
 - lib/kitchen/recipe.rb
+- lib/kitchen/reference_element.rb
+- lib/kitchen/references_element_enumerator.rb
 - lib/kitchen/search_history.rb
+- lib/kitchen/search_query.rb
+- lib/kitchen/selector.rb
 - lib/kitchen/selectors/base.rb
 - lib/kitchen/selectors/standard_1.rb
 - lib/kitchen/table_element.rb
 - lib/kitchen/table_element_enumerator.rb
+- lib/kitchen/templates/eob_section_title_template.xhtml.erb
+- lib/kitchen/templates/eoc_section_title_template.xhtml.erb
 - lib/kitchen/term_element.rb
 - lib/kitchen/term_element_enumerator.rb
 - lib/kitchen/transliterations.rb
 - lib/kitchen/type_casting_element_enumerator.rb
+- lib/kitchen/unit_element.rb
+- lib/kitchen/unit_element_enumerator.rb
 - lib/kitchen/utils.rb
 - lib/kitchen/version.rb
 - lib/locales/en.yml
+- lib/locales/pl.yml
 - lib/notes.md
 - lib/openstax_kitchen.rb
 - openstax_kitchen.gemspec
 - tutorials/00/expected_baked.html
 - tutorials/00/raw.html
-- tutorials/00/solution_1.rb
-- tutorials/00/solution_2.rb
+- tutorials/00/solution1.rb
+- tutorials/00/solution2.rb
 - tutorials/01/expected_baked.html
 - tutorials/01/raw.html
-- tutorials/01/solution_1.rb
-- tutorials/01/solution_2.rb
+- tutorials/01/solution1.rb
+- tutorials/01/solution2.rb
 - tutorials/02/expected_baked.html
 - tutorials/02/raw.html
-- tutorials/02/solution_1.rb
+- tutorials/02/solution1.rb
 - tutorials/03/expected_baked.html
 - tutorials/03/raw.html
-- tutorials/03/solution_1.rb
-- tutorials/03/solution_2.rb
+- tutorials/03/solution1.rb
+- tutorials/03/solution2.rb
 - tutorials/04/expected_baked.html
 - tutorials/04/raw.html
-- tutorials/04/solution_1.rb
-- tutorials/04/solution_2.rb
+- tutorials/04/solution1.rb
+- tutorials/04/solution2.rb
 - tutorials/05/expected_baked.html
 - tutorials/05/raw.html
-- tutorials/05/solution_1.rb
+- tutorials/05/solution1.rb
 - tutorials/check_it
 - tutorials/setup_my_recipes
 homepage: https://github.com/openstax/kitchen
@@ -262,7 +387,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Dockerfile

@@ -1,19 +0,0 @@
-FROM ruby:2.6-slim
-
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-    git \
-    build-essential \
-    && rm -rf /var/lib/apt/lists/*
-
-WORKDIR /code
-COPY . /code/
-
-RUN gem install bundler
-RUN bundle install
-
-# Install other things that make development good
-RUN gem install solargraph
-RUN bundle exec yard gems
-
-ENTRYPOINT ["/code/docker/entrypoint"]

data/docker-compose.yml

@@ -1,12 +0,0 @@
-version: '3.7'
-services:
-  app:
-    image: "openstax/kitchen"
-    build: .
-    volumes:
-      - .:/code
-    networks:
-      - openstax
-networks:
-  openstax:
-    name: openstax

data/docker/entrypoint

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-# uncomment this to load docker secrets into environment variables
-# export $(egrep  -v '^#'  /run/secrets/* | xargs)
-
-# exec "$@"
-
-tail -f /dev/null

data/lib/kitchen/directions/bake_chapter_glossary.rb

@@ -1,34 +0,0 @@
-module Kitchen
-  module Directions
-    module BakeChapterGlossary
-
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
-
-        definitions = chapter.glossaries.search("dl").cut
-        definitions.sort_by! do |definition|
-          [definition.first("dt").text.downcase, definition.first("dd").text.downcase]
-        end
-
-        chapter.glossaries.trash
-
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-glossary-container" data-type="composite-page" data-uuid-key="glossary">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_key_terms_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_terms_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{definitions.paste}
-            </div>
-          HTML
-        ) unless definitions.none?
-      end
-
-    end
-  end
-end

data/lib/kitchen/directions/bake_exercises.rb

@@ -1,164 +0,0 @@
-module Kitchen
-  module Directions
-    module BakeExercises
-
-      def self.v1(book:)
-        metadata_elements = book.metadata.search(%w(.authors .publishers .print-style
-                                                    .permissions [data-type='subject'])).copy
-
-        solutions_clipboards = []
-
-        book.chapters.each do |chapter|
-          exercise_clipboard = Clipboard.new
-          solution_clipboard = Clipboard.new
-          solutions_clipboards.push(solution_clipboard)
-
-          chapter.pages("$:not(.introduction)").each do |page|
-            exercise_section = page.exercises
-            exercise_section.first("[data-type='title']")&.trash
-            exercise_section_title = page.title.copy
-            exercise_section_title.name = "h3"
-            exercise_section_title.replace_children(with: <<~HTML
-                <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-                <span class="os-divider"> </span>
-                <span class="os-text" data-type="" itemprop="">#{exercise_section_title.children}</span>
-              HTML
-            )
-
-            exercise_section.prepend(child:
-              <<~HTML
-                <a href="##{page.title.id}">
-                  #{exercise_section_title.paste}
-                </a>
-              HTML
-            )
-
-            exercise_section.search("[data-type='exercise']").each do |exercise|
-              exercise.document.pantry(name: :link_text).store(
-                "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-                label: exercise.id
-              )
-
-              bake_exercise_in_place(exercise: exercise)
-              exercise.first("[data-type='solution']")&.cut(to: solution_clipboard)
-            end
-
-            exercise_section.cut(to: exercise_clipboard)
-          end
-
-          chapter.append(child:
-            <<~HTML
-              <div class="os-eoc os-exercises-container" data-type="composite-page" data-uuid-key=".exercises">
-                <h2 data-type="document-title">
-                  <span class="os-text">#{I18n.t(:eoc_exercises_title)}</span>
-                </h2>
-                <div data-type="metadata" style="display: none;">
-                  <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_exercises_title)}</h1>
-                  #{metadata_elements.paste}
-                </div>
-                #{exercise_clipboard.paste}
-              </div>
-            HTML
-          ) unless exercise_clipboard.none?
-        end
-
-        # Store a paste here to use at end so that uniquifyied IDs match legacy baking
-        eob_metadata = metadata_elements.paste
-
-        solutions = solutions_clipboards.map.with_index do |solution_clipboard, index|
-          <<~HTML
-            <div class="os-eob os-solution-container " data-type="composite-page" data-uuid-key=".solution#{index+1}">
-              <h2 data-type="document-title">
-                <span class="os-text">#{index+1}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{index+1}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{solution_clipboard.paste}
-            </div>
-          HTML
-        end
-
-        book.first("body").append(child:
-          <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-chapter" data-uuid-key=".solution">
-            <h1 data-type="document-title" id="composite-chapter-1">
-              <span class="os-text">#{I18n.t(:eoc_answer_key_title)}</span>
-            </h1>
-            <div data-type="metadata" style="display: none;">
-              <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_answer_key_title)}</h1>
-              #{eob_metadata}
-            </div>
-            #{solutions.join("\n")}
-          </div>
-          HTML
-        ) unless solutions.none?
-      end
-
-      def self.bake_exercise_in_place(exercise:)
-        # Bake an exercise in place going from:
-        #
-        # <div data-type="exercise" id="exerciseId">
-        #   <div data-type="problem" id="problemId">
-        #     Problem Content
-        #   </div>
-        #   <div data-type="solution" id="solutionId">
-        #     Solution Content
-        #   </div>
-        # </div>
-        #
-        # to
-        #
-        # <div data-type="exercise" id="exerciseId" class="os-hasSolution">
-        #   <div data-type="problem" id="problemId">
-        #     <a class="os-number" href="#exerciseId-solution">1</a>
-        #     <span class="os-divider">. </span>
-        #     <div class="os-problem-container ">
-        #       Problem Content
-        #     </div>
-        #   </div>
-        #   <div data-type="solution" id="exerciseId-solution">
-        #     <a class="os-number" href="#exerciseId">1</a>
-        #     <span class="os-divider">. </span>
-        #     <div class="os-solution-container ">
-        #       Solution Content
-        #     </div>
-        #   </div>
-        # </div>
-        #
-        # If there is no solution, don't add the 'os-hasSolution' class and don't
-        # link the number.
-
-        problem = exercise.first("[data-type='problem']")
-        solution = exercise.first("[data-type='solution']")
-
-        problem_number = "<span class='os-number'>#{exercise.count_in(:chapter)}</span>"
-
-        if solution.present?
-          solution.id = "#{exercise.id}-solution"
-
-          exercise.add_class("os-hasSolution")
-          problem_number = "<a href='##{solution.id}' class='os-number' >#{exercise.count_in(:chapter)}</a>"
-
-          solution.replace_children(with:
-            <<~HTML
-              <a class="os-number" href="##{exercise.id}">#{exercise.count_in(:chapter)}</a>
-              <span class="os-divider">. </span>
-              <div class="os-solution-container ">#{solution.children}</div>
-            HTML
-          )
-        end
-
-        problem.replace_children(with:
-          <<~HTML
-            #{problem_number}
-            <span class="os-divider">. </span>
-            <div class="os-problem-container ">#{problem.children}</div>
-          HTML
-        )
-      end
-
-    end
-  end
-end