openstax_kitchen 2.0.0 → 4.1.0

data/lib/kitchen/directions/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: ../../../.rubocop.yml
+
+# Directions are supposed to be a big list of steps, so don't let Rubocop penalize
+# us for that
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false # module names here are pretty clear

data/lib/kitchen/directions/bake_appendix.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeAppendix
-
       def self.v1(page:, number:)
         title = page.title
-        title.name = "h1"
+        title.name = 'h1'
         title.replace_children(with:
           <<~HTML
             <span class="os-part-text">#{I18n.t(:appendix)} </span>
@@ -15,12 +16,11 @@ module Kitchen
         )
 
         # Make a section with data-depth of X have a header level of X+1
-        page.search("section").each do |section|
+        page.search('section').each do |section|
           title = section.first!("[data-type='title']")
           title.name = "h#{section['data-depth'].to_i + 1}"
         end
       end
-
     end
   end
 end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bake directons for eoc glossary
+    #
+    module BakeChapterGlossary
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterGlossary
+  class V1
+    renderable
+
+    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
+
+      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]
+      end
+
+      chapter.glossaries.trash
+
+      @content = definitions.paste
+
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_introductions.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
     module BakeChapterIntroductions
-
       def self.v1(book:)
         book.chapters.each do |chapter|
           outline_items_html = chapter.pages.map do |page|
@@ -10,13 +11,13 @@ module Kitchen
             <<~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-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>
               </div>
             HTML
-          end.join("")
+          end.join('')
 
           introduction_page = chapter.introduction_page
 
@@ -24,16 +25,16 @@ module Kitchen
           introduction_page.search("div[data-type='abstract']").trash
 
           title = introduction_page.title.cut
-          title.name = "h2"
+          title.name = 'h2'
           MoveTitleTextIntoSpan.v1(title: title)
 
-          intro_content = introduction_page.search("> :not([data-type='metadata']):not(figure)").cut
+          intro_content = introduction_page.search("> :not([data-type='metadata']):not(.splash):not(.has-splash)").cut
 
           introduction_page.append(child:
             <<~HTML
               <div class="intro-body">
                 <div class="os-chapter-outline">
-                  <h3 class="os-title">Chapter Outline</h3>
+                  <h3 class="os-title">#{I18n.t(:chapter_outline)}</h3>
                   #{outline_items_html}
                 </div>
                 <div class="intro-text">
@@ -52,7 +53,6 @@ module Kitchen
         something_with_selectors.selectors.title_in_introduction_page =
           ".intro-text > [data-type='document-title']"
       end
-
     end
   end
 end

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

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterKeyConcepts
+  class V1
+    renderable
+    def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = 'key-concepts'
+      @title = I18n.t(:eoc_key_concepts)
+      @uuid_prefix = uuid_prefix
+
+      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.wrap("<div class='os-section-area'>")
+          page.search('.os-section-area').first.cut(to: key_concepts_clipboard)
+        end
+      end
+
+      @content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
+
+      append_to_element = append_to || chapter
+      @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+      append_to_element.append(child: render(file:
+        '../../templates/eoc_section_title_template.xhtml.erb'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_key_equations.rb

@@ -1,30 +1,40 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
+    # Bake directons for eoc key equations
+    #
     module BakeChapterKeyEquations
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          append_to: append_to,
+          uuid_prefix: uuid_prefix
+        )
+      end
 
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, append_to:, uuid_prefix:)
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = 'key-equations'
+          @title = I18n.t(:eoc_key_equations)
+          @uuid_prefix = uuid_prefix
 
-        chapter.key_equations.search("h3").trash
-        key_equations = chapter.key_equations.cut
+          chapter.key_equations.search('h3').trash
 
-        chapter.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">
-                <span class="os-text">#{I18n.t(:eoc_key_equations)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_equations)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{key_equations.paste}
-            </div>
-          HTML
-        ) unless key_equations.none?
-      end
+          return if chapter.key_equations.none?
 
+          @content = chapter.key_equations.cut.paste
+
+          append_to_element = append_to || chapter
+          @in_composite_chapter = append_to_element.is?(:composite_chapter)
+
+          append_to_element.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeChapterReferences
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterReferences
+  class V1
+    renderable
+
+    def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'references')
+      @metadata = metadata_source.children_to_keep.copy
+      @klass = klass
+      @title = I18n.t(:references)
+      @uuid_prefix = uuid_prefix
+
+      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)
+
+        references.each do |reference|
+          reference.prepend(child: title)
+        end
+      end
+
+      @content = chapter.pages.references.cut.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_section_exercises/main.rb

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeChapterSectionExercises
+  class V1
+    def bake(chapter:)
+      chapter.pages.each do |page|
+        page.search('section.section-exercises').each do |section|
+          section.wrap(
+            %(<div class="os-eos os-section-exercises-container"
+              data-uuid-key=".section-exercises">)
+          )
+
+          section_title = I18n.t(
+            :section_exercises,
+            number: "#{chapter.count_in(:book)}.#{section.count_in(:chapter)}")
+
+          section.prepend(sibling:
+            <<~HTML
+              <h3 data-type="document-title">
+                <span class="os-text">#{section_title}</span>
+              </h3>
+            HTML
+          )
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -1,52 +1,61 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Directions
+    # Bake directions for eoc summary
+    #
     module BakeChapterSummary
+      def self.v1(chapter:, metadata_source:, klass: 'summary', uuid_prefix: '.')
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          klass: klass
+        )
+      end
 
-      def self.v1(chapter:, metadata_source:)
-        metadata_elements = metadata_source.search(%w(.authors .publishers .print-style
-                                                      .permissions [data-type='subject'])).copy
+      class V1
+        renderable
+        def bake(chapter:, metadata_source:, uuid_prefix: '.', klass: 'summary')
+          @metadata = metadata_source.children_to_keep.copy
+          @klass = klass
+          @title = I18n.t(:eoc_summary_title)
+          @uuid_prefix = uuid_prefix
 
-        summaries = Clipboard.new
+          summaries = Clipboard.new
 
-        # TODO include specific page types somehow without writing it out
-        chapter.pages("$:not(.introduction)").each do |page|
-          summary = page.summary
-          summary.first("[data-type='title']").trash # get rid of old title
-          summary_title = page.title.copy
-          summary_title.name = "h3"
-          summary_title.replace_children(with: <<~HTML
+          # TODO: include specific page types somehow without writing it out
+          chapter.non_introduction_pages.each do |page|
+            summary = page.summary
+            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
-          )
+            )
 
-          summary.prepend(child:
-            <<~HTML
-              <a href="##{page.title.id}">
-                #{summary_title.paste}
-              </a>
-            HTML
-          )
-          summary.cut(to: summaries)
-        end
+            summary.prepend(child:
+              <<~HTML
+                <a href="##{page.title.id}">
+                  #{summary_title.paste}
+                </a>
+              HTML
+            )
+            summary.cut(to: summaries)
+          end
 
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-summary-container" data-type="composite-page" data-uuid-key=".summary">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_summary_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_summary_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{summaries.paste}
-            </div>
-          HTML
-        ) unless summaries.none?
-      end
+          return if summaries.none?
+
+          @content = summaries.paste
+          @in_composite_chapter = false
 
+          chapter.append(child: render(file:
+            '../templates/eoc_section_title_template.xhtml.erb'))
+        end
+      end
     end
   end
 end