openstax_kitchen 9.1.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df33d6b0ba524fe49e9e5310bcdb730406576a3b88f0462e2eedd932d08fc0cf
-  data.tar.gz: 6a23406fdebb4676c22424d14ab805304789814e84302a685aa245e2bf87f846
+  metadata.gz: 4340461612470e8ddff3976af6bf342821a18f1e01c70d5c6d4dcbf08636ac24
+  data.tar.gz: 293967ff3cf8af70f6d9d5f5d20866c77608af41c279590b3abb39966813f048
 SHA512:
-  metadata.gz: 3af05295d5045ec827b6e817443a4648591d138bc9d3cf697221187e26088badc6c76048f8b3902a167c073c1e9ee94b4c4f48934171428b649c879e23abd95f
-  data.tar.gz: 35ce7b8d16222c5f338d2eb6e9749158980e075b2d09bfa82e034e74bcfad13b748b80bceb1941fc0a8b4d26cf834474a0e7699a7327b55c6e6e42bc1e122024
+  metadata.gz: 70eedaaa535e97066b5b5b0d80e9c8916ffb6de5ecdf063f7a58d2c984253771742832278e53f5ce8bea3f0f3c7cbdd97da058258e5ace42dda0da372243ff2d
+  data.tar.gz: 72001901b5c82c46bd835521d9a815d178cc6bcea04502fd6b9b10bf36309ed42028b92714fd003e1a0042c60ce9eb4ab505dc627d8dd763f9c6892ff1fee7ea

data/CHANGELOG.md

@@ -6,6 +6,69 @@ 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)
+* 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)
+* Add `has_para` option to `BakeChapterGlossary` for books from Adaptarr (minor)
+* Create `BakeListsWithPara` to remove paragraphs from lists in books created by Adaptarr (minor)
+* Create `Strategy::ContemporaryMath` (minor)
+* Stop `BakeTableBody` from blowing up when table doesn't have an ID (patch)
+* Refactor `MoveExercisesToEOC::V2` & `BakeChapterKeyConcepts` to use `MoveCustomSectionToEocContainer` (minor)
+* Add wrapper support for `MoveCustomSectionToEocContainer` (minor)
+* Create `BakeHandbook` direction (minor)
+* Add `ExampleElement#titles_to_rename` & refactor `BakeExample` (patch)
+* Create `BakeUnitPageTitle` (minor)
+* Fix `BakeExample` to skip baked exercises (patch)
+* Add `FigureElement#figure_to_bake?` (minor)
+* Remove `itemprop` attribute from `BakeChapterSummary` and `BakeFurtherResearch` (major)
+* Fix `NoteElement#title` to exclude nested element titles (patch)
+* Remove `BakeTheorem` (minor)
+* Allow `BakeChapterSolutions` to bake solutions from multiple sections (minor)
+* Add `.os-problem-container` to `BakeFirstElement` selectors (minor)
+* Tweak `BakeExample` to not touch unbaked titles in captions (minor/patch)
+* Tweak `BakeNumberedTables.v1` to cut extra white space (minor)
+
+## [9.2.0] - 2021-07-19
+
+* Update `BakeFirstElements` to also add the `.has-first-inline-list` class (minor)
+
 ## [9.1.0] - 2021-07-16
 
 * Add `BakeNoteIFrames` direction (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (9.1.0)
+    openstax_kitchen (11.1.0)
       activesupport
       i18n
       nokogiri
@@ -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]

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

@@ -5,12 +5,13 @@ module Kitchen
     # Bake directons for eoc glossary
     #
     module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil, has_para: false)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
           append_to: append_to,
-          uuid_prefix: uuid_prefix
+          uuid_prefix: uuid_prefix,
+          has_para: has_para
         )
       end
     end

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

@@ -21,9 +21,18 @@ module Kitchen::Directions::BakeChapterGlossary
       attr_reader :sortable
     end
 
-    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '', has_para: false)
       @glossary = []
 
+      # Use for books created by Adaptarr, where dd contains paragraphs
+      # More info: https://github.com/openstax/kitchen/issues/284
+      if has_para
+        chapter.glossaries.search('dd').each do |description|
+          description_content = description.first('p').text
+          description.replace_children with: description_content
+        end
+      end
+
       chapter.glossaries.search('dl').each do |definition_element|
         @glossary.push(Definition.new(definition_element.cut))
       end

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