openstax_kitchen 1.0.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/normalize

@@ -0,0 +1,79 @@
+#!/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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/books/chemistry2e/bake.rb

@@ -0,0 +1,133 @@
+#!/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"
+)

data/codecov.yaml

@@ -0,0 +1,27 @@
+codecov:
+  require_ci_to_pass: no
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no
+
+ignore:
+  - "spec"
+  - "tutorials"
+  - "bin"
+  - "docker"
+  - "books"

data/docker-compose.yml

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

data/docker/bash

@@ -0,0 +1 @@
+docker-compose exec app bash

data/docker/entrypoint

@@ -0,0 +1,9 @@
+#!/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.rb

@@ -0,0 +1,57 @@
+require "kitchen/version"
+
+require "nokogiri"
+require "active_support/all"
+
+module Kitchen
+  module Directions; end
+end
+
+def file_glob(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}
+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")
+
+
+I18n.available_locales.each do |available_locale|
+  I18n.backend.store_translations(available_locale, Kitchen::TRANSLITERATIONS)
+end
+

data/lib/kitchen/ancestor.rb

@@ -0,0 +1,30 @@
+module Kitchen
+  class Ancestor
+
+    attr_accessor :type
+    attr_accessor :element
+
+    def initialize(element)
+      @element = element
+      @type = element.short_type
+      @descendant_counts = {}
+    end
+
+    def increment_descendant_count(descendant_type)
+      @descendant_counts[descendant_type.to_sym] = get_descendant_count(descendant_type) + 1
+    end
+
+    def decrement_descendant_count(descendant_type, by: 1)
+      @descendant_counts[descendant_type.to_sym] = get_descendant_count(descendant_type) - by
+    end
+
+    def get_descendant_count(descendant_type)
+      @descendant_counts[descendant_type.to_sym] || 0
+    end
+
+    def clone
+      Ancestor.new(element)
+    end
+
+  end
+end

data/lib/kitchen/book_document.rb

@@ -0,0 +1,18 @@
+module Kitchen
+  class BookDocument < Document
+
+    attr_reader :short_name
+
+    def initialize(document:, short_name: :not_set, config: nil)
+      @short_name = short_name
+
+      super(nokogiri_document: document.is_a?(Document) ? document.raw : document,
+            config: config)
+    end
+
+    def book
+      BookElement.new(node: nokogiri_document.search("html").first, document: self)
+    end
+
+  end
+end

data/lib/kitchen/book_element.rb

@@ -0,0 +1,24 @@
+module Kitchen
+  class BookElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: BookElementEnumerator,
+            short_type: :book)
+    end
+
+    def body
+      first!("body")
+    end
+
+    def metadata
+      first!("div[data-type='metadata']")
+    end
+
+    def toc
+      first!("nav#toc")
+    end
+
+  end
+end

data/lib/kitchen/book_element_enumerator.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  class BookElementEnumerator < ElementEnumeratorBase
+    # Unsure if this class is needed; there is only one book element per document
+  end
+end

data/lib/kitchen/book_recipe.rb

@@ -0,0 +1,25 @@
+module Kitchen
+  class BookRecipe < Recipe
+
+    attr_reader :book_short_name
+
+    # Make a new BookRecipe
+    #
+    # @yieldparam doc [BookDocument] an object representing an XML document
+    #
+    def initialize(book_short_name: :not_set, &block)
+      @book_short_name = book_short_name
+      super(&block)
+    end
+
+    def document=(document)
+      super(document)
+      @document = Kitchen::BookDocument.new(
+        document: @document,
+        short_name: book_short_name,
+        config: @document.config.clone
+      )
+    end
+
+  end
+end