openstax_kitchen 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 544eb8b780fd248111e4dc9738c32b7edfefc101fbf6abd82f25c01bada69708
-  data.tar.gz: c3f1e2658259f5d9a04dde8aa188793c3c82e8ef6a4f6c1354e2b50d5ed7982d
+  metadata.gz: 68b22024e79d8b530195dafc0dba4b939f7c5503023ae1fbc1ee876a038595d9
+  data.tar.gz: 4a35e7fdbae28ecadd234c1aff6596ef61ec4aaffd4adf2a29bc401ed54b7576
 SHA512:
-  metadata.gz: 1829a8193fd8d53e2eaa4d91bd00417eb439b1dce3e690b865ff7741d3aad8637282a680f7840842180bfd811cbd79d7275b1c75502fdbcb72d39ed81572b905
-  data.tar.gz: 6cf08743860774a7f7b6fa73d26d4adbc56d7e2849e2178fc020456f113774942d23f7f14f2a5f02393c43cbfa0312b787bbb8a1adbdca4943fd76cb697ff9c0
+  metadata.gz: 34d9856998c75fee77bc41b734399ffc3045a93082cba273b636b10411b852ee71f4e9bda86a38108e9293f53136194d3c85cb12ea5c92159d571c64d2b85044
+  data.tar.gz: d29fd215321a1ab877c16083b73bb0b872ee67c68a636425e6ef5ded5d8fd9ff7ae77599ec1d9a500e69ad627f175ac7c5fb1194310b8e0979d0cc7160403b55

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,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
 
@@ -37,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 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 (6.1.0)
       activesupport
       i18n
       nokogiri

data/lib/kitchen/composite_page_element.rb

@@ -43,13 +43,30 @@ 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_reference?
+    def is_citation_reference?
       has_class?('os-reference-container')
     end
 
+    # Returns true if this page is a book section reference
+    #
+    # @return [Boolean]
+    #
+    def is_section_reference?
+      has_class?('os-references-container')
+    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

@@ -12,24 +12,38 @@ module Kitchen::Directions::BakeChapterReferences
 
       chapter.references.search('h3').trash
 
-      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)
+      bake_page_references(page: chapter.introduction_page)
 
-        references.each do |reference|
-          reference.prepend(child: title)
-        end
+      chapter.non_introduction_pages.each do |page|
+        bake_page_references(page: page)
       end
 
       @content = chapter.pages.references.cut.paste
-
-      @in_composite_chapter = false
-
       chapter.append(child: render(file:
         '../../templates/eoc_section_title_template.xhtml.erb'))
     end
+
+    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|
+        reference.prepend(child: title)
+      end
+    end
   end
 end

data/lib/kitchen/directions/bake_inline_lists.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bakes inline lists with the desired list separator
+    # Does not separate the last list item
+    #
+    module BakeInlineLists
+      LIST_SEPARATOR = '; '
+      SEPARATOR_CLASS = '-os-inline-list-separator'
+
+      def self.v1(book:)
+        inline_lists = book.search('span[data-display="inline"][data-type="list"]')
+        inline_lists.each do |list|
+          list.search('span[data-type="item"]')[0..-2].each do |item|
+            item.append(child: "<span class=\"#{SEPARATOR_CLASS}\">#{LIST_SEPARATOR}</span>")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,13 @@ module Kitchen
           metadata_source: metadata_source
         )
       end
+
+      def self.v2(book:, metadata_source:)
+        V2.new.bake(
+          book: book,
+          metadata_source: metadata_source
+        )
+      end
     end
   end
 end

data/lib/kitchen/directions/bake_references/v2.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V2
+    renderable
+
+    def bake(book:, metadata_source:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'references'
+      @uuid_prefix = '.'
+      @title = I18n.t(:references)
+
+      book.chapters.each do |chapter|
+
+        chapter.references.search('h3').trash
+
+        chapter_references = chapter.pages.references.cut
+        chapter_title_no_num = chapter.title.search('.os-text')
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-chapter-area">
+              <h2 data-type="document-title">#{chapter_title_no_num}</h2>
+              #{chapter_references.paste}
+            </div>
+          HTML
+        )
+      end
+      chapter_area_references = book.chapters.search('.os-chapter-area').cut
+      @content = chapter_area_references.paste
+      book.body.append(child: render(file:
+        '../../templates/eob_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -96,8 +96,10 @@ module Kitchen
           when CompositePageElement
             if page.is_index?
               'os-toc-index'
-            elsif page.is_reference?
+            elsif page.is_citation_reference?
               'os-toc-reference'
+            elsif page.is_section_reference?
+              'os-toc-references'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 end

data/lib/locales/pl.yml

@@ -22,4 +22,5 @@ pl:
   eoc_key_equations: Najważniejsze wzory
   eob_index_title: Skorowidz rzeczowy
   eob_index_symbols_group: Symbole
+  references: Bibliografia
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -276,6 +276,7 @@ files:
 - lib/kitchen/directions/bake_index/main.rb
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
+- lib/kitchen/directions/bake_inline_lists.rb
 - lib/kitchen/directions/bake_link_placeholders.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
 - lib/kitchen/directions/bake_non_introduction_pages.rb
@@ -297,6 +298,7 @@ files:
 - lib/kitchen/directions/bake_preface/v1.rb
 - lib/kitchen/directions/bake_references/main.rb
 - lib/kitchen/directions/bake_references/v1.rb
+- lib/kitchen/directions/bake_references/v2.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_theorem/main.rb