openstax_kitchen 9.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca2eb47435f5ff74342d7de2afc02e2c55eed224f1ae669b440d52a1c50b1b0
-  data.tar.gz: f22d42bc7618868d1890e149d9e0bf5134945b8fccce5c7742827e6c53589d81
+  metadata.gz: e6964a7fe85234e82e7f54f3b6d4980633f4f4c29c49d3123743c214d9f46653
+  data.tar.gz: 2426f1990ae74d35d2ac098bcf7d5c09aa5094eeef598dd9658d8fedf97916c4
 SHA512:
-  metadata.gz: a457781d0bcb61533c5b96ca0b2ffcde74a69743a54c09f4b901b7e769056d1d616afa736df40067e7472a479c8526505d72fe5d7e9ecf3eca6789581d92c380
-  data.tar.gz: 9f517fbc86ae32e0fd2bbc108774a9f4b94a63df01675530c7f26d7f9bf9522654f4ddb5d7e1c9d141b1a67a0ccc6a98ac2f8c0cf94719ccf04b67cfbf69f240
+  metadata.gz: faba0041d8c958c3ffa369dbe2d0c5453f8a236bedd0654e362afa65c84093ec22771dadaa9a313e688f6644681267b63f263ba60af9d1b81a211bc3c98a5df1
+  data.tar.gz: a1e8ff40b3377508904ab62980302f129527755512f58506c805d7ae1507977ce65f1c993786cdeffc5f3871e4448e5d4df264979539d60f995d7f9c7b3ece48

data/CHANGELOG.md

