openstax_kitchen 1.0.0

data/lib/kitchen/page_element.rb

@@ -0,0 +1,51 @@
+module Kitchen
+  class PageElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: PageElementEnumerator,
+            short_type: :page)
+    end
+
+    def title
+      # The selector for intro titles changes during the baking process
+      first!(is_introduction? ?
+               selectors.title_in_introduction_page :
+               selectors.title_in_page)
+    end
+
+    def is_introduction?
+      has_class?("introduction")
+    end
+
+    def is_preface?
+      has_class?("preface")
+    end
+
+    def is_appendix?
+      has_class?("appendix")
+    end
+
+    def metadata
+      first!("div[data-type='metadata']")
+    end
+
+    def summary
+      first!("section.summary")
+    end
+
+    def exercises
+      first!("section.exercises")
+    end
+
+    def exercises_section
+      search("")
+    end
+
+    def self.is_the_element_class_for?(node)
+      node['data-type'] == "page"
+    end
+
+  end
+end

data/lib/kitchen/page_element_enumerator.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  class PageElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "div[data-type='page']", # TODO get from config?
+        sub_element_class: PageElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/pantry.rb

@@ -0,0 +1,35 @@
+module Kitchen
+  # A place to store labeled items during recipe work.  Essentially, a slightly
+  # improved hash.
+  #
+  class Pantry
+    include Enumerable
+
+    def store(item, label:)
+      @hash[label.to_sym] = item
+    end
+
+    def get(label)
+      @hash[label.to_sym]
+    end
+
+    def get!(label)
+      get(label) || raise(RecipeError, "There is no pantry item labeled '#{label}'")
+    end
+
+    def each(&block)
+      @hash.each{|k,v| block.call(k,v)}
+    end
+
+    def size
+      @hash.keys.size
+    end
+
+    protected
+
+    def initialize
+      @hash = {}
+    end
+
+  end
+end

data/lib/kitchen/patches/nokogiri.rb

@@ -0,0 +1,31 @@
+# Make debug output more useful (dumping entire document out is not useful)
+module Nokogiri
+  module XML
+    class Document
+      def inspect
+        "Nokogiri::XML::Document <hidden for brevity>"
+      end
+
+      def alphabetize_attributes!
+        traverse do |child|
+          next if child.text? || child.document?
+          child_attributes = child.attributes
+          child_attributes.each do |key, value|
+            child.remove_attribute(key)
+          end
+          sorted_keys = child_attributes.keys.sort
+          sorted_keys.each do |key|
+            value = child_attributes[key].to_s
+            child[key] = value
+          end
+        end
+      end
+    end
+
+    class Node
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/kitchen/patches/renderable.rb

@@ -0,0 +1,31 @@
+class Object
+
+  # Adds a `render` method to a class for rendering an ERB template to a string.
+  def self.renderable(dir: nil)
+    dir ||= begin
+      this_patch_file = __FILE__
+      this_patch_file_caller_index = caller_locations.find_index do |location|
+        location.absolute_path == this_patch_file
+      end
+
+      location_that_called_renderable = caller_locations[(this_patch_file_caller_index || -1)+1]
+      File.dirname(location_that_called_renderable.path)
+    end
+
+    class_eval <<~METHOD
+      def renderable_base_dir
+        "#{dir}"
+      end
+    METHOD
+
+    class_eval do
+      def render(file:)
+        file = File.absolute_path(file, renderable_base_dir)
+        template = File.open(file, 'rb', &:read)
+        ERB.new(template).result(binding)
+      end
+    end
+
+  end
+
+end

data/lib/kitchen/patches/string.rb

@@ -0,0 +1,5 @@
+class String
+  def uncapitalize
+    sub(/^[A-Z]/, &:downcase)
+  end
+end

data/lib/kitchen/recipe.rb

@@ -0,0 +1,78 @@
+module Kitchen
+  class Recipe
+
+    attr_reader :document
+    attr_reader :source_location
+
+    def document=(document)
+      @document =
+        case document
+        when Kitchen::Document
+          document
+        else
+          raise "Unsupported document type `#{document.class}`"
+        end
+    end
+
+    # Make a new Recipe
+    #
+    # @yieldparam doc [Document] an object representing an XML document
+    #
+    def initialize(&block)
+      @source_location = block.source_location[0]
+      @block = block
+    end
+
+    def node!
+      node || raise("The recipe's node has not been set")
+    end
+
+    def bake
+      begin
+        @block.to_proc.call(document)
+      rescue RecipeError => ee
+        print_recipe_error_and_exit(ee)
+      rescue ArgumentError => ee
+        if if_any_stack_file_matches_source_location?(ee)
+          print_recipe_error_and_exit(ee)
+        else
+          raise
+        end
+      rescue NoMethodError => ee
+        if if_any_stack_file_matches_source_location?(ee)
+          print_recipe_error_and_exit(ee)
+        else
+          raise
+        end
+      rescue NameError => ee
+        if if_stack_starts_with_source_location?(ee)
+          print_recipe_error_and_exit(ee)
+        else
+          raise
+        end
+      rescue ElementNotFoundError => ee
+        print_recipe_error_and_exit(ee)
+      rescue Nokogiri::CSS::SyntaxError => ee
+        print_recipe_error_and_exit(ee)
+      end
+    end
+
+    protected
+
+    def if_stack_starts_with_source_location?(error)
+      error.backtrace.first.start_with?(source_location)
+    end
+
+    def if_any_stack_file_matches_source_location?(error)
+      error.backtrace.any? {|entry| entry.start_with?(@source_location)}
+    end
+
+    def print_recipe_error_and_exit(error)
+      Kitchen::Debug.print_recipe_error(error: error,
+                                        source_location: source_location,
+                                        document: document)
+      exit(1)
+    end
+
+  end
+end

