openstax_kitchen 13.0.0 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f1212b9bee542b587323cef1fa5ff8dc7437d47921736f58c9c27ef6ee11b8
-  data.tar.gz: ca01c38368dc34a0e637f431caf7873f97d5dd52b465e1ae5411d6f0861b8e58
+  metadata.gz: 774e5af35ed15ba87d97802b8395412003291024053c9ed11aa66eaa4ba20712
+  data.tar.gz: eb371d8b10113005b69b5864c19fe8eed43aa5b9b965329cfcfdcc8a9287b842
 SHA512:
-  metadata.gz: c877a0d30bde86ccc5d0e2191b3e0efe853916294d907c764a088e67a2011f9f3fa03fb018ff8aa9992e1fbaeebb753625b90f593d888d8e8a4473139e9e0f43
-  data.tar.gz: f96e5128a718bf1897c65b5b558d2586e6905767e355cf9119c56b536f128bbbf403c658187e6faefc0bb7e7fc3013218353a81d99c1fc8dfc30a9ffed8354db
+  metadata.gz: c4953a8d928e31cf45116cb4ac8f5eb54ab06db3c5d91af038da6acefc1e643ab19a4a585fdfb3cf19de67f24ac3778e36aa972014a3b5f9397734b1c1498829
+  data.tar.gz: ad336376346ed97f0f924ef6fde9e41f0b7735fa920245fc58d1c7c679d88be72867af5dd6722c25bd6185fcdaa0b57708650dbb0ba94d6e3fa3da2b2751e19d

data/CHANGELOG.md

@@ -6,6 +6,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.0.0] - 2021-12-3
+
+* Create method in `Integer` class that generate roman numbers up to 100 (minor)
+* Add more roman numbers to `Integer` class (patch)
+* Create `V2` for `BakeChapterReferences` (minor)
+* Create `BakeExercisePrefixes` direction adding prefixes for exercises in selected sections (minor)
+* Add support for 'text-heavy-top-titled' tables in `BakeTableBody` (minor)
+* Remove `Nokigiri#previous` patch, `ElementBase#previous` now uses `#previous_element` (minor)
+* Modifies `BakeAnnotationClasses` for annotations wrapper to be a `span` intead of a `div` (major)
+
+## [16.0.0] - 2021-11-19
+
+* Add reference link separator to `BakeReferences.v1` (patch)
+* Modify `BakeFootnotes` to be more general (minor)
+* Add `#preceded_by_text` method to element_base and the nokigiri patch (minor)
+* Remove `Nokigiri#previous` patch, `ElementBase#previous` now uses `#previous_element` (minor)
+* Broaden caption selection for `BakeNumberedTable#v2` (patch)
+* Add details of question count to injected exercises in `BakeInjectedExercise` (major)
+* Add target labels to chapter content module pages option in `BakeNonIntroductionPages`, create a separate directory `BakeLOLinkLabels` to add `.label-text`, `.label-counter` spans wrappers for links with `.lo-reference` class (minor)
+* Add `BakeScreenreaderSpans` direction (minor)
+* Fix `BakeIndex` to group terms by character in polish books and transliterate it for others (minor)
+* Add optional bake `exercies-context` figure_reference if there is one present in singular part exercises to `BakeInjectedExercise`,`BakeInjectedQuestion` to move it down from exercise to question problem container. (major)
+* Create v3 for autotitled exercises with os-hasSolution class
+
+## [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
 

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 (13.0.0)
+    openstax_kitchen (17.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
@@ -99,7 +99,7 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
-    twitter_cldr (6.7.0)
+    twitter_cldr (6.9.0)
       camertron-eprun
       cldr-plurals-runtime-rb (~> 1.1)
       tzinfo
@@ -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,10 +19,19 @@ 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|
-          annotation_with_icon_class.search('div.os-icons').first.append(child:
+        book.search("p.#{annotation_icon_class}").each do |annotation_with_icon_class|
+          annotation_with_icon_class.search('div.os-icons').first&.name = 'span'
+
+          icon_title = I18n.t(:"annotation_icons.#{annotation_icon_class}.title")
+
+          annotation_with_icon_class.search('span.os-icons').first.append(child:
             <<~HTML
-              <span class = "#{annotation_icon_class}"></span>
+              <span
+                class = "#{annotation_icon_class}"
+                role="img"
+                title="#{icon_title}"
+                aria-label="#{icon_title}"
+              ></span>
             HTML
           )
         end

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,14 @@ 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
+
+      def self.v3(exercise:, title:)
+        V3.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_autotitled_exercise/v3.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  # Differences from V2:
+  # 1. Exercise with solution has class os-hasSolution
+  # 2. Solution id is based on exercise id
+  class V3
+    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.add_class('os-hasSolution')
+      exercise.solution.id = "#{exercise.id}-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,6 +41,8 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
+      return if content.empty?
+
       Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'glossary',
         uuid_key: "#{uuid_prefix}glossary",

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

@@ -10,6 +10,14 @@ module Kitchen
           uuid_prefix: uuid_prefix,
           klass: klass)
       end
+
+      def self.v2(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V2.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass)
+      end
     end
   end
 end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V2
+    def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+      chapter.pages.each do |page|
+        bake_page_cite(page: page)
+        bake_page_references(page: page)
+      end
+
+      return if chapter.pages.references.none?
+
+      content = chapter.pages.references.cut.paste
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: chapter
+      )
+    end
+
+    def bake_page_cite(page:)
+      page.search('[data-type="cite"]').each do |link|
+        link.id = "#{page.id}-endNote#{link.count_in(:chapter)}"
+
+        link.prepend(child:
+          <<~HTML
+            <sup class="os-end-note-number">#{link.count_in(:chapter)}</sup>
+          HTML
+        )
+
+        link.search('.delete-me').trash
+      end
+    end
+
+    def bake_page_references(page:)
+      page.references.each do |reference|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: reference)
+
+        reference.search('a').each do |ref_link|
+          ref_link.replace_children(with:
+            <<~HTML
+              <span>#{ref_link.count_in(:chapter)}.</span>
+            HTML
+          )
+          ref_link.href = "##{page.id}-endNote#{ref_link.count_in(:chapter)}"
+        end
+      end
+    end
+  end
+end

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_exercise_prefixes/main.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeExercisePrefixes
+      def self.v1(chapter:, sections_prefixed:)
+        V1.new.bake(
+          chapter: chapter,
+          sections_prefixed: sections_prefixed
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeExercisePrefixes
+  class V1
+    def bake(chapter:, sections_prefixed:)
+      sections_prefixed.each do |section_key|
+        chapter.composite_pages.each do |composite_page|
+          composite_page.search("section.#{section_key}").exercises.each do |exercise|
+            problem = exercise.problem
+            exercise_prefix =
+              "<span class='os-text'>#{I18n.t(:"sections_prefixed.#{section_key}")}</span>"
+            problem.prepend(child:
+              <<~HTML
+                #{exercise_prefix}
+              HTML
+            )
+          end
+        end
+      end
+    end
+  end
+end

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_footnotes/v1.rb

@@ -30,7 +30,7 @@ module Kitchen::Directions::BakeFootnotes
         aside_id_to_footnote_number[aside_id] = footnote_number
         if anchor.parent.name == 'p'
           anchor.parent.add_class('has-noteref')
-        elsif anchor.parent.name == 'em' && anchor.parent.parent.name == 'p'
+        elsif anchor.parent.name != 'p' && anchor.parent.parent.name == 'p'
           anchor.parent.parent.add_class('has-noteref')
         end
       end

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

@@ -165,7 +165,7 @@ module Kitchen::Directions::BakeIndex
         group_by = term_reference[0]
         content = term_reference
       else
-        group_by = I18n.transliterate(term_element.text.strip[0])
+        group_by = I18n.character_to_group(term_element.text.strip[0])
         content = term_element.text
       end
 

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.rb → bake_injected_exercise/bake_injected_exercise.rb}

