openstax_kitchen 12.2.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36305ee23acfe22fc13a9c06ee76f69243f1cd2cba33fe86c28c8c90b5eb36d
-  data.tar.gz: fd501ef342ff2c7334455cc214139581dadf1619fde7841a29650b4fc10acd79
+  metadata.gz: b0f1212b9bee542b587323cef1fa5ff8dc7437d47921736f58c9c27ef6ee11b8
+  data.tar.gz: ca01c38368dc34a0e637f431caf7873f97d5dd52b465e1ae5411d6f0861b8e58
 SHA512:
-  metadata.gz: e3b939d8a9851db4940213aae3350f720369eb794b8551627d2a44565af36aeda5ad701b62c2c1ec98fb7dcfabafa8bd2e4531642bf40dd777a635c0117560b6
-  data.tar.gz: 5ec8d3e59faa619a3b23a84ce74514c96b6d360dc1b46d233cd1566b63815a5a7edaa73980f102b4c6656c603c43ea349fcc2eac99149cbafb8fa91d8f0e2fdc
+  metadata.gz: c877a0d30bde86ccc5d0e2191b3e0efe853916294d907c764a088e67a2011f9f3fa03fb018ff8aa9992e1fbaeebb753625b90f593d888d8e8a4473139e9e0f43
+  data.tar.gz: f96e5128a718bf1897c65b5b558d2586e6905767e355cf9119c56b536f128bbbf403c658187e6faefc0bb7e7fc3013218353a81d99c1fc8dfc30a9ffed8354db

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [13.0.0] - 2021-10-6
+
+* Add `BakeLearningObjectives` v3 (minor)
+* Fix `BakeIframes` to skip already-baked iframes (patch)
+* Add `SectionElement` and `SectionElementEnumerator` classes (minor)
+* Refactor `EocCompositePageContainer` to be used by `EOB` sections as well (major)
+* Refactor `bake_references` `v1, v2 and v3` to use `CompositePageContainer` (major)
+
 ## [12.2.0] - 2021-10-1
 
 * Add `context_lead_text` to translations (minor)

data/Gemfile.lock

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

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

@@ -41,7 +41,7 @@ module Kitchen::Directions::BakeChapterGlossary
 
       content = @glossary.sort.map { |definition| definition.element.paste }.join
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'glossary',
         uuid_key: "#{uuid_prefix}glossary",
         metadata_source: metadata_source,

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

@@ -11,7 +11,7 @@ module Kitchen::Directions::BakeChapterReferences
 
       content = chapter.pages.references.cut.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: klass,
         uuid_key: "#{uuid_prefix}#{klass}",
         metadata_source: metadata_source,

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

@@ -23,7 +23,7 @@ module Kitchen::Directions::BakeChapterSolutions
 
       content = solutions_clipboard.paste
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: 'solutions',
         uuid_key: "#{uuid_prefix}solutions",
         metadata_source: metadata_source,

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -31,7 +31,7 @@ module Kitchen
 
           return if summaries.none?
 
