openstax_kitchen 1.0.0

data/lib/kitchen/directions/bake_index/v1.xhtml.erb

@@ -0,0 +1,28 @@
+<div class="os-eob os-index-container " data-type="composite-page" data-uuid-key="index">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eob_index_title) %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eob_index_title) %></h1>
+    <%= @metadata_elements.paste %>
+  </div>
+  <% @index.sections.each do |section| %>
+    <div class="group-by">
+      <span class="group-label"><%= section.name %></span>
+      <% section.items.each do |item| %>
+        <div class="os-index-item">
+          <% item.terms.each_with_index do |term, ii| %>
+            <% if ii == 0 %>
+              <span class="os-term" group-by="<%= term.group_by %>"><%= term.text %></span>
+            <% else %>
+              <span class="os-index-link-separator">, </span>
+            <% end %>
+            <a class="os-term-section-link" href="#<%= term.id %>">
+              <span class="os-term-section"><%= term.page_title %></span>
+            </a>
+          <% end %>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/lib/kitchen/directions/bake_math_in_paragraph.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  module Directions
+    module BakeMathInParagraph
+
+      def self.v1(book:)
+        book.search("p m|math").each do |math|
+          math.wrap("<span class='os-math-in-para'>")
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_notes.rb

@@ -0,0 +1,58 @@
+module Kitchen
+  module Directions
+    module BakeNotes
+
+      def self.v1(book:)
+        book.notes.each do |note|
+          title = note.title&.cut
+
+          note.replace_children(with:
+            <<~HTML
+              <div class="os-note-body">#{note.children}</div>
+            HTML
+          )
+
+          if title
+            if note.indicates_autogenerated_title?
+              note.prepend(child:
+                <<~HTML
+                  <h3 class="os-title" data-type="title">
+                    <span class="os-title-label">#{note.autogenerated_title}</span>
+                  </h3>
+                HTML
+              )
+
+              title.name = "h4"
+              title.add_class("os-subtitle")
+              title.replace_children(with:
+                <<~HTML
+                  <span class="os-subtitle-label">#{title.children}</span>
+                HTML
+              )
+              note.first!(".os-note-body").prepend(child: title.raw)
+            else
+              title.name = "h3"
+              title.add_class("os-title")
+              title.replace_children(with:
+                <<~HTML
+                  <span data-type="" id="#{title.id}" class="os-title-label">#{title.children}</span>
+                HTML
+              )
+              title.remove_attribute("id")
+              note.prepend(child: title.raw)
+            end
+          else
+            note.prepend(child:
+              <<~HTML
+                <h3 class="os-title" data-type="title">
+                  <span class="os-title-label">#{note.autogenerated_title}</span>
+                </h3>
+              HTML
+            )
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_numbered_table/main.rb

@@ -0,0 +1,11 @@
+module Kitchen
+  module Directions
+    module BakeNumberedTable
+
+      def self.v1(table:, number:)
+        V1.new.bake(table: table, number: number)
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_numbered_table/v1.rb

@@ -0,0 +1,47 @@
+module Kitchen::Directions::BakeNumberedTable
+  class V1
+
+    def bake(table:, number:)
+      table.wrap(%Q(<div class="os-table">))
+
+      table_label = "#{I18n.t(:table_label)} #{number}"
+      table.document.pantry(name: :link_text).store table_label, label: table.id
+
+      if table.top_titled?
+        table.prepend(sibling:
+          <<~HTML
+            <div class="os-table-title">#{table.title}</div>
+          HTML
+        )
+        table.title_row.trash
+      end
+
+      # TODO extra spaces added here to match legacy implementation, but probably not meaningful?
+      new_summary = table_label + "  "
+      new_caption = ""
+
+      if (caption = table.caption&.cut)
+        new_summary += caption.text
+        new_caption = <<~HTML
+          \n<span class="os-caption">#{caption.children}</span>
+        HTML
+      end
+
+      table[:summary] = new_summary
+
+      if !table.unnumbered?
+        table.append(sibling:
+          <<~HTML
+            <div class="os-caption-container">
+              <span class="os-title-label">#{I18n.t(:table_label)} </span>
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+              <span class="os-divider"> </span>#{new_caption}
+            </div>
+          HTML
+        )
+      end
+    end
+
+  end
+end

data/lib/kitchen/directions/bake_stepwise.rb

