openstax_kitchen 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f404296c40eba5dbfdeeb4c4de0d11492eb327e94d49c96689b262a03bc838de
-  data.tar.gz: b97faf532e7e098dba23ef1d1f3c42ca7c051d7fc6ad8351fa6b20209cb99ddd
+  metadata.gz: 994e6a3d5161afbcd853fe2b432e7aeb80bf2390d4d7b7ae8463e6da8ce21f15
+  data.tar.gz: 7c276963aaa777b1e6116b98a9af0659f8b4e9c1491a3fe968bd9f15fc46f61c
 SHA512:
-  metadata.gz: 7f8e774352355cc44b01765b101e97db3128e19e7416a6d5138d0a83db4378e7910d196e42849237e2130c6f7463db6f13679d53ac666b6a0abf6f867ecf6a36
-  data.tar.gz: 84fece5f5d36f16324022d3ca34b6827f6549bed21551caedbb2845ff41d5b7b1f4b47c8e07a6fac6b14ed2e5f092435b63618a3b9e0f925a40cda21b04babfb
+  metadata.gz: a0041d04e8a1e39295c21ed0884db3e1b838edac90c7c317409b3499e1e2d5744450d26ccb1518a55c7cf6ec39a35b278e03781b8f9933486d789583b9c39bdd
+  data.tar.gz: f9207ee80e17ae3035d2c29cca11f4d59e10afc7193e73f751763fb27987477e7cffcc914166927d196484c0c82767d3c1302bca92a64098d4eb2674edb83843

data/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2021-04-19
+
+* Add the ability to copy an element's ID to `ElementBase` (minor)
+* Create `pl.yml` and add pl to available locals in `StubHelpers` module (minor)
+* Add to `BakeNumberedNotes` directions for baking exercises in a note (with this comes removing bake checkpoints and theorems)
+* Add `BakeEquations` direction (minor)
+* Remove `NoteElement` logging (minor)
+* Adds `BakeChapterReviewExercises` v2 and a u-physics `Strategy` to `BakeChapterAnswerKey` to support baking exercises in u-physics (minor)
+* Have deprecated directions log a warning (minor)
+* Added `wrap_children` method on elements (minor)
+* Refactored `NoteElement` to infer the note title from book-specific locales (minor)
+* Added support for a recipe to infer or be given a book-specific locale file (minor)
+* Added `NumberedTable` support for titles and always captions (minor)
+* Added titles method to `ElementEnumeratorBase` and `ElementBase` (minor)
+* Added a file for baking composite chapters called (`bake_composite_chapters`) and the respective spec.
+(minor change)
+* Added `BakeProblemFirstElements` direction (minor)
+
 ## [3.0.0] - 2021-03-17
 
 * Added a subfigure? method to `FigureElements`(minor)
@@ -19,11 +37,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added ability to filter searches based on `only` and `except` conditions, which can be names of element methods or blocks of code (minor)
 * Changed from tracking and using `css_or_xpath` strings and arrays to `search_query` objects that
   wrap `css_or_xpath` variables along with `only` and `except` conditions. (major?)
+* Refactored bake_exercises to better support parallel work on multiple versions. (minor)
 
 ## [2.0.0] - 2020-12-18
-
-* Refactored bake_exercises to better support parallel work on multiple versions.
-(minor change) Does not affect existing recipes.
+* Added a file for baking key concepts called (`bake_chapter_key_concepts`) and the respective specs.
+(minor change) only affects the book if called from the recipe
 * Changed the main gem source file to have the same name as the gem (`openstax_kitchen`) so that you don't have to `require` a different name than you use in your `gem` call.
 
 ## [1.0.0] - 2020-12-15

data/Gemfile.lock

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

data/README.md

