openstax_kitchen 5.0.0 → 6.0.0

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

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

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

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

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

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

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

@@ -0,0 +1,27 @@
+# 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:)
+        @classes.each do |klass|
+          chapter.search(".#{klass} [data-type='solution']").each do |solution|
+            append_to.add_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)
+        @classes = strategy_options[:classes] || (raise 'missing classes for strategy')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class Precalculus
+      def bake(chapter:, append_to:)
+        try_note_solutions(chapter: chapter, append_to: append_to)
+
+        # Bake section exercises
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+          bake_section(chapter: page, append_to: append_to, klass: 'section-exercises',
+                       number: number)
+        end
+
+        # Bake other types of exercises
+        classes = %w[review-exercises practice-test]
+        classes.each do |klass|
+          bake_section(chapter: chapter, append_to: append_to, klass: klass)
+        end
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:, number: nil)
+        section_solutions_set = Kitchen::Clipboard.new
+        chapter.search(".#{klass}").each do |section|
+          section.search('[data-type="solution"]').each do |solution|
+            solution.cut(to: section_solutions_set)
+          end
+        end
+
+        return if section_solutions_set.items.empty?
+
+        title = <<~HTML
+          <h3 data-type="title">
+            <span class="os-title-label">#{I18n.t(:"eoc.#{klass}", number: number)}</span>
+          </h3>
+        HTML
+
+        append_solution_area(title: title, solutions: section_solutions_set, append_to: append_to)
+      end
+
+      def try_note_solutions(chapter:, append_to:)
+        append_to.add_child(
+          <<~HTML
+            <div class="os-module-reset-solution-area os-try-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{I18n.t(:"notes.try")}</span>
+              </h3>
+            </div>
+          HTML
+        )
+        chapter.non_introduction_pages.each do |page|
+          solutions = Kitchen::Clipboard.new
+          page.notes('$.try').each do |note|
+            note.exercises.each do |exercise|
+              solution = exercise.solution
+              solution&.cut(to: solutions) #if solution
+            end
+          end
+          next if solutions.items.empty?
+
+          title_snippet = Kitchen::Directions::EocSectionTitleLinkSnippet.v2(page: page)
+
+          append_solution_area(title: title_snippet, solutions: solutions,
+                               append_to: append_to.search('.os-try-solution-area').first)
+        end
+      end
+
+      def append_solution_area(title:, solutions:, append_to:)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              #{title}
+            </div>
+          HTML
+        ).first
+
+        append_to.add_child(solutions.paste)
+      end
+    end
+  end
+end

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

@@ -2,22 +2,26 @@
 
 module Kitchen::Directions::MoveSolutionsToAnswerKey
   class V1