@@ -6,9 +6,58 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 `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)
+* Selector optimization in precalculus `Strategy` & elsewhere (patch)
+* Tweaks inline list seperators to only target labeled items (major?)
+* Add definition of handbook page selector needed for BakeToc, create a link class for this page (minor)
+
 ## [9.0.0] - 2021-07-12
 
-* Refactor `BakeChapterKeyConcepts`, `BakeChapterReferences`, `BakeChapterSolutions`, and `MoveExercisesToEoc` versions 1-3 to use new general eoc directions (major?)
+* Refactor `BakeChapterKeyConcepts`, `BakeChapterReferences`, `BakeChapterSolutions`, and `MoveExercisesToEoc` versions 1-3 to use new general eoc directions (major)
 * Fixed `BakeExample.v1` to also search inside `.body` for titles (minor)
 * Add documentation to `MoveCustomSectionToEocContainer` & `EocCompositePageContainer` (minor)
 * Add a `MoveCustomSectionToEocContainer` to allow for custom sections (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (9.0.0)
+    openstax_kitchen (11.0.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

@@ -29,10 +29,8 @@ module Kitchen
     # @return [Element]
     #
     def title
-      # Get the title in the immediate children, not the one in the metadata.  Could use
-      # CSS of ":not([data-type='metadata']) > [data-type='document-title'], [data-type='document-title']"
-      # but xpath is shorter
-      first!("./*[@data-type = 'document-title' or @data-type = 'title']")
+      first!('h3[data-type="title"], h2[data-type="document-title"],' \
+             'h1[data-type="document-title"]')
     end
 
     # Returns true if this page is a book index

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

@@ -3,29 +3,19 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
-      key_concepts_clipboard = Kitchen::Clipboard.new
-      chapter.non_introduction_pages.each do |page|
-        key_concepts = page.key_concepts
-        next if key_concepts.none?
-
-        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-        key_concepts.each do |key_concept|
-          Kitchen::Directions::RemoveSectionTitle.v1(section: key_concept)
-          key_concept.prepend(child: title)
-          key_concept.wrap("<div class='os-section-area'>")
-          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
-        end
-      end
-
-      content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
-
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
         container_key: 'key-concepts',
         uuid_key: "#{uuid_prefix}key-concepts",
-        metadata_source: metadata_source,
-        content: content,
-        append_to: append_to || chapter
-      )
+        section_selector: 'section.key-concepts',
+        append_to: append_to || chapter,
+        wrap_section: true, wrap_content: true
+      ) do |section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: section)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: section.ancestor(:page))
+        section.prepend(child: title)
+      end
     end
   end
 end

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

@@ -3,9 +3,7 @@
 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
 

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterSolutions
-      def self.v1(chapter:, metadata_source:, uuid_prefix: '')
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, uuid_prefix: uuid_prefix)
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          classes: classes
+        )
       end
     end
   end

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

@@ -2,20 +2,22 @@
 
 module Kitchen::Directions::BakeChapterSolutions
   class V1
-    def bake(chapter:, metadata_source:, uuid_prefix: '')
+    def bake(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
       solutions_clipboard = Kitchen::Clipboard.new
 
-      chapter.search('section.free-response').each do |free_response_question|
-        exercises = free_response_question.exercises
-        # must run AFTER .free-response notes are baked
+      classes.each do |klass|
+        chapter.search("section.#{klass}").each do |question|
+          exercises = question.exercises
+          # must run AFTER the other sections are baked
 
-        next if exercises.none?
+          next if exercises.none?
 
-        exercises.each do |exercise|
-          solution = exercise.solution
-          next unless solution.present?
+          exercises.each do |exercise|
+            solution = exercise.solution
+            next unless solution.present?
 
-          solution.cut(to: solutions_clipboard)
+            solution.cut(to: solutions_clipboard)
+          end
         end
       end
 

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?
@@ -26,7 +26,6 @@ module Kitchen
             summary.first("[data-type='title']")&.trash # get rid of old title if exists
             title = EocSectionTitleLinkSnippet.v1(page: page)
             summary.prepend(child: title)
-            summary.first('h3')[:itemprop] = 'name'
             summary.cut(to: summaries)
           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_example.rb

@@ -20,18 +20,14 @@ module Kitchen
                .pantry(name: :link_text)
                .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
-        example.titles.each do |title|
-          if title.parent.has_class?('os-caption-container') || \
-             title.parent.has_class?('os-caption')
-            next
-          end
-
+        example.titles_to_rename.each do |title|
           title.name = 'h4'
         end
 
         example.exercises.each do |exercise|
+          next if exercise.baked?
+
           if (problem = exercise.problem)
-            problem.titles.each { |title| title.name = 'h4' }
             problem.wrap_children(class: 'os-problem-container')
           end
 
@@ -54,10 +50,12 @@ module Kitchen
 
           exercise.add_class('unnumbered')
 
-          commentary = exercise.first('[data-type="commentary"]')
+          commentary = exercise.first('div[data-type="commentary"]')
           next unless commentary.present?
 
           commentary_title = commentary.titles.first
+          next unless commentary_title.present?
+
           commentary_title.name = 'h4'
           commentary_title['data-type'] = 'commentary-title'
           commentary_title.wrap_children('span', class: 'os-title-label')

data/lib/kitchen/directions/bake_first_elements.rb

@@ -3,12 +3,15 @@
 module Kitchen
   module Directions
     module BakeFirstElements
-      def self.v1(within:)
+      def self.v1(within:, first_inline_list: false)
+        # add has-first-element class
         selectors = [
           'div.os-problem-container > div.os-table',
           'div.os-problem-container > span[data-type="media"]',
+          'div.os-problem-container > div.os-figure',
           'div.os-solution-container > div.os-table',
-          'div.os-solution-container > span[data-type="media"]'
+          'div.os-solution-container > span[data-type="media"]',
+          'div.os-solution-container > div.os-figure'
         ]
         selectors.each do |selector|
           within.search("#{selector}:first-child").each do |problem|
@@ -16,6 +19,16 @@ module Kitchen
             problem.parent.add_class('has-first-element')
           end
         end
+
+        return unless first_inline_list
+
+        # add first-inline-element class
+        inline_selector = 'div.os-solution-container > ol[type="1"]:first-child,' \
+                          'div.os-problem-container > ol[type="1"]:first-child'
+        within.search(inline_selector).each do |inline_list|
+          inline_list.add_class('first-inline-list-element')
+          inline_list.parent.add_class('has-first-inline-list-element')
+        end
       end
     end
   end

data/lib/kitchen/directions/bake_folio.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeFolio
+      def self.v1(book:)
+        book['data-pdf-folio-preface-message'] = I18n.t(:"folio.preface")
+        book['data-pdf-folio-access-message'] = I18n.t(:"folio.access_for_free")
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Kitchen::Directions::BakeFreeResponse
       @metadata_elements = metadata_source.children_to_keep.copy
 
       @free_response_clipboard = Kitchen::Clipboard.new
-      chapter.non_introduction_pages.each do |page|
+      chapter.pages.each do |page|
         free_response_questions = page.free_response
         next if free_response_questions.none?
 

data/lib/kitchen/directions/bake_further_research.rb

@@ -20,13 +20,11 @@ module Kitchen
             container_key: 'further-research',
             uuid_key: "#{uuid_prefix}further-research",
             section_selector: 'section.further-research',
-            append_to: nil,
-            include_intro_page: false
+            append_to: nil
           ) do |further_research|
             RemoveSectionTitle.v1(section: further_research)
             title = EocSectionTitleLinkSnippet.v1(page: further_research.ancestor(:page))
             further_research.prepend(child: title)
-            further_research.first('h3')[:itemprop] = 'name'
           end
         end
       end