openstax_kitchen 12.1.0 → 15.0.0

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

@@ -62,6 +62,12 @@ module Kitchen
           elsif table.column_header?
             custom_table = CustomBody.new(table: table, klass: 'column-header')
             custom_table.modify_body(has_fake_title: false)
+          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_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:
@@ -44,10 +39,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_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/bake_unnumbered_tables.rb

@@ -9,6 +9,7 @@ module Kitchen
           table.remove_attribute('summary')
           table.parent.add_class('os-unstyled-container') if table.unstyled?
           table.parent.add_class('os-column-header-container') if table.column_header?
+          table.parent.add_class('os-top-titled-container') if table.top_titled?
         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

@@ -427,23 +427,6 @@ module Kitchen
       )
     end
 
-    # Searches for elements handled by a list of enumerator classes.  All element that
-    # matches one of those enumerator classes are iterated over.
-    #
-    # @param enumerator_classes [Array<ElementEnumeratorBase>]
-    # @return [TypeCastingElementEnumerator]
-    #
-    def search_with(*enumerator_classes)
-      block_error_if(block_given?)
-      raise 'must supply at least one enumerator class' if enumerator_classes.empty?
-
-      factory = enumerator_classes[0].factory
-      enumerator_classes[1..-1].each do |enumerator_class|
-        factory = factory.or_with(enumerator_class.factory)
-      end
-      factory.build_within(self)
-    end
-
     # Removes the element from its parent and places it on the specified clipboard
     #
     # @param to [Symbol, String, Clipboard, nil] the name of the clipboard (or a Clipboard
@@ -770,7 +753,8 @@ module Kitchen
     #   Returns a pages enumerator
     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
+                   :composite_pages, :composite_chapters, :solutions, :injected_questions,
+                   :search_with, :sections
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -318,6 +318,24 @@ module Kitchen
                css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through sections within the scope of this enumerator
+    #
+    # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
+    #   a "$" in this argument will be replaced with the default selector for the element being
+    #   iterated over.
+    # @param only [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will only be included in the
+    #   search results if the method or callable returns true
+    # @param except [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will not be included in the
+    #   search results if the method or callable returns false
+    #
+    def sections(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(SectionElementEnumerator,
+               css_or_xpath: css_or_xpath, only: only, except: except)
+    end
+
     # Returns an enumerator that iterates within the scope of this enumerator
     #
     # @param css_or_xpath [String] additional selectors to further narrow the element iterated over
@@ -327,6 +345,23 @@ module Kitchen
       chain_to(ElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Searches for elements handled by a list of enumerator classes.  All element that
+    # matches one of those enumerator classes are iterated over.
+    #
+    # @param enumerator_classes [Array<ElementEnumeratorBase>]
+    # @return [TypeCastingElementEnumerator]
+    #
+    def search_with(*enumerator_classes)
+      block_error_if(block_given?)
+      raise 'must supply at least one enumerator class' if enumerator_classes.empty?
+
+      factory = enumerator_classes[0].factory
+      enumerator_classes[1..-1].each do |enumerator_class|
+        factory = factory.or_with(enumerator_class.factory)
+      end
+      factory.build_within(self)
+    end
+
     # Returns an enumerator that iterates through elements within the scope of this enumerator
     #
     # @param enumerator_class [ElementEnumeratorBase] the enumerator to use for the iteration

data/lib/kitchen/figure_element.rb

@@ -47,16 +47,24 @@ module Kitchen
       parent.name == 'figure'
     end
 
+    # Returns true if the figure is unnumbered
+    #
+    # @return [Boolean]
+    #
+
+    def unnumbered?
+      has_class?('unnumbered')
+    end
+
     # Returns true unless the figure is a subfigure or has the 'unnumbered' class,
     # unless the figure has both the 'unnumbered' and the 'splash' classes.
     #
     # @return [Boolean]
-    #
-    def figure_to_bake?
-      return false if subfigure? || (has_class?('unnumbered') && !has_class?('splash') && !caption)
+
+    def figure_to_number?
+      return false if subfigure? || unnumbered?
 
       true
     end
-
   end
 end

data/lib/kitchen/note_element.rb

@@ -33,7 +33,9 @@ module Kitchen
       # 1. it is the note body's first child
       # 2. it is the first child's first child and the first child is a paragraph
       first_child = first_note_body_child
-      first_grandchild = first_child&.element_children&.[](0) if first_child.name == 'p'
+      return unless first_child
+
+      first_grandchild = get_first_grandchild_for_title(first_child)
 
       if first_child.data_type == 'title'
         first_child
@@ -47,6 +49,10 @@ module Kitchen
       note_body ? note_body.element_children[0] : element_children[0]
     end
 
+    def get_first_grandchild_for_title(first_child)
+      first_child&.element_children&.[](0) if first_child.name == 'p'
+    end
+
     # Returns true if the note's title is autogenerated
     #
     # @return [Boolean]

data/lib/kitchen/patches/renderable.rb

@@ -29,7 +29,7 @@ class Object
       def render(file:)
         file = File.absolute_path(file, renderable_base_dir)
         template = File.open(file, 'rb', &:read)
-        ERB.new(template).result(binding)
+        ERB.new(template, trim_mode: '-').result(binding)
       end
     end
   end

data/lib/kitchen/section_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class SectionElement < ElementBase
+
+    # Creates a new +SectionElement+
+    #
+    # @param node [Nokogiri::XML::Node] the node this element wraps
+    # @param document [Document] this element's document
+    #
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: SectionElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :section
+    end
+
+  end
+end

data/lib/kitchen/section_element_enumerator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for table elements
+  #
+  class SectionElementEnumerator < ElementEnumeratorBase
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:section),
+        sub_element_class: SectionElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/selectors/base.rb

@@ -62,6 +62,9 @@ module Kitchen
       # Selector for an injected question
       # @return [String]
       attr_accessor :injected_question
+      # Selector for a section
+      # @return [String]
+      attr_accessor :section
 
       # Override specific selectors
       #

data/lib/kitchen/selectors/standard_1.rb

@@ -29,6 +29,7 @@ module Kitchen
         self.solution                   = "div[data-type='solution'], " \
                                           "div[data-type='question-solution']"
         self.injected_question          = "div[data-type='exercise-question']"
+        self.section                    = 'section'
       end
 
     end

data/lib/kitchen/table_element.rb

@@ -97,6 +97,14 @@ module Kitchen
       has_class?('column-header')
     end
 
+    # Returns true if the table is text heavy
+    #
+    # @return [Boolean]
+    #
+    def text_heavy?
+      has_class?('text-heavy')
+    end
+
     # Returns an element for the table caption, if present
     #
     # @return [Element, nil]