openstax_kitchen 1.0.0

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -0,0 +1,52 @@
+module Kitchen
+  module Directions
+    module BakeChapterSummary
+
+      def self.v1(chapter:, metadata_source:)
+        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
+                                                      .permissions [data-type='subject'])).copy
+
+        summaries = Clipboard.new
+
+        # TODO include specific page types somehow without writing it out
+        chapter.pages("$:not(.introduction)").each do |page|
+          summary = page.summary
+          summary.first("[data-type='title']").trash # get rid of old title
+          summary_title = page.title.copy
+          summary_title.name = "h3"
+          summary_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="">#{summary_title.children}</span>
+            HTML
+          )
+
+          summary.prepend(child:
+            <<~HTML
+              <a href="##{page.title.id}">
+                #{summary_title.paste}
+              </a>
+            HTML
+          )
+          summary.cut(to: summaries)
+        end
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-eoc os-summary-container" data-type="composite-page" data-uuid-key=".summary">
+              <h2 data-type="document-title">
+                <span class="os-text">#{I18n.t(:eoc_summary_title)}</span>
+              </h2>
+              <div data-type="metadata" style="display: none;">
+                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_summary_title)}</h1>
+                #{metadata_elements.paste}
+              </div>
+              #{summaries.paste}
+            </div>
+          HTML
+        ) unless summaries.none?
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_composite_pages.rb

@@ -0,0 +1,13 @@
+module Kitchen
+  module Directions
+    module BakeCompositePages
+
+      def self.v1(book:)
+        book.search("[data-type='composite-page']").each do |page|
+          page.id = "composite-page-#{page.count_in(:book)}"
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_example.rb

@@ -0,0 +1,31 @@
+module Kitchen
+  module Directions
+    module BakeExample
+
+      def self.v1(example:, number:, title_tag:)
+        example.replace_children(with:
+          <<~HTML
+            <div class="body">
+              #{example.children}
+            </div>
+          HTML
+        )
+
+        example.prepend(child:
+          <<~HTML
+            <#{title_tag} class="os-title">
+              <span class="os-title-label">#{I18n.t(:example_label)} </span>
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+            </#{title_tag}>
+          HTML
+        )
+
+        example.document.pantry(name: :link_text).store "#{I18n.t(:example_label)} #{number}", label: example.id
+
+        example.titles.each {|title| title.name = "h4"}
+      end
+
+    end
+  end
+end

data/lib/kitchen/directions/bake_exercises.rb

@@ -0,0 +1,164 @@
+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

data/lib/kitchen/directions/bake_figure.rb

