openstax_kitchen 2.0.0 → 3.0.0

data/lib/kitchen/version.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# A library for modifying the structure of OpenStax book XML.
+#
 module Kitchen
-  VERSION = "2.0.0"
+  VERSION = '3.0.0'
 end

data/lib/locales/en.yml

@@ -2,14 +2,20 @@ en:
   figure: Figure
   table_label: Table
   appendix: Appendix
+  chapter_outline: Chapter Outline
+  toc_title: Contents
   example_label: Example
   exercise_label: Exercise
+  chapter: Chapter
+  unit: Unit
+  learning_objectives: Learning Objectives
   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
+  eoc_suggested_reading: Suggestions for Further Study
   eob_index_title: Index
   eob_index_symbols_group: Symbols
   notes:

data/lib/openstax_kitchen.rb

@@ -1,57 +1,58 @@
-require "kitchen/version"
+# frozen_string_literal: true
 
-require "nokogiri"
-require "active_support/all"
+require 'kitchen/version'
+
+require 'nokogiri'
+require 'active_support/all'
 
 module Kitchen
+  # Contains snippets of recipes that accomplish a certain medium-sized task
   module Directions; end
 end
 
 def file_glob(relative_folder_and_extension)
-  Dir[File.expand_path(__dir__ + "/" + relative_folder_and_extension)]
+  Dir[File.expand_path("#{__dir__}/#{relative_folder_and_extension}")]
 end
 
-def require_all(relative_folder, file_matcher="**/*.rb")
-  file_glob(relative_folder + "/#{file_matcher}").each{|f| require f}
+def require_all(relative_folder, file_matcher='**/*.rb')
+  file_glob(relative_folder + "/#{file_matcher}").each { |f| require f }
 end
 
-require_all("kitchen/patches")
-require_all("kitchen/mixins")
-
-require "kitchen/selectors/base"
-require_all("kitchen/selectors")
-
-require "kitchen/utils"
-require "kitchen/transliterations"
-require "kitchen/errors"
-require "kitchen/ancestor"
-require "kitchen/search_history"
-require "kitchen/config"
-require "kitchen/document"
-require "kitchen/book_document"
-require "kitchen/debug/print_recipe_error"
-require "kitchen/recipe"
-require "kitchen/book_recipe"
-require "kitchen/oven"
-require "kitchen/clipboard"
-require "kitchen/pantry"
-require "kitchen/counter"
-
-require "kitchen/element_enumerator_base"
-require "kitchen/element_enumerator_factory"
-require_all("kitchen", "*enumerator.rb")
-
-require "kitchen/element_base"
-require_all("kitchen", "*element.rb")
-require "kitchen/element_factory"
-
-
-require_all("kitchen/directions")
-
-I18n.load_path << file_glob("/locales/*.yml")
-
+require_all('kitchen/patches')
+require_all('kitchen/mixins')
+
+require 'kitchen/selectors/base'
+require_all('kitchen/selectors')
+
+require 'kitchen/utils'
+require 'kitchen/transliterations'
+require 'kitchen/errors'
+require 'kitchen/ancestor'
+require 'kitchen/search_query'
+require 'kitchen/search_history'
+require 'kitchen/config'
+require 'kitchen/document'
+require 'kitchen/book_document'
+require 'kitchen/debug/print_recipe_error'
+require 'kitchen/recipe'
+require 'kitchen/book_recipe'
+require 'kitchen/oven'
+require 'kitchen/clipboard'
+require 'kitchen/pantry'
+require 'kitchen/counter'
+
+require 'kitchen/element_enumerator_base'
+require 'kitchen/element_enumerator_factory'
+require_all('kitchen', '*enumerator.rb')
+
+require 'kitchen/element_base'
+require_all('kitchen', '*element.rb')
+require 'kitchen/element_factory'
+
+require_all('kitchen/directions')
+
+I18n.load_path << file_glob('/locales/*.yml')
 
 I18n.available_locales.each do |available_locale|
   I18n.backend.store_translations(available_locale, Kitchen::TRANSLITERATIONS)
 end
-

data/openstax_kitchen.gemspec

@@ -1,39 +1,45 @@
+# frozen_string_literal: true
+
 require_relative 'lib/kitchen/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "openstax_kitchen"
+  spec.name          = 'openstax_kitchen'
   spec.version       = Kitchen::VERSION
-  spec.authors       = ["JP Slavinsky"]
-  spec.email         = ["jpslav@gmail.com"]
+  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.summary       = 'OpenStax content baking library'
+  spec.description   = 'OpenStax content baking library'
+  spec.homepage      = 'https://github.com/openstax/kitchen'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  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"
+  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)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^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_dependency 'nokogiri'
+  spec.add_dependency 'rainbow'
 
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'inch'
   spec.add_development_dependency 'nokogiri-diff'
   spec.add_development_dependency 'rainbow'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'yard'
 end

data/tutorials/00/solution1.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+@solution1 = 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/solution2.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+@solution2 = Kitchen::Recipe.new do |doc|
+
+  doc.search('div').first.name = 'h1'
+  doc.search('span').first.replace_children(with: 'World!')
+
+end

