openstax_kitchen 1.0.0 → 4.0.0

data/lib/kitchen/directions/bake_checkpoint.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeCheckpoint
+      def self.v1(checkpoint:, number:)
+        checkpoint.wrap_children(class: 'os-note-body')
+
+        checkpoint.prepend(child:
+          <<~HTML
+            <div class="os-title">
+              <span class="os-title-label">#{I18n.t(:checkpoint)} </span>
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+            </div>
+          HTML
+        )
+
+        exercise = checkpoint.exercises.first!
+        exercise.search("[data-type='commentary']").trash
+
+        problem = exercise.problem
+        problem.wrap_children(class: 'os-problem-container')
+
+        solution = exercise.solution
+        exercise.add_class('unnumbered') unless solution.present?
+        return unless solution.present?
+
+        solution.id = "#{exercise.id}-solution"
+        exercise.add_class('os-hasSolution')
+
+        solution.replace_children(with:
+          <<~HTML
+            <span class="os-divider"> </span>
+            <a class="os-number" href="##{exercise.id}">#{number}</a>
+            <div class="os-solution-container">#{solution.children}</div>
+          HTML
+        )
+
+        exercise.add_class('unnumbered')
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_composite_chapters.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeCompositeChapters
+      def self.v1(book:)
+        book.search("[data-type='composite-chapter']").each do |chapter|
+          chapter.first("[data-type='document-title']").id =
+            "composite-chapter-#{chapter.count_in(:book)}"
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_composite_pages.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 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_equations.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeEquations
+      def self.v1(book:, number_decorator: :none)
+        book.chapters.search('[data-type="equation"]:not(.unnumbered)').each do |eq|
+          chapter = eq.ancestor(:chapter)
+          number = "#{chapter.count_in(:book)}.#{eq.count_in(:chapter)}"
+
+          # Store label information
+          equation_label = "#{I18n.t(:equation)} #{number}"
+          book.pantry(name: :link_text).store equation_label, label: eq.id
+
+          decorated_number =
+            case number_decorator
+            when :none
+              number
+            when :parentheses
+              "(#{number})"
+            else
+              raise "Unsupported number_decorator '#{number_decorator}'"
+            end
+
+          # Bake the equation
+          eq.append(child:
+            <<~HTML
+              <div class="os-equation-number">
+                <span class="os-number">#{decorated_number}</span>
+              </div>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_example.rb

@@ -1,15 +1,10 @@
+# frozen_string_literal: true
+
 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.wrap_children(class: 'body')
 
         example.prepend(child:
           <<~HTML
@@ -21,11 +16,44 @@ module Kitchen
           HTML
         )
 
-        example.document.pantry(name: :link_text).store "#{I18n.t(:example_label)} #{number}", label: example.id
+        example.document
+               .pantry(name: :link_text)
+               .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
-        example.titles.each {|title| title.name = "h4"}
-      end
+        example.titles.each do |title|
+          next if title.parent.has_class?('os-caption-container')
 
+          title.name = 'h4'
+        end
+
+        example.exercises.each do |exercise|
+          if (problem = exercise.problem)
+            problem.titles.each { |title| title.name = 'h4' }
+            problem.wrap_children(class: 'os-problem-container')
+          end
+
+          if (solution = exercise.solution)
+            solution.replace_children(with:
+              <<~HTML
+                <h4 data-type="solution-title">
+                  <span class="os-title-label">#{I18n.t(:solution)} </span>
+                </h4>
+                <div class="os-solution-container">#{solution.children}</div>
+              HTML
+            )
+          end
+
+          exercise.add_class('unnumbered')
+
+          commentary = exercise.first('[data-type="commentary"]')
+          next unless commentary.present?
+
+          commentary_title = commentary.titles.first
+          commentary_title.name = 'h4'
+          commentary_title['data-type'] = 'commentary-title'
+          commentary_title.wrap_children('span', class: 'os-title-label')
+        end
+      end
     end
   end
 end

data/lib/kitchen/directions/bake_figure.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 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.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
 
-        figure.document.pantry(name: :link_text).store "Figure #{number}", label: figure.id
+        figure.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
+        title = figure.title&.cut
 
         caption = figure.caption&.cut
         figure.append(sibling:
           <<~HTML
             <div class="os-caption-container">
-              <span class="os-title-label">Figure </span>
+              <span class="os-title-label">#{I18n.t(:figure)} </span>
               <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
+              #{"<span class=\"os-title\" data-type=\"title\" id=\"#{title.id}\">#{title.children}</span>" if title}
               <span class="os-divider"> </span>
-              #{'<span class="os-caption">' + caption.children.to_s + '</span>'if caption}
+              #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
             </div>
           HTML
         )

data/lib/kitchen/directions/bake_first_elements.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFirstElements
+      def self.v1(within:, selectors:)
+        selectors.each do |selector|
+          within.search("#{selector}:first-child").each do |problem|
+            problem.add_class('first-element')
+            problem.parent.add_class('has-first-element')
+          end
+        end
+      end
+    end
+  end
+end

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitchen::Directions::BakeFootnotes
   class V1
 
@@ -6,7 +8,8 @@ module Kitchen::Directions::BakeFootnotes
       # appendices, etc) or within chapters. Tackle each case separately
 
       book.body.element_children.only(Kitchen::PageElement,
-                                      Kitchen::CompositePageElement).each do |page|
+                                      Kitchen::CompositePageElement,
+                                      Kitchen::CompositeChapterElement).each do |page|
         bake_footnotes_within(page)
       end
 
