openstax_kitchen 4.1.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80bf07271b311949246bf6a63a9d10fe5f14396175f66a129debcc9e9ef15e3
-  data.tar.gz: 7a3a7050d134a0b106d3a80dc18add9209742fca1eea4873f351eb0dd4d05034
+  metadata.gz: 46fe1771e5853e9149dc1df841fafeaba3d3b157ab850d66f94745406867d901
+  data.tar.gz: 1f97e7a288fb5a9c7c96c3f9352238736ac9854a8b0a06379328253f89e9552f
 SHA512:
-  metadata.gz: 7fee3b2b4dd92639af2e20520c3f65a31255d944df649e91c5c0e5c8f0a8e1e1f6d19b4477480c5cbc899f7124727c8a40b5a0759985ec94225885baf36b3287
-  data.tar.gz: ed62932aa44e597135158cc182daefd2773b89070e1d82750669d4d1f760fa8179f1197c67eddcdec73c1cdc2b1bd7537ca28c8f5603d3a2a7962457d777141f
+  metadata.gz: d5a8b103ba036bd0db84ad87857873ff3f6c048c03951e6e5543577330df875025a97338c62b96f6278ca751be81a04be3e95ef6468458fed086e3bdad7adcc3
+  data.tar.gz: ff6c97185d2c264019fe041e17b83678c12f1f894bef9c0d11d01eab304b6a9c3200c2c9e03405267dc462a52775d78b44daa0050a9002ac1ea6bfef1998f111

data/.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: CHANGELOG.md
+
+on:
+  pull_request:
+
+jobs:
+  exists:
+    timeout-minutes: 10
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Check for CHANGELOG.md in this PR
+        # https://dev.to/scienta/get-changed-files-in-github-actions-1p36
+        run: |
+          if [[ $(git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep CHANGELOG.md) ]]; then
+            echo "CHANGELOG.md is included in the pull request! Way to go!"
+            exit 0
+          else
+            echo "CHANGELOG.md was not modified in this pull request.  Boo!"
+            exit 1
+          fi

data/.github/workflows/rubocop.yml

@@ -0,0 +1,28 @@
+name: Rubocop
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    timeout-minutes: 10
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Build docker image and run rubocop within it
+        # See https://docs.codecov.io/docs/testing-with-docker
+        run: |
+          ./docker/build --ci
+          ./docker/rubocop ${{ github.event.pull_request.base.sha }} ${{ github.sha }}

data/CHANGELOG.md

@@ -6,6 +6,68 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [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
+
+* Allow `BakeChapterSummary` to skip pages where there is no summary (minor)
+* Change `PageElement#summary` to return nil instead of raise an error if no matches (major?)
+* Fix bug in `BakeNumberedNotes:::V3` when there are multiple os-numbers (minor)
+* Add Rubocop and a working CHANGELOG check to GitHub actions (patch)
+* Allow `BakeFootnotes` to number footnotes with Roman numerals (minor)
+* Create V2 for `BakeNumberedTables` (minor)
+* Remove extraneous title in `BakeChapterSectionExercises` (minor)
+* Create V2 for `BookAnswerKeyContainer` and `MoveSolutionsToEOC` with singular option for wrapper class (minor)
+* Delete `abstract` and `description` elements from preface in `BakePreface` (minor)
+* Stop deleting the first `<strong>` tag in `BakeNumberedNotes` (major)
+* Allow `BakeFigure` to bake unnumbered splash figures (minor)
+* Extend `ChapterReviewContainer` to accept other classes (major?)
+* Add a `Strategy` for Precalculus (minor)
+* Create a `BakeNumberedNotes` V2 (minor)
+* Added a version of `BakeChapterIntroductions` without a chapter outline (minor)
+* Add `BakeChapterSolutions` which bakes the free response solutions at the eoc (minor)
+* Changed locale `eoc_answer_key_title` to `answer_key_title` as it was only used in eob (major)
+* Added spec for translations (minor)
+* Remove summary attribute from numbered tables, add option to pass title element to `BakePreface` (minor)
+* Renamed `American Government` strategy to `Default` inside `move_solutions_to_answer_key` for other books to use it with a sent in classname (major)
+* Adds `#previous` method to note_elements to find the immediately previous element (minor)
+* 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)
+* 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
+
+* Reditributed duplicated id logic across `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, added a couple more tests for `#copy`, `#cut`, and `#paste`, created a new class `IdTracker` and moved `#record_id_copied`, `#record_id_cut`, `#record_id_pasted`, and `modified_id_to_paste` into the new class (major)
+* Moved selectors from recipe to kitchen on `BakeFirstElements` Direction (minor)
+* Auto-detect language based on document; force output encoding to UTF-8 (major)
+* Switched to using a library to sort strings in a language-specific way (patch)
+* Remove summary attribute from `BakeNumberedTable` (major)
+
 ## [4.1.1] - 2021-05-24
 
 * Adds low level Nokogiri caching, disabled by default (patch)

