openstax_kitchen 6.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 544eb8b780fd248111e4dc9738c32b7edfefc101fbf6abd82f25c01bada69708
-  data.tar.gz: c3f1e2658259f5d9a04dde8aa188793c3c82e8ef6a4f6c1354e2b50d5ed7982d
+  metadata.gz: fca2eb47435f5ff74342d7de2afc02e2c55eed224f1ae669b440d52a1c50b1b0
+  data.tar.gz: f22d42bc7618868d1890e149d9e0bf5134945b8fccce5c7742827e6c53589d81
 SHA512:
-  metadata.gz: 1829a8193fd8d53e2eaa4d91bd00417eb439b1dce3e690b865ff7741d3aad8637282a680f7840842180bfd811cbd79d7275b1c75502fdbcb72d39ed81572b905
-  data.tar.gz: 6cf08743860774a7f7b6fa73d26d4adbc56d7e2849e2178fc020456f113774942d23f7f14f2a5f02393c43cbfa0312b787bbb8a1adbdca4943fd76cb697ff9c0
+  metadata.gz: a457781d0bcb61533c5b96ca0b2ffcde74a69743a54c09f4b901b7e769056d1d616afa736df40067e7472a479c8526505d72fe5d7e9ecf3eca6789581d92c380
+  data.tar.gz: 9f517fbc86ae32e0fd2bbc108774a9f4b94a63df01675530c7f26d7f9bf9522654f4ddb5d7e1c9d141b1a67a0ccc6a98ac2f8c0cf94719ccf04b67cfbf69f240

data/.github/workflows/changelog.yml

@@ -2,9 +2,6 @@ name: CHANGELOG.md
 
 on:
   pull_request:
-  push:
-    branches:
-      - main
 
 jobs:
   exists:

data/CHANGELOG.md

@@ -6,6 +6,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+* Added tags to classnames to optimize searches in `calculus strategy` for `move_solutions_to_answer_key` (minor)
+
+## [8.0.0] - 2021-06-29
+
+* Sort terms in `BakeChapterGlossary` in language specific way (major)
+* Spanish translation change (minor)
+* Fixed the implementation of `Element#wrap_children` to reuse existing document elements (major).
+
+## [7.0.0] - 2021-06-21
+
+* Changed selector expected by `default strategy` in `move_solutions_to_answer_key` to optimize search (major)
+* Fix Rubocop GitHub Action's regular expression used to select files to lint (patch)
+* Add optional numbering to multiple solutions inside examples (minor)
+* Added monkey patch for array to be able to add a prefix: `%w[multiple-choice true-false].prefix('section.')` (minor)
+* Add more specific book part selector (`os-eob`) for References in `is_citation_reference?`, `is_section_reference?` methods in `Element Base` to fix toc selector for References which are moved to EoC (major)
+
+## [6.1.0] - 2021-06-21
+
+* Create a `BakeReferences` V2 for unnumbered section references (minor)
+* Don't check for CHANGELOG when merge a PR to main (patch)
+* Added `BakeInlineLists` (minor)
 
 ## [6.0.0] - 2021-06-15
 
@@ -33,10 +66,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Adds `BakeNumberedNotes` V3 (minor)
 * Added line that puts the classname `has-footnote` in the footnote ref's parent element (major)
 * Added a condition into `BakeChapterSummary` so it doesn't bake the title if it already includes the respective number in it
-* Create v3 of MoveExercisesToEOC which differs from v1 by the presence of a section title
-and from v2 the lack of additional "os-section-area" and os-#{@klass} wrapper (minor)
-* Add a condition in BakeNumberedExercise to make it possible to suppress even solutions in the Answer Key (minor)
-* Fix BakeFurtherResearch baking with main bake script error by breaking the loop if further research sections are not present (minor)
+* Create v3 of `MoveExercisesToEOC` which differs from v1 by the presence of a section title
+and from v2 the lack of additional `os-section-area` and `os-#{@klass} wrapper` (minor)
+* Add a condition in `BakeNumberedExercise` to make it possible to suppress even solutions in the Answer Key (minor)
+* Fix `BakeFurtherResearch` baking with main bake script error by breaking the loop if further research sections are not present (minor)
+* Rework v1 of `BakeChapterReferences` to bake references also from introduction pages (major)
 * Fix for `BakeIndex` for words that start with a number to be grouped as symbols and for first letters with accent marks to be grouped with regular letters in alphabetic order (major)
 
 ## [5.0.0] - 2021-06-02

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (6.0.0)
+    openstax_kitchen (9.0.0)
       activesupport
       i18n
       nokogiri
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/docker/rubocop

