openstax_kitchen 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4f70bbb3dd410d515f7501ed2b95635d4ca8b8369fe1b8ed5eda66e5c64c07
-  data.tar.gz: ec5151233398b0136e0494efe4b4637876ab3e318f6606ea66fe8a750c46cbf0
+  metadata.gz: 47c8699f2836cea06df2e5a97aa79c350662e8193c9c1abfafd50740de61cbf6
+  data.tar.gz: 2384b847a91f55624ca266274fb273f98cfcaeb81962c988b04efcb0d619f2a1
 SHA512:
-  metadata.gz: fce19e98ac530ffd809acb5ff968dbd9b786b11eaa217faec40f7e0af7ad5e2a2f70fae5aed9eb0d2b71bce7456a4d4b9e3842d2d484b17f7da529ed02af9d3a
-  data.tar.gz: 36d66b6aa6cc8585726007f0edeff8eae49be3222dd33b367adb1b0b6554c0bfbc4f39537ad1e95fbf9bc0cf15a91049347c4940644dcf47348eb932bf42f623
+  metadata.gz: 6a617ef7617b5ebb0ae959615125a82945f965fcb7cbc080eff8da974fb843bd81fc72226fc62d9439f9012d95af21c80e6d85d81a1a0594c7b7546d8fd6e6f8
+  data.tar.gz: cad462c3c8809912d290148a5c5f64fd8518bd8043ba66d315babeed504dc083761014abd038a9fea8eb88caaa9dcc930be4f9c0b4f048e3590a0645b8bf0da9

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.0] - 2020-10-03
+## [2.0.0] - 2020-12-18
 
-First official version.
+* 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (1.0.0)
+    openstax_kitchen (2.0.0)
       activesupport
       i18n
       nokogiri
@@ -21,7 +21,7 @@ GEM
       simplecov (~> 0.18.0)
     concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    docile (1.3.2)
+    docile (1.3.3)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     mini_portile2 (2.4.0)

data/README.md

@@ -10,7 +10,7 @@ Kitchen lets you modify the structure and content of XML files.  You create a `R
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kitchen'
+gem 'openstax_kitchen'
 ```
 
 And then execute:
