openstax_kitchen 11.0.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6964a7fe85234e82e7f54f3b6d4980633f4f4c29c49d3123743c214d9f46653
-  data.tar.gz: 2426f1990ae74d35d2ac098bcf7d5c09aa5094eeef598dd9658d8fedf97916c4
+  metadata.gz: 4340461612470e8ddff3976af6bf342821a18f1e01c70d5c6d4dcbf08636ac24
+  data.tar.gz: 293967ff3cf8af70f6d9d5f5d20866c77608af41c279590b3abb39966813f048
 SHA512:
-  metadata.gz: faba0041d8c958c3ffa369dbe2d0c5453f8a236bedd0654e362afa65c84093ec22771dadaa9a313e688f6644681267b63f263ba60af9d1b81a211bc3c98a5df1
-  data.tar.gz: a1e8ff40b3377508904ab62980302f129527755512f58506c805d7ae1507977ce65f1c993786cdeffc5f3871e4448e5d4df264979539d60f995d7f9c7b3ece48
+  metadata.gz: 70eedaaa535e97066b5b5b0d80e9c8916ffb6de5ecdf063f7a58d2c984253771742832278e53f5ce8bea3f0f3c7cbdd97da058258e5ace42dda0da372243ff2d
+  data.tar.gz: 72001901b5c82c46bd835521d9a815d178cc6bcea04502fd6b9b10bf36309ed42028b92714fd003e1a0042c60ce9eb4ab505dc627d8dd763f9c6892ff1fee7ea

data/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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)
@@ -20,6 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (11.0.0)
+    openstax_kitchen (11.1.0)
       activesupport
       i18n
       nokogiri

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_chapter_introductions/bake_chapter_objectives.rb

@@ -0,0 +1,46 @@
+# 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
+
+      # 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,56 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterIntroductions
+  class V1
+    def bake(book:)
+      # <b>DEPRECATED:</b> Please use <tt>v2</tt> instead.
+      warn '[DEPRECATION] `BakeChapterIntroductions.v1` is deprecated. Please use `v2` instead.'
+
+      book.chapters.each do |chapter|
+        introduction_page = chapter.introduction_page
+
+        introduction_page.search("div[data-type='description']").trash
+        introduction_page.search("div[data-type='abstract']").trash
+
+        title = introduction_page.title.cut
+        title.name = 'h2'
+        Kitchen::Directions::MoveTitleTextIntoSpan.v1(title: title)
+
+        intro_content = introduction_page.search(
+          "> :not([data-type='metadata']):not(.splash):not(.has-splash)"
+        ).cut
+
+        chapter_objectives_html = 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('')
+
+        chapter_outline =
+          Kitchen::Directions::BakeChapterIntroductions.bake_chapter_outline(
+            chapter_objectives_html: chapter_objectives_html
+          )
+
+        introduction_page.append(child:
+          <<~HTML
+            <div class="intro-body">
+              #{chapter_outline}
+              <div class="intro-text">
+                #{title.paste}
+                #{intro_content.paste}
+              </div>
+            </div>
+          HTML
+        )
+      end
+
+      Kitchen::Directions::BakeChapterIntroductions.v1_update_selectors(book)
+    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_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_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'

data/lib/kitchen/directions/bake_figure.rb

@@ -3,7 +3,7 @@
 module Kitchen
   module Directions
     module BakeFigure
-      def self.v1(figure:, number:)
+      def self.v1(figure:, number:, cases: false)
         return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
 
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
@@ -19,14 +19,16 @@ module Kitchen
           return
         end
 
-        figure.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
+        # 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
             <div class="os-caption-container">
-              <span class="os-title-label">#{I18n.t(:figure)} </span>
+              <span class="os-title-label">#{I18n.t("figure#{'.nominative' if cases}")} </span>
               <span class="os-number">#{number}</span>
               <span class="os-divider"> </span>
               #{"<span class=\"os-title\" data-type=\"title\" id=\"#{title.id}\">#{title.children}</span>" if title}