@@ -210,6 +210,13 @@ And we can wrap an element with another element:
 doc.search("span").first.wrap("<span class='other'>")
 ```
 
+or wrap an element's children:
+
+```ruby
+# <div><span>Hi</span></div> => <div><span><span class="other" data-type="foo">Hi</span></span></div>
+doc.search("span").first.wrap_children('span', class: 'other', data_type: 'foo')
+```
+
 ### Checking for elements
 
 You can see if an element contains an element matching a selector:

data/lib/kitchen/directions/bake_book_answer_key/eob_solutions_container.xhtml.erb

@@ -0,0 +1,9 @@
+<div class="os-eob os-solutions-container" data-type="composite-chapter" data-uuid-key=".solutions">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_answer_key_title) %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_answer_key_title) %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeBookAnswerKey
+      def self.v1(book:)
+        V1.new.bake(book: book)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeBookAnswerKey
+  class V1
+    renderable
+
+    def bake(book:)
+      @metadata = book.metadata.children_to_keep.copy
+      book.body.append(child: render(file: 'eob_solutions_container.xhtml.erb'))
+      book.body.first('.os-eob.os-solutions-container')
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterAnswerKey
+      def self.v1(chapter:, metadata_source:, strategy:, append_to:)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          strategy: strategy, append_to: append_to)
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_answer_key/strategies/calculus.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterAnswerKey
+  module Strategies
+    class Calculus
+      def bake(chapter:, append_to:)
+        checkpoint_solutions = chapter.search('.checkpoint [data-type="solution"]').cut
+        append_solution_area(I18n.t(:checkpoint), checkpoint_solutions, append_to)
+
+        chapter.search('.section-exercises').each do |section|
+          section_solutions = section.search('[data-type="solution"]').cut
+          section_title = I18n.t(
+            :section_exercises,
+            number: "#{chapter.count_in(:book)}.#{section.count_in(:chapter)}"
+          )
+          append_solution_area(section_title, section_solutions, append_to)
+        end
+
+        chapter.search('.review-exercises').each do |section|
+          section_solutions = section.search('[data-type="solution"]').cut
+          append_solution_area(I18n.t(:review_exercises), section_solutions, append_to)
+        end
+      end
+
+      protected
+
+      def append_solution_area(title, clipboard, append_to)
+        append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{title}</span>
+              </h3>
+              #{clipboard.paste}
+            </div>
+          HTML
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_answer_key/strategies/uphysics.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterAnswerKey
+  module Strategies
+    class UPhysics
+      def bake(chapter:, append_to:)
+        bake_from_notes(chapter: chapter, append_to: append_to, klass: 'check-understanding')
+
+        classes = %w[review-conceptual-questions review-problems review-additional-problems
+                     review-challenge]
+        classes.each do |klass|
+          bake_section(chapter: chapter, append_to: append_to, klass: klass)
+        end
+      end
+
+      protected
+
+      def bake_section(chapter:, append_to:, klass:)
+        section_solutions_set = []
+        chapter.search(".#{klass}").each do |section|
+          section.search('[data-type="solution"]').each do |solution|
+            section_solutions_set.push(solution.cut)
+          end
+        end
+
+        return if section_solutions_set.empty?
+
+        title = I18n.t(:"eoc.#{klass}")
+        append_solution_area(title, section_solutions_set, append_to)
+      end
+
+      def bake_from_notes(chapter:, append_to:, klass:)
+        solutions = []
+        chapter.notes(".#{klass}").each do |note|
+          solution = note.exercises.first.solution
+          solutions.push(solution.cut) if solution
+        end
+        return if solutions.empty?
+
+        title = I18n.t(:"notes.#{klass}")
+        append_solution_area(title, solutions, append_to)
+      end
+
+      def append_solution_area(title, solutions, append_to)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              <h3 data-type="title">
+                <span class="os-title-label">#{title}</span>
+              </h3>
+            </div>
+          HTML
+        ).first
+
+        solutions.each do |solution|
+          append_to.add_child(solution.raw)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterAnswerKey
+  class V1
+    def bake(chapter:, metadata_source:, strategy:, append_to:)
+      strategy =
+        case strategy
+        when :calculus
+          Strategies::Calculus
+        when :uphysics
+          Strategies::UPhysics
+        else
+          raise 'No such strategy'
+        end
+
+      append_to.append(child:
+        <<~HTML
+          <div class="os-eob os-solutions-container" data-type="composite-page" data-uuid-key=".solutions#{chapter.count_in(:book)}">
+            <h2 data-type="document-title">
+              <span class="os-text">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</span>
+            </h2>
+            <div data-type="metadata" style="display: none;">
+              <h1 data-type="document-title" itemprop="name">#{I18n.t(:chapter)} #{chapter.count_in(:book)}</h1>
+              #{metadata_source.children_to_keep.copy.paste}
+            </div>
+          </div>
+        HTML
+      )
+      strategy.new.bake(chapter: chapter, append_to: append_to.last_element)
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_glossary.rb

@@ -5,7 +5,7 @@ module Kitchen
     # Bake directons for eoc glossary
     #
     module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:)
+      def self.v1(chapter:, metadata_source:, append_to: nil)
         metadata_elements = metadata_source.children_to_keep.copy
 
         definitions = chapter.glossaries.search('dl').cut
@@ -17,7 +17,9 @@ module Kitchen
 
         return if definitions.none?
 
-        chapter.append(child:
+        append_to_element = append_to || chapter
+
+        append_to_element.append(child:
           <<~HTML
             <div class="os-eoc os-glossary-container" data-type="composite-page" data-uuid-key="glossary">
               <h2 data-type="document-title">

data/lib/kitchen/directions/bake_chapter_key_concepts/key_concepts.xhtml.erb

@@ -0,0 +1,16 @@
+<div class="os-eoc os-key-concepts-container" data-type="composite-page" data-uuid-key=".key-concepts">
+  <h2 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_key_concepts) %></span>
+  </h2>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_key_concepts) %></h1>
+    <%= @metadata_elements.paste %>
+  </div>
+  <div class="os-key-concepts">
+    <% @key_concepts.each do |key_concept| %>
+      <div class="os-section-area">
+        <%= key_concept %>
+      </div>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterKeyConcepts
+      def self.v1(chapter:, metadata_source:, append_to: nil)
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterKeyConcepts
+  class V1
+    renderable
+    def bake(chapter:, metadata_source:, append_to:)
+      @metadata_elements = metadata_source.children_to_keep.copy
+
+      @key_concepts = []
+      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&.cut(to: key_concepts_clipboard)
+        end
+        @key_concepts.push(key_concepts_clipboard.paste)
+        key_concepts_clipboard.clear
+      end
+
+      append_to_element = append_to || chapter
+
+      append_to_element.append(child: render(file: 'key_concepts.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -5,7 +5,7 @@ module Kitchen
     # Bake directions for eoc key equations
     #
     module BakeChapterKeyEquations
-      def self.v1(chapter:, metadata_source:)
+      def self.v1(chapter:, metadata_source:, append_to: nil)
         metadata_elements = metadata_source.children_to_keep.copy
 
         chapter.key_equations.search('h3').trash
@@ -13,7 +13,9 @@ module Kitchen
 
         return if key_equations.none?
 
-        chapter.append(child:
+        append_to_element = append_to || chapter
+
+        append_to_element.append(child:
           <<~HTML
             <div class="os-eoc os-key-equations-container" data-type="composite-page" data-uuid-key=".key-equations">
               <h2 data-type="document-title">

data/lib/kitchen/directions/bake_chapter_review/chapter_review.xhtml.erb

@@ -0,0 +1,9 @@
+<div class="os-eoc os-chapter-review-container" data-type="composite-chapter" data-uuid-key=".chapter-review">
+  <h2 data-type="document-title">
+    <span class="os-text"><%= I18n.t(:eoc_chapter_review) %></span>
+  </h2>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_chapter_review) %></h1>
+    <%= @metadata.paste %>
+  </div>
+</div>

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReview
+      def self.v1(chapter:, metadata_source:)
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReview
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:)
+      @metadata = metadata_source.children_to_keep.copy
+      chapter.append(child: render(file: 'chapter_review.xhtml.erb'))
+      chapter.first('.os-eoc.os-chapter-review-container')
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReviewExercises
+      def self.v1(chapter:, metadata_source:, append_to:, klass:)
+        V1.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to, klass: klass)
+      end
+
+      def self.v2(chapter:, metadata_source:, append_to:, klass:)
+        V2.new.bake(chapter: chapter, metadata_source: metadata_source, append_to: append_to, klass: klass)
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_review_exercises/review_exercises.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eoc os-<%=@klass%>-container" data-type="composite-page" data-uuid-key=".<%=@klass%>">
+  <h3 data-type="document-title">
+    <span class="os-text"><%= @title %></span>
+  </h3>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eoc_exercises_title) %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>