openstax_kitchen 3.0.0 → 3.1.0

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteSubtitle
+      def self.v1(note:)
+        title = note.title&.cut
+
+        return unless title
+
+        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.rb → bake_notes/bake_notes.rb}

@@ -4,14 +4,12 @@ module Kitchen
   module Directions
     module BakeNotes
       def self.v1(book:)
-        book.notes.each do |note|
+        warn 'WARNING! deprecated direction used: BakeNotes'
+
+        book.notes('$:not(.checkpoint):not(.theorem)').each do |note|
           title = note.title&.cut
 
-          note.replace_children(with:
-            <<~HTML
-              <div class="os-note-body">#{note.children}</div>
-            HTML
-          )
+          note.wrap_children(class: 'os-note-body')
 
           if title
             if note.indicates_autogenerated_title?
@@ -25,20 +23,12 @@ module Kitchen
 
               title.name = 'h4'
               title.add_class('os-subtitle')
-              title.replace_children(with:
-                <<~HTML
-                  <span class="os-subtitle-label">#{title.children}</span>
-                HTML
-              )
+              title.wrap_children('span', class: 'os-subtitle-label')
               note.first!('.os-note-body').prepend(child: title.raw)
             else
               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.wrap_children('span', data_type: '', id: title.id, class: 'os-title-label')
               title.remove_attribute('id')
               note.prepend(child: title.raw)
             end

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

@@ -0,0 +1,63 @@
+# 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)
+            bake_note_exercise(note: note)
+          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
+            <div 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>
+          HTML
+        )
+
+        return unless note['use-subtitle']
+
+        BakeNoteSubtitle.v1(note: note)
+      end
+
+      def self.bake_note_exercise(note:)
+        exercise = note.exercises.first
+        return unless 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
+
+        # 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
+        )
+      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,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNumberedExercise
+      def self.v1(exercise:, number:)
+        V1.new.bake(exercise: exercise, number: number)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedExercise
+  class V1
+    def bake(exercise:, number:)
+      problem = exercise.problem
+      solution = exercise.solution
+
+      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
+        )
+      end
+
+      problem.replace_children(with:
+        <<~HTML
+          #{problem_number}
+          <span class='os-divider'>. </span>
+          <div class="os-problem-container">#{problem.children}</div>
+        HTML
+      )
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 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

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

@@ -3,7 +3,7 @@
 module Kitchen::Directions::BakeNumberedTable
   class V1
 
-    def bake(table:, number:)
+    def bake(table:, number:, always_caption: false)
       table.wrap(%(<div class="os-table">))
 
       table_label = "#{I18n.t(:table_label)} #{number}"
@@ -22,14 +22,28 @@ 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_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
@@ -41,7 +55,7 @@ module Kitchen::Directions::BakeNumberedTable
           <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>#{caption_title}
             <span class="os-divider"> </span>#{new_caption}
           </div>
         HTML

data/lib/kitchen/directions/bake_page_abstracts.rb

@@ -9,6 +9,22 @@ module Kitchen
           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.text}</span>
+              HTML
+            )
+          end
+        end
+      end
     end
   end
 end

data/lib/kitchen/directions/bake_problem_first_elements.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeProblemFirstElements
+      def self.v1(within:, selectors:)
+        selectors.each do |selector|
+          within.search(".os-problem-container > #{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_stepwise.rb

@@ -9,11 +9,7 @@ module Kitchen
           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
-            )
+            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>

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

@@ -59,6 +59,7 @@ 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="">
@@ -69,6 +70,11 @@ module Kitchen
             </a>
             <ol class="os-chapter">
               #{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

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module EocSectionTitleLinkSnippet
+      def self.v1(page:)
+        chapter = page.ancestor(:chapter)
+        <<~HTML
+          <a href="##{page.title.id}">
+            <h3 data-type="document-title" id="#{page.title.copied_id}">
+              <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="">#{page.title.text}</span>
+            </h3>
+          </a>
+        HTML
+      end
+    end
+  end
+end

data/lib/kitchen/element_base.rb

@@ -423,6 +423,12 @@ module Kitchen
       temp_copy.to_s
     end
 
+    # Copy the element's id
+    def copied_id
+      document.record_id_copied(id)
+      document.modified_id_to_paste(id)
+    end
+
     # Delete the element
     #
     def trash
@@ -491,6 +497,35 @@ module Kitchen
       self
     end
 
+    # Wraps the element's children in a new element.  Yields the new wrapper element
+    # to a block, if provided.
+    #
+    # @param name [String] the wrapper's tag name, defaults to 'div'.
+    # @param attributes [Hash] the wrapper's attributes.  XML attributes often use hyphens
+    #   (e.g. 'data-type') which are hard to put into symbols.  Therefore underscores in
+    #   keys passed to this method will be converted to hyphens.  If you really want an
+    #   underscore you can use a double underscore.
+    # @yieldparam [Element] the wrapper Element
+    # @return [Element] self
+    #
+    def wrap_children(name='div', attributes={})
+      if name.is_a?(Hash)
+        attributes = name
+        name = 'div'
+      end
+
+      node.children = node.document.create_element(name) do |new_node|
+        # For some reason passing attributes to create_element doesn't work, so doing here
+        attributes.each do |k, v|
+          new_node[k.to_s.gsub(/([^_])_([^_])/, '\1-\2').gsub('__', '_')] = v
+        end
+        new_node.children = children.to_s
+        yield Element.new(node: new_node, document: document, short_type: nil) if block_given?
+      end.to_s
+
+      self
+    end
+
     # TODO: methods like replace_children that take string, either forbid or handle Element/Node args
 
     # Get the content of children matching the provided selector.  Mostly
@@ -604,10 +639,14 @@ module Kitchen
       end
     end
 
+    def last_element
+      node.last_element_child
+    end
+
     # @!method pages
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
-                   :metadatas, :units
+                   :metadatas, :non_introduction_pages, :units, :titles, :exercises, :composite_pages
 
     # Returns this element as an enumerator (over only one element, itself)
     #