openstax_kitchen 2.0.0 → 3.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitchen::Directions::BakeFootnotes
   class V1
 
@@ -26,12 +28,10 @@ module Kitchen::Directions::BakeFootnotes
         aside_id_to_footnote_number[aside_id] = footnote_number
       end
 
-
-      container.search("aside").each do |aside|
+      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>")
+        aside.prepend(child: "<div data-type='footnote-number'>#{footnote_number}</div>")
       end
-
     end
 
   end

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 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

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 module Kitchen::Directions::BakeIndex
+  # Bake directions for eob index
+  #
   class V1
     renderable
 
     class Term
-      attr_reader :text, :id, :group_by, :page_title
+      attr_reader :text
+      attr_reader :id
+      attr_reader :group_by
+      attr_reader :page_title
 
       def initialize(text:, id:, group_by:, page_title:)
         @text = text.strip
@@ -38,7 +45,7 @@ module Kitchen::Directions::BakeIndex
       end
 
       def <=>(other)
-        self.sortable <=> other.sortable
+        sortable <=> other.sortable
       end
 
       protected
@@ -64,7 +71,8 @@ module Kitchen::Directions::BakeIndex
       def <=>(other)
         return -1 if force_first
         return 1 if other.force_first
-        self.name <=> other.name
+
+        name <=> other.name
       end
 
       protected
@@ -107,8 +115,7 @@ module Kitchen::Directions::BakeIndex
     end
 
     def bake(book:)
-      @metadata_elements = book.metadata.search(%w(.authors .publishers .print-style
-                                                   .permissions [data-type='subject'])).copy
+      @metadata_elements = book.metadata.children_to_keep.copy
       @index = Index.new
 
       book.pages.terms.each do |term_element|
@@ -117,21 +124,21 @@ module Kitchen::Directions::BakeIndex
         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
+        group_by = I18n.t(:eob_index_symbols_group) unless group_by.match?(/\w/)
         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/,'')
-        ))
+        @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'))
+      book.first('body').append(child: render(file: 'v1.xhtml.erb'))
     end
 
   end

data/lib/kitchen/directions/bake_link_placeholders.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for link placeholders
+    #
+    module BakeLinkPlaceholders
+      def self.v1(book:)
+        book.search('a').each do |anchor|
+          next unless anchor.text == '[link]'
+
+          id = anchor[:href][1..-1]
+          replacement = book.document.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
+    end
+  end
+end

data/lib/kitchen/directions/bake_math_in_paragraph.rb

@@ -1,13 +1,15 @@
+# frozen-string-literal: true
+
 module Kitchen
   module Directions
+    # Wraps any math contained in a <p> tag
+    # with a <span> with class 'os-math-in-para'
     module BakeMathInParagraph
-
       def self.v1(book:)
-        book.search("p m|math").each do |math|
+        book.search('p m|math', '//p//math | //p//m').each do |math|
           math.wrap("<span class='os-math-in-para'>")
         end
       end
-
     end
   end
 end

data/lib/kitchen/directions/bake_notes.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeNotes
-
       def self.v1(book:)
         book.notes.each do |note|
           title = note.title&.cut
@@ -22,23 +23,23 @@ module Kitchen
                 HTML
               )
 
-              title.name = "h4"
-              title.add_class("os-subtitle")
+              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)
+              note.first!('.os-note-body').prepend(child: title.raw)
             else
-              title.name = "h3"
-              title.add_class("os-title")
+              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")
+              title.remove_attribute('id')
               note.prepend(child: title.raw)
             end
           else
@@ -52,7 +53,6 @@ module Kitchen
           end
         end
       end
-
     end
   end
 end

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 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

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 module Kitchen::Directions::BakeNumberedTable
   class V1
 
     def bake(table:, number:)
