RubyGems - openstax_kitchen - Versions diffs - 1.0.0 - Mend

openstax_kitchen 1.0.0

Files changed (121) hide show

checksums.yaml +7 -0
data/.devcontainer/devcontainer.json +19 -0
data/.github/workflows/tests.yml +36 -0
data/.gitignore +20 -0
data/.rspec +3 -0
data/.solargraph.yml +15 -0
data/CHANGELOG.md +11 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Dockerfile +19 -0
data/Gemfile +9 -0
data/Gemfile.lock +74 -0
data/LICENSE.txt +21 -0
data/README.md +674 -0
data/Rakefile +6 -0
data/bin/console +14 -0
data/bin/normalize +79 -0
data/bin/setup +8 -0
data/books/chemistry2e/bake.rb +133 -0
data/codecov.yaml +27 -0
data/docker-compose.yml +12 -0
data/docker/bash +1 -0
data/docker/entrypoint +9 -0
data/lib/kitchen.rb +57 -0
data/lib/kitchen/ancestor.rb +30 -0
data/lib/kitchen/book_document.rb +18 -0
data/lib/kitchen/book_element.rb +24 -0
data/lib/kitchen/book_element_enumerator.rb +5 -0
data/lib/kitchen/book_recipe.rb +25 -0
data/lib/kitchen/chapter_element.rb +35 -0
data/lib/kitchen/chapter_element_enumerator.rb +13 -0
data/lib/kitchen/clipboard.rb +37 -0
data/lib/kitchen/composite_chapter_element.rb +23 -0
data/lib/kitchen/composite_page_element.rb +27 -0
data/lib/kitchen/composite_page_element_enumerator.rb +13 -0
data/lib/kitchen/config.rb +20 -0
data/lib/kitchen/counter.rb +34 -0
data/lib/kitchen/debug/print_recipe_error.rb +80 -0
data/lib/kitchen/directions/bake_appendix.rb +26 -0
data/lib/kitchen/directions/bake_chapter_glossary.rb +34 -0
data/lib/kitchen/directions/bake_chapter_introductions.rb +58 -0
data/lib/kitchen/directions/bake_chapter_key_equations.rb +30 -0
data/lib/kitchen/directions/bake_chapter_summary.rb +52 -0
data/lib/kitchen/directions/bake_composite_pages.rb +13 -0
data/lib/kitchen/directions/bake_example.rb +31 -0
data/lib/kitchen/directions/bake_exercises.rb +164 -0
data/lib/kitchen/directions/bake_figure.rb +25 -0
data/lib/kitchen/directions/bake_footnotes/main.rb +11 -0
data/lib/kitchen/directions/bake_footnotes/v1.rb +38 -0
data/lib/kitchen/directions/bake_index/main.rb +11 -0
data/lib/kitchen/directions/bake_index/v1.rb +138 -0
data/lib/kitchen/directions/bake_index/v1.xhtml.erb +28 -0
data/lib/kitchen/directions/bake_math_in_paragraph.rb +13 -0
data/lib/kitchen/directions/bake_notes.rb +58 -0
data/lib/kitchen/directions/bake_numbered_table/main.rb +11 -0
data/lib/kitchen/directions/bake_numbered_table/v1.rb +47 -0
data/lib/kitchen/directions/bake_stepwise.rb +27 -0
data/lib/kitchen/directions/bake_toc.rb +103 -0
data/lib/kitchen/directions/bake_unnumbered_tables.rb +14 -0
data/lib/kitchen/directions/move_title_text_into_span.rb +15 -0
data/lib/kitchen/document.rb +142 -0
data/lib/kitchen/element.rb +15 -0
data/lib/kitchen/element_base.rb +444 -0
data/lib/kitchen/element_enumerator.rb +12 -0
data/lib/kitchen/element_enumerator_base.rb +101 -0
data/lib/kitchen/element_enumerator_factory.rb +111 -0
data/lib/kitchen/element_factory.rb +32 -0
data/lib/kitchen/errors.rb +4 -0
data/lib/kitchen/example_element.rb +20 -0
data/lib/kitchen/example_element_enumerator.rb +13 -0
data/lib/kitchen/figure_element.rb +20 -0
data/lib/kitchen/figure_element_enumerator.rb +13 -0
data/lib/kitchen/mixins/block_error_if.rb +19 -0
data/lib/kitchen/note_element.rb +43 -0
data/lib/kitchen/note_element_enumerator.rb +13 -0
data/lib/kitchen/oven.rb +61 -0
data/lib/kitchen/page_element.rb +51 -0
data/lib/kitchen/page_element_enumerator.rb +13 -0
data/lib/kitchen/pantry.rb +35 -0
data/lib/kitchen/patches/nokogiri.rb +31 -0
data/lib/kitchen/patches/renderable.rb +31 -0
data/lib/kitchen/patches/string.rb +5 -0
data/lib/kitchen/recipe.rb +78 -0
data/lib/kitchen/search_history.rb +33 -0
data/lib/kitchen/selectors/base.rb +8 -0
data/lib/kitchen/selectors/standard_1.rb +12 -0
data/lib/kitchen/table_element.rb +36 -0
data/lib/kitchen/table_element_enumerator.rb +13 -0
data/lib/kitchen/term_element.rb +16 -0
data/lib/kitchen/term_element_enumerator.rb +13 -0
data/lib/kitchen/transliterations.rb +19 -0
data/lib/kitchen/type_casting_element_enumerator.rb +23 -0
data/lib/kitchen/utils.rb +19 -0
data/lib/kitchen/version.rb +3 -0
data/lib/locales/en.yml +21 -0
data/lib/notes.md +9 -0
data/openstax_kitchen.gemspec +39 -0
data/tutorials/00/expected_baked.html +3 -0
data/tutorials/00/raw.html +3 -0
data/tutorials/00/solution_1.rb +7 -0
data/tutorials/00/solution_2.rb +6 -0
data/tutorials/01/expected_baked.html +66 -0
data/tutorials/01/raw.html +62 -0
data/tutorials/01/solution_1.rb +16 -0
data/tutorials/01/solution_2.rb +24 -0
data/tutorials/02/expected_baked.html +207 -0
data/tutorials/02/raw.html +201 -0
data/tutorials/02/solution_1.rb +29 -0
data/tutorials/03/expected_baked.html +33 -0
data/tutorials/03/raw.html +31 -0
data/tutorials/03/solution_1.rb +16 -0
data/tutorials/03/solution_2.rb +15 -0
data/tutorials/04/expected_baked.html +36 -0
data/tutorials/04/raw.html +36 -0
data/tutorials/04/solution_1.rb +20 -0
data/tutorials/04/solution_2.rb +25 -0
data/tutorials/05/expected_baked.html +11 -0
data/tutorials/05/raw.html +11 -0
data/tutorials/05/solution_1.rb +9 -0
data/tutorials/check_it +64 -0
data/tutorials/setup_my_recipes +30 -0
metadata +278 -0