-          EocCompositePageContainer.v1(
+          CompositePageContainer.v1(
             container_key: klass,
             uuid_key: "#{uuid_prefix}#{klass}",
             metadata_source: metadata_source,

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

@@ -7,6 +7,8 @@ module Kitchen::Directions::BakeIframes
       return unless iframes.any?
 
       iframes.each do |iframe|
+        next if iframe.has_class?('os-is-iframe')
+
         iframe.wrap('<div class="os-has-iframe" data-type="alternatives">')
         iframe.add_class('os-is-iframe')
         link_ref = iframe[:src]

data/lib/kitchen/directions/bake_learning_objectives.rb

@@ -30,6 +30,19 @@ module Kitchen
           end
         end
       end
+
+      # Wraps & moves abstract under the corresponding chapter objective in the intro page
+      def self.v3(chapter:)
+        abstracts = chapter.abstracts.map do |abstract|
+          abstract.wrap('<div class="learning-objective">')
+          abstract.parent
+        end
+
+        chapter.introduction_page.search('div.os-chapter-objective') \
+               .each_with_index do |objective, index|
+          objective.append(child: abstracts[index].cut.paste)
+        end
+      end
     end
   end
 end

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

@@ -6,18 +6,15 @@ module Kitchen
     #
     module BakeReferences
       def self.v1(book:, metadata_source:, numbered_title: false)
-        V1.new.bake(
-          book: book,
-          metadata_source: metadata_source,
-          numbered_title: numbered_title
-        )
+        V1.new.bake(book: book, metadata_source: metadata_source, numbered_title: numbered_title)
       end
 
       def self.v2(book:, metadata_source:)
-        V2.new.bake(
-          book: book,
-          metadata_source: metadata_source
-        )
+        V2.new.bake(book: book, metadata_source: metadata_source)
+      end
+
+      def self.v3(book:, metadata_source:)
+        V3.new.bake(book: book, metadata_source: metadata_source)
       end
     end
   end

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

@@ -5,11 +5,6 @@ module Kitchen::Directions::BakeReferences
     renderable
 
     def bake(book:, metadata_source:, numbered_title:)
-      @metadata = metadata_source.children_to_keep.copy
-      @klass = 'reference'
-      @uuid_prefix = '.'
-      @title = I18n.t(:references)
-
       book.chapters.each do |chapter|
         chapter.search('[data-type="cite"]').each do |link|
           link.prepend(child:
@@ -44,10 +39,16 @@ module Kitchen::Directions::BakeReferences
           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'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'reference',
+        uuid_key: '.reference',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -2,14 +2,7 @@
 
 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
@@ -26,10 +19,16 @@ module Kitchen::Directions::BakeReferences
           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'))
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
     end
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeReferences
+  class V3
+    def bake(book:, metadata_source:)
+      return unless book.references.any?
+
+      book.chapters.pages.each do |page|
+        page.references.each do |reference|
+          reference.titles.trash
+          reference.prepend(child:
+            Kitchen::Directions::EocSectionTitleLinkSnippet.v1(
+              page: page,
+              title_tag: 'h2',
+              wrapper: nil
+            )
+          )
+        end
+      end
+
+      chapter_area_references = book.chapters.references.cut
+
+      Kitchen::Directions::CompositePageContainer.v1(
+        container_key: 'references',
+        uuid_key: '.references',
+        metadata_source: metadata_source,
+        content: chapter_area_references.paste,
+        append_to: book.body
+      )
+    end
+  end
+end

data/lib/kitchen/directions/{eoc_composite_page_container → composite_page_container}/main.rb

@@ -2,7 +2,7 @@
 
 module Kitchen
   module Directions
-    module EocCompositePageContainer
+    module CompositePageContainer
       # Creates a wrapper for the given content & appends it to the given element
       #
       # @param container_key [String] Appended to 'eoc.' to form the I18n key for the container title; also used as part of a class on the container.

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::CompositePageContainer
+  class V1
+    renderable
+
+    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
+      @in_composite_chapter = append_to.is?(:composite_chapter)
+      @is_eoc = append_to.is?(:chapter) || @in_composite_chapter
+      @section = @is_eoc ? 'eoc' : 'eob'
+      @title = I18n.t(:"#{@section}.#{container_key}")
+      @uuid_key = uuid_key
+      @container_class_type = container_key
+      @metadata = metadata_source.children_to_keep.copy
+      @content = content
+      @main_title_tag = 'h1'
+
+      if @in_composite_chapter
+        @main_title_tag = 'h3'
+      elsif @is_eoc
+        @main_title_tag = 'h2'
+      end
+
+      append_to.append(child: render(file:
+        '../../templates/composite_page_template.xhtml.erb'))
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module Kitchen::Directions::MoveCustomSectionToEocContainer
           section_clipboard.paste
         end
 
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::CompositePageContainer.v1(
         container_key: container_key,
         uuid_key: uuid_key,
         metadata_source: metadata_source,

data/lib/kitchen/element_base.rb

@@ -754,7 +754,7 @@ module Kitchen
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
                    :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
                    :composite_pages, :composite_chapters, :solutions, :injected_questions,
-                   :search_with
+                   :search_with, :sections
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -318,6 +318,24 @@ module Kitchen
                css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through sections within the scope of this enumerator
+    #
+    # @param css_or_xpath [String] additional selectors to further narrow the element iterated over;
+    #   a "$" in this argument will be replaced with the default selector for the element being
+    #   iterated over.
+    # @param only [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will only be included in the
+    #   search results if the method or callable returns true
+    # @param except [Symbol, Callable] the name of a method to call on an element or a
+    #   lambda or proc that accepts an element; elements will not be included in the
+    #   search results if the method or callable returns false
+    #
+    def sections(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(SectionElementEnumerator,
+               css_or_xpath: css_or_xpath, only: only, except: except)
+    end
+
     # Returns an enumerator that iterates within the scope of this enumerator
     #
     # @param css_or_xpath [String] additional selectors to further narrow the element iterated over

data/lib/kitchen/section_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class SectionElement < ElementBase
+
+    # Creates a new +SectionElement+
+    #
+    # @param node [Nokogiri::XML::Node] the node this element wraps
+    # @param document [Document] this element's document
+    #
+    def initialize(node:, document: nil)
+      super(node: node,
+            document: document,
+            enumerator_class: SectionElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :section
+    end
+
+  end
+end

data/lib/kitchen/section_element_enumerator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for table elements
+  #
+  class SectionElementEnumerator < ElementEnumeratorBase
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:section),
+        sub_element_class: SectionElement,
+        enumerator_class: self
+      )
+    end
+
+  end
+end

data/lib/kitchen/selectors/base.rb

@@ -62,6 +62,9 @@ module Kitchen
       # Selector for an injected question
       # @return [String]
       attr_accessor :injected_question
+      # Selector for a section
+      # @return [String]
+      attr_accessor :section
 
       # Override specific selectors
       #

data/lib/kitchen/selectors/standard_1.rb

@@ -29,6 +29,7 @@ module Kitchen
         self.solution                   = "div[data-type='solution'], " \
                                           "div[data-type='question-solution']"
         self.injected_question          = "div[data-type='exercise-question']"
+        self.section                    = 'section'
       end
 
     end

data/lib/kitchen/templates/composite_page_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-<%= @section%> os-<%=@container_class_type%>-container" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
+  <<%= @main_title_tag %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
+    <span class="os-text"><%= @title %></span>
+  </<%= @main_title_tag %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/version.rb

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

data/lib/locales/en.yml

@@ -40,5 +40,8 @@ en:
   folio:
     preface: Preface
     access_for_free: Access for free at openstax.org
+  eob:
+    references: References
+    reference: References
   index:
     main: Index

data/lib/locales/es.yml

@@ -35,5 +35,8 @@ es:
   folio:
     preface: Prefacio
     access_for_free: Acceso gratis en openstax.org
+  eob:
+    references: Referencias
+    reference: Referencias
   index:
     main: Índice

data/lib/locales/pl.yml

@@ -67,6 +67,9 @@ pl:
     key-equations: Najważniejsze wzory
     summary: Podsumowanie
     references: Bibliografia
+  eob:
+    references: Bibliografia
+    reference: Bibliografia
   index:
     name: Skorowidz nazwisk
     term: Skorowidz rzeczowy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 13.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -320,6 +320,7 @@ files:
 - 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_references/v3.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
 - lib/kitchen/directions/bake_toc.rb
@@ -334,8 +335,8 @@ files:
 - lib/kitchen/directions/chapter_review_container/chapter_review.xhtml.erb
 - lib/kitchen/directions/chapter_review_container/main.rb
 - lib/kitchen/directions/chapter_review_container/v1.rb
-- lib/kitchen/directions/eoc_composite_page_container/main.rb
-- lib/kitchen/directions/eoc_composite_page_container/v1.rb
+- lib/kitchen/directions/composite_page_container/main.rb
+- lib/kitchen/directions/composite_page_container/v1.rb
 - lib/kitchen/directions/eoc_section_title_link_snippet.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/main.rb
 - lib/kitchen/directions/move_custom_section_to_eoc_container/v1.rb
@@ -393,14 +394,16 @@ files:
 - lib/kitchen/references_element_enumerator.rb
 - lib/kitchen/search_history.rb
 - lib/kitchen/search_query.rb
+- lib/kitchen/section_element.rb
+- lib/kitchen/section_element_enumerator.rb
 - lib/kitchen/selector.rb
 - lib/kitchen/selectors/base.rb
 - lib/kitchen/selectors/standard_1.rb
 - lib/kitchen/solution_element_enumerator.rb
 - lib/kitchen/table_element.rb
 - lib/kitchen/table_element_enumerator.rb
+- lib/kitchen/templates/composite_page_template.xhtml.erb
 - lib/kitchen/templates/eob_section_title_template.xhtml.erb
-- lib/kitchen/templates/eoc_section_template.xhtml.erb
 - lib/kitchen/templates/eoc_section_template_old.xhtml.erb
 - lib/kitchen/term_element.rb
 - lib/kitchen/term_element_enumerator.rb

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::EocCompositePageContainer
-  class V1
-    renderable
-
-    def bake(container_key:, uuid_key:, metadata_source:, content:, append_to:)
-      @title = I18n.t(:"eoc.#{container_key}")
-      @uuid_key = uuid_key
-      @container_class_type = container_key
-      @metadata = metadata_source.children_to_keep.copy
-      @content = content
-      @in_composite_chapter = append_to.is?(:composite_chapter)
-
-      append_to.append(child: render(file:
-        '../../templates/eoc_section_template.xhtml.erb'))
-    end
-  end
-end

data/lib/kitchen/templates/eoc_section_template.xhtml.erb

@@ -1,11 +0,0 @@
-<% main_title_tag = @in_composite_chapter ? 'h3' : 'h2' %>
-<div class="os-eoc os-<%=@container_class_type%>-container" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
-  <<%= main_title_tag %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
-    <span class="os-text"><%= @title %></span>
-  </<%= main_title_tag %>>
-  <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
-    <%= @metadata.paste %>
-  </div>
-  <%= @content %>
-</div>