data/lib/kitchen/search_history.rb

@@ -0,0 +1,33 @@
+module Kitchen
+  class SearchHistory
+    attr_reader :latest
+    attr_reader :upstream
+
+    def self.empty
+      new
+    end
+
+    def add(css_or_xpath)
+      self.class.new(self, css_or_xpath.nil? ? nil : [css_or_xpath].join(", "))
+    end
+
+    def to_s(missing_string="?")
+      to_a.map{|item| "[#{item || missing_string}]"}.join(" ")
+    end
+
+    def to_a
+      empty? ? [] : [upstream&.to_a || [], latest].flatten
+    end
+
+    def empty?
+      upstream.nil? && latest.nil?
+    end
+
+    protected
+
+    def initialize(upstream=nil, latest=nil)
+      @upstream = upstream
+      @latest = latest
+    end
+  end
+end

data/lib/kitchen/selectors/base.rb

@@ -0,0 +1,8 @@
+module Kitchen
+  module Selectors
+    class Base
+      attr_accessor :title_in_page
+      attr_accessor :title_in_introduction_page
+    end
+  end
+end

data/lib/kitchen/selectors/standard_1.rb

@@ -0,0 +1,12 @@
+module Kitchen
+  module Selectors
+    class Standard1 < Base
+
+      def initialize
+        self.title_in_page              = "./*[@data-type = 'document-title']"
+        self.title_in_introduction_page = "./*[@data-type = 'document-title']"
+      end
+
+    end
+  end
+end

data/lib/kitchen/table_element.rb

@@ -0,0 +1,36 @@
+module Kitchen
+  class TableElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: TableElementEnumerator,
+            short_type: :table)
+    end
+
+    def title_row
+      top_titled? ? first('thead').first('tr') : nil
+    end
+
+    def title
+      title_row&.first('th').children
+    end
+
+    def top_titled?
+      has_class?('top-titled')
+    end
+
+    def unnumbered?
+      has_class?('unnumbered')
+    end
+
+    def caption
+      first("caption")
+    end
+
+    def self.is_the_element_class_for?(node)
+      node.name == "table"
+    end
+
+  end
+end

data/lib/kitchen/table_element_enumerator.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  class TableElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "table", # TODO get from config?
+        sub_element_class: TableElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/term_element.rb

@@ -0,0 +1,16 @@
+module Kitchen
+  class TermElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: TermElementEnumerator,
+            short_type: :term)
+    end
+
+    def self.is_the_element_class_for?(node)
+      node['data-type'] == "term"
+    end
+
+  end
+end

data/lib/kitchen/term_element_enumerator.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  class TermElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "span[data-type='term']", # TODO get from config?
+        sub_element_class: TermElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/transliterations.rb

@@ -0,0 +1,19 @@
+module Kitchen
+  # These are added to every translation locale, including the `test` locale
+  # set by `stub_locales`.  When we sort strings with accent marks, we use
+  # `ActiveSupport::Inflector.transliterate` to ensure that the sorting is
+  # sensible.  This method does not know about Greek characters by default so
+  # we teach it about them by adding the rules below to the i18n configuration.
+
+  TRANSLITERATIONS = {
+    i18n: {
+      transliterate: {
+        rule: {
+          σ: "σ",
+          Δ: "Δ",
+          π: "π",
+        }
+      }
+    }
+  }
+end

data/lib/kitchen/type_casting_element_enumerator.rb

@@ -0,0 +1,23 @@
+module Kitchen
+  class TypeCastingElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        enumerator_class: self,
+        detect_sub_element_class: true
+      )
+    end
+
+    def only(*element_classes)
+      element_classes.flatten!
+
+      TypeCastingElementEnumerator.new do |block|
+        self.each do |element|
+          next unless element_classes.include?(element.class)
+          block.yield(element)
+        end
+      end
+    end
+
+  end
+end

data/lib/kitchen/utils.rb

@@ -0,0 +1,19 @@
+module Kitchen
+  module Utils
+
+    def self.search_path_to_type(search_path)
+      [search_path].flatten.join(",")
+    end
+
+    def self.normalized_xhtml_string(xml_thing_with_to_s)
+      doc = Nokogiri::XML(xml_thing_with_to_s.to_s) do |config|
+        config.noblanks
+      end
+
+      doc.alphabetize_attributes!
+
+      doc.to_xhtml(indent: 2)
+    end
+
+  end
+end