openstax_kitchen 1.0.0

data/lib/kitchen/chapter_element.rb

@@ -0,0 +1,35 @@
+module Kitchen
+  class ChapterElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: ChapterElementEnumerator,
+            short_type: :chapter)
+    end
+
+    def title
+      # Get the title in the immediate children, not the one in the metadata.  Could use
+      # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
+      # but xpath is shorter
+      first!("./*[@data-type = 'document-title']")
+    end
+
+    def introduction_page
+      pages('.introduction').first
+    end
+
+    def glossaries
+      search("div[data-type='glossary']")
+    end
+
+    def key_equations
+      search("section.key-equations")
+    end
+
+    def self.is_the_element_class_for?(node)
+      node['data-type'] == "chapter"
+    end
+
+  end
+end

data/lib/kitchen/chapter_element_enumerator.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  class ChapterElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "div[data-type='chapter']", # TODO element.document.selectors.chapter
+        sub_element_class: ChapterElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/clipboard.rb

@@ -0,0 +1,37 @@
+module Kitchen
+  # A place to store lists of things during recipe work.  Essentially a
+  # slightly fancy array.
+  #
+  class Clipboard
+    include Enumerable
+
+    attr_reader :items
+
+    def initialize
+      clear
+    end
+
+    def add(item)
+      @items.push(item)
+    end
+
+    def clear
+      @items = []
+    end
+
+    def paste
+      @items.map(&:paste).join("")
+    end
+
+    def each(&block)
+      @items.each do |item|
+        block.call(item)
+      end
+      self
+    end
+
+    def sort_by!(&block)
+      @items.sort_by!(&block)
+    end
+  end
+end

data/lib/kitchen/composite_chapter_element.rb

@@ -0,0 +1,23 @@
+module Kitchen
+  class CompositeChapterElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: ElementEnumerator,
+            short_type: :composite_chapter)
+    end
+
+    def title
+      # Get the title in the immediate children, not the one in the metadata.  Could use
+      # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
+      # but xpath is shorter
+      first!("./*[@data-type = 'document-title']")
+    end
+
+    def self.is_the_element_class_for?(node)
+      node['data-type'] == "composite-chapter"
+    end
+
+  end
+end

data/lib/kitchen/composite_page_element.rb

@@ -0,0 +1,27 @@
+module Kitchen
+  class CompositePageElement < ElementBase
+
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: CompositePageElementEnumerator,
+            short_type: :composite_page)
+    end
+
+    def title
+      # Get the title in the immediate children, not the one in the metadata.  Could use
+      # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
+      # but xpath is shorter
+      first!("./*[@data-type = 'document-title']")
+    end
+
+    def self.is_the_element_class_for?(node)
+      node['data-type'] == "composite-page"
+    end
+
+    def is_index?
+      has_class?("os-index-container")
+    end
+
+  end
+end

data/lib/kitchen/composite_page_element_enumerator.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  class CompositePageElementEnumerator < ElementEnumeratorBase
+
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: "div[data-type='composite-page']",
+        sub_element_class: CompositePageElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/config.rb

@@ -0,0 +1,20 @@
+module Kitchen
+  class Config
+
+    attr_reader :selectors
+
+    def self.new_from_file(file)
+      raise "NYI"
+    end
+
+    def self.new_default
+      new
+    end
+
+    def initialize(hash: {}, selectors: nil)
+      @selectors = selectors || Kitchen::Selectors::Standard1.new
+      @hash = hash
+    end
+
+  end
+end

data/lib/kitchen/counter.rb

@@ -0,0 +1,34 @@
+module Kitchen
+  class Counter # hehe
+
+    def initialize
+      reset
+    end
+
+    # Increase the value of the counter
+    #
+    # @param by [Integer] the amount to increase by
+    #
+    def increment(by: 1)
+      @value += by
+    end
+
+    # (see #increment)
+    alias_method :inc, :increment
+
+    # Returns the value of the counter
+    #
+    # @return [Integer]
+    def get
+      @value
+    end
+
+    # Reset the value of the counter
+    #
+    # @param to [Integer] the value to reset to
+    def reset(to: 0)
+      @value = to
+    end
+
+  end
+end

data/lib/kitchen/debug/print_recipe_error.rb

