openstax_kitchen 2.0.0 → 4.1.0

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -0,0 +1,30 @@
+# 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
+
+      def self.v2(chapter:)
+        chapter.abstracts.each do |abstract|
+          abstract.prepend(child: "<h3 data-type='title'>#{I18n.t(:learning_objectives)}</h3>")
+          ul = abstract.first!('ul')
+          ul.add_class('os-abstract')
+          ul.search('li').each_with_index do |li, index|
+            li.replace_children(with:
+              <<~HTML
+                <span class="os-abstract-token">#{chapter.count_in(:book)}.#{abstract.count_in(:chapter)}.#{index + 1}</span>
+                <span class="os-abstract-content">#{li.children}</span>
+              HTML
+            )
+          end
+        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_references/main.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for EOB references
+    #
+    module BakeReferences
+      def self.v1(book:, metadata_source:)
+        V1.new.bake(
+          book: book,
+          metadata_source: metadata_source
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V1
+    renderable
+
+    def bake(book:, metadata_source:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'reference'
+      @uuid_prefix = '.'
+      @title = I18n.t(:references)
+
+      book.chapters.each do |chapter|
+        chapter.search('[data-type="cite"]').each do |link|
+          link.prepend(child:
+            <<~HTML
+              <sup class="os-citation-number">#{link.count_in(:chapter)}</sup>
+            HTML
+          )
+        end
+
+        chapter.references.each do |reference|
+          reference.prepend(child:
+            <<~HTML.chomp
+              <span class="os-reference-number">#{reference.count_in(:chapter)}. </span>
+            HTML
+          )
+        end
+
+        chapter_references = chapter.pages.references.cut
+        chapter_title_no_num = chapter.title.search('.os-text')
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-chapter-area">
+              <h2 data-type="document-title">#{chapter_title_no_num}</h2>
+              #{chapter_references.paste}
+            </div>
+          HTML
+        )
+      end
+      chapter_area_references = book.chapters.search('.os-chapter-area').cut
+      @content = chapter_area_references.paste
+      book.body.append(child: render(file:
+        '../../templates/eob_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_stepwise.rb

@@ -1,27 +1,23 @@
+# 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|
-            li.replace_children(with:
-              <<~HTML
-                <span class="os-stepwise-content">#{li.children}</span>
-              HTML
-            )
+          ol.search('li').each_with_index do |li, ii|
+            li.wrap_children('span', class: 'os-stepwise-content')
             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,31 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for EOC suggested reading
+    #
+    module BakeSuggestedReading
+      def self.v1(book:)
+        metadata_elements = book.metadata.children_to_keep.copy
+        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>
+                <div data-type="metadata" style="display: none;">
+                  <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_suggested_reading)}</h1>
+                  #{metadata_elements.paste}
+                </div>
+                #{suggested_reading.paste}
+              </div>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeTheorem
+  class V1
+    def bake(theorem:, number:)
+      theorem['use-subtitle'] = true
+      new_subtitle = theorem.title.cut
+
+      theorem.wrap_children(class: 'os-note-body')
+      note_body = theorem.first('.os-note-body')
+
+      note_body.prepend(sibling:
+        <<~HTML
+          <div class="os-title">
+            <span class="os-title-label">#{I18n.t(:theorem)} </span>
+            <span class="os-number">#{number}</span>
+            <span class="os-divider"> </span>
+          </div>
+        HTML
+      )
+
+      new_subtitle.name = 'h4'
+      new_subtitle.add_class('os-subtitle')
+      new_subtitle.children.wrap('<span class="os-subtitle-label">')
+      note_body.prepend(child: new_subtitle.paste)
+    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_text}</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
@@ -40,16 +59,22 @@ module Kitchen
 
       def self.li_for_chapter(chapter)
         pages = chapter.element_children.only(PageElement, CompositePageElement)
+        inner_composite_chapters = chapter.element_children.only(CompositeChapterElement)
 
         <<~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")}
+              #{
+                inner_composite_chapters.map do |composite_chapter|
+                  li_for_composite_chapter(composite_chapter)
+                end.join("\n")
+              }
             </ol>
           </li>
         HTML
@@ -57,21 +82,24 @@ 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.is_reference?
+              'os-toc-reference'
             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 +110,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 +125,6 @@ module Kitchen
           </li>
         HTML
       end
-
     end
   end
 end

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

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeUnitTitle
+  class V1
+    def bake(book:)
+      book.units.each do |unit|
+        compose_unit_title(unit: unit)
+      end
+    end
+
+    def compose_unit_title(unit:)
+      heading = unit.title
+      heading.replace_children(with:
+        <<~HTML
+          <span class="os-part-text">#{I18n.t(:unit)} </span>
+          <span class="os-number">#{unit.count_in(:book)}</span>
+          <span class="os-divider"> </span>
+          <span data-type="" itemprop="" class="os-text">#{heading.text}</span>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_unnumbered_tables.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 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")
+        book.tables('$.unnumbered').each do |table|
+          table.wrap(%(<div class="os-table">))
+          table.remove_attribute('summary')
+          table.parent.add_class('os-unstyled-container') if table.unstyled?
+          table.parent.add_class('os-column-header-container') if table.column_header?
         end
       end
-
     end
   end
 end

data/lib/kitchen/directions/book_answer_key_container/eob_solutions_container.xhtml.erb

@@ -0,0 +1,9 @@
+<div class="os-eob os-solutions-container" data-type="composite-chapter" data-uuid-key=".solutions">
+  <h1 data-type="document-title">
+    <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>
+    <%= @metadata.paste %>
+  </div>
+</div>