openstax_kitchen 12.1.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28254d4a9107528ff5dbebacc82e5cc3cbf20e71fcc9d8303c2f41fd90d2d4be
-  data.tar.gz: 2c71714f62fe45ea772614d5c72f6a95ce59deebc63e1259b182e25d70481400
+  metadata.gz: 074dfc264ca97aab5805a3ab189b49fe1e97a1108366b592b5599a70e15f1345
+  data.tar.gz: fee3491d899d7983e55e5c6eb22010b49d23e8dd43e54ca97950a7be2fbda93f
 SHA512:
-  metadata.gz: dfaf9123a29ef2bedddb524ed7758b1092c88c6cbc850aeee0d4530633783ab2cbec39b68f3b5fc391219f344f191c4714f779ef8efc57c7f35c47d075eb813e
-  data.tar.gz: c686d00ca4305b0f90f23c4ba2cfb3151a5c0384f7979e82fe16d5432a9e79b32705822aeae244601343d3620e053247b848edf78631c59f93a920e312d7951d
+  metadata.gz: d9a5936f931cf6b1c3485543adf375426d71b444109c68fc80b0a06ef6f953e4ac43cd40b27941c06dec0541e02dd2b3387074aa8a956821cdca781f97607f1d
+  data.tar.gz: 13d5bf302fe8144acef670f017bc8393847292d37f4a4dae68922cbf56c52da41c18719ec586ca1b5b1a135dc0c303e168f5515903e2b667299347cba909e7d4

data/CHANGELOG.md

@@ -6,6 +6,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [15.0.0] - 2021-11-05
+
+* Add unstyled tables to `BakeTableBody` (minor)
+* Add to `BakeNumberedExercises` rules for baking exercises in appendecies (minor)
+* Add `BakeUnnumberedExercise` direction (minor)
+* Change whitespace for `BakeIndex` and `BakeExample` (major)
+* Add `BakeAllNumberedExerciseTypes` direction for easier baking of compound sections (minor)
+* Add `solution_stays_put` option for `BakeNumberedExercise` (minor)
+* Add `BakeAllChapterSolutionsTypes` direction to move injected solutions and regular ones to EOC (minor)
+* Refactor: moves all `Answer key strategies` that are book-specific to the
+recipes side and keeps the `Default Strategy`in kitchen (major)
+* Adds missing spanish translations (minor)
+
+## [14.0.0] - 2021-10-22
+
+* Fix `BakeAutotitledExercise` V2 to stop breaking for exercises without solutions (patch)
+* Add `BakeAutotitledExercise` V2 (minor)
+* Fix `BakeChapterGlossary::V1` to stop adding an empty wrapper if there is no content (patch)
+* Create `BakeNoteExercise` and `BakeNoteInjectedQuestion` and support exercises in `BakeUnclassifiedNotes` (minor)
+* Add baking section with class `column header` to `BakeAppendix` (patch)
+* Expand `BakeAnnotationClasses` to book from chapter to bake also paragraphs from Preface (major)
+* Create separate direction `BakeUnnumberedFigure`, clean `BakeFigure` to not match unnumbered figures , rename and update `figure_to_bake?` method to `figure_to_number?` to support only numbered figures except subfigures (major)
+
+## [13.0.0] - 2021-10-6
+
+* Add `BakeLearningObjectives` v3 (minor)
+* Fix `BakeIframes` to skip already-baked iframes (patch)
+* Add `SectionElement` and `SectionElementEnumerator` classes (minor)
+* Refactor `EocCompositePageContainer` to be used by `EOB` sections as well (major)
+* Refactor `bake_references` `v1, v2 and v3` to use `CompositePageContainer` (major)
+
+## [12.2.0] - 2021-10-1
+
+* Add `context_lead_text` to translations (minor)
+* Make `ElementBase#search_with` callable from an `ElementEnumerator` (minor)
+* Support top-titled tables in `BakeUnnumberedTables` (minor)
+* Stop `NoteElement#title` from breaking for empty notes (patch)
+* Add text heavy tables to `BakeTableBody` (minor)
+* Modify `BakeAutotitledNotes` to bake unnumbered exercises with solution (minor)
+* Create `AddInjectedExerciseId` to separate creating ids from `BakeInjectedExerciseQuestion` (minor)
+* Rework `AddInjectedExerciseId` to use loop inside module (minor)
+
 ## [12.1.0] - 2021-09-24
 
 * Fix `BakeExample#titles_to_rename` to exclude exercise titles (patch)

