openstax_kitchen 8.0.1 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c444687ca21462df4d8110fd8789f10ba40a439b5d037b3eba8d255b5e16fa
-  data.tar.gz: 353afbf616ae3f9794ee13594cf9baa244fbc1077e55c78c193aac1a89cefffd
+  metadata.gz: 3a071ba6e289c222a7333f401c7d6bd25d6dba9527253b6c6ae123169d9b6425
+  data.tar.gz: 2debc535f61a289f6668019f1eeb5cd639efaf8d49172d668f8b602e02e91b07
 SHA512:
-  metadata.gz: 0b52d4418f83bdacfac36d7d6c904500cd4bb965795f91e718c6588e0f27c72eb5b73d9b05db9f2bafa60711717c93888a0d09ced10c6986e7ec0a83d7283a31
-  data.tar.gz: 34ebd35add4868907853f3a3e4cc839f521352d3eadc763350487e5a7f372f947e6e837d0fea7ad198810d968c1e1bfc7a591f515b65218253c084db21b85a45
+  metadata.gz: 6bfeae3a664c95c17249ab32a8bba863091fb1e23f501273fd57d9752688c29ba9877b5a6404393dc88ae993f16af3f89fa768e3984cf81233908ab238b0350a
+  data.tar.gz: '086fa06f8f7eb33f3908c15ba0172a02a1738c943ba87b25245f63626cda51e5163edbece95cdce2ce1907d5815aefd179db7fb7e3a4fe2a7165c623c5120ede'

data/CHANGELOG.md

@@ -6,6 +6,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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)
+* 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)
+* Add a `EocCompositePageContainer` direction to handle creation of eoc page wrapper (minor)
+* Refactor `BakeChapterKeyEquations`, `BakeChapterGlossary`, `BakeChapterSummary`, `BakeFurtherResearch` (major)
+* Fix metadata title in composite pages (major)
 
 ## [8.0.1] - 2021-06-29
 

data/Gemfile.lock

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

data/lib/kitchen/chapter_element.rb

@@ -52,14 +52,6 @@ module Kitchen
       search("div[data-type='glossary']")
     end
 
-    # Returns an enumerator for the key equations
-    #
-    # @return [ElementEnumerator]
-    #
-    def key_equations
-      search('section.key-equations')
-    end
-
     # Returns an enumerator for the abstracts
     #
     # @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/.rubocop.yml

@@ -15,6 +15,9 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Metrics/ParameterLists:
+  Max: 5
+
 Style/ClassAndModuleChildren:
   Enabled: false
 

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

@@ -2,8 +2,6 @@
 
 module Kitchen::Directions::BakeChapterGlossary
   class V1
-    renderable
-
     class Definition
       attr_reader :element
 
@@ -23,26 +21,33 @@ module Kitchen::Directions::BakeChapterGlossary
       attr_reader :sortable
     end
 
-    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'glossary'
-      @title = I18n.t(:eoc_key_terms_title)
-      @uuid_prefix = 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
 
       chapter.glossaries.trash
 
-      @content = @glossary.sort.map { |definition| definition.element.paste }.join
-
-      append_to_element = append_to || chapter
-      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+      content = @glossary.sort.map { |definition| definition.element.paste }.join
 
-      append_to_element.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: 'glossary',
+        uuid_key: "#{uuid_prefix}glossary",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: append_to || chapter
+      )
     end
   end
 end

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

@@ -2,34 +2,21 @@
 
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
-    renderable
     def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'key-concepts'
-      @title = I18n.t(:eoc_key_concepts)
-      @uuid_prefix = 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?
-
-        key_concepts.search('h3').trash
-        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-        key_concepts.each do |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
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
+        container_key: 'key-concepts',
+        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)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: section.ancestor(:page))
+        section.prepend(child: title)
       end
-
-      @content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
-
-      append_to_element = append_to || chapter
-      @in_composite_chapter = append_to_element.is?(:composite_chapter)
-
-      append_to_element.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
     end
   end
 end

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -15,24 +15,17 @@ module Kitchen
       end
 
       class V1
-        renderable
         def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