@@ -0,0 +1,3 @@
+module Kitchen
+  VERSION = "1.0.0"
+end

data/lib/locales/en.yml ADDED

@@ -0,0 +1,21 @@
+en:
+  figure: Figure
+  table_label: Table
+  appendix: Appendix
+  example_label: Example
+  exercise_label: Exercise
+  stepwise_step_label: Step
+  eoc_key_terms_title: Key Terms
+  eoc_summary_title: Summary
+  eoc_exercises_title: Exercises
+  eoc_answer_key_title: Answer Key
+  eoc_key_equations: Key Equations
+  eob_index_title: Index
+  eob_index_symbols_group: Symbols
+  notes:
+    link-to-learning: Link to Learning
+    sciences-interconnect: How Sciences Interconnect
+    chemistry:
+      link-to-learning: Link to Learning
+      everyday-life: Chemistry in Everyday Life
+      chemist-portrait: Portrait of a Chemist

data/lib/notes.md ADDED

@@ -0,0 +1,9 @@
+```ruby
+def first_of
+  FirstOfEnumerator(book.units.chapters, book.chapters, book).pages.each do |page|
+  end
+end
+```
+When baking moves an important element (e.g. something with a data-type that we latch onto), it should update how to find that element in the future by changing the selector on the doc.

data/openstax_kitchen.gemspec ADDED