data/Gemfile.lock

@@ -1,16 +1,17 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (4.1.1)
+    openstax_kitchen (8.0.0)
       activesupport
       i18n
       nokogiri
       rainbow
+      twitter_cldr
 
 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)
@@ -18,12 +19,14 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.2)
-    codecov (0.2.13)
-      simplecov (~> 0.18.0)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.1.0)
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    docile (1.3.3)
+    docile (1.4.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     inch (0.8.0)
@@ -83,10 +86,12 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     sparkr (0.4.1)
     sync (0.5.0)
     tdiff (0.3.4)
@@ -94,6 +99,10 @@ GEM
       tins (~> 1.0)
     tins (1.26.0)
       sync
+    twitter_cldr (6.6.0)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.1)
+      tzinfo
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)

data/docker/rubocop

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# set -x
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+commit_range="${1:-main}"
+if [ ! -z "$2" ]; then
+  commit_range="$commit_range..$2"
+fi
+
+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 $commit_range | grep -E "(lib\/|spec\/).*\.rb$" | xargs)
+
+if [[ -z "${changed_ruby_files// }" ]]; then
+  echo "No files to lint with Rubocop"
+else
+  docker run -v $DIR/..:/code \
+             -w /code \
+             openstax/kitchen.ci:latest \
+             /bin/bash -c "bundle config path vendor/bundle; bundle install; bundle exec rubocop $changed_ruby_files --disable-pending-cops"
+fi

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

@@ -17,7 +17,9 @@ module Kitchen
 
         # Make a section with data-depth of X have a header level of X+1
         page.search('section').each do |section|
-          title = section.first!("[data-type='title']")
+          title = section.titles.first
+          next unless title.present?
+
           title.name = "h#{section['data-depth'].to_i + 1}"
         end
       end

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

@@ -4,21 +4,39 @@ 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
+      @glossary = []
 
-      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]
+      chapter.glossaries.search('dl').each do |definition_element|
+        @glossary.push(Definition.new(definition_element.cut))
       end
 
       chapter.glossaries.trash
 
-      @content = definitions.paste
+      @content = @glossary.sort.map { |definition| definition.element.paste }.join
 
       append_to_element = append_to || chapter
       @in_composite_chapter = append_to_element.is?(:composite_chapter)

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -3,21 +3,31 @@
 module Kitchen
   module Directions
     module BakeChapterIntroductions
-      def self.v1(book:)
+      def self.v1(book:, bake_chapter_objectives: true)
         book.chapters.each do |chapter|
-          outline_items_html = chapter.pages.map do |page|
-            next if page.is_introduction?
+          chapter_outline_html = ''
 
-            <<~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) - 1}</span>
-                  <span class="os-divider"> </span>
-                  <span data-type="" itemprop="" class="os-text">#{page.title.children[0].text}</span>
-                </a>
+          if bake_chapter_objectives
+            outline_items_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_html = <<~HTML
+              <div class="os-chapter-outline">
+                <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
+                #{outline_items_html}
               </div>
             HTML
-          end.join('')
+          end
 
           introduction_page = chapter.introduction_page
 
@@ -33,10 +43,7 @@ module Kitchen
           introduction_page.append(child:
             <<~HTML
               <div class="intro-body">
-                <div class="os-chapter-outline">
-                  <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
-                  #{outline_items_html}
-                </div>
+                #{chapter_outline_html}
                 <div class="intro-text">
                   #{title.paste}
                   #{intro_content.paste}

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeChapterSectionExercises
-      def self.v1(chapter:)
-        V1.new.bake(chapter: chapter)
+      def self.v1(chapter:, trash_title: false)
+        V1.new.bake(chapter: chapter, trash_title: trash_title)
       end
     end
   end