@@ -26,12 +29,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_free_response/free_response.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eoc os-free-response-container" data-type="composite-page" data-uuid-key=".free-response">
+  <<%= @title_tag %> data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_free_response) %></span>
+  </<%= @title_tag %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_free_response) %></h1>
+    <%= @metadata_elements.paste %>
+  </div>
+    <%= @free_response_clipboard.paste %>
+</div>

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFreeResponse
+      def self.v1(chapter:, metadata_source:, append_to: nil)
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeFreeResponse
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to:)
+      @metadata_elements = metadata_source.children_to_keep.copy
+
+      @free_response_clipboard = Kitchen::Clipboard.new
+      chapter.non_introduction_pages.each do |page|
+        free_response_questions = page.free_response
+        next if free_response_questions.none?
+
+        free_response_questions.search('h3').trash
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+        free_response_questions.each do |free_response_question|
+          free_response_question.prepend(child: title)
+          free_response_question.cut(to: @free_response_clipboard)
+        end
+      end
+
+      append_to_element = append_to || chapter
+      @title_tag = append_to ? 'h3' : 'h2'
+
+      append_to_element.append(child: render(file: 'free_response.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_further_research.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for further research
+    #
+    module BakeFurtherResearch
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix)
+      end
+
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, uuid_prefix: '.')
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = 'further-research'
+          @title = I18n.t(:eoc_further_research_title)
+          @uuid_prefix = uuid_prefix
+
+          further_researches = Clipboard.new
+
+          chapter.non_introduction_pages.each do |page|
+            further_research = page.first('.further-research')
+            further_research.first("[data-type='title']")&.trash # get rid of old title if exists
+            further_research_title = page.title.copy
+            further_research_title.name = 'h3'
+            further_research_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="">#{further_research_title.children}</span>
+            HTML
+            )
+
+            further_research.prepend(child:
+              <<~HTML
+                <a href="##{page.title.id}">
+                  #{further_research_title.paste}
+                </a>
+              HTML
+            )
+            further_research.cut(to: further_researches)
+          end
+
+          return if further_researches.none?
+
+          @content = further_researches.paste
+
+          @in_composite_chapter = false
+
+          chapter.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
+      end
+    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
@@ -37,8 +44,12 @@ module Kitchen::Directions::BakeIndex
         @term_text = @term_text.uncapitalize
       end
 
+      def capitalize_term_text!
+        @term_text = @term_text.capitalize
+      end
+
       def <=>(other)
-        self.sortable <=> other.sortable
+        sortable <=> other.sortable
       end
 
       protected
@@ -64,7 +75,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
@@ -76,6 +88,11 @@ module Kitchen::Directions::BakeIndex
           different_caps_item = @items_by_term_text[term.text.uncapitalize]
           different_caps_item&.uncapitalize_term_text!
 
+          unless different_caps_item
+            different_caps_item = @items_by_term_text[term.text.capitalize]
+            different_caps_item&.capitalize_term_text!
+          end
+
           (different_caps_item || IndexItem.new(term_text: term.text)).tap do |item|
             @items.add(item)
           end
@@ -107,31 +124,42 @@ 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|
-        # Markup the term
         page = term_element.ancestor(:page)
         term_element.id = "auto_#{page.id}_term#{term_element.count_in(:book)}"
+        page_title = page.title.text
+        add_term_to_index(term_element, page_title)
+      end
 
-        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
+      book.chapters.composite_pages.terms.each do |term_element|
+        page = term_element.ancestor(:composite_page)
+        chapter = term_element.ancestor(:chapter)
+        term_element.id = "auto_composite_page_term#{term_element.count_in(:book)}"
+        chapter_number = chapter.count_in(:book)
+        page_title = "#{chapter_number} #{page.title.text.strip}".strip
+        add_term_to_index(term_element, page_title)
+      end
+
+      book.first('body').append(child: render(file: 'v1.xhtml.erb'))
+    end
 
-        # Add it to our index object
-        @index.add_term(Term.new(
+    def add_term_to_index(term_element, page_title)
+      group_by = term_element.text.strip[0]
+      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/,'')
-        ))
-      end
-
-      book.first("body").append(child: render(file: 'v1.xhtml.erb'))
+          page_title: page_title.gsub(/\n/, '')
+        )
+      )
     end
 
   end