openstax_kitchen 3.1.0 → 5.0.0

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/v1.rb

@@ -27,13 +27,6 @@ module Kitchen::Directions::BakeIndex
       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)
@@ -44,13 +37,13 @@ module Kitchen::Directions::BakeIndex
         @term_text = @term_text.uncapitalize
       end
 
-      def <=>(other)
-        sortable <=> other.sortable
+      def capitalize_term_text!
+        @term_text = @term_text.capitalize
       end
 
-      protected
-
-      attr_reader :sortable
+      def <=>(other)
+        I18n.sort_strings(term_text, other.term_text)
+      end
     end
 
     class IndexSection
@@ -84,6 +77,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
@@ -119,27 +117,39 @@ module Kitchen::Directions::BakeIndex
       @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]
-        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/, '')
-          )
-        )
+      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
 
+    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.gsub(/\n/, '')
+        )
+      )
+    end
+
   end
 end

data/lib/kitchen/directions/bake_link_placeholders.rb

@@ -10,7 +10,7 @@ module Kitchen
           next unless anchor.text == '[link]'
 
           id = anchor[:href][1..-1]
-          replacement = book.document.pantry(name: :link_text).get(id)
+          replacement = book.pantry(name: :link_text).get(id)
           if replacement.present?
             anchor.replace_children(with: replacement)
           else

data/lib/kitchen/directions/bake_notes/bake_note_subtitle.rb

@@ -8,6 +8,10 @@ module Kitchen
 
         return unless title
 
+        # Store label information
+        note_label = title.children
+        note.pantry(name: :link_text).store note_label, label: note.id
+
         title.name = 'h4'
         title.add_class('os-subtitle')
         title.wrap_children('span', class: 'os-subtitle-label')

data/lib/kitchen/directions/bake_notes/bake_numbered_notes.rb

@@ -7,7 +7,9 @@ module Kitchen
         classes.each do |klass|
           book.chapters.notes("$.#{klass}").each do |note|
             bake_note(note: note)
-            bake_note_exercise(note: note)
+            note.exercises.each do |exercise|
+              bake_note_exercise(note: note, exercise: exercise)
+            end
           end
         end
       end
@@ -19,11 +21,11 @@ module Kitchen
         note_count = note.count_in(:chapter)
         note.prepend(child:
           <<~HTML
-            <div class="os-title">
+            <h3 class="os-title">
               <span class="os-title-label">#{note.autogenerated_title}</span>
               <span class="os-number">#{chapter_count}.#{note_count}</span>
               <span class="os-divider"> </span>
-            </div>
+            </h3>
           HTML
         )
 
@@ -32,31 +34,17 @@ module Kitchen
         BakeNoteSubtitle.v1(note: note)
       end
 
-      def self.bake_note_exercise(note:)
-        exercise = note.exercises.first
-        return unless exercise
-
+      def self.bake_note_exercise(note:, exercise:)
         exercise.add_class('unnumbered')
         # bake problem
         exercise.problem.wrap_children('div', class: 'os-problem-container')
         exercise.problem.first('strong')&.trash
         exercise.search('[data-type="commentary"]').each(&:trash)
-        solution = exercise.solution
-        return unless solution
+        return unless exercise.solution
 
         # bake solution in place
-        exercise.add_class('os-hasSolution')
-        solution[:id] = "#{exercise[:id]}-solution"
-        solution_number = note.first('.os-number').text
-        solution.replace_children(with:
-          <<~HTML
-            <a class="os-number" href="##{exercise[:id]}">#{solution_number}</a>
-            <span class="os-divider"> </span>
-            <div class="os-solution-container">
-              #{solution.children}
-            </div>
-          HTML
-        )
+        BakeNumberedExercise.bake_solution_v1(
+          exercise: exercise, number: note.first('.os-number').text, divider: ' ')
       end
     end
   end

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

@@ -3,8 +3,12 @@
 module Kitchen
   module Directions
     module BakeNumberedExercise
-      def self.v1(exercise:, number:)
-        V1.new.bake(exercise: exercise, number: number)
+      def self.v1(exercise:, number:, suppress_solution: false)
+        V1.new.bake(exercise: exercise, number: number, suppress_solution: suppress_solution)
+      end
+
+      def self.bake_solution_v1(exercise:, number:, divider: '. ')
+        V1.new.bake_solution(exercise: exercise, number: number, divider: divider)
       end
     end
   end

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

@@ -2,24 +2,23 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:)
+    def bake(exercise:, number:, suppress_solution: false)
       problem = exercise.problem
       solution = exercise.solution
 
+      exercise.pantry(name: :link_text).store(
+        "#{I18n.t(:exercise_label)} #{exercise.ancestor(:chapter).count_in(:book)}.#{number}",
+        label: exercise.id
+      )
       problem_number = "<span class='os-number'>#{number}</span>"
 
       if solution.present?
-        solution.id = "#{exercise.id}-solution"
-        exercise.add_class('os-hasSolution')
-        problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
-
-        solution.replace_children(with:
-          <<~HTML
-            <a class='os-number' href='##{exercise.id}'>#{number}</a>
-            <span class='os-divider'>. </span>
-            <div class="os-solution-container">#{solution.children}</div>
-          HTML
-        )
+        if suppress_solution
+          solution.trash
+        else
+          problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
+          bake_solution(exercise: exercise, number: number)
+        end
       end
 
       problem.replace_children(with:
@@ -30,5 +29,19 @@ module Kitchen::Directions::BakeNumberedExercise
         HTML
       )
     end
+
+    def bake_solution(exercise:, number:, divider: '. ')
+      solution = exercise.solution
+      solution.id = "#{exercise.id}-solution"
+      exercise.add_class('os-hasSolution')
+
+      solution.replace_children(with:
+        <<~HTML
+          <a class='os-number' href='##{exercise.id}'>#{number}</a>
+          <span class='os-divider'>#{divider}</span>
+          <div class="os-solution-container">#{solution.children}</div>
+        HTML
+      )
+    end
   end
 end

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

@@ -7,7 +7,7 @@ module Kitchen::Directions::BakeNumberedTable
       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
+      table.pantry(name: :link_text).store table_label, label: table.id
 
       if table.top_titled?
         table.parent.add_class('os-top-titled-container')
@@ -22,21 +22,16 @@ module Kitchen::Directions::BakeNumberedTable
       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 = ''
       caption_title = ''
 
       if (title = table.first("span[data-type='title']")&.cut)
-        new_summary += title.text
         caption_title = <<~HTML
           \n<span class="os-title" data-type="title">#{title.children}</span>
         HTML
       end
 
-      new_summary += ' '
-
       if (caption = table.caption&.cut)
-        new_summary += caption.text
         new_caption = <<~HTML
           \n<span class="os-caption">#{caption.children}</span>
         HTML
@@ -46,8 +41,6 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       end
 
-      table[:summary] = new_summary
-
       return if table.unnumbered?
 
       table.append(sibling:

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -19,7 +19,7 @@ module Kitchen
             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.text}</span>
+                <span class="os-abstract-content">#{li.children}</span>
               HTML
             )
           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