-          @metadata = metadata_source.children_to_keep.copy
-          @klass = 'key-equations'
-          @title = I18n.t(:eoc_key_equations)
-          @uuid_prefix = uuid_prefix
-
-          chapter.key_equations.search('h3').trash
-
-          return if chapter.key_equations.none?
-
-          @content = chapter.key_equations.cut.paste
-
-          append_to_element = append_to || chapter
-          @in_composite_chapter = append_to_element.is?(:composite_chapter)
-
-          append_to_element.append(child: render(file:
-            '../templates/eoc_section_title_template.xhtml.erb'))
+          MoveCustomSectionToEocContainer.v1(
+            chapter: chapter,
+            metadata_source: metadata_source,
+            container_key: 'key-equations',
+            uuid_key: "#{uuid_prefix}key-equations",
+            section_selector: 'section.key-equations',
+            append_to: append_to
+          ) do |section|
+            RemoveSectionTitle.v1(section: section)
+          end
         end
       end
     end

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

@@ -2,25 +2,22 @@
 
 module Kitchen::Directions::BakeChapterReferences
   class V1
-    renderable
-
     def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = klass
-      @title = I18n.t(:references)
-      @uuid_prefix = uuid_prefix
-
-      chapter.references.search('h3').trash
-
       bake_page_references(page: chapter.introduction_page)
 
       chapter.non_introduction_pages.each do |page|
         bake_page_references(page: page)
       end
 
-      @content = chapter.pages.references.cut.paste
-      chapter.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+      content = chapter.pages.references.cut.paste
+
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: chapter
+      )
     end
 
     def bake_page_references(page:)
@@ -42,6 +39,7 @@ module Kitchen::Directions::BakeChapterReferences
               end
 
       references.each do |reference|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: reference)
         reference.prepend(child: title)
       end
     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,36 +2,34 @@
 
 module Kitchen::Directions::BakeChapterSolutions
   class V1
-    renderable
-
-    def bake(chapter:, metadata_source:, uuid_prefix: '')
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'solutions'
-      @title = I18n.t(:eoc_solutions_title)
-      @uuid_prefix = 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
 
-      @content = solutions_clipboard.paste
-
-      @in_composite_chapter = false
+      content = solutions_clipboard.paste
 
-      chapter.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: 'solutions',
+        uuid_key: "#{uuid_prefix}solutions",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: chapter
+      )
     end
   end
 end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -15,52 +15,29 @@ module Kitchen
       end
 
       class V1
-        renderable
         def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
-          @metadata = metadata_source.children_to_keep.copy
-          @klass = klass
-          @title = I18n.t(:eoc_summary_title)
-          @uuid_prefix = uuid_prefix
-
           summaries = Clipboard.new
 
-          # TODO: include specific page types somehow without writing it out
           chapter.non_introduction_pages.each do |page|
             summary = page.summary
 
             next if summary.nil?
 
             summary.first("[data-type='title']")&.trash # get rid of old title if exists
-            summary_title = page.title.copy
-            summary_title.name = 'h3'
-
-            unless summary_title.children.search('span.os-number').present?
-              summary_title.replace_children(with:
-                <<~HTML
-                  <span class="os-number">#{chapter.count_in(:book)}.#{page.count_in(:chapter)}</span>
-                  <span class="os-divider"> </span>
-                  <span class="os-text" data-type="" itemprop="">#{summary_title.children}</span>
-                HTML
-              )
-            end
-
-            summary.prepend(child:
-              <<~HTML
-                <a href="##{page.title.id}">
-                  #{summary_title.paste}
-                </a>
-              HTML
-            )
+            title = EocSectionTitleLinkSnippet.v1(page: page)
+            summary.prepend(child: title)
             summary.cut(to: summaries)
           end
 
           return if summaries.none?
 
-          @content = summaries.paste
-          @in_composite_chapter = false
-
-          chapter.append(child: render(file:
-            '../templates/eoc_section_title_template.xhtml.erb'))
+          EocCompositePageContainer.v1(
+            container_key: klass,
+            uuid_key: "#{uuid_prefix}#{klass}",
+            metadata_source: metadata_source,
+            content: summaries.paste,
+            append_to: chapter
+          )
         end
       end
     end