openstax_kitchen 1.0.0 → 4.0.0

data/Dockerfile

@@ -1,19 +0,0 @@
-FROM ruby:2.6-slim
-
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-    git \
-    build-essential \
-    && rm -rf /var/lib/apt/lists/*
-
-WORKDIR /code
-COPY . /code/
-
-RUN gem install bundler
-RUN bundle install
-
-# Install other things that make development good
-RUN gem install solargraph
-RUN bundle exec yard gems
-
-ENTRYPOINT ["/code/docker/entrypoint"]

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"
-)

data/docker-compose.yml

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

data/docker/entrypoint

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

@@ -1,57 +0,0 @@
-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/directions/bake_chapter_glossary.rb

@@ -1,34 +0,0 @@
-module Kitchen
-  module Directions
-    module BakeChapterGlossary
-
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
-
-        definitions = chapter.glossaries.search("dl").cut
-        definitions.sort_by! do |definition|
-          [definition.first("dt").text.downcase, definition.first("dd").text.downcase]
-        end
-
-        chapter.glossaries.trash
-
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-glossary-container" data-type="composite-page" data-uuid-key="glossary">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_key_terms_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_terms_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{definitions.paste}
-            </div>
-          HTML
-        ) unless definitions.none?
-      end
-
-    end
-  end
-end

data/lib/kitchen/directions/bake_exercises.rb

@@ -1,164 +0,0 @@
-module Kitchen
-  module Directions
-    module BakeExercises
-
-      def self.v1(book:)
-        metadata_elements = book.metadata.search(%w(.authors .publishers .print-style
-                                                    .permissions [data-type='subject'])).copy
-
-        solutions_clipboards = []
-
-        book.chapters.each do |chapter|
-          exercise_clipboard = Clipboard.new
-          solution_clipboard = Clipboard.new
-          solutions_clipboards.push(solution_clipboard)
-
-          chapter.pages("$:not(.introduction)").each do |page|
-            exercise_section = page.exercises
-            exercise_section.first("[data-type='title']")&.trash
-            exercise_section_title = page.title.copy
-            exercise_section_title.name = "h3"
-            exercise_section_title.replace_children(with: <<~HTML
-                <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-                <span class="os-divider"> </span>
-                <span class="os-text" data-type="" itemprop="">#{exercise_section_title.children}</span>
-              HTML
-            )
-
-            exercise_section.prepend(child:
-              <<~HTML
-                <a href="##{page.title.id}">
-                  #{exercise_section_title.paste}
-                </a>
-              HTML
-            )
-
-            exercise_section.search("[data-type='exercise']").each do |exercise|
-              exercise.document.pantry(name: :link_text).store(
-                "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-                label: exercise.id
-              )
-
-              bake_exercise_in_place(exercise: exercise)
-              exercise.first("[data-type='solution']")&.cut(to: solution_clipboard)
-            end
-
-            exercise_section.cut(to: exercise_clipboard)
-          end
-
-          chapter.append(child:
-            <<~HTML
-              <div class="os-eoc os-exercises-container" data-type="composite-page" data-uuid-key=".exercises">
-                <h2 data-type="document-title">
-                  <span class="os-text">#{I18n.t(:eoc_exercises_title)}</span>
-                </h2>
-                <div data-type="metadata" style="display: none;">
-                  <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_exercises_title)}</h1>
-                  #{metadata_elements.paste}
-                </div>
-                #{exercise_clipboard.paste}
-              </div>
-            HTML
-          ) unless exercise_clipboard.none?
-        end
-
-        # Store a paste here to use at end so that uniquifyied IDs match legacy baking
-        eob_metadata = metadata_elements.paste
-
-        solutions = solutions_clipboards.map.with_index do |solution_clipboard, index|
-          <<~HTML
-            <div class="os-eob os-solution-container " data-type="composite-page" data-uuid-key=".solution#{index+1}">
-              <h2 data-type="document-title">
-                <span class="os-text">#{index+1}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{index+1}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{solution_clipboard.paste}
-            </div>
-          HTML
-        end
-
-        book.first("body").append(child:
-          <<~HTML
-          <div class="os-eob os-solution-container " data-type="composite-chapter" data-uuid-key=".solution">
-            <h1 data-type="document-title" id="composite-chapter-1">
-              <span class="os-text">#{I18n.t(:eoc_answer_key_title)}</span>
-            </h1>
-            <div data-type="metadata" style="display: none;">
-              <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_answer_key_title)}</h1>
-              #{eob_metadata}
-            </div>
-            #{solutions.join("\n")}
-          </div>
-          HTML
-        ) unless solutions.none?
-      end
-
-      def self.bake_exercise_in_place(exercise:)
-        # Bake an exercise in place going from:
-        #
-        # <div data-type="exercise" id="exerciseId">
-        #   <div data-type="problem" id="problemId">
-        #     Problem Content
-        #   </div>
-        #   <div data-type="solution" id="solutionId">
-        #     Solution Content
-        #   </div>
-        # </div>
-        #
-        # to
-        #
-        # <div data-type="exercise" id="exerciseId" class="os-hasSolution">
-        #   <div data-type="problem" id="problemId">
-        #     <a class="os-number" href="#exerciseId-solution">1</a>
-        #     <span class="os-divider">. </span>
-        #     <div class="os-problem-container ">
-        #       Problem Content
-        #     </div>
-        #   </div>
-        #   <div data-type="solution" id="exerciseId-solution">
-        #     <a class="os-number" href="#exerciseId">1</a>
-        #     <span class="os-divider">. </span>
-        #     <div class="os-solution-container ">
-        #       Solution Content
-        #     </div>
-        #   </div>
-        # </div>
-        #
-        # If there is no solution, don't add the 'os-hasSolution' class and don't
-        # link the number.
-
-        problem = exercise.first("[data-type='problem']")
-        solution = exercise.first("[data-type='solution']")
-
-        problem_number = "<span class='os-number'>#{exercise.count_in(:chapter)}</span>"
-
-        if solution.present?
-          solution.id = "#{exercise.id}-solution"
-
-          exercise.add_class("os-hasSolution")
-          problem_number = "<a href='##{solution.id}' class='os-number' >#{exercise.count_in(:chapter)}</a>"
-
-          solution.replace_children(with:
-            <<~HTML
-              <a class="os-number" href="##{exercise.id}">#{exercise.count_in(:chapter)}</a>
-              <span class="os-divider">. </span>
-              <div class="os-solution-container ">#{solution.children}</div>
-            HTML
-          )
-        end
-
-        problem.replace_children(with:
-          <<~HTML
-            #{problem_number}
-            <span class="os-divider">. </span>
-            <div class="os-problem-container ">#{problem.children}</div>
-          HTML
-        )
-      end
-
-    end
-  end
-end