-      table.wrap(%Q(<div class="os-table">))
+      table.wrap(%(<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.parent.add_class('os-top-titled-container')
         table.prepend(sibling:
           <<~HTML
             <div class="os-table-title">#{table.title}</div>
@@ -16,9 +19,11 @@ module Kitchen::Directions::BakeNumberedTable
         table.title_row.trash
       end
 
-      # TODO extra spaces added here to match legacy implementation, but probably not meaningful?
-      new_summary = table_label + "  "
-      new_caption = ""
+      table.parent.add_class('os-column-header-container') if table.column_header?
+
+      # 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
@@ -29,18 +34,18 @@ module Kitchen::Directions::BakeNumberedTable
 
       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
+      return 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

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Adds learning objectives header to abstracts
+    module BakePageAbstracts
+      def self.v1(chapter:)
+        chapter.abstracts.each do |abstract|
+          abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakePreface
+  class V1
+    def bake(book:)
+      book.pages('$.preface').each do |page|
+        page.titles.each do |title|
+          title.replace_children(with:
+            <<~HTML
+              <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+            HTML
+          )
+          title.name = 'h1'
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_stepwise.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 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")
+        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|
+          ol.search('li').each_with_index do |li, ii|
             li.replace_children(with:
               <<~HTML
                 <span class="os-stepwise-content">#{li.children}</span>
@@ -15,13 +16,12 @@ module Kitchen
             )
             li.prepend(child:
               <<~HTML
-                <span class="os-stepwise-token">#{I18n.t(:stepwise_step_label)} #{ii+1}. </span>
+                <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_suggested_reading.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for EOC suggested reading
+    #
+    module BakeSuggestedReading
+      def self.v1(book:)
+        book.chapters.each do |chapter|
+          suggested_reading = chapter.search('section.suggested-reading').cut
+
+          chapter.append(child:
+            <<~HTML
+              <div class="os-eoc os-suggested-reading-container" data-type="composite-page" data-uuid-key=".suggested-reading">
+                <h2 data-type="document-title">
+                  <span class="os-text">#{I18n.t(:eoc_suggested_reading)}</span>
+                </h2>
+                #{suggested_reading.paste}
+              </div>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeToc
-
       def self.v1(book:)
         li_tags = book.body.element_children.map do |element|
           case element
+          when UnitElement
+            li_for_unit(element)
           when ChapterElement
             li_for_chapter(element)
           when PageElement, CompositePageElement
@@ -14,25 +17,41 @@ module Kitchen
           end
         end.compact.join("\n")
 
-        book.first!("nav").replace_children(with: <<~HTML
-            <h1 class="os-toc-title">Contents</h1>
-            <ol>
-              #{li_tags}
-            </ol>
-          HTML
+        book.first!('nav').replace_children(with: <<~HTML
+          <h1 class="os-toc-title">#{I18n.t(:toc_title)}</h1>
+          <ol>
+            #{li_tags}
+          </ol>
+        HTML
         )
       end
 
+      def self.li_for_unit(unit)
+        chapters = unit.element_children.only(ChapterElement)
+        <<~HTML
+          <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit">
+            <a href="#">
+              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span> #{unit.count_in(:book)}</span>
+              <span class="os-divider"> </span>
+              <span data-type itemprop class="os-text"> #{unit.title.children} </span>
+            </a>
+            <ol class="os-unit">
+              #{chapters.map { |chapter| li_for_chapter(chapter) }.join("\n")}
+            </ol>
+          </li>
+        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}
+              #{chapter.title.children}
             </a>
             <ol class="os-chapter">
-              #{pages.map{|page| li_for_page(page)}.join("\n")}
+              #{pages.map { |page| li_for_page(page) }.join("\n")}
             </ol>
           </li>
         HTML
@@ -44,12 +63,12 @@ module Kitchen
         <<~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-number"><span class="os-part-text">#{I18n.t(: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>
+              <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")}
+              #{pages.map { |page| li_for_page(page) }.join("\n")}
             </ol>
           </li>
         HTML
@@ -57,21 +76,22 @@ module Kitchen
 
       def self.li_for_page(page)
         li_class =
-          if page.is_a?(PageElement)
+          case page
+          when PageElement
             if page.has_ancestor?(:chapter)
-              "os-toc-chapter-page"
+              'os-toc-chapter-page'
             elsif page.is_appendix?
-              "os-toc-appendix"
+              'os-toc-appendix'
             elsif page.is_preface?
-              "os-toc-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)
+          when CompositePageElement
             if page.is_index?
-              "os-toc-index"
+              'os-toc-index'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
-              "os-toc-chapter-composite-page"
+              'os-toc-chapter-composite-page'
             else
               raise "do not know what TOC class to use for page with classes #{page.classes}"
             end
@@ -82,8 +102,8 @@ module Kitchen
         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")
+        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)
@@ -97,7 +117,6 @@ module Kitchen
           </li>
         HTML
       end
-
     end
   end
 end