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

data/tutorials/05/expected_baked.html ADDED

@@ -0,0 +1,11 @@
+<!--
+1. Copy the "div#original" element and add the copy right after the original one.
+2. Get rid of the "badness" div
+-->
+<html>
+  <body>
+    <div id="original">Someone make a copy of me</div>
+    <div id="original_copy_1">Someone make a copy of me</div>
+  </body>
+</html>

data/tutorials/05/raw.html ADDED

@@ -0,0 +1,11 @@
+<!--
+1. Copy the "div#original" element and add the copy right after the original one.
+2. Get rid of the "badness" div
+-->
+<html>
+  <body>
+    <div id="original">Someone make a copy of me</div>
+    <div id="badness">This one has got to go</div>
+  </body>
+</html>

data/tutorials/05/solution_1.rb ADDED

@@ -0,0 +1,9 @@
+@solution_1 = Kitchen::Recipe.new do |doc|
+  original = doc.search("#original").first
+  original.append(sibling: <<~HTML
+      \n#{original.copy.paste}
+    HTML
+  )
+  doc.search("#badness").trash
+end

data/tutorials/check_it ADDED

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "kitchen"
+require "rspec"
+require "byebug"
+require "rainbow"
+def parse_doc(filename)
+  Nokogiri::XML(File.open(filename)){|config| config.noblanks}
+end
+def parse_doc_and_prep_for_diff(filename)
+  doc = parse_doc(filename)
+  string = doc.to_xhtml
+  # Get rid of whitespace at the start of lines (remove impact of indentation)
+  string.gsub(/^\s*/,"")
+end
+if ARGV.empty?
+  puts "Usage: check_it tutorial-folder-number [recipe-name]\n" \
+       "  e.g. check_it 02"
+  exit(0)
+end
+tutorial_number = ARGV[0]
+Dir[File.expand_path(__dir__ + "/#{tutorial_number}/*.rb")].each{|f| require f}
+recipe_name = (ARGV[1] || "my_recipe")
+recipe_variable_name = "@#{recipe_name}".to_sym
+if !instance_variables.include?(recipe_variable_name)
+  puts Rainbow("There is no recipe named '#{recipe_variable_name}' defined in the " \
+               "tutorials/#{tutorial_number} directory").red
+  exit(1)
+end
+recipe = instance_variable_get(recipe_variable_name)
+Kitchen::Oven.bake(
+  input_file: File.expand_path("#{tutorial_number}/raw.html", __dir__),
+  recipes: recipe,
+  output_file: File.expand_path("#{tutorial_number}/actual_baked.html", __dir__)
+)
+actual = parse_doc_and_prep_for_diff("#{tutorial_number}/actual_baked.html")
+expected = parse_doc_and_prep_for_diff("#{tutorial_number}/expected_baked.html")
+differ = RSpec::Support::Differ.new(color: true)
+diff = differ.diff(expected, actual)
+# Get rid of some coloring junk at the start
+diff.sub!(/\e\[0m\n\e\[0m/, "")
+if diff.blank?
+  puts Rainbow("The actual output matches the expected output! Way to go!").green
+else
+  puts Rainbow("The actual output does not match the expected output.").yellow
+  puts Rainbow("-").red + " = actual output"
+  puts Rainbow("+").green + " = expected output"
+  puts "\n"
+  puts diff
+end

data/tutorials/setup_my_recipes ADDED

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "byebug"
+require "rainbow"
+Dir.chdir(__dir__)
+tutorial_numbers = Dir.glob("*").select{|f| File.directory?(f) && f.match?(/\d\d/)}
+tutorial_numbers.each do |tutorial_number|
+  file_name = File.expand_path("#{tutorial_number}/my_recipe.rb", __dir__)
+  if File.exist?(file_name)
+    puts "Skipped making recipe skeleton; my_recipe.rb exists in tutorials folder '#{tutorial_number}'"
+    next
+  else
+    File.open(file_name, "w") do |f|
+      f.write <<~CONTENTS
+        # This file is IGNORED by Git
+        @my_recipe = Kitchen::Recipe.new do |doc|
+          # Write you recipe here
+        end
+      CONTENTS
+    end
+    puts "Generated recipe skeleton (my_recipe.rb) in tutorials folder '#{tutorial_number}'"
+  end
+end

metadata ADDED

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: openstax_kitchen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- JP Slavinsky
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri-diff
+  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: rainbow
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/devcontainer.json"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".solargraph.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/normalize
+- bin/setup
+- books/chemistry2e/bake.rb
+- codecov.yaml
+- docker-compose.yml
+- docker/bash
+- docker/entrypoint
+- lib/kitchen.rb
+- lib/kitchen/ancestor.rb
+- lib/kitchen/book_document.rb
+- lib/kitchen/book_element.rb
+- lib/kitchen/book_element_enumerator.rb
+- lib/kitchen/book_recipe.rb
+- lib/kitchen/chapter_element.rb
+- lib/kitchen/chapter_element_enumerator.rb
+- lib/kitchen/clipboard.rb
+- lib/kitchen/composite_chapter_element.rb
+- lib/kitchen/composite_page_element.rb
+- lib/kitchen/composite_page_element_enumerator.rb
+- lib/kitchen/config.rb
+- lib/kitchen/counter.rb
+- lib/kitchen/debug/print_recipe_error.rb
+- lib/kitchen/directions/bake_appendix.rb
+- lib/kitchen/directions/bake_chapter_glossary.rb
+- lib/kitchen/directions/bake_chapter_introductions.rb
+- lib/kitchen/directions/bake_chapter_key_equations.rb
+- lib/kitchen/directions/bake_chapter_summary.rb
+- lib/kitchen/directions/bake_composite_pages.rb
+- lib/kitchen/directions/bake_example.rb
+- lib/kitchen/directions/bake_exercises.rb
+- lib/kitchen/directions/bake_figure.rb
+- lib/kitchen/directions/bake_footnotes/main.rb
+- lib/kitchen/directions/bake_footnotes/v1.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_math_in_paragraph.rb
+- lib/kitchen/directions/bake_notes.rb
+- lib/kitchen/directions/bake_numbered_table/main.rb
+- lib/kitchen/directions/bake_numbered_table/v1.rb
+- lib/kitchen/directions/bake_stepwise.rb
+- lib/kitchen/directions/bake_toc.rb
+- lib/kitchen/directions/bake_unnumbered_tables.rb
+- lib/kitchen/directions/move_title_text_into_span.rb
+- lib/kitchen/document.rb
+- lib/kitchen/element.rb
+- lib/kitchen/element_base.rb
+- lib/kitchen/element_enumerator.rb
+- lib/kitchen/element_enumerator_base.rb
+- lib/kitchen/element_enumerator_factory.rb
+- lib/kitchen/element_factory.rb
+- lib/kitchen/errors.rb
+- lib/kitchen/example_element.rb
+- lib/kitchen/example_element_enumerator.rb
+- lib/kitchen/figure_element.rb
+- lib/kitchen/figure_element_enumerator.rb
+- lib/kitchen/mixins/block_error_if.rb
+- lib/kitchen/note_element.rb
+- lib/kitchen/note_element_enumerator.rb
+- lib/kitchen/oven.rb
+- lib/kitchen/page_element.rb
+- lib/kitchen/page_element_enumerator.rb
+- lib/kitchen/pantry.rb
+- lib/kitchen/patches/nokogiri.rb
+- lib/kitchen/patches/renderable.rb
+- lib/kitchen/patches/string.rb
+- lib/kitchen/recipe.rb
+- lib/kitchen/search_history.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/term_element.rb
+- lib/kitchen/term_element_enumerator.rb
+- lib/kitchen/transliterations.rb
+- lib/kitchen/type_casting_element_enumerator.rb
+- lib/kitchen/utils.rb
+- lib/kitchen/version.rb
+- lib/locales/en.yml
+- lib/notes.md
+- openstax_kitchen.gemspec
+- tutorials/00/expected_baked.html
+- tutorials/00/raw.html
+- tutorials/00/solution_1.rb
+- tutorials/00/solution_2.rb
+- tutorials/01/expected_baked.html
+- tutorials/01/raw.html
+- tutorials/01/solution_1.rb
+- tutorials/01/solution_2.rb
+- tutorials/02/expected_baked.html
+- tutorials/02/raw.html
+- tutorials/02/solution_1.rb
+- tutorials/03/expected_baked.html
+- tutorials/03/raw.html
+- tutorials/03/solution_1.rb
+- tutorials/03/solution_2.rb
+- tutorials/04/expected_baked.html
+- tutorials/04/raw.html
+- tutorials/04/solution_1.rb
+- tutorials/04/solution_2.rb
+- tutorials/05/expected_baked.html
+- tutorials/05/raw.html
+- tutorials/05/solution_1.rb
+- tutorials/check_it
+- tutorials/setup_my_recipes
+homepage: https://github.com/openstax/kitchen
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/openstax/kitchen
+  source_code_uri: https://github.com/openstax/kitchen
+  changelog_uri: https://github.com/openstax/kitchen/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: OpenStax content baking library
+test_files: []