openstax_kitchen 12.2.0 → 16.0.0

data/lib/kitchen/element_enumerator_base.rb

@@ -318,6 +318,42 @@ 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 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/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/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/nokogiri.rb

@@ -74,6 +74,14 @@ module Nokogiri
         prev.text? ? prev.previous : prev
       end
 
+      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?
+      end
+
       def self.selector_to_css_nodes(selector)
         # No need to parse the same selector more than once.
         @parsed_selectors ||= {}

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,12 @@ module Kitchen
       # Selector for an injected question
       # @return [String]
       attr_accessor :injected_question
+      # 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

@@ -29,6 +29,8 @@ module Kitchen
         self.solution                   = "div[data-type='solution'], " \
                                           "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/templates/composite_page_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-<%= @section%> os-<%=@container_class_type%>-container" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
+  <<%= @main_title_tag %> data-type="<%= @in_composite_chapter ? 'title' : '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>
+  <%= @content %>
+</div>

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '12.2.0'
+  VERSION = '16.0.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
@@ -40,5 +41,8 @@ en:
   folio:
     preface: Preface
     access_for_free: Access for free at openstax.org
+  eob:
+    references: References
+    reference: References
   index:
     main: Index

data/lib/locales/es.yml

@@ -21,19 +21,27 @@ 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
+  eob:
+    references: Referencias
+    reference: Referencias
   index:
     main: Índice

data/lib/locales/pl.yml

@@ -67,6 +67,9 @@ pl:
     key-equations: Najważniejsze wzory
     summary: Podsumowanie
     references: Bibliografia
+  eob:
+    references: Bibliografia
+    reference: Bibliografia
   index:
     name: Skorowidz nazwisk
     term: Skorowidz rzeczowy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 16.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -244,11 +244,15 @@ files:
 - lib/kitchen/debug/print_recipe_error.rb
 - lib/kitchen/directions/.rubocop.yml
 - lib/kitchen/directions/bake_accessibility_fixes.rb
+- lib/kitchen/directions/bake_all_chapter_solutions_types.rb
+- lib/kitchen/directions/bake_all_numbered_exercise_types.rb
 - lib/kitchen/directions/bake_annotation_classes/main.rb
 - lib/kitchen/directions/bake_annotation_classes/v1.rb
 - lib/kitchen/directions/bake_appendix.rb
 - lib/kitchen/directions/bake_autotitled_exercise/main.rb
 - lib/kitchen/directions/bake_autotitled_exercise/v1.rb
+- lib/kitchen/directions/bake_autotitled_exercise/v2.rb
+- lib/kitchen/directions/bake_autotitled_exercise/v3.rb
 - lib/kitchen/directions/bake_chapter_glossary/main.rb
 - lib/kitchen/directions/bake_chapter_glossary/v1.rb
 - lib/kitchen/directions/bake_chapter_introductions/bake_chapter_objectives.rb
@@ -293,16 +297,19 @@ files:
 - lib/kitchen/directions/bake_index/main.rb
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
-- lib/kitchen/directions/bake_injected_exercise.rb
 - lib/kitchen/directions/bake_injected_exercise/add_injected_exercise_id.rb
+- lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise.rb
 - lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise_question.rb
 - lib/kitchen/directions/bake_inline_lists.rb
 - lib/kitchen/directions/bake_learning_objectives.rb
 - lib/kitchen/directions/bake_link_placeholders.rb
 - lib/kitchen/directions/bake_lists_with_para.rb
+- lib/kitchen/directions/bake_lo_link_labels.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
 - lib/kitchen/directions/bake_non_introduction_pages.rb
 - lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
+- lib/kitchen/directions/bake_notes/bake_note_exercise.rb
+- lib/kitchen/directions/bake_notes/bake_note_injected_question.rb
 - lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/main.rb
 - lib/kitchen/directions/bake_notes/bake_numbered_notes/v1.rb
@@ -320,6 +327,8 @@ files:
 - lib/kitchen/directions/bake_references/main.rb
 - lib/kitchen/directions/bake_references/v1.rb
 - lib/kitchen/directions/bake_references/v2.rb
+- lib/kitchen/directions/bake_references/v3.rb
+- lib/kitchen/directions/bake_screenreader_spans.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_toc.rb
@@ -327,15 +336,18 @@ files:
 - lib/kitchen/directions/bake_unit_page_title/v1.rb
 - lib/kitchen/directions/bake_unit_title/main.rb
 - lib/kitchen/directions/bake_unit_title/v1.rb
+- lib/kitchen/directions/bake_unnumbered_exercise.rb
+- lib/kitchen/directions/bake_unnumbered_figure.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
-- lib/kitchen/directions/book_answer_key_container/eob_answer_key_outer_container.xhtml.erb
+- lib/kitchen/directions/book_answer_key_container/eob_answer_key_container.xhtml.erb
 - lib/kitchen/directions/book_answer_key_container/main.rb
 - lib/kitchen/directions/book_answer_key_container/v1.rb
 - lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb
 - lib/kitchen/directions/chapter_review_container/main.rb
 - lib/kitchen/directions/chapter_review_container/v1.rb
-- lib/kitchen/directions/eoc_composite_page_container/main.rb
-- lib/kitchen/directions/eoc_composite_page_container/v1.rb
+- lib/kitchen/directions/composite_page_container/main.rb
+- lib/kitchen/directions/composite_page_container/v1.rb
+- lib/kitchen/directions/default_strategy_for_answer_key_solutions.rb
 - lib/kitchen/directions/eoc_section_title_link_snippet.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/main.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/v1.rb