@@ -0,0 +1,39 @@
+require_relative 'lib/kitchen/version'
+Gem::Specification.new do |spec|
+  spec.name          = "openstax_kitchen"
+  spec.version       = Kitchen::VERSION
+  spec.authors       = ["JP Slavinsky"]
+  spec.email         = ["jpslav@gmail.com"]
+  spec.summary       = %q{OpenStax content baking library}
+  spec.description   = %q{OpenStax content baking library}
+  spec.homepage      = "https://github.com/openstax/kitchen"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/openstax/kitchen"
+  spec.metadata["changelog_uri"] = "https://github.com/openstax/kitchen/CHANGELOG.md"
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'rainbow'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'i18n'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'nokogiri-diff'
+  spec.add_development_dependency 'rainbow'
+end

data/tutorials/00/expected_baked.html ADDED

@@ -0,0 +1,3 @@
+<h1 class="hello">
+  <span>World!</span>
+</h1>

data/tutorials/00/raw.html ADDED

@@ -0,0 +1,3 @@
+<div class="hello">
+  <span>Planet?</span>
+</div>

data/tutorials/00/solution_1.rb ADDED

@@ -0,0 +1,7 @@
+@solution_1 = Kitchen::Recipe.new do |doc|
+  div = doc.search("div").first
+  div.name = "h1"
+  div.search("span").first.replace_children(with: "World!")
+end

data/tutorials/00/solution_2.rb ADDED

@@ -0,0 +1,6 @@
+@solution_2 = Kitchen::Recipe.new do |doc|
+  doc.search("div").first.name = "h1"
+  doc.search("span").first.replace_children(with: "World!")
+end

data/tutorials/01/expected_baked.html ADDED

@@ -0,0 +1,66 @@
+<!--
+1. Move the `will-move` divs to an new container with a class of `eoc` at the end of the chapter
+2. Add a section title with the class "os-title" and the value "End of Chapter Collations"
+3. Change `will-move` divs to sections
+-->
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Move-to, creating containers</title>
+  </head>
+  <body>
+    <div data-type="chapter">
+      <h1 data-type="document-title">Chapter Title</h1>
+      <div data-type="page">
+        <h2 data-type="document-title">Page Title</h2>
+        <div class="will-not-move">
+          <h3>I didn't go anywhere</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+        </div>
+        <div class="will-not-move">
+          <h3> I'm here to stay.</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+        </div>
+         <div class="will-not-move">
+          <h3>Don't make me move!</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </div>
+      </div>
+      <div class="eoc">
+        <div class="os-title">End of Chapter Collations</div>
+        <section class="will-move">
+          <h3>I cannot stand still</h3>
+          <p>
+            Content will move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </section>
+        <section class="will-move">
+          <h3>I have to go!</h3>
+          <p>
+            Content will move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </section>
+      </div>
+    </div>
+  </body>
+</html>

data/tutorials/01/raw.html ADDED

@@ -0,0 +1,62 @@
+<!--
+1. Move the `will-move` divs to an new container with a class of `eoc` at the end of the chapter
+2. Add a section title with the class "os-title" and the value "End of Chapter Collations"
+3. Change `will-move` divs to sections
+-->
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Move-to, creating containers</title>
+  </head>
+  <body>
+    <div data-type="chapter">
+      <h1 data-type="document-title">Chapter Title</h1>
+      <div data-type="page">
+        <h2 data-type="document-title">Page Title</h2>
+        <div class="will-not-move">
+          <h3>I didn't go anywhere</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+        </div>
+        <div class="will-move">
+          <h3>I cannot stand still</h3>
+          <p>
+            Content will move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </div>
+        <div class="will-not-move">
+          <h3> I'm here to stay.</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+        </div>
+        <div class="will-move">
+          <h3>I have to go!</h3>
+          <p>
+            Content will move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </div>
+        <div class="will-not-move">
+          <h3>Don't make me move!</h3>
+          <p>
+            Content will not move <br /> Lorem ipsum.
+          </p>
+          <p>
+            Lorem ipsum.
+          </p>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/tutorials/01/solution_1.rb ADDED

@@ -0,0 +1,16 @@
+@solution_1 = Kitchen::Recipe.new do |doc|
+  doc.search("[data-type='chapter']").each do |chapter|
+    movers = chapter.search(".will-move").cut
+    movers.each{|mover| mover.name = "section"}
+    chapter.append(child: <<~HTML
+        <div class="eoc">
+          <div class="os-title">End of Chapter Collations</div>
+          #{movers.paste}
+        </div>
+      HTML
+    )
+  end
+end

data/tutorials/01/solution_2.rb ADDED