-    def bake(chapter:, metadata_source:, strategy:, append_to:)
+    def bake(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
       strategy =
         case strategy
         when :calculus
-          Strategies::Calculus
+          Strategies::Calculus.new
         when :uphysics
-          Strategies::UPhysics
-        when :american_government
-          Strategies::AmericanGovernment
+          Strategies::UPhysics.new
+        when :precalculus
+          Strategies::Precalculus.new
+        when :default
+          Strategies::Default.new(strategy_options)
         else
           raise 'No such strategy'
         end
 
+      solutions_or_solution = solutions_plural ? 'solutions' : 'solution'
       append_to.append(child:
         <<~HTML
-          <div class="os-eob os-solutions-container" data-type="composite-page" data-uuid-key=".solutions#{chapter.count_in(:book)}">
+          <div class="os-eob os-#{solutions_or_solution}-container" data-type="composite-page" \
+          data-uuid-key=".#{solutions_or_solution}#{chapter.count_in(:book)}">
             <h2 data-type="document-title">
               <span class="os-text">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</span>
             </h2>
@@ -28,7 +32,7 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
           </div>
         HTML
       )
-      strategy.new.bake(chapter: chapter, append_to: append_to.last_element)
+      strategy.bake(chapter: chapter, append_to: append_to.last_element)
     end
   end
 end

data/lib/kitchen/element_base.rb

@@ -508,6 +508,21 @@ 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
+    # nil if there's no previous sibling
+    #
+    def previous
+      prev = raw.previous
+      return prev if prev.nil?
+
+      Element.new(
+        node: prev,
+        document: document,
+        short_type: "previous(#{short_type})"
+      )
+    end
+
     # TODO: make it clear if all of these methods take Element, Node, or String
 
     # If child argument given, prepends it before the element's current children.

data/lib/kitchen/page_element.rb

@@ -88,11 +88,10 @@ module Kitchen
 
     # Returns the summary element.
     #
-    # @raise [ElementNotFoundError] if no matching element is found
-    # @return [Element]
+    # @return [Element, nil] the summary or nil if no summary found
     #
     def summary
-      first!(selectors.page_summary)
+      first(selectors.page_summary)
     end
 
     # Returns the exercises element.

data/lib/kitchen/patches/integer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# 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
+
+  # Formats as different types of integers, including roman numerals.
+  #
+  # @return [String]
+  #
+  def to_format(format)
+    case format
+    when :arabic
+      to_s
+    when :roman
+      raise 'Unknown conversion to Roman numerals' if self >= ROMAN_NUMERALS.size
+
+      ROMAN_NUMERALS[self]
+    else
+      raise 'Unknown integer format'
+    end
+  end
+end

data/lib/kitchen/patches/nokogiri.rb

@@ -67,6 +67,13 @@ module Nokogiri
         self[:class]&.split || []
       end
 
+      def previous
+        prev = previous_element
+        return nil if prev.nil?
+
+        prev.text? ? prev.previous : prev
+      end
+
       def self.selector_to_css_nodes(selector)
         # No need to parse the same selector more than once.
         @parsed_selectors ||= {}

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -16,12 +16,13 @@ en:
   learning_objectives: Learning Objectives
   stepwise_step_label: Step
   references: References
+  answer_key_title: Answer Key
   eoc_chapter_review: Chapter Review
   eoc_key_terms_title: Key Terms
   eoc_summary_title: Summary
   eoc_exercises_title: Exercises
   eoc_composite_metadata_title: Chapter Review
-  eoc_answer_key_title: Answer Key
+  eoc_solutions_title: Solutions
   eoc_key_concepts: Key Concepts
   eoc_key_equations: Key Equations
   eoc_suggested_reading: Suggestions for Further Study

data/lib/locales/es.yml

@@ -16,12 +16,13 @@ es:
   learning_objectives: Objetivos De Aprendizaje
   stepwise_step_label: Paso
   references: Referencias
+  answer_key_title: Respuestas Clave
   eoc_chapter_review: Revisión Del Capítulo
   eoc_key_terms_title: Términos Clave
   eoc_summary_title: Resumen
   eoc_exercises_title: Ejercicios
   eoc_composite_metadata_title: Revisión Del Capítulo
-  eoc_answer_key_title: Respuestas Clave
+  eoc_solutions_title: Soluciones
   eoc_key_concepts: Conceptos Clave
   eoc_key_equations: Ecuaciones Clave
   eoc_suggested_reading: Sugerencias Para Estudios Adicionales

data/lib/locales/pl.yml

@@ -14,10 +14,11 @@ pl:
   chapter_review: Podsumowanie rozdziału
   learning_objectives: Cel dydaktyczny
   stepwise_step_label: Krok
+  answer_key_title: Rozwiązania zadań
   eoc_chapter_review: Podsumowanie rozdziału
-  eoc_key_terms_title: Kluczowe pojęcia
+  key_terms_title: Kluczowe pojęcia
+  eoc_solutions_title: Rozwiązania
   eoc_summary_title: Podsumowanie
-  eoc_answer_key_title: Rozwiązania zadań
   eoc_key_equations: Najważniejsze wzory
   eob_index_title: Skorowidz rzeczowy
   eob_index_symbols_group: Symbole

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,7 +200,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".devcontainer/devcontainer.json"
-- ".github/config.yml"
+- ".github/workflows/changelog.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".inch.yml"
@@ -222,6 +223,7 @@ files:
 - docker/bash
 - docker/build
 - docker/ci
+- docker/rubocop
 - docker/run
 - docker/tag_and_push_latest
 - lefthook.yml
@@ -245,6 +247,7 @@ files:
 - lib/kitchen/directions/bake_chapter_glossary/main.rb
 - lib/kitchen/directions/bake_chapter_glossary/v1.rb
 - lib/kitchen/directions/bake_chapter_introductions.rb
+- lib/kitchen/directions/bake_chapter_introductions/chapter_introduction.xhtml.erb
 - lib/kitchen/directions/bake_chapter_key_concepts/main.rb
 - lib/kitchen/directions/bake_chapter_key_concepts/v1.rb
 - lib/kitchen/directions/bake_chapter_key_equations.rb
@@ -252,6 +255,8 @@ files:
 - lib/kitchen/directions/bake_chapter_references/v1.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/main.rb
 - lib/kitchen/directions/bake_chapter_section_exercises/v1.rb
+- lib/kitchen/directions/bake_chapter_solutions/main.rb
+- lib/kitchen/directions/bake_chapter_solutions/v1.rb
 - lib/kitchen/directions/bake_chapter_summary.rb
 - lib/kitchen/directions/bake_chapter_title/main.rb
 - lib/kitchen/directions/bake_chapter_title/v1.rb
@@ -276,12 +281,17 @@ files:
 - lib/kitchen/directions/bake_non_introduction_pages.rb
 - lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
 - lib/kitchen/directions/bake_notes/bake_note_subtitle.rb
-- lib/kitchen/directions/bake_notes/bake_numbered_notes.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/main.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v1.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v2.rb
+- lib/kitchen/directions/bake_notes/bake_numbered_notes/v3.rb
 - lib/kitchen/directions/bake_notes/bake_unclassified_notes.rb
 - lib/kitchen/directions/bake_numbered_exercise/main.rb
 - lib/kitchen/directions/bake_numbered_exercise/v1.rb
+- lib/kitchen/directions/bake_numbered_table/bake_table_body.rb
 - lib/kitchen/directions/bake_numbered_table/main.rb
 - lib/kitchen/directions/bake_numbered_table/v1.rb
+- lib/kitchen/directions/bake_numbered_table/v2.rb
 - lib/kitchen/directions/bake_page_abstracts.rb
 - lib/kitchen/directions/bake_preface/main.rb
 - lib/kitchen/directions/bake_preface/v1.rb
@@ -295,7 +305,7 @@ files:
 - lib/kitchen/directions/bake_unit_title/main.rb
 - lib/kitchen/directions/bake_unit_title/v1.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
-- lib/kitchen/directions/book_answer_key_container/eob_solutions_container.xhtml.erb
+- lib/kitchen/directions/book_answer_key_container/eob_answer_key_outer_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
@@ -305,9 +315,11 @@ files:
 - lib/kitchen/directions/move_exercises_to_eoc/main.rb
 - 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/strategies/american_government.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.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
@@ -336,6 +348,7 @@ files:
 - lib/kitchen/page_element_enumerator.rb
 - lib/kitchen/pantry.rb
 - lib/kitchen/patches/i18n.rb
+- lib/kitchen/patches/integer.rb
 - lib/kitchen/patches/nokogiri.rb
 - lib/kitchen/patches/nokogiri_profiling.rb
 - lib/kitchen/patches/renderable.rb