openstax_kitchen 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e1365bab888949c899b5cb36518be9456bd23d0369ddab9a42ac81f82cc024
-  data.tar.gz: cd86a88028f0946885add3866ffad6133f84ce48a779800cb5105cc8153736d4
+  metadata.gz: 544eb8b780fd248111e4dc9738c32b7edfefc101fbf6abd82f25c01bada69708
+  data.tar.gz: c3f1e2658259f5d9a04dde8aa188793c3c82e8ef6a4f6c1354e2b50d5ed7982d
 SHA512:
-  metadata.gz: 16b9afc1d63a6098aad2396e114975ea35d39890c9a4c27c88dfef7710d129ddf16e3f18d775042ae919d0dff5284d41b53f668621d5cd74f2e723a670fd33d9
-  data.tar.gz: 9b93c51846a460a3e71c6a6080f53be61f1fa93ab268f954ddf3b7d447a1f9602dd789d876bc41e2997f8f44e682453c413f2f28ea7754c4d7f1015d3ecde1a6
+  metadata.gz: 1829a8193fd8d53e2eaa4d91bd00417eb439b1dce3e690b865ff7741d3aad8637282a680f7840842180bfd811cbd79d7275b1c75502fdbcb72d39ed81572b905
+  data.tar.gz: 6cf08743860774a7f7b6fa73d26d4adbc56d7e2849e2178fc020456f113774942d23f7f14f2a5f02393c43cbfa0312b787bbb8a1adbdca4943fd76cb697ff9c0

data/.github/workflows/changelog.yml

@@ -0,0 +1,27 @@
+name: CHANGELOG.md
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+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,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [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)
+* 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)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (5.0.0)
+    openstax_kitchen (6.0.0)
       activesupport
       i18n
       nokogiri
@@ -21,12 +21,12 @@ GEM
     byebug (11.1.2)
     camertron-eprun (1.1.1)
     cldr-plurals-runtime-rb (1.1.0)
-    codecov (0.2.13)
-      simplecov (~> 0.18.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)
@@ -86,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)

data/docker/rubocop

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# set -x
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+from="${1:-main}"
+to="${2:-HEAD}"
+
+echo "Checking from $from to $to"
+
+# 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)
+
+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/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_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_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

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

@@ -2,9 +2,10 @@
 
 module Kitchen::Directions::BakeChapterSectionExercises
   class V1
-    def bake(chapter:)
+    def bake(chapter:, trash_title:)
       chapter.pages.each do |page|
         page.search('section.section-exercises').each do |section|
+          section.first('h3[data-type="title"]')&.trash if trash_title
           section.wrap(
             %(<div class="os-eos os-section-exercises-container"
               data-uuid-key=".section-exercises">)

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+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|
+        exercises = free_response_question.exercises
+        # must run AFTER .free-response notes are baked
+
+        next if exercises.none?
+
+        exercises.each do |exercise|
+          solution = exercise.solution
+          next unless solution.present?
+
+          solution.cut(to: solutions_clipboard)
+        end
+      end
+
+      @content = solutions_clipboard.paste
+
+      @in_composite_chapter = false
+
+      chapter.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -27,15 +27,22 @@ module Kitchen
           # 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'
-            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
-            )
+
+            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

data/lib/kitchen/directions/bake_example.rb

@@ -21,7 +21,10 @@ module Kitchen
                .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
         example.titles.each do |title|
-          next if title.parent.has_class?('os-caption-container')
+          if title.parent.has_class?('os-caption-container') || \
+             title.parent.has_class?('os-caption')
+            next
+          end
 
           title.name = 'h4'
         end

data/lib/kitchen/directions/bake_figure.rb

@@ -4,7 +4,20 @@ module Kitchen
   module Directions
     module BakeFigure
       def self.v1(figure:, number:)
+        return if figure.has_class?('unnumbered') && !figure.has_class?('splash')
+
         figure.wrap(%(<div class="os-figure#{' has-splash' if figure.has_class?('splash')}">))
+        if figure.has_class?('unnumbered') && figure.has_class?('splash')
+          caption = figure.caption&.cut
+          figure.append(sibling:
+            <<~HTML
+              <div class="os-caption-container">
+                #{"<span class=\"os-caption\">#{caption.children}</span>" if caption}
+              </div>
+            HTML
+          )
+          return
+        end
 
         figure.pantry(name: :link_text).store "#{I18n.t(:figure)} #{number}", label: figure.id
         title = figure.title&.cut

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeFootnotes
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, number_format: :arabic)
+        V1.new.bake(book: book, number_format: number_format)
       end
     end
   end

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

@@ -3,37 +3,40 @@
 module Kitchen::Directions::BakeFootnotes
   class V1
 
-    def bake(book:)
+    def bake(book:, number_format: :arabic)
       # Footnotes are numbered either within their top-level pages (preface,
       # appendices, etc) or within chapters. Tackle each case separately
 
       book.body.element_children.only(Kitchen::PageElement,
                                       Kitchen::CompositePageElement,
                                       Kitchen::CompositeChapterElement).each do |page|
-        bake_footnotes_within(page)
+        bake_footnotes_within(page, number_format: number_format)
       end
 
       book.chapters.each do |chapter|
-        bake_footnotes_within(chapter)
+        bake_footnotes_within(chapter, number_format: number_format)
       end
     end
 
-    def bake_footnotes_within(container)
-      footnote_number = 0
+    def bake_footnotes_within(container, number_format:)
+      footnote_count = 0
       aside_id_to_footnote_number = {}
 
       container.search("a[role='doc-noteref']").each do |anchor|
-        footnote_number += 1
-        anchor.replace_children(with: footnote_number.to_s)
+        footnote_count += 1
+        footnote_number = footnote_count.to_format(number_format)
+        anchor.replace_children(with: footnote_number)
         aside_id = anchor[:href][1..-1]
         aside_id_to_footnote_number[aside_id] = footnote_number
+        anchor.parent.add_class('has-noteref') if anchor.parent.name == 'p'
       end
 
       container.search('aside').each do |aside|
         footnote_number = aside_id_to_footnote_number[aside.id]
         aside.prepend(child: "<div data-type='footnote-number'>#{footnote_number}</div>")
       end
-    end
 
+      footnote_count
+    end
   end
 end