openstax_kitchen 10.0.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a071ba6e289c222a7333f401c7d6bd25d6dba9527253b6c6ae123169d9b6425
-  data.tar.gz: 2debc535f61a289f6668019f1eeb5cd639efaf8d49172d668f8b602e02e91b07
+  metadata.gz: ddc1370c1b05b52bdf0df2f0a7cd4624b1725f39aae33f57f9715e091a358f8d
+  data.tar.gz: fcd328b3dd9c091f2461e3acd22db036c02c4005bb5c8f31071096ed96461179
 SHA512:
-  metadata.gz: 6bfeae3a664c95c17249ab32a8bba863091fb1e23f501273fd57d9752688c29ba9877b5a6404393dc88ae993f16af3f89fa768e3984cf81233908ab238b0350a
-  data.tar.gz: '086fa06f8f7eb33f3908c15ba0172a02a1738c943ba87b25245f63626cda51e5163edbece95cdce2ce1907d5815aefd179db7fb7e3a4fe2a7165c623c5120ede'
+  metadata.gz: fd04ee2890144c697d9ab1ff10f97b9593f594eca116856bc6f26edb51f28e6330a0daca42c23e29d7bc08f2d336e764c957dcf93d6f638a22be1572a3ab939c
+  data.tar.gz: bb270311e092585ef966c4f2ba76d8847d7fbaedaae9c102274363ac5c21bbf411a6af5ebd7689c6b8ffd02d81ea46b586cd2273eab26320f21c559d28019bcb

data/CHANGELOG.md