data/Gemfile

@@ -9,3 +9,4 @@ gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 
 gem 'codecov', require: false
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (12.1.0)
+    openstax_kitchen (15.0.0)
       activesupport
       i18n
       nokogiri
@@ -27,7 +27,7 @@ GEM
     concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     docile (1.4.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     inch (0.8.0)
       pry
@@ -107,7 +107,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     yard (0.9.24)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/codecov.yaml

@@ -5,6 +5,10 @@ coverage:
   precision: 2
   round: down
   range: "70...100"
+  status:
+    project:
+      default:
+        threshold: 0.01%      # codecov/project fails if there is a drop of more than 0.01%
 
 parsers:
   gcov:

data/lib/kitchen/directions/bake_all_chapter_solutions_types.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAllChapterSolutionsTypes
+      def self.v1(chapter:, within:, metadata_source:, uuid_prefix: '')
+        solutions_clipboard = Kitchen::Clipboard.new
+
+        within.search_with(ExerciseElementEnumerator, InjectedQuestionElementEnumerator)\
+              .each do |exercise|
+
+          solution = exercise.solution
+          next unless solution.present?
+
+          solution.cut(to: solutions_clipboard)
+        end
+
+        content = solutions_clipboard.paste
+
+        Kitchen::Directions::CompositePageContainer.v1(
+          container_key: 'solutions',
+          uuid_key: "#{uuid_prefix}solutions",
+          metadata_source: metadata_source,
+          content: content,
+          append_to: chapter
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_all_numbered_exercise_types.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAllNumberedExerciseTypes
+      def self.v1(within:, exercise_options: {}, question_options: {})
+        exercise_counter = 1
+        within.search_with(ExerciseElementEnumerator, InjectedQuestionElementEnumerator)\
+              .each do |exercise|
+          next if exercise.has_class?('unnumbered')
+
+          if exercise.instance_of?(ExerciseElement)
+            exercise_options[:exercise] = exercise
+            exercise_options[:number] = exercise_counter
+            BakeNumberedExercise.v1(exercise_options)
+          else
+            question_options[:number] = exercise_counter
+            question_options[:question] = exercise
+            BakeInjectedExerciseQuestion.v1(question_options)
+          end
+          exercise_counter += 1
+        end
+      end
+    end
+  end
+end

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

@@ -3,9 +3,9 @@
 module Kitchen
   module Directions
     module BakeAnnotationClasses
-      def self.v1(chapter:)
+      def self.v1(book:)
         V1.new.bake(
-          chapter: chapter)
+          book: book)
       end
     end
   end

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

@@ -2,8 +2,8 @@
 
 module Kitchen::Directions::BakeAnnotationClasses
   class V1
-    def bake(chapter:)
-      chapter.search('p.annotation').each do |annotation|
+    def bake(book:)
+      book.search('p.annotation').each do |annotation|
         annotation.wrap_children('span', class: 'os-text')
         annotation.prepend(child:
           <<~HTML
@@ -19,7 +19,7 @@ module Kitchen::Directions::BakeAnnotationClasses
                                    auditory-icon
                                    kinesthetic-icon]
       annotation_icon_classes.each do |annotation_icon_class|
-        chapter.search("p.#{annotation_icon_class}").each do |annotation_with_icon_class|
+        book.search("p.#{annotation_icon_class}").each do |annotation_with_icon_class|
           annotation_with_icon_class.search('div.os-icons').first.append(child:
             <<~HTML
               <span class = "#{annotation_icon_class}"></span>

data/lib/kitchen/directions/bake_appendix.rb

@@ -21,6 +21,7 @@ module Kitchen
           next unless title.present?
 
           title.name = "h#{section['data-depth'].to_i + 1}"
+          section.name = 'div' if section.has_class?('column-container')
         end
       end
     end

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

@@ -6,6 +6,10 @@ module Kitchen
       def self.v1(exercise:, number: nil)
         V1.new.bake(exercise: exercise, number: number)
       end
+
+      def self.v2(exercise:, title:)
+        V2.new.bake(exercise: exercise, title: title)
+      end
     end
   end
 end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  # Differences from V1:
+  # 1. Title is an <h3><span>, not <h4>, & above the problem instead of within it
+  # 2. Title is generated in the recipe and passed to the method
+  class V2
+    def bake(exercise:, title:)
+      exercise.add_class('unnumbered')
+      exercise.titles.first&.trash
+
+      # bake problem
+      exercise.prepend(child:
+        <<~HTML
+          <h3 class="os-title" data-type="title">
+            <span class="os-title-label">#{title}</span>
+          </h3>
+        HTML
+      )
+      exercise.problem.wrap_children(class: 'os-problem-container')
+      return unless exercise.solution
+
+      exercise.solution.wrap_children(class: 'os-solution-container')
+      exercise.solution.prepend(child:
+        <<~HTML
+          <h4 class="solution-title" data-type="title">
+            <span class="os-text">#{I18n.t(:solution)}</span>
+          </h4>
+        HTML
+      )
+    end
+  end
+end

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

@@ -41,7 +41,9 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      return if content.empty?
+
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'glossary',
         uuid_key: "#{uuid_prefix}glossary",
         metadata_source: metadata_source,

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

@@ -11,7 +11,7 @@ module Kitchen::Directions::BakeChapterReferences
 
       content = chapter.pages.references.cut.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: klass,
         uuid_key: "#{uuid_prefix}#{klass}",
         metadata_source: metadata_source,

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

@@ -23,7 +23,7 @@ module Kitchen::Directions::BakeChapterSolutions
 
       content = solutions_clipboard.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'solutions',
         uuid_key: "#{uuid_prefix}solutions",
         metadata_source: metadata_source,

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -31,7 +31,7 @@ module Kitchen
 
           return if summaries.none?
 
-          EocCompositePageContainer.v1(
+          CompositePageContainer.v1(
             container_key: klass,
             uuid_key: "#{uuid_prefix}#{klass}",
             metadata_source: metadata_source,

data/lib/kitchen/directions/bake_example.rb

@@ -39,7 +39,7 @@ module Kitchen
             solution.replace_children(with:
               <<~HTML
                 <h4 data-type="solution-title">
-                  <span class="os-title-label">#{I18n.t(:solution)} </span>
+                  <span class="os-title-label">#{I18n.t(:solution)}</span>
                   #{solution_number}
                 </h4>
                 <div class="os-solution-container">#{solution.children}</div>

data/lib/kitchen/directions/bake_figure.rb

@@ -4,27 +4,13 @@ module Kitchen
   module Directions
     module BakeFigure
       def self.v1(figure:, number:, cases: false)
-        return if figure.has_class?('unnumbered') && !figure.has_class?('splash') && !figure.caption
-
+        warn 'warning! exclude unnumbered figures from `BakeFigure` loop' if figure.unnumbered?
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
 
-        if figure.has_class?('unnumbered') && (figure.caption || figure.has_class?('splash'))
-          caption = figure.caption&.cut
-          figure.append(sibling:
-            <<~HTML
-              <div class="os-caption-container">
-                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
-              </div>
-            HTML
-          )
-          return
-        end
-
         # Store label information
         figure.target_label(label_text: 'figure', custom_content: number, cases: cases)
 
         title = figure.title&.cut
-
         caption = figure.caption&.cut
         figure.append(sibling:
           <<~HTML

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

@@ -7,6 +7,8 @@ module Kitchen::Directions::BakeIframes
       return unless iframes.any?
 
       iframes.each do |iframe|
+        next if iframe.has_class?('os-is-iframe')
+
         iframe.wrap('<div class="os-has-iframe" data-type="alternatives">')
         iframe.add_class('os-is-iframe')
         link_ref = iframe[:src]

data/lib/kitchen/directions/bake_index/v1.xhtml.erb

@@ -11,16 +11,12 @@
       <span class="group-label"><%= section.name %></span>
       <% section.items.each do |item| %>
         <div class="os-index-item">
-          <% item.terms.each_with_index do |term, ii| %>
-            <% if ii == 0 %>
+          <%- item.terms.each_with_index do |term, ii| -%>
+            <%- if ii == 0 -%>
               <span class="os-term" group-by="<%= term.group_by %>"><%= term.text %></span>
-            <% else %>
-              <span class="os-index-link-separator">, </span>
-            <% end %>
-            <a class="os-term-section-link" href="#<%= term.id %>">
-              <span class="os-term-section"><%= term.page_title %></span>
-            </a>
-          <% end %>
+            <%- else -%><span class="os-index-link-separator">, </span><% end %>
+            <a class="os-term-section-link" href="#<%= term.id %>"><span class="os-term-section"><%= term.page_title %></span></a><!--
+          --><%- end %>
         </div>
       <% end %>
     </div>

data/lib/kitchen/directions/bake_injected_exercise/add_injected_exercise_id.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Ids should be added before exercises are moved to EOC,
+    # since they're using part of the ancestor page id.
+    #
+    # In some books exercises are numbered after moving.
+    # That's why this step has to be separated from BakeInjectedExerciseQuestion
+    module AddInjectedExerciseId
+      def self.v1(book:)
+        book.pages.injected_questions.each(&:id)
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_learning_objectives.rb

@@ -30,6 +30,19 @@ module Kitchen
           end
         end
       end
+
+      # Wraps & moves abstract under the corresponding chapter objective in the intro page
+      def self.v3(chapter:)
+        abstracts = chapter.abstracts.map do |abstract|
+          abstract.wrap('<div class="learning-objective">')
+          abstract.parent
+        end
+
+        chapter.introduction_page.search('div.os-chapter-objective') \
+               .each_with_index do |objective, index|
+          objective.append(child: abstracts[index].cut.paste)
+        end
+      end
     end
   end
 end

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

@@ -30,20 +30,7 @@ module Kitchen
           HTML
         )
 
-        bake_unclassified_exercises(note: note) if bake_exercises
-      end
-
-      def self.bake_unclassified_exercises(note:)
-        note.exercises.each do |exercise|
-          exercise.problem.wrap_children('div', class: 'os-problem-container')
-
-          exercise.problem.prepend(child:
-            <<~HTML
-              <span class="os-title-label">#{I18n.t(:"exercises.exercise")} </span>
-              <span class="os-number">#{exercise.count_in(:note)}</span>
-            HTML
-          )
-        end
+        BakeNoteExercise.v2(note: note) if bake_exercises
       end
     end
   end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteExercise
+      def self.v1(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.v2(note:)
+        note.exercises.each do |exercise|
+          exercise.problem.wrap_children('div', class: 'os-problem-container')
+
+          unless exercise.has_class?('unnumbered')
+            exercise.problem.prepend(child:
+              <<~HTML
+                <span class="os-title-label">#{I18n.t(:"exercises.exercise")} </span>
+                <span class="os-number">#{exercise.count_in(:note)}</span>
+              HTML
+            )
+          end
+
+          next unless exercise.solution
+
+          exercise.solution.wrap_children('div', class: 'os-solution-container')
+
+          exercise.solution.prepend(child:
+            <<~HTML
+              <span class="os-title-label">#{I18n.t(:"exercises.solution")}</span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeNoteInjectedQuestion
+      def self.v1(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/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