openstax_kitchen 4.1.1 → 8.0.0

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

@@ -3,8 +3,9 @@
 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)
+      def self.v1(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
+        V1.new.bake(exercise: exercise, number: number, suppress_solution_if: suppress_solution_if,
+                    note_suppressed_solutions: note_suppressed_solutions)
       end
 
       def self.bake_solution_v1(exercise:, number:, divider: '. ')

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

@@ -2,7 +2,7 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:, suppress_solution: false)
+    def bake(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
       problem = exercise.problem
       solution = exercise.solution
 
@@ -12,9 +12,18 @@ module Kitchen::Directions::BakeNumberedExercise
       )
       problem_number = "<span class='os-number'>#{number}</span>"
 
+      suppress_solution =
+        case suppress_solution_if
+        when Symbol
+          number.send(suppress_solution_if)
+        else
+          suppress_solution_if
+        end
+
       if solution.present?
         if suppress_solution
           solution.trash
+          exercise.add_class('os-hasSolution-trashed') if note_suppressed_solutions
         else
           problem_number = "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
           bake_solution(exercise: exercise, number: number)

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for table body
+    #
+    module BakeTableBody
+      def self.v1(table:, number:)
+        table.remove_attribute('summary')
+        table.wrap(%(<div class="os-table">))
+
+        table_label = "#{I18n.t(:table_label)} #{number}"
+        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>
+            HTML
+          )
+          table.title_row.trash
+        end
+
+        table.parent.add_class('os-column-header-container') if table.column_header?
+      end
+    end
+  end
+end

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

@@ -6,6 +6,10 @@ module Kitchen
       def self.v1(table:, number:, always_caption: false)
         V1.new.bake(table: table, number: number, always_caption: always_caption)
       end
+
+      def self.v2(table:, number:)
+        V2.new.bake(table: table, number: number)
+      end
     end
   end
 end

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

@@ -4,39 +4,19 @@ module Kitchen::Directions::BakeNumberedTable
   class V1
 
     def bake(table:, number:, always_caption: false)
-      table.wrap(%(<div class="os-table">))
-
-      table_label = "#{I18n.t(:table_label)} #{number}"
-      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>
-          HTML
-        )
-        table.title_row.trash
-      end
-
-      table.parent.add_class('os-column-header-container') if table.column_header?
+      Kitchen::Directions::BakeTableBody.v1(table: table, number: number)
 
       # 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 +26,6 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       end
 
-      table[:summary] = new_summary
-
       return if table.unnumbered?
 
       table.append(sibling:
@@ -61,6 +39,5 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       )
     end
-
   end
 end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeNumberedTable
+  # Difference from v1: only in the caption
+  # V2 caption titles are nested within an .os-caption span
+  class V2
+
+    def bake(table:, number:)
+      Kitchen::Directions::BakeTableBody.v1(table: table, number: number)
+
+      caption = ''
+      if table&.caption&.first("span[data-type='title']")
+        caption_el = table.caption
+        caption_el.add_class('os-caption')
+        caption_el.name = 'span'
+        caption = caption_el.cut
+      end
+
+      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}
+          </div>
+        HTML
+      )
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakePreface
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, title_element: 'h1')
+        V1.new.bake(book: book, title_element: title_element)
       end
     end
   end

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

@@ -2,15 +2,16 @@
 
 module Kitchen::Directions::BakePreface
   class V1
-    def bake(book:)
+    def bake(book:, title_element:)
       book.pages('$.preface').each do |page|
+        page.search('div[data-type="description"], div[data-type="abstract"]').each(&:trash)
         page.titles.each do |title|
           title.replace_children(with:
             <<~HTML
               <span data-type="" itemprop="" class="os-text">#{title.text}</span>
             HTML
           )
-          title.name = 'h1'
+          title.name = title_element
         end
       end
     end

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

@@ -11,6 +11,13 @@ module Kitchen
           metadata_source: metadata_source
         )
       end
+
+      def self.v2(book:, metadata_source:)
+        V2.new.bake(
+          book: book,
+          metadata_source: metadata_source
+        )
+      end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V2
+    renderable
+
+    def bake(book:, metadata_source:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'references'
+      @uuid_prefix = '.'
+      @title = I18n.t(:references)
+
+      book.chapters.each do |chapter|
+
+        chapter.references.search('h3').trash
+
+        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_toc.rb

@@ -96,8 +96,10 @@ module Kitchen
           when CompositePageElement
             if page.is_index?
               'os-toc-index'
-            elsif page.is_reference?
+            elsif page.is_citation_reference?
               'os-toc-reference'
+            elsif page.is_section_reference?
+              'os-toc-references'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else

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

@@ -0,0 +1,9 @@
+<div class="os-eob os-<%= @solutions_or_solution %>-container" data-type="composite-chapter" data-uuid-key=".<%= @solutions_or_solution %>">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:answer_key_title) %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:answer_key_title) %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BookAnswerKeyContainer
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, solutions_plural: true)
+        V1.new.bake(book: book, solutions_plural: solutions_plural)
       end
     end
   end

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