@@ -0,0 +1,24 @@
+@solution_2 = Kitchen::BookRecipe.new do |doc|
+  #                       ^
+  #                       |
+  #
+  # BookRecipe gives us `doc.book` and `book.chapters` to make the code cleaner
+  #
+  #    |       |
+  #    v       v
+  doc.book.chapters.each do |chapter|
+    movers = chapter.search(".will-move").cut
+    movers.each{|mover| mover.name = "section"}
+    chapter.append(child: <<~HTML
+        <div class="eoc">
+          <div class="os-title">End of Chapter Collations</div>
+          #{movers.paste}
+        </div>
+      HTML
+    )
+  end
+end

data/tutorials/02/expected_baked.html ADDED

@@ -0,0 +1,207 @@
+<!--
+1. For each chapter, add a new container as its last child with class "eoc"
+2. Give it a title of "End of Chapter Stuff". Use the proper header
+   container based on nesting, and give it a data-type of 'document-title'.
+3. Inside each "eoc" container, make two new containers, one with class
+   "critical-thinking-container" and title "Critical Thinking Questions" and
+   another with class "review-questions-container" and title "Review Questions".
+4. To the "critical-thinking-container" move all of the containers from each
+   chapter that have the class "critical-thinking".
+5. To the "review-questions-container" move all of the containers from each chapter
+   that have the class "review-questions".
+6. Remove the h3 tags from the containers that are moving.
+-->
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Move-to, creating containers</title>
+  </head>
+  <body>
+    <div class="book">
+      <div data-type="chapter">
+        <h1 data-type="document-title">Chapter Title (1)</h1>
+        <div data-type="page">
+          <h2 data-type="document-title">Page title (1.1)</h2>
+          <div class="will-not-move">
+            <h3>I didn't go anywhere</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3> I'm here to stay.</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+           <div class="will-not-move">
+            <h3>Don't make me move!</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+        </div>
+        <div data-type="page">
+          <h2 data-type="document-title">Page title (1.2)</h2>
+          <div class="will-not-move">
+            <h3>I didn't go anywhere</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3> I'm here to stay.</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+           <div class="will-not-move">
+            <h3>Don't make me move!</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+        </div>
+        <div data-type="page">
+          <h2 data-type="document-title">Page title (1.3)</h2>
+          <div class="will-not-move">
+            <h3>I didn't go anywhere</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3> I'm here to stay.</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3>Don't make me move!</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+        </div>
+        <div class="eoc">
+          <h2 data-type="document-title">End of Chapter Stuff</h2>
+          <div class="critical-thinking-container">
+            <div class="os-title">Critical Thinking Questions</div>
+            <div class="critical-thinking" id="03">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="critical-thinking" id="05">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="critical-thinking" id="07">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+          </div>
+          <div class="review-questions-container">
+            <div class="os-title">Review Questions</div>
+            <div class="review-questions" id="01">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="review-questions" id="02">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="review-questions" id="04">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="review-questions" id="06">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div data-type="chapter">
+        <h1 data-type="document-title">Chapter Title (2)</h1>
+        <div data-type="page">
+          <h2 data-type="document-title">Page title (2.1)</h2>
+          <div class="will-not-move">
+            <h3>I didn't go anywhere</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3> I'm here to stay.</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+           <div class="will-not-move">
+            <h3>Don't make me move!</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+        </div>
+        <div data-type="page">
+          <h2 data-type="document-title">Page title (2.2)</h2>
+          <div class="will-not-move">
+            <h3>I didn't go anywhere</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+          <div class="will-not-move">
+            <h3> I'm here to stay.</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+           <div class="will-not-move">
+            <h3>Don't make me move!</h3>
+            <p>
+              Content will not move <br /> Lorem ipsum dolor ...
+            </p>
+          </div>
+        </div>
+        <div class="eoc">
+          <h2 data-type="document-title">End of Chapter Stuff</h2>
+          <div class="critical-thinking-container">
+            <div class="os-title">Critical Thinking Questions</div>
+            <div class="critical-thinking" id="09">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="critical-thinking" id="11">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+          </div>
+          <div class="review-questions-container">
+            <div class="os-title">Review Questions</div>
+            <div class="review-questions" id="08">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+            <div class="review-questions" id="10">
+              <p>
+                Content will move <br /> Lorem ipsum dolor ...
+              </p>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>