@@ -0,0 +1,80 @@
+require 'rainbow'
+
+module Kitchen
+  module Debug
+
+    CONTEXT_LINES = 2
+
+    def self.print_recipe_error(error:, source_location:, document:)
+      error_location = error.backtrace.detect do |entry|
+        entry.start_with?(source_location) || entry.match?(/kitchen\/lib\/kitchen\/directions/)
+      end
+
+      error_filename, error_line_number = error_location.match(/(.*):(\d+):/)[1..2]
+      error_line_number = error_line_number.to_i
+
+      puts "The recipe has an error: " + Rainbow(error.message).bright
+      puts "at or near the following #{Rainbow('highlighted').red} line"
+      puts "\n"
+      puts "-----+ #{Rainbow(error_filename).bright} -----"
+
+      line_numbers_before = (error_line_number-CONTEXT_LINES..error_line_number-1)
+      line_numbers_after  = (error_line_number+1..error_line_number+CONTEXT_LINES)
+
+      File.readlines(error_filename).each.with_index do |line, line_index|
+        line_number = line_index + 1
+
+        if line_numbers_before.include?(line_number) ||
+           line_numbers_after.include?(line_number)
+          print_file_line(line_number, line)
+        end
+
+        if line_number == error_line_number
+          print_file_line(line_number, Rainbow(line.chomp).red)
+        end
+      end
+
+      puts "\n"
+
+      print_specific_help_line(error)
+
+      current_node = document.location&.raw
+
+      if current_node
+        puts "Encountered on line #{Rainbow(current_node.line).red} in the input document on element:"
+        puts current_node.dup.tap{|node| node.inner_html="..." if node.inner_html != ""}.to_s
+        puts "\n"
+      end
+
+      if ENV['VERBOSE']
+        puts "Full backtrace:\n"
+        puts error.backtrace.map{|line| Rainbow(line).blue}
+      else
+        puts "Full backtrace suppressed (enable by setting the VERBOSE environment variable to something)"
+      end
+    end
+
+    protected
+
+    def self.print_file_line(line_number, line)
+      puts "#{"%5s" % line_number}| #{line}"
+    end
+
+    def self.print_specific_help_line(error)
+      # No specific help lines at the moment, an example is shown for the future
+
+      # help_line = case error.message
+      # when /some string in error/
+      #   "`foo` needs to be called on a Bar object"
+      # else
+      #   nil
+      # end
+
+      # if !help_line.nil?
+      #   puts help_line
+      #   puts "\n"
+      # end
+    end
+
+  end
+end

data/lib/kitchen/directions/bake_appendix.rb

@@ -0,0 +1,26 @@
+module Kitchen
+  module Directions
+    module BakeAppendix
+
+      def self.v1(page:, number:)
+        title = page.title
+        title.name = "h1"
+        title.replace_children(with:
+          <<~HTML
+            <span class="os-part-text">#{I18n.t(:appendix)} </span>
+            <span class="os-number">#{number}</span>
+            <span class="os-divider"> </span>
+            <span data-type="" itemprop="" class="os-text">#{title.children}</span>
+          HTML
+        )
+
+        # Make a section with data-depth of X have a header level of X+1
+        page.search("section").each do |section|
+          title = section.first!("[data-type='title']")
+          title.name = "h#{section['data-depth'].to_i + 1}"
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_glossary.rb

@@ -0,0 +1,34 @@
+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_chapter_introductions.rb

@@ -0,0 +1,58 @@
+module Kitchen
+  module Directions
+    module BakeChapterIntroductions
+
+      def self.v1(book:)
+        book.chapters.each do |chapter|
+          outline_items_html = chapter.pages.map do |page|
+            next if page.is_introduction?
+
+            <<~HTML
+              <div class="os-chapter-objective">
+                <a class="os-chapter-objective" href="##{page.title[:id]}">
+                  <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)-1}</span>
+                  <span class="os-divider"> </span>
+                  <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
+                </a>
+              </div>
+            HTML
+          end.join("")
+
+          introduction_page = chapter.introduction_page
+
+          introduction_page.search("div[data-type='description']").trash
+          introduction_page.search("div[data-type='abstract']").trash
+
+          title = introduction_page.title.cut
+          title.name = "h2"
+          MoveTitleTextIntoSpan.v1(title: title)
+
+          intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
+
+          introduction_page.append(child:
+            <<~HTML
+              <div class="intro-body">
+                <div class="os-chapter-outline">
+                  <h3 class="os-title">Chapter Outline</h3>
+                  #{outline_items_html}
+                </div>
+                <div class="intro-text">
+                  #{title.paste}
+                  #{intro_content.paste}
+                </div>
+              </div>
+            HTML
+          )
+        end
+
+        v1_update_selectors(book)
+      end
+
+      def self.v1_update_selectors(something_with_selectors)
+        something_with_selectors.selectors.title_in_introduction_page =
+          ".intro-text > [data-type='document-title']"
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -0,0 +1,30 @@
+module Kitchen
+  module Directions
+    module BakeChapterKeyEquations
+
+      def self.v1(chapter:, metadata_source:)
+        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
+                                                      .permissions [data-type='subject'])).copy
+
+        chapter.key_equations.search("h3").trash
+        key_equations = chapter.key_equations.cut
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-eoc os-key-equations-container" data-type="composite-page" data-uuid-key=".key-equations">
+              <h2 data-type="document-title">
+                <span class="os-text">#{I18n.t(:eoc_key_equations)}</span>
+              </h2>
+              <div data-type="metadata" style="display: none;">
+                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_equations)}</h1>
+                #{metadata_elements.paste}
+              </div>
+              #{key_equations.paste}
+            </div>
+          HTML
+        ) unless key_equations.none?
+      end
+
+    end
+  end
+end