@@ -32,7 +32,7 @@ We'll first talk about the generic way since those tools are also available in t
 Kitchen lets you modify the structure and content of XML files.  You create a `Recipe` and `bake` it in the `Oven`:
 
 ```ruby
-require "kitchen"
+require "openstax_kitchen"
 
 recipe = Kitchen::Recipe.new do |document|
   document.search("div.section").each do |element|
@@ -430,10 +430,10 @@ Want to make a one-file script to do some baking?  Use the "inline" form of bund
 require "bundler/inline"
 
 gemfile do
-  gem 'kitchen', git: 'https://github.com/openstax/kitchen.git', ref: 'some_sha_here'
+  gem 'openstax_kitchen', '2.0.0'
 end
 
-require "kitchen"
+require "openstax_kitchen"
 
 recipe = Kitchen::Recipe.new do |doc|
   # ... recipe steps here

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "kitchen"
+require "openstax_kitchen"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/kitchen/version.rb

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

data/tutorials/check_it

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "kitchen"
+require "openstax_kitchen"
 require "rspec"
 require "byebug"
 require "rainbow"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -143,14 +143,11 @@ files:
 - 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
@@ -223,6 +220,7 @@ files:
 - lib/kitchen/version.rb
 - lib/locales/en.yml
 - lib/notes.md
+- lib/openstax_kitchen.rb
 - openstax_kitchen.gemspec
 - tutorials/00/expected_baked.html
 - tutorials/00/raw.html

data/bin/normalize

@@ -1,79 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/inline"
-
-gemfile do
-  gem 'nokogiri'
-  gem 'byebug'
-end
-
-require 'nokogiri'
-require 'byebug'
-
-# In HTML attribute order doesn't matter, but to make sure our diffs are useful resort all
-# attributes.
-def sort_attributes(document)
-  document.traverse do |child|
-    next if child.text? || child.document?
-    attributes = child.attributes
-    attributes.each do |key, value|
-      child.remove_attribute(key)
-    end
-    sorted_keys = attributes.keys.sort
-    sorted_keys.each do |key|
-      value = attributes[key].to_s
-      child[key] = value
-    end
-  end
-end
-
-# Legacy baked docs have a few issues that I think are unintentional; clean those
-def clean_legacy_baked(document)
-  document.traverse do |child|
-    next if child.text? || child.document?
-
-    # Legacy bakings of unnumbered tables include a bogus number, delete it
-    if child.name == "table" && (child[:class] || "").include?("unnumbered")
-      child.remove_attribute("summary")
-    end
-
-    # Sometimes there is `class=' '`, get rid of these
-    child.attributes.each do |key, value|
-      child.remove_attribute(key) if key == "class" && value.to_s.strip == ""
-    end
-  end
-end
-
-def mask_copied_id_numbers(document)
-  document.traverse do |child|
-    if child[:id]
-      child[:id] = child[:id].gsub(/_copy_(\d+)$/,"_copy_XXX")
-    end
-  end
-end
-
-def process(input_file:, output_file:)
-  read_and_write(input_file: input_file, output_file: output_file) do |doc|
-    clean_legacy_baked(doc)
-    sort_attributes(doc)
-    mask_copied_id_numbers(doc)
-  end
-end
-
-def read_and_write(input_file:, output_file:)
-  doc = Nokogiri::XML(File.open(input_file)){|config| config.noblanks}
-
-  yield(doc) if block_given?
-
-  File.open(output_file, "w") do |f|
-    f.write doc.to_xhtml(indent:2)
-  end
-end
-
-ARGV.each do |input_file|
-  output_file = input_file.gsub(/(\.\w+)\z/,'.normalized\1')
-
-  process(input_file: input_file, output_file: output_file)
-
-  puts "Normalized '#{input_file}' to '#{output_file}'"
-end

data/books/chemistry2e/bake.rb

@@ -1,133 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/inline"
-
-gemfile do
-  gem 'kitchen', path: '/Users/jps/dev/openstax/kitchen'
-  gem 'byebug'
-end
-
-require "kitchen"
-require 'byebug'
-
-include Kitchen::Directions
-
-recipe = Kitchen::BookRecipe.new(book_short_name: :chemistry) do |doc|
-  book = doc.book
-
-  # Some stuff just goes away
-  book.search("cnx-pi").trash
-
-  # Update the preface title
-  book.pages("$.preface").search("div[data-type='document-title']").each do |title| # TODO add title method
-    title.replace_children(with:
-      <<~HTML
-        <span data-type="" itemprop="" class="os-text">#{title.text}</span>
-      HTML
-    )
-    title.name = "h1"
-  end
-
-  book.chapters.each do |chapter|
-    BakeChapterGlossary.v1(chapter: chapter, metadata_source: book.metadata)
-    BakeChapterKeyEquations.v1(chapter: chapter, metadata_source: book.metadata)
-    BakeChapterSummary.v1(chapter: chapter, metadata_source: book.metadata)
-  end
-
-  BakeExercises.v1(book: book)
-  BakeChapterIntroductions.v1(book: book)
-
-  book.chapters.each do |chapter|
-    # Fix up chapter titles - TODO put this in BakeChapter
-    heading = chapter.at("h1[2]")
-    heading[:id] = "chapTitle#{chapter.count_in(:book)}"
-    heading.replace_children(with:
-      <<~HTML
-        <span class="os-part-text">Chapter </span>
-        <span class="os-number">#{chapter.count_in(:book)}</span>
-        <span class="os-divider"> </span>
-        <span data-type="" itemprop="" class="os-text">#{heading.text}</span>
-      HTML
-    )
-
-    chapter.tables("$:not(.unnumbered)").each do |table|
-      BakeNumberedTable.v1(table: table, number: "#{chapter.count_in(:book)}.#{table.count_in(:chapter)}")
-    end
-
-    chapter.examples.each do |example|
-      BakeExample.v1(example: example,
-                     number: "#{chapter.count_in(:book)}.#{example.count_in(:chapter)}",
-                     title_tag: "h3")
-    end
-
-    chapter.pages("$:not(.introduction)").each do |page|
-      page.search("div[data-type='description']").each(&:trash)
-      page.add_class("chapter-content-module")
-
-      title = page.search("div[data-type='document-title']").first
-      title.name = "h2"
-      title.replace_children(with:
-        <<~HTML
-          <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-          <span class="os-divider"> </span>
-          <span data-type="" itemprop="" class="os-text">#{title.text}</span>
-        HTML
-      )
-    end
-
-    chapter.figures.each do |figure|
-      BakeFigure.v1(figure: figure, number: "#{chapter.count_in(:book)}.#{figure.count_in(:chapter)}")
-    end
-  end
-
-  book.pages("$.appendix").each do |page|
-    appendix_letter = [*('A'..'Z')][page.count_in(:book)-1]
-
-    page.figures.each do |figure|
-      BakeFigure.v1(figure: figure, number: "#{appendix_letter}#{figure.count_in(:page)}")
-    end
-
-    page.tables("$:not(.unnumbered)").each do |table|
-      BakeNumberedTable.v1(table: table, number: "#{appendix_letter}#{table.count_in(:page)}")
-    end
-
-    page.examples.each do |example|
-      BakeExample.v1(example: example,
-                     number: "#{appendix_letter}#{example.count_in(:page)}",
-                     title_tag: "div")
-    end
-
-    BakeAppendix.v1(page: page, number: appendix_letter)
-  end
-
-  BakeNotes.v1(book: book)
-  BakeStepwise.v1(book: book)
-  BakeUnnumberedTables.v1(book: book)
-  BakeMathInParagraph.v1(book: book)
-  BakeIndex.v1(book: book)
-  BakeCompositePages.v1(book: book)
-  BakeFootnotes.v1(book: book)
-
-  BakeToc.v1(book: book)
-
-  # competing docs from elements - BakeLinkPlaceholders
-  book.search("a").each do |anchor|
-    next unless anchor.text == "[link]"
-    id = anchor[:href][1..-1]
-    replacement = doc.pantry(name: :link_text).get(id)
-    if replacement.present?
-      anchor.replace_children(with: replacement)
-    else
-      # TODO log a warning!
-      puts "warning! could not find a replacement for '[link]' on an element with ID '#{id}'"
-    end
-  end
-
-end
-
-puts Kitchen::Oven.bake(
-  # input_file: "collection.assembled.xhtml",
-  input_file: "entire.collection.assembled.xhtml",
-  recipes: recipe,
-  output_file: "collection.kitchen.xhtml"
-)