@@ -4,10 +4,11 @@ module Kitchen::Directions::BookAnswerKeyContainer
   class V1
     renderable
 
-    def bake(book:)
+    def bake(book:, solutions_plural: true)
       @metadata = book.metadata.children_to_keep.copy
-      book.body.append(child: render(file: 'eob_solutions_container.xhtml.erb'))
-      book.body.first('div.os-eob.os-solutions-container')
+      @solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
+      book.body.append(child: render(file: 'eob_answer_key_outer_container.xhtml.erb'))
+      book.body.first("div.os-eob.os-#{@solutions_or_solution}-container")
     end
   end
 end

data/lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb

@@ -1,9 +1,9 @@
-<div class="os-eoc os-chapter-review-container" data-type="composite-chapter" data-uuid-key=".chapter-review">
+<div class="os-eoc os-<%= @klass %>-container" data-type="composite-chapter" data-uuid-key=".<%= @klass %>">
   <h2 data-type="document-title">
-    <span class="os-text"><%= I18n.t(:eoc_chapter_review) %></span>
+    <span class="os-text"><%= @title %></span>
   </h2>
   <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_chapter_review) %></h1>
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
     <%= @metadata.paste %>
   </div>
 </div>

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module ChapterReviewContainer
-      def self.v1(chapter:, metadata_source:)
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source)
+      def self.v1(chapter:, metadata_source:, klass: 'chapter-review')
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, klass: klass)
       end
     end
   end

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

@@ -4,10 +4,12 @@ module Kitchen::Directions::ChapterReviewContainer
   class V1
     renderable
 
-    def bake(chapter:, metadata_source:)
+    def bake(chapter:, metadata_source:, klass: 'chapter-review')
       @metadata = metadata_source.children_to_keep.copy
+      @klass = klass
+      @title = I18n.t(:"eoc.#{klass}")
       chapter.append(child: render(file: 'chapter_review.xhtml.erb'))
-      chapter.first('div.os-eoc.os-chapter-review-container')
+      chapter.element_children[-1]
     end
   end
 end

data/lib/kitchen/directions/eoc_section_title_link_snippet.rb

@@ -15,6 +15,19 @@ module Kitchen
           </a>
         HTML
       end
+
+      def self.v2(page:)
+        chapter = page.ancestor(:chapter)
+        <<~HTML
+          <div>
+            <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>
+          </div>
+        HTML
+      end
     end
   end
 end

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

@@ -22,6 +22,16 @@ module Kitchen
           uuid_prefix: uuid_prefix
         )
       end
+
+      def self.v3(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
+        V3.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          klass: klass,
+          uuid_prefix: uuid_prefix
+        )
+      end
     end
   end
 end

data/lib/kitchen/directions/move_exercises_to_eoc/v3.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveExercisesToEOC
+  # The difference from v1 is the presence of a section title
+  # and from v2 the lack of additional "os-section-area" and os-#{@klass} wrappers
+  class V3
+    renderable
+
+    def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
+      @klass = klass
+      @metadata = metadata_source.children_to_keep.copy
+      @title = I18n.t(:"eoc.#{klass}")
+      @uuid_prefix = uuid_prefix
+
+      exercise_clipboard = Kitchen::Clipboard.new
+
+      chapter.non_introduction_pages.each do |page|
+        sections = page.search("section.#{@klass}")
+
+        sections.each do |exercise_section|
+          exercise_section.first("[data-type='title']")&.trash
+
+          section_title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+
+          exercise_section.exercises.each do |exercise|
+            exercise.document.pantry(name: :link_text).store(
+              "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
+              label: exercise.id
+            )
+          end
+
+          # Configure section title
+          exercise_section.prepend(child: section_title)
+          exercise_section.cut(to: exercise_clipboard)
+        end
+      end
+
+      return if exercise_clipboard.none?
+
+      @content = exercise_clipboard.paste
+
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+  end
+end

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

@@ -3,11 +3,15 @@
 module Kitchen
   module Directions
     module MoveSolutionsToAnswerKey
-      def self.v1(chapter:, metadata_source:, strategy:, append_to:)
+      def self.v1(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
-          strategy: strategy, append_to: append_to)
+          strategy: strategy,
+          append_to: append_to,
+          strategy_options: strategy_options,
+          solutions_plural: solutions_plural
+        )
       end
     end
   end