@@ -4,13 +4,15 @@
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 
-from="${1:-main}"
-to="${2:-HEAD}"
+commit_range="${1:-main}"
+if [ ! -z "$2" ]; then
+  commit_range="$commit_range..$2"
+fi
 
-echo "Checking from $from to $to"
+echo "Checking $commit_range"
 
 # https://dev.to/scienta/get-changed-files-in-github-actions-1p36
-changed_ruby_files=$(git diff --name-only --diff-filter=ACMRT $from $to | grep -E "(lib\/|spec\/)*.rb$" | xargs)
+changed_ruby_files=$(git diff --name-only --diff-filter=ACMRT $commit_range | grep -E "(lib\/|spec\/).*\.rb$" | xargs)
 
 if [[ -z "${changed_ruby_files// }" ]]; then
   echo "No files to lint with Rubocop"

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

@@ -43,12 +43,29 @@ module Kitchen
       has_class?('os-index-container')
     end
 
-    # Returns true if this page is a book reference
+    # 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
+    # to the reference note at the end of the book.
+    #
+    # Second one is a section with references on the Introduction page that is moved to the EOB.
+    #
+    # Difference in classes is important.
+
+    # Returns true if this page is a book citation reference
+    #
+    # @return [Boolean]
+    #
+    def is_citation_reference?
+      has_class?('os-eob os-reference-container')
+    end
+
+    # Returns true if this page is a book section reference
     #
     # @return [Boolean]
     #
-    def is_reference?
-      has_class?('os-reference-container')
+    def is_section_reference?
+      has_class?('os-eob os-references-container')
     end
 
   end

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

@@ -2,29 +2,43 @@
 
 module Kitchen::Directions::BakeChapterGlossary
   class V1
-    renderable
+    class Definition
+      attr_reader :element
+
+      def initialize(element)
+        term = Kitchen::I18nString.new(element.first('dt').text.downcase)
+        description = Kitchen::I18nString.new(element.first('dd').text.downcase)
+        @sortable = [term, description]
+        @element = element
+      end
+
+      def <=>(other)
+        sortable <=> other.sortable
+      end
+
+      protected
+
+      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
-
-      definitions = chapter.glossaries.search('dl').cut
-      return if definitions.none?
-      definitions.sort_by! do |definition|
-        [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
+      @glossary = []
+
+      chapter.glossaries.search('dl').each do |definition_element|
+        @glossary.push(Definition.new(definition_element.cut))
       end
 
       chapter.glossaries.trash
 
-      @content = definitions.paste
-
-      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,30 @@
 
 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|
+          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>"
-
-      append_to_element = append_to || chapter
-      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+      content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
 
-      append_to_element.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: 'key-concepts',
+        uuid_key: "#{uuid_prefix}key-concepts",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: append_to || chapter
+      )
     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/main.rb

@@ -8,8 +8,7 @@ module Kitchen
           chapter: chapter,
           metadata_source: metadata_source,
           uuid_prefix: uuid_prefix,
-          klass: klass
-        )
+          klass: klass)
       end
     end
   end

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

@@ -2,34 +2,46 @@
 
 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|
-        references = page.references
-        next if references.none?
-
-        references.search('h3').trash
-        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-
-        references.each do |reference|
-          reference.prepend(child: title)
-        end
+        bake_page_references(page: page)
       end
 
-      @content = chapter.pages.references.cut.paste
+      content = chapter.pages.references.cut.paste
 
-      @in_composite_chapter = false
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: chapter
+      )
+    end
 
-      chapter.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+    def bake_page_references(page:)
+      return if page.nil?
+
+      references = page.references
+      return if references.none?
+
+      title = if page.is_introduction?
+                <<~HTML
+                  <a href="##{page.title.id}">
+                    <h3 data-type="document-title" id="#{page.title.copied_id}">
+                      <span class="os-text" data-type="" itemprop="">#{page.title_text}</span>
+                    </h3>
+                  </a>
+                HTML
+              else
+                Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
+              end
+
+      references.each do |reference|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: reference)
+        reference.prepend(child: title)
+      end
     end
   end
 end

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

@@ -2,14 +2,7 @@
 
 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
-
       solutions_clipboard = Kitchen::Clipboard.new
 
       chapter.search('section.free-response').each do |free_response_question|
@@ -26,12 +19,15 @@ module Kitchen::Directions::BakeChapterSolutions
         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,30 @@ 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.first('h3')[:itemprop] = 'name'
             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