openstax_kitchen 12.2.0 → 16.0.0

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

@@ -17,37 +17,6 @@ module Kitchen
       def self.v3(book:, classes:, suppress_solution: true)
         V3.new.bake(book: book, classes: classes, suppress_solution: suppress_solution)
       end
-
-      # Used by V1, V2, V3
-      def self.bake_note_exercise(note:, exercise:, divider: ' ', suppress_solution: false)
-        exercise.add_class('unnumbered')
-        number = note.first('.os-number').text.gsub(/#/, '')
-
-        # bake problem
-        exercise.problem.wrap_children('div', class: 'os-problem-container')
-        exercise.search('[data-type="commentary"]').each(&:trash)
-        return unless exercise.solution
-
-        # bake solution in place
-        if suppress_solution
-          exercise.add_class('os-hasSolution')
-          exercise.solution.trash
-        else
-          BakeNumberedExercise.bake_solution_v1(
-            exercise: exercise,
-            number: number,
-            divider: divider
-          )
-        end
-      end
-
-      def self.bake_note_injected_question(note:, question:)
-        question.add_class('unnumbered')
-        number = note.first('.os-number').text.gsub(/#/, '')
-        Kitchen::Directions::BakeInjectedExerciseQuestion.v1(
-          question: question, number: number, only_number_solution: true
-        )
-      end
     end
   end
 end

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

@@ -8,10 +8,10 @@ module Kitchen::Directions
           book.chapters.pages.notes("$.#{klass}").each do |note|
             bake_note(note: note, cases: cases)
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise)
+              BakeNoteExercise.v1(note: note, exercise: exercise)
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
           end
         end

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

@@ -17,10 +17,10 @@ module Kitchen::Directions
               HTML
             )
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise, divider: '. ')
+              BakeNoteExercise.v1(note: note, exercise: exercise, divider: '. ')
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
           end
         end

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

@@ -25,12 +25,12 @@ module Kitchen::Directions
 
             note.title&.trash
             note.exercises.each do |exercise|
-              BakeNumberedNotes.bake_note_exercise(
+              BakeNoteExercise.v1(
                 note: note, exercise: exercise, divider: '. ', suppress_solution: suppress_solution
               )
             end
             note.injected_questions.each do |question|
-              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+              BakeNoteInjectedQuestion.v1(note: note, question: question)
             end
 
             note.search("div[data-type='solution']").each&.trash if suppress_solution

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

@@ -3,15 +3,15 @@
 module Kitchen
   module Directions
     module BakeUnclassifiedNotes
-      def self.v1(book:)
+      def self.v1(book:, bake_exercises: false)
         book.notes.each do |note|
           next unless note.classes.empty?
 
-          bake_note(note: note)
+          bake_note(note: note, bake_exercises: bake_exercises)
         end
       end
 
-      def self.bake_note(note:)
+      def self.bake_note(note:, bake_exercises:)
         note.wrap_children(class: 'os-note-body')
 
         title = note.title&.cut
@@ -24,6 +24,8 @@ module Kitchen
             </h3>
           HTML
         )
+
+        BakeNoteExercise.v2(note: note) if bake_exercises
       end
     end
   end

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

@@ -3,14 +3,19 @@
 module Kitchen
   module Directions
     module BakeNumberedExercise
+      # rubocop:disable Metrics/ParameterLists
+      # :/
       def self.v1(exercise:, number:, suppress_solution_if: false,
-                  note_suppressed_solutions: false, cases: false)
+                  note_suppressed_solutions: false, cases: false, solution_stays_put: false)
         V1.new.bake(exercise: exercise, number: number, suppress_solution_if: suppress_solution_if,
-                    note_suppressed_solutions: note_suppressed_solutions, cases: cases)
+                    note_suppressed_solutions: note_suppressed_solutions, cases: cases,
+                    solution_stays_put: solution_stays_put)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def self.bake_solution_v1(exercise:, number:, divider: '. ')
-        V1.new.bake_solution(exercise: exercise, number: number, divider: divider)
+        V1.new.bake_solution(exercise: exercise, number: number, divider: divider,
+                             solution_stays_put: false)
       end
     end
   end

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