@@ -0,0 +1,27 @@
+module Kitchen
+  module Directions
+    module BakeStepwise
+
+      def self.v1(book:)
+        book.search("ol.stepwise").each do |ol|
+          ol.remove_class("stepwise")
+          ol.add_class("os-stepwise")
+
+          ol.search("li").each_with_index do |li, ii|
+            li.replace_children(with:
+              <<~HTML
+                <span class="os-stepwise-content">#{li.children}</span>
+              HTML
+            )
+            li.prepend(child:
+              <<~HTML
+                <span class="os-stepwise-token">#{I18n.t(:stepwise_step_label)} #{ii+1}. </span>
+              HTML
+            )
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -0,0 +1,103 @@
+module Kitchen
+  module Directions
+    module BakeToc
+
+      def self.v1(book:)
+        li_tags = book.body.element_children.map do |element|
+          case element
+          when ChapterElement
+            li_for_chapter(element)
+          when PageElement, CompositePageElement
+            li_for_page(element)
+          when CompositeChapterElement
+            li_for_composite_chapter(element)
+          end
+        end.compact.join("\n")
+
+        book.first!("nav").replace_children(with: <<~HTML
+            <h1 class="os-toc-title">Contents</h1>
+            <ol>
+              #{li_tags}
+            </ol>
+          HTML
+        )
+      end
+
+      def self.li_for_composite_chapter(chapter)
+        pages = chapter.element_children.only(CompositePageElement)
+
+        <<~HTML
+          <li class="os-toc-composite-chapter" cnx-archive-shortid="" cnx-archive-uri="">
+            <a href="##{chapter.title.id}">
+              #{chapter.title.children.to_s}
+            </a>
+            <ol class="os-chapter">
+              #{pages.map{|page| li_for_page(page)}.join("\n")}
+            </ol>
+          </li>
+        HTML
+      end
+
+      def self.li_for_chapter(chapter)
+        pages = chapter.element_children.only(PageElement, CompositePageElement)
+
+        <<~HTML
+          <li class="os-toc-chapter" cnx-archive-shortid="" cnx-archive-uri="">
+            <a href="##{chapter.title.id}">
+              <span class="os-number"><span class="os-part-text">Chapter </span>#{chapter.count_in(:book)}</span>
+              <span class="os-divider"> </span>
+              <span class="os-text" data-type="" itemprop="">#{chapter.title.first!(".os-text").text}</span>
+            </a>
+            <ol class="os-chapter">
+              #{pages.map{|page| li_for_page(page)}.join("\n")}
+            </ol>
+          </li>
+        HTML
+      end
+
+      def self.li_for_page(page)
+        li_class =
+          if page.is_a?(PageElement)
+            if page.has_ancestor?(:chapter)
+              "os-toc-chapter-page"
+            elsif page.is_appendix?
+              "os-toc-appendix"
+            elsif page.is_preface?
+              "os-toc-preface"
+            else
+              raise "do not know what TOC class to use for page with classes #{page.classes}"
+            end
+          elsif page.is_a?(CompositePageElement)
+            if page.is_index?
+              "os-toc-index"
+            elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
+              "os-toc-chapter-composite-page"
+            else
+              raise "do not know what TOC class to use for page with classes #{page.classes}"
+            end
+          else
+            raise(ArgumentError, "don't know how to put `#{page.class}` into the TOC")
+          end
+
+        title = page.title.copy
+
+        # The part text gets inserted as a child to the number span
+        part_text = title.first(".os-part-text")
+        number = title.first(".os-number")
+        if part_text && number
+          part_text = part_text.cut
+          number.prepend(child: part_text.paste)
+        end
+
+        <<~HTML
+          <li class="#{li_class}" cnx-archive-shortid="" cnx-archive-uri="#{page.id}">
+            <a href="##{page.id}">
+              #{title.element_children.copy.paste}
+            </a>
+          </li>
+        HTML
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_unnumbered_tables.rb

@@ -0,0 +1,14 @@
+module Kitchen
+  module Directions
+    module BakeUnnumberedTables
+
+      def self.v1(book:)
+        book.tables("$.unnumbered").each do |table|
+          table.wrap(%Q(<div class="os-table">))
+          table.remove_attribute("summary")
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/move_title_text_into_span.rb

@@ -0,0 +1,15 @@
+module Kitchen
+  module Directions
+    module MoveTitleTextIntoSpan
+
+      def self.v1(title:)
+        title.replace_children(with:
+          <<~HTML
+            <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+          HTML
+        )
+      end
+
+    end
+  end
+end

