openstax_kitchen 2.0.0 → 4.1.0

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

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.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_non_introduction_pages.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNonIntroductionPages
+      def self.v1(chapter:)
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+
+          page.search("div[data-type='description']").each(&:trash)
+          page.add_class('chapter-content-module')
+
+          title = page.title
+          title.name = 'h2'
+          title.replace_children(with:
+            <<~HTML
+              <span class="os-number">#{number}</span>
+              <span class="os-divider"> </span>
+              <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAutotitledNotes
+      def self.v1(book:, classes:)
+        book.notes.each do |note|
+          next unless (note.classes & classes).any?
+
+          bake_note(note: note)
+        end
+      end
+
+      def self.bake_note(note:)
+        note.wrap_children(class: 'os-note-body')
+
+        BakeNoteSubtitle.v1(note: note)
+
+        note.prepend(child:
+          <<~HTML
+            <h3 class="os-title" data-type="title">
+              <span class="os-title-label">#{note.autogenerated_title}</span>
+            </h3>
+          HTML
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteSubtitle
+      def self.v1(note:)
+        title = note.title&.cut
+
+        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')
+        note.first!('.os-note-body').prepend(child: title.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNumberedNotes
+      def self.v1(book:, classes:)
+        classes.each do |klass|
+          book.chapters.notes("$.#{klass}").each do |note|
+            bake_note(note: note)
+            note.exercises.each do |exercise|
+              bake_note_exercise(note: note, exercise: exercise)
+            end
+          end
+        end
+      end
+
+      def self.bake_note(note:)
+        note.wrap_children(class: 'os-note-body')
+
+        chapter_count = note.ancestor(:chapter).count_in(:book)
+        note_count = note.count_in(:chapter)
+        note.prepend(child:
+          <<~HTML
+            <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>
+            </h3>
+          HTML
+        )
+
+        return unless note['use-subtitle']
+
+        BakeNoteSubtitle.v1(note: note)
+      end
+
+      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)
+        return unless exercise.solution
+
+        # bake solution in place
+        BakeNumberedExercise.bake_solution_v1(
+          exercise: exercise, number: note.first('.os-number').text, divider: ' ')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeUnclassifiedNotes
+      def self.v1(book:)
+        book.notes.each do |note|
+          next unless note.classes.empty?
+
+          bake_note(note: note)
+        end
+      end
+
+      def self.bake_note(note:)
+        note.wrap_children(class: 'os-note-body')
+
+        title = note.title&.cut
+        return unless title
+
+        note.prepend(child:
+          <<~HTML
+            <h3 class="os-title" data-type="title">
+              <span class="os-title-label" data-type="" id="#{title[:id]}">#{title.children}</span>
+            </h3>
+          HTML
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNumberedExercise
+      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
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedExercise
+  class V1
+    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?
+        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:
+        <<~HTML
+          #{problem_number}
+          <span class='os-divider'>. </span>
+          <div class="os-problem-container">#{problem.children}</div>
+        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/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)
+      def self.v1(table:, number:, always_caption: false)
+        V1.new.bake(table: table, number: number, always_caption: always_caption)
       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">))
+    def bake(table:, number:, always_caption: false)
+      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')
         table.prepend(sibling:
           <<~HTML
             <div class="os-table-title">#{table.title}</div>
@@ -16,31 +19,47 @@ 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 = ''
+      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
+      elsif always_caption
+        new_caption = <<~HTML
+          \n<span class="os-caption"></span>
+        HTML
       end
 
       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>#{caption_title}
+            <span class="os-divider"> </span>#{new_caption}
+          </div>
+        HTML
+      )
     end
 
   end