@@ -343,16 +355,10 @@ files:
 - lib/kitchen/directions/move_exercises_to_eoc/v1.rb
 - lib/kitchen/directions/move_exercises_to_eoc/v2.rb
 - lib/kitchen/directions/move_exercises_to_eoc/v3.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/main.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/answer_key_inner_container.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_exercise_section.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_numbered_note.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/solution_area_snippet.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/strategies/contemporary_math.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/strategies/default.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/strategies/precalculus.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/strategies/uphysics.rb
-- lib/kitchen/directions/move_solutions_to_answer_key/v1.rb
 - lib/kitchen/directions/move_title_text_into_span.rb
 - lib/kitchen/document.rb
 - lib/kitchen/element.rb
@@ -370,6 +376,8 @@ files:
 - lib/kitchen/figure_element_enumerator.rb
 - lib/kitchen/i18n_string.rb
 - lib/kitchen/id_tracker.rb
+- lib/kitchen/injected_exercise_element.rb
+- lib/kitchen/injected_exercise_element_enumerator.rb
 - lib/kitchen/injected_question_element.rb
 - lib/kitchen/injected_question_element_enumerator.rb
 - lib/kitchen/metadata_element.rb
@@ -393,14 +401,16 @@ files:
 - lib/kitchen/references_element_enumerator.rb
 - lib/kitchen/search_history.rb
 - lib/kitchen/search_query.rb
+- lib/kitchen/section_element.rb
+- lib/kitchen/section_element_enumerator.rb
 - lib/kitchen/selector.rb
 - lib/kitchen/selectors/base.rb
 - lib/kitchen/selectors/standard_1.rb
 - lib/kitchen/solution_element_enumerator.rb
 - lib/kitchen/table_element.rb
 - lib/kitchen/table_element_enumerator.rb
+- lib/kitchen/templates/composite_page_template.xhtml.erb
 - lib/kitchen/templates/eob_section_title_template.xhtml.erb
-- lib/kitchen/templates/eoc_section_template.xhtml.erb
 - lib/kitchen/templates/eoc_section_template_old.xhtml.erb
 - lib/kitchen/term_element.rb
 - lib/kitchen/term_element_enumerator.rb

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

@@ -1,9 +0,0 @@
-<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/eoc_composite_page_container/v1.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::EocCompositePageContainer
-  class V1
-    renderable
-
-    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
-      @title = I18n.t(:"eoc.#{container_key}")
-      @uuid_key = uuid_key
-      @container_class_type = container_key
-      @metadata = metadata_source.children_to_keep.copy
-      @content = content
-      @in_composite_chapter = append_to.is?(:composite_chapter)
-
-      append_to.append(child: render(file:
-        '../../templates/eoc_section_template.xhtml.erb'))
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module MoveSolutionsToAnswerKey
-      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_options: strategy_options,
-          solutions_plural: solutions_plural
-        )
-      end
-    end
-  end
-end

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::MoveSolutionsToAnswerKey
-  module Strategies
-    class Calculus
-      def bake(chapter:, append_to:)
-        checkpoint_solutions = chapter.search('div.checkpoint div[data-type="solution"]').cut
-        append_solution_area(I18n.t(:checkpoint), checkpoint_solutions, append_to)
-
-        chapter.search('section.section-exercises').each do |section|
-          section_solutions = section.search('div[data-type="solution"]').cut
-          section_title = I18n.t(
-            :section_exercises,
-            number: "#{chapter.count_in(:book)}.#{section.count_in(:chapter)}"
-          )
-          append_solution_area(section_title, section_solutions, append_to)
-        end
-
-        chapter.search('section.review-exercises').each do |section|
-          section_solutions = section.search('div[data-type="solution"]').cut
-          append_solution_area(I18n.t(:review_exercises), section_solutions, append_to)
-        end
-      end
-
-      protected
-
-      def append_solution_area(title, clipboard, append_to)
-        append_to.append(child:
-          <<~HTML
-            <div class="os-solution-area">
-              <h3 data-type="title">
-                <span class="os-title-label">#{title}</span>
-              </h3>
-              #{clipboard.paste}
-            </div>
-          HTML
-        )
-      end
-    end
-  end
-end

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/contemporary_math.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::MoveSolutionsToAnswerKey
-  module Strategies
-    class ContemporaryMath
-      def bake(chapter:, append_to:)
-        # Hacky numbering fix
-        chapter.notes('$.your-turn').exercises.each do |exercise|
-          solution = exercise.solution
-          next unless solution
-
-          number = exercise.ancestor(:note).count_in(:chapter)
-          solution.first('a.os-number').inner_html = number.to_s
-          solution.first('span.os-divider').inner_html = '. '
-        end
-
-        Kitchen::Directions::MoveSolutionsFromNumberedNote.v1(
-          chapter: chapter, append_to: append_to, note_class: 'your-turn'
-        )
-
-        # Bake section exercises
-        chapter.non_introduction_pages.each do |page|
-          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
-          Kitchen::Directions::MoveSolutionsFromExerciseSection.v1(
-            chapter: page, append_to: append_to, section_class: 'section-exercises',
-            title_number: number
-          )
-        end
-
-        # Bake other exercise sections
-        classes = %w[chapter-review chapter-test]
-        classes.each do |klass|
-          Kitchen::Directions::MoveSolutionsFromExerciseSection.v1(
-            chapter: chapter, append_to: append_to, section_class: klass
-          )
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/default.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::MoveSolutionsToAnswerKey
-  module Strategies
-    class Default
-      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)
-          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')
-      end
-    end
-  end
-end