data/tutorials/01/solution1.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+@solution1 = 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/solution2.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+@solution2 = 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/solution1.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+@solution1 = Kitchen::Recipe.new do |doc|
+
+  doc.search("[data-type='chapter']").each do |chapter|
+    review_questions = chapter.search('.review-questions').cut
+    critical_thinking = chapter.search('.critical-thinking').cut
+
+    [review_questions, critical_thinking].each do |clipboard|
+      clipboard.each do |element|
+        element.first('h3').trash
+      end
+    end
+
+    chapter.append(child: <<~HTML
+      <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>
+          #{critical_thinking.paste}
+        </div>
+        <div class="review-questions-container">
+          <div class="os-title">Review Questions</div>
+          #{review_questions.paste}
+        </div>
+      </div>
+    HTML
+    )
+  end
+
+end

data/tutorials/03/{solution_1.rb → solution1.rb}

@@ -1,15 +1,17 @@
-@solution_1 = Kitchen::BookRecipe.new do |doc|
+# frozen_string_literal: true
+
+@solution1 = Kitchen::BookRecipe.new do |doc|
   book = doc.book
 
   book.chapters.each do |chapter|
     chapter.prepend(child: <<~HTML
-        <h1 data-type="document-title">Chapter #{chapter.count_in(:book)}</h1>
-      HTML
+      <h1 data-type="document-title">Chapter #{chapter.count_in(:book)}</h1>
+    HTML
     )
 
     chapter.pages.each do |page|
       page_title = page.title
-      page_title.name = "h2"
+      page_title.name = 'h2'
       page_title.prepend(child: "#{chapter.count_in(:book)}.#{page.count_in(:chapter)} ")
     end
   end

data/tutorials/03/solution2.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+@solution2 = Kitchen::BookRecipe.new do |doc|
+  book = doc.book
+
+  book.chapters.each do |chapter|
+    chapter.prepend(child: <<~HTML
+      <h1 data-type="document-title">Chapter #{chapter.count_in(:book)}</h1>
+    HTML
+    )
+
+    chapter.pages.each do |page|
+      page.title
+          .set(:name, 'h2')
+          .prepend(child: "#{chapter.count_in(:book)}.#{page.count_in(:chapter)} ")
+    end
+  end
+end

data/tutorials/04/{solution_1.rb → solution1.rb}

@@ -1,4 +1,6 @@
-@solution_1 = Kitchen::BookRecipe.new do |doc|
+# frozen_string_literal: true
+
+@solution1 = Kitchen::BookRecipe.new do |doc|
   book = doc.book
 
   book.tables.each do |table|
@@ -13,7 +15,7 @@
     doc.pantry(name: :link_text).store figure_name, label: figure.id
   end
 
-  book.search("a.needs-label").each do |anchor|
+  book.search('a.needs-label').each do |anchor|
     id = anchor[:href][1..-1]
     anchor.replace_children(with: doc.pantry(name: :link_text).get(id))
   end

data/tutorials/04/{solution_2.rb → solution2.rb}

@@ -1,4 +1,6 @@
-@solution_2 = Kitchen::BookRecipe.new do |doc|
+# frozen_string_literal: true
+
+@solution2 = Kitchen::BookRecipe.new do |doc|
   book = doc.book
 
   # Solution 1 treats figures and tables almost identically and ends up duplicating
@@ -6,8 +8,8 @@
   # enumerator and the label):
 
   enumerators_to_labels_map = {
-    book.tables => "Table",
-    book.figures => "Figure"
+    book.tables => 'Table',
+    book.figures => 'Figure'
   }
 
   enumerators_to_labels_map.each do |enumerator, label|
@@ -18,7 +20,7 @@
     end
   end
 
-  book.search("a.needs-label").each do |anchor|
+  book.search('a.needs-label').each do |anchor|
     id = anchor[:href][1..-1]
     anchor.replace_children(with: doc.pantry(name: :link_text).get(id))
   end

data/tutorials/05/solution1.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+@solution1 = 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

@@ -1,20 +1,21 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "openstax_kitchen"
-require "rspec"
-require "byebug"
-require "rainbow"
+require 'bundler/setup'
+require 'openstax_kitchen'
+require 'rspec'
+require 'byebug'
+require 'rainbow'
 
 def parse_doc(filename)
-  Nokogiri::XML(File.open(filename)){|config| config.noblanks}
+  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*/,"")
+  string.gsub(/^\s*/, '')
 end
 
 if ARGV.empty?
@@ -25,12 +26,12 @@ end
 
 tutorial_number = ARGV[0]
 
-Dir[File.expand_path(__dir__ + "/#{tutorial_number}/*.rb")].each{|f| require f}
+Dir[File.expand_path(__dir__ + "/#{tutorial_number}/*.rb")].sort.each { |f| require f }
 
-recipe_name = (ARGV[1] || "my_recipe")
+recipe_name = (ARGV[1] || 'my_recipe')
 recipe_variable_name = "@#{recipe_name}".to_sym
 
-if !instance_variables.include?(recipe_variable_name)
+unless 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)
@@ -51,14 +52,14 @@ 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/, "")
+diff.sub!(/\e\[0m\n\e\[0m/, '')
 
 if diff.blank?
-  puts Rainbow("The actual output matches the expected output! Way to go!").green
+  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 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