openstax_kitchen 14.0.0 → 17.1.0

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

@@ -44,8 +44,9 @@ module Kitchen
           table.target_label(label_text: 'table', custom_content: number, cases: cases)
 
           if table.top_titled?
+            klass = table.text_heavy? ? 'text-heavy-top-titled' : 'top-titled'
             custom_table = CustomBody.new(table: table,
-                                          klass: 'top-titled',
+                                          klass: klass,
                                           fake_title_class: 'os-table-title',
                                           fake_title: table.title,
                                           to_trash: table.title_row)
@@ -65,6 +66,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/v1.rb

@@ -12,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|

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/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/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_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
@@ -219,6 +223,22 @@ module Kitchen
       self[:'data-type']
     end
 
+    # Returns the element's href
+    #
+    # @return [String]
+    #
+    def href
+      self[:href]
+    end
+
+    # Sets the element's href
+    #
+    # @param value [String] the new value for the href
+    #
+    def href=(value)
+      self[:href] = value
+    end
+
     # A way to set values and chain them
     #
     # @param property [String, Symbol] the name of the property to set
@@ -502,12 +522,12 @@ 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
-      prev = raw.previous
+      prev = raw.previous_element
       return prev if prev.nil?
 
       Element.new(
@@ -754,7 +774,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, :sections
+                   :search_with, :sections, :injected_exercises
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -336,6 +336,24 @@ module Kitchen
                css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through injected exercises 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 injected_exercises(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(InjectedExerciseElementEnumerator,
+               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

data/lib/kitchen/injected_exercise_element.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class InjectedExerciseElement < ElementBase
+
+    # Creates a new +InjectedQuestionElement+
+    #
+    # @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: InjectedExerciseElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :injected_exercise
+    end
+
+    # Returns the exercise context element.
+    # @return [Element]
+    #
+    def exercise_context
+      first("div[data-type='exercise-context']")
+    end
+
+    # Returns the exercise question element.
+    # @return [Element]
+    #
+    def exercise_question
+      first("div[data-type='exercise-question']")
+    end
+
+  end
+end

data/lib/kitchen/injected_exercise_element_enumerator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for example elements
+  #
+  class InjectedExerciseElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:injected_exercise),
+        sub_element_class: InjectedExerciseElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/injected_question_element.rb

@@ -55,6 +55,13 @@ module Kitchen
       first("div[data-type='question-solution']")
     end
 
+    # Returns the exercise context element.
+    # @return [Element]
+    #
+    def exercise_context_in_question
+      first("div[data-type='exercise-context']")
+    end
+
     # Returns the answer correctness given an alphabet
     #
     # @return [Array]

data/lib/kitchen/patches/i18n.rb

@@ -4,6 +4,10 @@ require 'twitter_cldr'
 
 # rubocop:disable Style/Documentation
 module I18n
+  def self.character_to_group(character)
+    I18n.locale == :pl ? character : I18n.transliterate(character)
+  end
+
   def self.sort_strings(first, second)
     string_sorter.compare(first, second)
   end

data/lib/kitchen/patches/integer.rb

@@ -3,7 +3,22 @@
 # Monkey patches for +Integer+
 #
 class Integer
-  ROMAN_NUMERALS = %w[0 i ii iii iv v vi vii viii ix x xi xii xiii xiv xv xvi xvii xviii xix xx].freeze
+
+  @roman_numerals = {
+    100 => 'c',
+    90 => 'xc',
+    50 => 'l',
+    40 => 'xl',
+    10 => 'x',
+    9 => 'ix',
+    5 => 'v',
+    4 => 'iv',
+    1 => 'i'
+  }
+
+  class << self
+    attr_accessor :roman_numerals
+  end
 
   # Formats as different types of integers, including roman numerals.
   #
@@ -14,11 +29,25 @@ class Integer
     when :arabic
       to_s
     when :roman
-      raise 'Unknown conversion to Roman numerals' if self >= ROMAN_NUMERALS.size
+      raise 'Unknown conversion to Roman numerals' if self > self.class.roman_numerals.keys.first
 
-      ROMAN_NUMERALS[self]
+      to_roman
     else
       raise 'Unknown integer format'
     end
   end
+
+  def to_roman
+    return 0 if zero?
+
+    roman = ''
+    integer = self
+    self.class.roman_numerals.each do |number, letter|
+      until integer < number
+        roman += letter
+        integer -= number
+      end
+    end
+    roman
+  end
 end

data/lib/kitchen/patches/nokogiri.rb

@@ -67,11 +67,12 @@ module Nokogiri
         self[:class]&.split || []
       end
 
-      def previous
-        prev = previous_element
-        return nil if prev.nil?
+      def preceded_by_text?
+        prev = previous_sibling
+        while !prev.nil? && prev.blank? do prev = prev.previous_sibling end
+        return false if prev.nil?
 
-        prev.text? ? prev.previous : prev
+        prev.text?
       end
 
       def self.selector_to_css_nodes(selector)

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/selectors/base.rb

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

data/lib/kitchen/selectors/standard_1.rb

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

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '14.0.0'
+  VERSION = '17.1.0'
 end

data/lib/locales/en.yml

@@ -28,6 +28,7 @@ en:
   iframe_link_text: Click to view content
   handbook_outline_title: Outline
   context_lead_text: 'Refer to '
+  lo_label_text: 'LO '
   eoc:
     glossary: Key Terms
     key-equations: Key Equations
@@ -45,3 +46,18 @@ en:
     reference: References
   index:
     main: Index
+  annotation_icons:
+    linguistic-icon:
+      title: Language lens icon
+    culture-icon:
+      title: Culture lens icon
+    dreaming-icon:
+      title: Generating and capturing ideas icon
+    visual-icon:
+      title: Visual learning style icon
+    speech-icon:
+      title: Voice to text icon
+    auditory-icon:
+      title: Auditory learning style icon
+    kinesthetic-icon:
+      title: Kinesthetic learning style icon

data/lib/locales/es.yml

@@ -21,17 +21,22 @@ es:
   eoc_exercises_title: Ejercicios
   eoc_composite_metadata_title: Revisión Del Capítulo
   eoc_solutions_title: Soluciones
-  eoc_key_concepts: Conceptos Clave
   eoc_suggested_reading: Sugerencias Para Estudios Adicionales
   eob_index_symbols_group: Símbolos
   review_exercises: Ejercicios De Repaso
   section_exercises: ! 'Sección %{number} Ejercicios'
+  iframe_link_text: Haga Clic Para Ver El Contenido
+  handbook_outline_title: Esquema
+  context_lead_text: 'Referirse a '
   eoc:
     glossary: Términos Clave
     key-equations: Ecuaciones Clave
     summary: Resumen
     further-research: Investigación Adicional
+    key-concepts: Conceptos Clave
     references: Referencias
+    solutions: Soluciones
+    section-exercises: ! 'Sección %{number} Ejercicios'
   folio:
     preface: Prefacio
     access_for_free: Acceso gratis en openstax.org