@@ -2,13 +2,25 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:, suppress_solution_if: false,
-             note_suppressed_solutions: false, cases: false)
+    # rubocop:disable Metrics/ParameterLists
+    def bake(exercise:, number:, suppress_solution_if:,
+             note_suppressed_solutions:, cases:, solution_stays_put:)
       problem = exercise.problem
       solution = exercise.solution
 
+      in_appendix = exercise.has_ancestor?(:page) && exercise.ancestor(:page).has_class?('appendix')
+
       # Store label information
-      label_number = "#{exercise.ancestor(:chapter).count_in(:book)}.#{number}"
+      if in_appendix
+        label_number = number
+        title_label = "<span class=\"os-title-label\">#{I18n.t('exercise')}</span>"
+        problem_divider = ''
+      else
+        label_number = "#{exercise.ancestor(:chapter).count_in(:book)}.#{number}"
+        title_label = ''
+        problem_divider = "<span class='os-divider'>. </span>"
+      end
+
       exercise.target_label(label_text: 'exercise', custom_content: label_number, cases: cases)
 
       problem_number = "<span class='os-number'>#{number}</span>"
@@ -26,25 +38,54 @@ module Kitchen::Directions::BakeNumberedExercise
           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)
+          problem_number = \
+            if solution_stays_put || in_appendix
+              "<span class='os-number'>#{number}</span>"
+            else
+              "<a class='os-number' href='##{exercise.id}-solution'>#{number}</a>"
+            end
+          bake_solution(
+            exercise: exercise,
+            number: number,
+            solution_stays_put: solution_stays_put,
+            in_appendix: in_appendix
+          )
         end
       end
 
       problem.replace_children(with:
         <<~HTML
+          #{title_label}
           #{problem_number}
-          <span class='os-divider'>. </span>
+          #{problem_divider}
           <div class="os-problem-container">#{problem.children}</div>
         HTML
       )
     end
+    # rubocop:enable Metrics/ParameterLists
 
-    def bake_solution(exercise:, number:, divider: '. ')
+    def bake_solution(exercise:, number:, solution_stays_put:, divider: '. ', in_appendix: false)
       solution = exercise.solution
+      if solution_stays_put
+        solution.wrap_children(class: 'os-solution-container')
+        solution.prepend(child:
+          <<~HTML
+            <h4 class="solution-title" data-type="title">
+              <span class="os-text">#{I18n.t(:solution)}</span>
+            </h4>
+          HTML
+        )
+        return
+      end
+
       solution.id = "#{exercise.id}-solution"
       exercise.add_class('os-hasSolution')
 
+      if in_appendix
+        solution.wrap_children(class: 'os-solution-container')
+        return
+      end
+
       solution.replace_children(with:
         <<~HTML
           <a class='os-number' href='##{exercise.id}'>#{number}</a>

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

@@ -65,6 +65,9 @@ module Kitchen
           elsif table.text_heavy?
             custom_table = CustomBody.new(table: table, klass: 'text-heavy')
             custom_table.modify_body(has_fake_title: false)
+          elsif table.unstyled?
+            custom_table = CustomBody.new(table: table, klass: 'unstyled')
+            custom_table.modify_body(has_fake_title: false)
           end
         end
       end

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

@@ -9,7 +9,8 @@ module Kitchen::Directions::BakeNumberedTable
       Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number, cases: cases)
 
       caption = ''
-      if table&.caption&.first("span[data-type='title']") && !table.top_captioned?
+      if (table&.caption&.first("span[data-type='title']") || table&.caption) \
+        && !table.top_captioned?
         caption_el = table.caption
         caption_el.add_class('os-caption')
         caption_el.name = 'span'

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

@@ -6,18 +6,15 @@ module Kitchen
     #
     module BakeReferences
       def self.v1(book:, metadata_source:, numbered_title: false)
-        V1.new.bake(
-          book: book,
-          metadata_source: metadata_source,
-          numbered_title: numbered_title
-        )
+        V1.new.bake(book: book, metadata_source: metadata_source, numbered_title: numbered_title)
       end
 
       def self.v2(book:, metadata_source:)
-        V2.new.bake(
-          book: book,
-          metadata_source: metadata_source
-        )
+        V2.new.bake(book: book, metadata_source: metadata_source)
+      end
+
+      def self.v3(book:, metadata_source:)
+        V3.new.bake(book: book, metadata_source: metadata_source)
       end
     end
   end

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