@@ -0,0 +1,25 @@
+module Kitchen
+  module Directions
+    module BakeFigure
+
+      def self.v1(figure:, number:)
+        figure.wrap(%Q(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+
+        figure.document.pantry(name: :link_text).store "Figure #{number}", label: figure.id
+
+        caption = figure.caption&.cut
+        figure.append(sibling:
+          <<~HTML
+            <div class="os-caption-container">
+              <span class="os-title-label">Figure </span>
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+              <span class="os-divider"> </span>
+              #{'<span class="os-caption">' + caption.children.to_s + '</span>'if caption}
+            </div>
+          HTML
+        )
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,38 @@
+module Kitchen::Directions::BakeFootnotes
+  class V1
+
+    def bake(book:)
+      # Footnotes are numbered either within their top-level pages (preface,
+      # appendices, etc) or within chapters. Tackle each case separately
+
+      book.body.element_children.only(Kitchen::PageElement,
+                                      Kitchen::CompositePageElement).each do |page|
+        bake_footnotes_within(page)
+      end
+
+      book.chapters.each do |chapter|
+        bake_footnotes_within(chapter)
+      end
+    end
+
+    def bake_footnotes_within(container)
+      footnote_number = 0
+      aside_id_to_footnote_number = {}
+
+      container.search("a[role='doc-noteref']").each do |anchor|
+        footnote_number += 1
+        anchor.replace_children(with: footnote_number.to_s)
+        aside_id = anchor[:href][1..-1]
+        aside_id_to_footnote_number[aside_id] = footnote_number
+      end
+
+
+      container.search("aside").each do |aside|
+        footnote_number = aside_id_to_footnote_number[aside.id]
+        aside.prepend(child: "<div class='footnote-number'>#{footnote_number}</div>")
+      end
+
+    end
+
+  end
+end

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

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

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

@@ -0,0 +1,138 @@
+module Kitchen::Directions::BakeIndex
+  class V1
+    renderable
+
+    class Term
+      attr_reader :text, :id, :group_by, :page_title
+
+      def initialize(text:, id:, group_by:, page_title:)
+        @text = text.strip
+        @id = id
+        @group_by = group_by
+        @page_title = page_title
+      end
+    end
+
+    class IndexItem
+      attr_reader :term_text
+      attr_reader :terms
+
+      def initialize(term_text:)
+        @term_text = term_text
+        @terms = []
+
+        # Sort by transliterated version first to support accent marks,
+        # then by the raw text to support the same text with different capitalization
+        @sortable = [
+          ActiveSupport::Inflector.transliterate(term_text).downcase,
+          term_text
+        ]
+      end
+
+      def add_term(term)
+        @terms.push(term)
+      end
+
+      def uncapitalize_term_text!
+        @term_text = @term_text.uncapitalize
+      end
+
+      def <=>(other)
+        self.sortable <=> other.sortable
+      end
+
+      protected
+
+      attr_reader :sortable
+    end
+
+    class IndexSection
+      attr_reader :name
+      attr_reader :items
+
+      def initialize(name:)
+        @force_first = name == I18n.t(:eob_index_symbols_group)
+        @name = name
+        @items = SortedSet.new
+        @items_by_term_text = {}
+      end
+
+      def add_term(term)
+        item_for(term).add_term(term)
+      end
+
+      def <=>(other)
+        return -1 if force_first
+        return 1 if other.force_first
+        self.name <=> other.name
+      end
+
+      protected
+
+      attr_reader :force_first
+
+      def item_for(term)
+        @items_by_term_text[term.text] ||= begin
+          different_caps_item = @items_by_term_text[term.text.uncapitalize]
+          different_caps_item&.uncapitalize_term_text!
+
+          (different_caps_item || IndexItem.new(term_text: term.text)).tap do |item|
+            @items.add(item)
+          end
+        end
+      end
+    end
+
+    class Index
+      attr_reader :sections
+
+      def initialize
+        @sections = SortedSet.new
+        @sections_by_name = {}
+      end
+
+      def add_term(term)
+        section_named(term.group_by.capitalize).add_term(term)
+      end
+
+      protected
+
+      def section_named(name)
+        @sections_by_name[name] ||= begin
+          IndexSection.new(name: name).tap do |section|
+            @sections.add(section)
+          end
+        end
+      end
+    end
+
+    def bake(book:)
+      @metadata_elements = book.metadata.search(%w(.authors .publishers .print-style
+                                                   .permissions [data-type='subject'])).copy
+      @index = Index.new
+
+      book.pages.terms.each do |term_element|
+        # Markup the term
+        page = term_element.ancestor(:page)
+        term_element.id = "auto_#{page.id}_term#{term_element.count_in(:book)}"
+
+        group_by = term_element.text.strip[0]
+        if !group_by.match? (/\w/)
+          group_by = I18n.t(:eob_index_symbols_group)
+        end
+        term_element['group-by'] = group_by
+
+        # Add it to our index object
+        @index.add_term(Term.new(
+          text: term_element.text,
+          id: term_element.id,
+          group_by: group_by,
+          page_title: page.title.text.gsub(/\n/,'')
+        ))
+      end
+
+      book.first("body").append(child: render(file: 'v1.xhtml.erb'))
+    end
+
+  end
+end