data/lib/kitchen/document.rb

@@ -0,0 +1,142 @@
+require 'forwardable'
+
+module Kitchen
+  class Document
+    extend Forwardable
+
+    attr_accessor :location
+    attr_reader :config
+
+    def_delegators :config, :selectors
+    def_delegators :@nokogiri_document, :to_xhtml, :to_s, :to_xml, :to_html
+
+    def initialize(nokogiri_document:, config: nil)
+      @nokogiri_document = nokogiri_document
+      @location = nil
+      @config = config || Config.new_default
+      @next_paste_count_for_id = {}
+      @id_copy_suffix = "_copy_"
+    end
+
+    # Returns an enumerator that iterates over all children of this document
+    # that match the provided selector or XPath arguments.
+    #
+    # @param selector_or_xpath_args [Array<String>] CSS selectors or XPath arguments
+    # @return [ElementEnumerator]
+    #
+    def search(*selector_or_xpath_args)
+      selector_or_xpath_args = [selector_or_xpath_args].flatten
+
+      ElementEnumerator.new do |block|
+        nokogiri_document.search(*selector_or_xpath_args).each do |inner_node|
+          element = Kitchen::Element.new(node: inner_node,
+                                         document: self,
+                                         short_type: Utils.search_path_to_type(selector_or_xpath_args))
+          self.location = element
+          block.yield(element)
+        end
+      end
+    end
+
+    # Returns the document's clipboard with the given name.
+    #
+    # @param name [Symbol, String] the name of the clipboard.  String values are
+    #   converted to symbols.
+    # @return [Clipboard]
+    #
+    def clipboard(name: :default)
+      (@clipboards ||= {})[name.to_sym] ||= Clipboard.new
+    end
+
+    # Returns the document's pantry with the given name.
+    #
+    # @param name [Symbol, String] the name of the pantry.  String values are
+    #   converted to symbols.
+    # @return [Pantry]
+    #
+    def pantry(name: :default)
+      (@pantries ||= {})[name.to_sym] ||= Pantry.new
+    end
+
+    # Returns the document's counter with the given name.
+    #
+    # @param name [Symbol, String] the name of the counter.  String values are
+    #   converted to symbols.
+    # @return [Counter]
+    #
+    def counter(name)
+      (@counters ||= {})[name.to_sym] ||= Counter.new
+    end
+
+    # Create a new Element
+    #
+    # TODO don't know if we need this
+    #
+    # @param name [String] the tag name
+    # @param args [Array<String, Hash>]
+    #
+    # @example div with a class
+    #   create_element("div", class: "foo") #=> <div class="foo"></div>
+    # @example div with some content and a class
+    #   cretae_element("div", "contents", class: "foo") #=> <div class="foo">contents</div>
+    # @example div created by block
+    #   create_element("div") {|elem| elem['class'] = 'foo'} #=> <div class="foo"></div>
+    #
+    # @return [Element]
+    #
+    def create_element(name, *args, &block)
+      Kitchen::Element.new(
+        node: @nokogiri_document.create_element(name, *args, &block),
+        document: self,
+        short_type: "created_element_#{SecureRandom.hex(4)}"
+      )
+    end
+
+    def create_element_from_string(string)
+      Kitchen::Element.new(
+        node: @nokogiri_document.create_element("div"),
+        document: self,
+        short_type: "created_element_#{SecureRandom.hex(4)}"
+      ).element_children.first
+    end
+
+    def record_id_copied(id)
+      return if id.blank?
+      @next_paste_count_for_id[id] ||= 1
+    end
+
+    def modified_id_to_paste(original_id)
+      return nil if original_id.nil?
+      return "" if original_id.blank?
+
+      count = next_count_for_pasted_id(original_id)
+
+      # A count of 0 means the element was cut and this is the first paste, do not
+      # modify the ID; otherwise, use the uniquified ID.
+      if count == 0
+        original_id
+      else
+        "#{original_id}#{@id_copy_suffix}#{count}"
+      end
+    end
+
+    # Returns the underlying Nokogiri Document object
+    #
+    # @return [Nokogiri::XML::Document]
+    def raw
+      @nokogiri_document
+    end
+
+    protected
+
+    def next_count_for_pasted_id(id)
+      return if id.blank?
+      (@next_paste_count_for_id[id] ||= 0).tap do
+        @next_paste_count_for_id[id] += 1
+      end
+    end
+
+    attr_reader :nokogiri_document
+
+  end
+end