@@ -6,6 +6,67 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [12.0.0] - 2021-09-21
+
+* Fixes `BakeStepwise` to skip nested lists (patch)
+* Adds an optional selector to `RemoveSectionTitles` (minor)
+* Patches `BakeFreeResponse` to only delete the first h3, not all h3s (patch)
+* Lets `BakeExample` not count titles in lists as commentary titles (minor)
+* Renames `BakePageAbstracts` to `BakeLearningObjectives` and adds optional parameter for titles in `v2` (major)
+* Gets rid of extraneous titles in `BakeAutoTitledNotes` when subtitles are off (minor)
+* Adds `BakeAutotitledExercise` direction and the option to `bake_unclassified_exercises` within `BakeAutotitledNotes`
+* Adds optional numbering for `BakeReferences.v1` (minor)
+* Patches`BakeNumberedNotes.v3` to suppress solutions outside examples when suppress_solutions is true (minor)
+
+## [11.2.0] - 2021-09-10
+
+* Adds `BakeAccessibilityFixes` direction for (minor)
+* Remove deprecation warning from `BakeChapterIntroductions.v1` and adapted to be used like `.v2` (minor)
+* Small class fix for `BakeFootnotes.v1` (patch)
+* Fix `BakeNumberedNotes` to find related example better (minor)
+* Small fix for parameter in `bake_note` definition (minor)
+* Small fixes to return when no elements are found and not add an empty wrapper in `BakeChapterReferences` and
+`BakeFreeResponse` (minor)
+* Adding class `os-timeline-table-container` to numbered tables when required (minor)
+* Fix `BakeExample` to catch the multiple solutions to one exercise (patch)
+
+## [11.1.0] - 2021-08-30
+
+* Update injected questions to synthesize ids during baking (minor)
+* Fix `BakeListsWithPara` to copy all children from para not just text (minor)
+* Implement labels with cases to `BakeAutotitledNotes` and `BakeNumberedNotes` (minor)
+* Add ids to injected questions (minor)
+* Create `BakeIframes` outer directory to allow bake iframes also from outside notes, remove `BakeNoteIFrames` module from notes directory (minor)
+* Update the contemporary math `Strategy` to target injected solution sections (minor)
+* Update `BakeNumberedNotes` to handle injected questions in notes (minor)
+* Create `InjectedQuestionElement` and `InjectedQuestionElementEnumerator` classes (minor)
+* Create `BakeInjectedExercise` and `BakeInjectedExerciseQuestion` directions (minor)
+* Update `MoveSolutionsFromExerciseSection` and `MoveSolutionsFromNumberedNote` to move injected solutions (minor)
+* Add `SolutionElementEnumerator` to support the above (minor)
+* Remove multipart exercise baking from `BakeNumberedExercise`; this is now done in `InjectedExercise` directions (patch)
+* Modify target labels to use grammatical cases (minor)
+* Modify `BakeIndex` to bake multiple types of indexes (minor)
+* Create `v2` in `BakeChapterIntroductions` that should replace `v1` (minor)
+* Added a DEPRECATION warning in `v1` for `BakeChapterIntroductions` (minor)
+* Added a bit more description to deprecation warning for `BakeChapterIntroductions.v1`  (minor)
+
+## [11.0.0] - 2021-08-6
+
+* Add `ChangeSubsectionTitleTag` direction for modifying eoc sections (minor)
+* Add `MoveSolutionsFromNumberedNote`, `MoveSolutionsFromExerciseSection`, and `SolutionAreaSnippet` for answer key baking (minor)
+* Refactor the following `Strategies`: contemporary math, precalculus, uphysics (minor)
+* Fix `BakeUnitPageTite` to utilize only pages which are direct children of the unit (patch)
+* Patch `BakeFirstElements` to include first figure elements (patch)
+* Refactor `MoveCustomSectionToEocContainer` to remove `include_intro_page` (major)
+* Update `BakeFirstElement` to optionally add the `has-first-inline-element` class (patch)
+* Patch `BakeExample` crashing if an example has commentary but no title (patch)
+* Refactor `EocSectionTitleLinkSnippet` to only have v1 with optional params (major)
+* Adds `PageElement#count_in_chapter_without_intro_page` (minor)
+* Adds `ChapterElement#has_introduction?` (minor)
+* Adds `BakeFolio` to set spanish translation variables in the html tag for folio-pdf purposes (minor)
+* Create `BakeCustomSections` direction for English Composition (minor)
+* Create `BakeAnnotationClasses` v1 for English Composition (minor)
+
 ## [10.0.0] - 2021-07-30
 
 * Add support for baking multipart questions to `BakeNumberedExercise` (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (10.0.0)
+    openstax_kitchen (12.0.0)
       activesupport
       i18n
       nokogiri
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -99,7 +99,7 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
-    twitter_cldr (6.6.0)
+    twitter_cldr (6.7.0)
       camertron-eprun
       cldr-plurals-runtime-rb (~> 1.1)
       tzinfo

data/lib/kitchen/chapter_element.rb

@@ -44,6 +44,14 @@ module Kitchen
       pages('$.introduction').first
     end
 
+    # Returns true if the chapter has an introduction
+    #
+    # @return [Boolean]
+    #
+    def has_introduction?
+      @has_introduction ||= introduction_page.present?
+    end
+
     # Returns an enumerator for the glossaries
     #
     # @return [ElementEnumerator]
@@ -60,5 +68,12 @@ module Kitchen
       search('div[data-type="abstract"]')
     end
 
+    # Returns an enumerator for the learning objectives
+    #
+    # @return [ElementEnumerator]
+    #
+    def learning_objectives
+      search('section.learning-objectives')
+    end
   end
 end

data/lib/kitchen/composite_page_element.rb

@@ -41,6 +41,14 @@ module Kitchen
       has_class?('os-index-container')
     end
 
+    # Returns true if this page is a book index of type
+    #
+    # @return [Boolean]
+    #
+    def is_index_of_type?
+      (self[:class] || '').match?(/os-index-.+-container/)
+    end
+
     # In books we can find two types of EOB References.
     #
     # One of them has form similar to footnotes. There are citation links in the text that provides

data/lib/kitchen/directions/bake_accessibility_fixes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAccessibilityFixes
+      def self.v1(section:)
+        section.search('ol[data-number-style="lower-alpha"]').each { |ol| ol['type'] = 'a' }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAnnotationClasses
+  class V1
+    def bake(chapter:)
+      chapter.search('p.annotation').each do |annotation|
+        annotation.wrap_children('span', class: 'os-text')
+        annotation.prepend(child:
+          <<~HTML
+            <div class="os-icons"></div>
+          HTML
+        )
+      end
+      annotation_icon_classes = %w[linguistic-icon
+                                   culture-icon
+                                   dreaming-icon
+                                   visual-icon
+                                   speech-icon
+                                   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:
+            <<~HTML
+              <span class = "#{annotation_icon_class}"></span>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeAutotitledExercise
+      def self.v1(exercise:, number: nil)
+        V1.new.bake(exercise: exercise, number: number)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeAutotitledExercise
+  class V1
+    def bake(exercise:, number:)
+      exercise.add_class('unnumbered') unless number
+
+      # bake problem
+      exercise.problem.wrap_children('div', class: 'os-problem-container')
+      exercise.problem.prepend(child:
+        <<~HTML
+          <h4 class="exercise-title" data-type="title">#{exercise.autogenerated_title}</h4>
+        HTML
+      )
+      return unless exercise.solution
+
+      # bake solution in place
+      exercise.solution.wrap_children('div', class: 'os-solution-container')
+      exercise.solution.prepend(child:
+        <<~HTML
+          <h4 class="solution-title" data-type="title">
+            <span class="os-text">#{I18n.t(:"exercises.solution")}</span>
+          </h4>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_introductions/bake_chapter_objectives.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterIntroductions
+  class BakeChapterObjectives
+    def bake(chapter:, strategy:)
+      case strategy
+      when :default
+        bake_as_note(chapter: chapter)
+      when :add_objectives
+        add_chapter_objectives(chapter: chapter)
+      when :none
+        ''
+      else
+        raise 'No such strategy'
+      end
+    end
+
+    def bake_as_note(chapter:)
+      chapter_objectives_note = chapter.notes('$.chapter-objectives').first
+
+      return unless chapter_objectives_note.present?
+
+      # trash existing title
+      chapter_objectives_note.titles.first&.trash
+      Kitchen::Directions::BakeAutotitledNotes.v1(
+        book: chapter,
+        classes: %w[chapter-objectives],
+        bake_subtitle: false
+      )
+
+      chapter_objectives_note.cut.paste
+    end
+
+    def add_chapter_objectives(chapter:)
+      chapter.non_introduction_pages.map do |page|
+        <<~HTML
+          <div class="os-chapter-objective">
+            <a class="os-chapter-objective" href="##{page.title[:id]}">
+              <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
+              <span class="os-divider"> </span>
+              <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
+            </a>
+          </div>
+        HTML
+      end.join('')
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_introductions/bake_chapter_outline.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterIntroductions
+  class BakeChapterOutline
+    def bake(chapter_objectives_html:)
+      <<~HTML
+        <div class="os-chapter-outline">
+          <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
+          #{chapter_objectives_html}
+        </div>
+      HTML
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterIntroductions
+      def self.v1(book:)
+        V1.new.bake(
+          book: book
+        )
+      end
+
+      def self.v2(
+        book:,
+        strategy_options: {
+          strategy: :default, bake_chapter_outline: false, introduction_order: :v1
+        }
+      )
+        V2.new.bake(
+          book: book,
+          strategy_options: strategy_options
+        )
+      end
+
+      def self.bake_chapter_objectives(chapter:, strategy:)
+        BakeChapterObjectives.new.bake(
+          chapter: chapter,
+          strategy: strategy
+        )
+      end
+
+      def self.bake_chapter_outline(chapter_objectives_html:)
+        BakeChapterOutline.new.bake(
+          chapter_objectives_html: chapter_objectives_html
+        )
+      end
+
+      def self.v1_update_selectors(something_with_selectors)
+        something_with_selectors.selectors.title_in_introduction_page =
+          ".intro-text > [data-type='document-title']"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterIntroductions
+  class V1
+    def bake(book:)
+      Kitchen::Directions::BakeChapterIntroductions.v2(
+        book: book,
+        strategy_options: {
+          strategy: :add_objectives,
+          bake_chapter_outline: true,
+          introduction_order: :v1
+        }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterIntroductions
+  class V2
+    def bake(book:, strategy_options:)
+      book.chapters.each do |chapter|
+        introduction_page = chapter.introduction_page
+        title = bake_title(introduction_page: introduction_page)
+
+        chapter_intro_html =
+          Kitchen::Directions::BakeChapterIntroductions.bake_chapter_objectives(
+            chapter: chapter,
+            strategy: strategy_options[:strategy]
+          )
+
+        if strategy_options[:bake_chapter_outline]
+          chapter_intro_html =
+            Kitchen::Directions::BakeChapterIntroductions.bake_chapter_outline(
+              chapter_objectives_html: chapter_intro_html
+            )
+        end
+
+        case strategy_options[:introduction_order]
+        when :v1
+          v1_introduction_order(
+            introduction_page: introduction_page,
+            chapter_intro_html: chapter_intro_html,
+            title: title
+          )
+        when :v2
+          v2_introduction_order(
+            introduction_page: introduction_page,
+            chapter_intro_html: chapter_intro_html,
+            title: title
+          )
+        end
+      end
+
+      Kitchen::Directions::BakeChapterIntroductions.v1_update_selectors(book)
+    end
+
+    def v1_introduction_order(introduction_page:, chapter_intro_html:, title:)
+      intro_content = introduction_page.search(
+        "> :not([data-type='metadata']):not(.splash):not(.has-splash)"
+      ).cut
+
+      introduction_page.append(child:
+        <<~HTML
+          <div class="intro-body">
+            #{chapter_intro_html}
+            <div class="intro-text">
+              #{title.paste}
+              #{intro_content.paste}
+            </div>
+          </div>
+        HTML
+      )
+    end
+
+    def v2_introduction_order(introduction_page:, chapter_intro_html:, title:)
+      if chapter_intro_html.empty?
+        chapter_intro_html = introduction_page.notes('$.chapter-objectives').first&.cut&.paste
+      end
+      extra_content = introduction_page.search(
+        '> :not([data-type="metadata"]):not(.splash):not(.has-splash)'
+      ).cut
+
+      introduction_page.append(child:
+        <<~HTML
+          <div class="intro-body">
+            #{chapter_intro_html}
+            <div class="intro-text">
+              #{title.paste}
+              #{extra_content.paste}
+            </div>
+          </div>
+        HTML
+      )
+    end
+
+    def bake_title(introduction_page:)
+      introduction_page.search(
+        'div[data-type="description"], div[data-type="abstract"]'
+      ).each(&:trash)
+
+      title = introduction_page.title.cut
+      title.name = 'h2'
+      Kitchen::Directions::MoveTitleTextIntoSpan.v1(title: title)
+    end
+  end
+end

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

@@ -10,7 +10,6 @@ module Kitchen::Directions::BakeChapterKeyConcepts
         uuid_key: "#{uuid_prefix}key-concepts",
         section_selector: 'section.key-concepts',
         append_to: append_to || chapter,
-        include_intro_page: false,
         wrap_section: true, wrap_content: true
       ) do |section|
         Kitchen::Directions::RemoveSectionTitle.v1(section: section)

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

@@ -3,12 +3,12 @@
 module Kitchen::Directions::BakeChapterReferences
   class V1
     def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
-      bake_page_references(page: chapter.introduction_page)
-
-      chapter.non_introduction_pages.each do |page|
+      chapter.pages.each do |page|
         bake_page_references(page: page)
       end
 
+      return if chapter.pages.references.none?
+
       content = chapter.pages.references.cut.paste
 
       Kitchen::Directions::EocCompositePageContainer.v1(

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -18,7 +18,7 @@ module Kitchen
         def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
           summaries = Clipboard.new
 
-          chapter.non_introduction_pages.each do |page|
+          chapter.pages.each do |page|
             summary = page.summary
 
             next if summary.nil?

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

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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeCustomSections
+  class V1
+    def bake(chapter:, custom_sections_properties:)
+      custom_sections_properties.each do |_custom_section_name, property|
+        title_text = I18n.t(:"custom-sections.#{property[:class]}")
+        property_class = property[:class]
+        inject = property[:inject]
+        chapter.search(".#{property_class}").each do |custom_section|
+
+          case inject
+          when 'title'
+            custom_section_title = custom_section.first('h2')
+            custom_section_title_os_text = custom_section_title.first('.os-text')
+            custom_section_title_sibling = custom_section.first('h2 + div')
+            div_id = custom_section_title_sibling['id']
+            custom_section_title_sibling.trash
+            custom_section_title.append(sibling:
+              <<~HTML
+                <h3 class="os-subtitle" id="#{div_id}">#{custom_section_title_os_text.text}</h3>
+              HTML
+            )
+            custom_section_title_os_text.replace_children(with: title_text)
+          when 'subtitle'
+            custom_section_title = custom_section.titles.first
+            custom_section_title.name = 'h4'
+            custom_section_title.prepend(sibling:
+              <<~HTML
+                <h3 class="os-title">#{title_text}</h3>
+              HTML
+            )
+          when 'title_prefix'
+            custom_section_title = custom_section.titles.first
+            custom_section_title.replace_children(with: "#{title_text}: " +
+                                                  custom_section_title.text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_eoc_section_content/change_subsection_title_tag.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module ChangeSubsectionTitleTag
+      def self.v1(section:)
+        section.search('section').each do |subsection|
+          subsection.first('h4').name = 'h5'
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_eoc_section_content/remove_section_title.rb

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module RemoveSectionTitle
-      def self.v1(section:)
-        section.first('[data-type="title"]')&.trash
+      def self.v1(section:, selector: '')
+        section.first("#{selector}[data-type=\"title\"]")&.trash
       end
     end
   end

data/lib/kitchen/directions/bake_equations.rb

@@ -3,14 +3,13 @@
 module Kitchen
   module Directions
     module BakeEquations
-      def self.v1(book:, number_decorator: :none)
+      def self.v1(book:, number_decorator: :none, cases: false)
         book.chapters.search('div[data-type="equation"]:not(.unnumbered)').each do |eq|
           chapter = eq.ancestor(:chapter)
           number = "#{chapter.count_in(:book)}.#{eq.count_in(:chapter)}"
 
           # Store label information
-          equation_label = "#{I18n.t(:equation)} #{number}"
-          book.pantry(name: :link_text).store equation_label, label: eq.id
+          eq.target_label(label_text: 'equation', custom_content: number, cases: cases)
 
           decorated_number =
             case number_decorator

data/lib/kitchen/directions/bake_example.rb

@@ -3,22 +3,21 @@
 module Kitchen
   module Directions
     module BakeExample
-      def self.v1(example:, number:, title_tag:, numbered_solutions: false)
+      def self.v1(example:, number:, title_tag:, numbered_solutions: false, cases: false)
         example.wrap_children(class: 'body')
 
         example.prepend(child:
           <<~HTML
             <#{title_tag} class="os-title">
-              <span class="os-title-label">#{I18n.t(:example_label)} </span>
+              <span class="os-title-label">#{I18n.t("example#{'.nominative' if cases}")} </span>
               <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
             </#{title_tag}>
           HTML
         )
 
-        example.document
-               .pantry(name: :link_text)
-               .store("#{I18n.t(:example_label)} #{number}", label: example.id)
+        # Store label information
+        example.target_label(label_text: 'example', custom_content: number, cases: cases)
 
         example.titles_to_rename.each do |title|
           title.name = 'h4'
@@ -31,9 +30,9 @@ module Kitchen
             problem.wrap_children(class: 'os-problem-container')
           end
 
-          if (solution = exercise.solution)
+          exercise.solutions.each do |solution|
             solution_number = if numbered_solutions
-                                "<span class=\"os-number\">#{exercise.count_in(:example)}</span>"
+                                "<span class=\"os-number\">#{solution.count_in(:example)}</span>"
                               else
                                 ''
                               end
@@ -54,6 +53,8 @@ module Kitchen
           next unless commentary.present?
 
           commentary_title = commentary.titles.first
+          next unless commentary_title.present? && commentary_title.parent['data-type'] != 'list'
+
           commentary_title.name = 'h4'
           commentary_title['data-type'] = 'commentary-title'
           commentary_title.wrap_children('span', class: 'os-title-label')