@@ -7,12 +7,21 @@ module Kitchen::Directions::BakeInjectedExercise
 
   class V1
     def bake(exercise:)
-      context = exercise.search('div[data-type="exercise-context"]')&.first
+      question_count = exercise.injected_questions.count
+      exercise[:'data-question-count'] = question_count
+      exercise[:'data-is-multipart'] = question_count > 1 ? 'True' : 'False'
+
+      context = exercise&.exercise_context
+
       return unless context
 
       # link replacement is done by BakeLinkPlaceholders
       link = context.first('a').cut
       context.replace_children(with: "#{I18n.t(:context_lead_text)}#{link.paste}")
+      return unless question_count == 1
+
+      question = exercise.exercise_question
+      question.prepend(child: context.cut.paste)
     end
   end
 end

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

@@ -41,11 +41,15 @@ module Kitchen::Directions::BakeInjectedExerciseQuestion
         end
       end
 
+      context = question.exercise_context_in_question&.cut&.paste
+
       question.prepend(child:
         <<~HTML
           #{problem_number unless only_number_solution}
           #{"<span class='os-divider'>. </span>" unless only_number_solution}
           <div class="os-problem-container">
+            #{context if context.present?}
+            #{"<span class='os-divider'>. </span>" if context.present?}
             #{question.stimulus&.cut&.paste}
             #{question.stem.cut.paste}
             #{question.answers&.cut&.paste}

data/lib/kitchen/directions/bake_lo_link_labels.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directions for LO link labels
+    module BakeLOLinkLabels
+      def self.v1(book:)
+        book.search('a.lo-reference').each do |anchor|
+          anchor.wrap_children('span', class: 'label-counter')
+          anchor.prepend(child:
+            <<~HTML
+              <span class="label-text">#{I18n.t(:lo_label_text)}</span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_non_introduction_pages.rb

@@ -3,13 +3,15 @@
 module Kitchen
   module Directions
     module BakeNonIntroductionPages
-      def self.v1(chapter:)
+      def self.v1(chapter:, add_target_label: false)
         chapter.non_introduction_pages.each do |page|
           number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
 
           page.search("div[data-type='description']").each(&:trash)
           page.add_class('chapter-content-module')
 
+          page.target_label(custom_content: number) if add_target_label
+
           title = page.title
           title.name = 'h2'
           title.replace_children(with:

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

@@ -30,32 +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')
-
-          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
+        BakeNoteExercise.v2(note: note) if bake_exercises
       end
     end
   end