@@ -5,11 +5,6 @@ module Kitchen::Directions::BakeReferences
     renderable
 
     def bake(book:, metadata_source:, numbered_title:)
-      @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:
@@ -17,6 +12,19 @@ module Kitchen::Directions::BakeReferences
               <sup class="os-citation-number">#{link.count_in(:chapter)}</sup>
             HTML
           )
+
+          next if link.nil?
+
+          link_sibling = link.previous unless link.preceded_by_text?
+          next if link_sibling.nil?
+
+          next unless link_sibling&.raw&.attr('data-type') == 'cite'
+
+          link.prepend(sibling:
+            <<~HTML
+              <span class="os-reference-link-separator">, </span>
+            HTML
+            )
         end
 
         chapter.references.each do |reference|
@@ -44,10 +52,16 @@ module Kitchen::Directions::BakeReferences
           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'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'reference',
+        uuid_key: '.reference',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -2,14 +2,7 @@
 
 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
@@ -26,10 +19,16 @@ module Kitchen::Directions::BakeReferences
           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'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V3
+    def bake(book:, metadata_source:)
+      return unless book.references.any?
+
+      book.chapters.pages.each do |page|
+        page.references.each do |reference|
+          reference.titles.trash
+          reference.prepend(child:
+            Kitchen::Directions::EocSectionTitleLinkSnippet.v1(
+              page: page,
+              title_tag: 'h2',
+              wrapper: nil
+            )
+          )
+        end
+      end
+
+      chapter_area_references = book.chapters.references.cut
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_screenreader_spans.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeScreenreaderSpans
+      # Add text for accessibility.
+      # Additional screenreader spans can be added below.
+      def self.v1(book:)
+        book.search('u[data-effect="double-underline"]').each do |element|
+          element.add_previous_sibling(
+            '<span data-screenreader-only="true">double underline</span>'
+          )
+        end
+        book.search('u[data-effect="underline"]').each do |element|
+          element.add_previous_sibling(
+            '<span data-screenreader-only="true">underline</span>'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_unnumbered_exercise.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeUnnumberedExercise
+      def self.v1(exercise:)
+        exercise.problem.wrap_children(class: 'os-problem-container')
+        return unless exercise.solution
+
+        exercise.solutions.each do |solution|
+          solution.wrap_children(class: 'os-solution-container')
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_unnumbered_figure.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeUnnumberedFigure
+      def self.v1(book:)
+        book.figures(only: :unnumbered?).each do |figure|
+          next unless figure.caption || figure.title
+
+          figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+          title = figure.title&.cut
+          caption = figure.caption&.cut
+          figure.append(sibling:
+            <<~HTML
+              <div class="os-caption-container">
+                #{"<span class=\"os-title\" data-type=\"title\" id=\"#{title.id}\">#{title.children}</span>" if title}
+                #{'<span class="os-divider"> </span>' if title && caption}
+                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
+              </div>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<div class="os-eob os-<%= @solutions_or_solution %>-container" data-type="<%= @composite_element %>" data-uuid-key=".<%= @uuid_key %>">
+  <<%= @main_title_tag %> data-type="document-title">
+    <span class="os-text"><%= @title %></span>
+  </<%= @main_title_tag %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

@@ -4,10 +4,14 @@ module Kitchen::Directions::BookAnswerKeyContainer
   class V1
     renderable
 
-    def bake(book:, solutions_plural: true)
+    def bake(book:, solutions_plural:)
+      @composite_element = 'composite-chapter'
       @metadata = book.metadata.children_to_keep.copy
       @solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
-      book.body.append(child: render(file: 'eob_answer_key_outer_container.xhtml.erb'))
+      @title = I18n.t(:answer_key_title)
+      @main_title_tag = 'h1'
+      @uuid_key = @solutions_or_solution
+      book.body.append(child: render(file: 'eob_answer_key_container.xhtml.erb'))
       book.body.first("div.os-eob.os-#{@solutions_or_solution}-container")
     end
   end

data/lib/kitchen/directions/{eoc_composite_page_container → composite_page_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module EocCompositePageContainer
+    module CompositePageContainer
       # Creates a wrapper for the given content & appends it to the given element
       #
       # @param container_key [String] Appended to 'eoc.' to form the I18n key for the container title; also used as part of a class on the container.

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::CompositePageContainer
+  class V1
+    renderable
+
+    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
+      @in_composite_chapter = append_to.is?(:composite_chapter)
+      @is_eoc = append_to.is?(:chapter) || @in_composite_chapter
+      @section = @is_eoc ? 'eoc' : 'eob'
+      @title = I18n.t(:"#{@section}.#{container_key}")
+      @uuid_key = uuid_key
+      @container_class_type = container_key
+      @metadata = metadata_source.children_to_keep.copy
+      @content = content
+      @main_title_tag = 'h1'
+
+      if @in_composite_chapter
+        @main_title_tag = 'h3'
+      elsif @is_eoc
+        @main_title_tag = 'h2'
+      end
+
+      append_to.append(child: render(file:
+        '../../templates/composite_page_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/default_strategy_for_answer_key_solutions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::DefaultStrategyForAnswerKeySolutions
+  def self.v1(strategy_options:, chapter:, append_to:)
+    V1.new(
+      strategy_options
+    ).bake(
+      chapter: chapter,
+      append_to: append_to
+    )
+  end
+
+  class V1
+    def bake(chapter:, append_to:)
+      bake_section(chapter: chapter, append_to: append_to)
+    end
+
+    protected
+
+    def bake_section(chapter:, append_to:)
+      @selectors.each do |selector|
+        chapter.search("#{selector} div[data-type='solution']").each do |solution|
+          append_to.append(child: solution.cut.to_s) unless @condition.present? && !@condition
+        end
+      end
+    end
+
+    # This method helps to obtain more strategy-specific params through
+    # "strategy_options: {blah1: 1, blah2: 2}"
+    def initialize(strategy_options)
+      @selectors = strategy_options[:selectors] || (raise 'missing selectors for strategy')
+      @condition = strategy_options[:condition]
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module Kitchen::Directions::MoveCustomSectionToEocContainer
           section_clipboard.paste
         end
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: container_key,
         uuid_key: uuid_key,
         metadata_source: metadata_source,

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::AnswerKeyInnerContainer
+  def self.v1(chapter:, metadata_source:, append_to:, solutions_plural: true)
+    V1.new.bake(
+      chapter: chapter,
+      metadata_source: metadata_source,
+      append_to: append_to,
+      solutions_plural: solutions_plural
+    )
+  end
+
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, append_to:, solutions_plural:)
+      @solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
+      @uuid_key = "#{@solutions_or_solution}#{chapter.count_in(:book)}"
+      @metadata = metadata_source.children_to_keep.copy
+      @composite_element = 'composite-page'
+      @title = "#{I18n.t(:chapter)} #{chapter.count_in(:book)}"
+      @main_title_tag = 'h2'
+
+      append_to.append(
+        child: render(file: '../book_answer_key_container/eob_answer_key_container.xhtml.erb')
+      ).first("div[data-uuid-key='.#{@uuid_key}']")
+    end
+  end
+end

data/lib/kitchen/element_base.rb

@@ -82,9 +82,13 @@ module Kitchen
     #   Set the inner HTML for this element
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#inner_html=-instance_method Nokogiri::XML::Node#inner_html=
     #   @return Object
+    # @!method preceded_by_text
+    #   Returns true if the immediately preceding sibling is text
+    #   @return Boolean
     def_delegators :@node, :name=, :name, :[], :[]=, :add_class, :remove_class,
                    :text, :wrap, :children, :to_html, :remove_attribute,
-                   :key?, :classes, :path, :inner_html=
+                   :key?, :classes, :path, :inner_html=, :add_previous_sibling,
+                   :preceded_by_text?
 
     # @!method config
     #   Get the config for this element's document
@@ -502,8 +506,8 @@ module Kitchen
       Element.new(node: raw.parent, document: document, short_type: "parent(#{short_type})")
     end
 
-    # returns previous element
-    # skips double indentations that the nokigiri sometimes picks up
+    # returns previous element sibling
+    # (only returns elements or nil)
     # nil if there's no previous sibling
     #
     def previous
@@ -754,7 +758,7 @@ module Kitchen
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
                    :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
                    :composite_pages, :composite_chapters, :solutions, :injected_questions,
-                   :search_with
+                   :search_with, :sections, :injected_exercises
 
     # Returns this element as an enumerator (over only one element, itself)
     #