openstax_kitchen 6.0.0 → 9.0.0

data/lib/kitchen/directions/bake_eoc_section_content/remove_section_title.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module RemoveSectionTitle
+      def self.v1(section:)
+        section.first('[data-type="title"]')&.trash
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_example.rb

@@ -3,7 +3,7 @@
 module Kitchen
   module Directions
     module BakeExample
-      def self.v1(example:, number:, title_tag:)
+      def self.v1(example:, number:, title_tag:, numbered_solutions: false)
         example.wrap_children(class: 'body')
 
         example.prepend(child:
@@ -36,10 +36,16 @@ module Kitchen
           end
 
           if (solution = exercise.solution)
+            solution_number = if numbered_solutions
+                                "<span class=\"os-number\">#{exercise.count_in(:example)}</span>"
+                              else
+                                ''
+                              end
             solution.replace_children(with:
               <<~HTML
                 <h4 data-type="solution-title">
                   <span class="os-title-label">#{I18n.t(:solution)} </span>
+                  #{solution_number}
                 </h4>
                 <div class="os-solution-container">#{solution.children}</div>
               HTML

data/lib/kitchen/directions/bake_further_research.rb

@@ -13,47 +13,21 @@ module Kitchen
       end
 
       class V1
-        renderable
         def bake(chapter:, metadata_source:, uuid_prefix: '.')
-          @metadata = metadata_source.children_to_keep.copy
-          @klass = 'further-research'
-          @title = I18n.t(:eoc_further_research_title)
-          @uuid_prefix = uuid_prefix
-
-          further_researches = Clipboard.new
-
-          chapter.non_introduction_pages.each do |page|
-            further_research = page.first('.further-research')
-            next unless further_research.present?
-
-            further_research.first("[data-type='title']")&.trash # get rid of old title if exists
-            further_research_title = page.title.copy
-            further_research_title.name = 'h3'
-            further_research_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="">#{further_research_title.children}</span>
-            HTML
-            )
-
-            further_research.prepend(child:
-              <<~HTML
-                <a href="##{page.title.id}">
-                  #{further_research_title.paste}
-                </a>
-              HTML
-            )
-            further_research.cut(to: further_researches)
+          MoveCustomSectionToEocContainer.v1(
+            chapter: chapter,
+            metadata_source: metadata_source,
+            container_key: 'further-research',
+            uuid_key: "#{uuid_prefix}further-research",
+            section_selector: 'section.further-research',
+            append_to: nil,
+            include_intro_page: false
+          ) do |further_research|
+            RemoveSectionTitle.v1(section: further_research)
+            title = EocSectionTitleLinkSnippet.v1(page: further_research.ancestor(:page))
+            further_research.prepend(child: title)
+            further_research.first('h3')[:itemprop] = 'name'
           end
-
-          return if further_researches.none?
-
-          @content = further_researches.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_inline_lists.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bakes inline lists with the desired list separator
+    # Does not separate the last list item
+    #
+    module BakeInlineLists
+      LIST_SEPARATOR = '; '
+      SEPARATOR_CLASS = '-os-inline-list-separator'
+
+      def self.v1(book:)
+        inline_lists = book.search('span[data-display="inline"][data-type="list"]')
+        inline_lists.each do |list|
+          list.search('span[data-type="item"]')[0..-2].each do |item|
+            item.append(child: "<span class=\"#{SEPARATOR_CLASS}\">#{LIST_SEPARATOR}</span>")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,13 @@ module Kitchen
           metadata_source: metadata_source
         )
       end
+
+      def self.v2(book:, metadata_source:)
+        V2.new.bake(
+          book: book,
+          metadata_source: metadata_source
+        )
+      end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+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
+
+        chapter_references = chapter.pages.references.cut
+        chapter_title_no_num = chapter.title.search('.os-text')
+
+        chapter.append(child:
+          <<~HTML
+            <div class="os-chapter-area">
+              <h2 data-type="document-title">#{chapter_title_no_num}</h2>
+              #{chapter_references.paste}
+            </div>
+          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'))
+    end
+  end
+end

data/lib/kitchen/directions/bake_toc.rb

@@ -96,8 +96,10 @@ module Kitchen
           when CompositePageElement
             if page.is_index?
               'os-toc-index'
-            elsif page.is_reference?
+            elsif page.is_citation_reference?
               'os-toc-reference'
+            elsif page.is_section_reference?
+              'os-toc-references'
             elsif page.has_ancestor?(:composite_chapter) || page.has_ancestor?(:chapter)
               'os-toc-chapter-composite-page'
             else

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module EocCompositePageContainer
+      # 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.
+      # @param uuid_key [String] the uuid key for the wrapper class, e.g. `'.summary'`
+      # @param metadata_source [MetadataElement] metadata for the book
+      # @param content [String] the content to be contained by the wrapper
+      # @param append_to [ElementBase] the element to be appended, usually either a `ChapterElement` or a `CompositeChapterElement`
+      # @return [ElementBase] the append_to element with container appended
+      #
+      def self.v1(container_key:, uuid_key:, metadata_source:, content:,
+                  append_to:)
+        V1.new.bake(
+          container_key: container_key,
+          uuid_key: uuid_key,
+          metadata_source: metadata_source,
+          content: content,
+          append_to: append_to
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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/directions/move_custom_section_to_eoc_container/main.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ParameterLists
+# More parameters are ok here because these generic classes DRY up a lot of other code
+module Kitchen
+  module Directions
+    module MoveCustomSectionToEocContainer
+      # Creates a custom eoc composite page for a section within the given chapter.
+      # The sections are moved into this composite page, and can be transformed before the moved by an optional block argument.
+      #
+      # @param chapter [ChapterElement] the chapter in which the section to be moved is contained
+      # @param metadata_source [MetadataElement] metadata for the book
+      # @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.
+      # @param uuid_key [String] the uuid key for the wrapper class, e.g. `'.summary'`
+      # @param section_selector [String] the selector for the section to be moved, e.g. `'section.summary'`
+      # @param append_to [ElementBase] the element to be appended. Defaults to the value of `chapter` param if none given.
+      # @param include_intro_page [Boolean] control the introduction page for the chapter should be searched for a section to move, default is true
+      # @return [ElementBase] the append_to element with container appended
+      #
+      def self.v1(chapter:, metadata_source:, container_key:, uuid_key:,
+                  section_selector:, append_to: nil, include_intro_page: true)
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          container_key: container_key,
+          uuid_key: uuid_key,
+          section_selector: section_selector,
+          append_to: append_to || chapter,
+          include_intro_page: include_intro_page
+        ) do |section|
+          yield section if block_given?
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ParameterLists
+# More parameters are ok here because these generic classes DRY up a lot of other code
+module Kitchen::Directions::MoveCustomSectionToEocContainer
+  class V1
+    def bake(chapter:, metadata_source:, container_key:, uuid_key:,
+             section_selector:, append_to:, include_intro_page:, &block)
+      section_clipboard = Kitchen::Clipboard.new
+      pages = include_intro_page ? chapter.pages : chapter.non_introduction_pages
+      sections = pages.search(section_selector)
+      sections.each(&block)
+      sections.cut(to: section_clipboard)
+
+      return if section_clipboard.none?
+
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: container_key,
+        uuid_key: uuid_key,
+        metadata_source: metadata_source,
+        content: section_clipboard.paste,
+        append_to: append_to || chapter
+      )
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

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

@@ -2,35 +2,18 @@
 
 module Kitchen::Directions::MoveExercisesToEOC
   class V1
-    renderable
-
     def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
-      @klass = klass
-      @metadata = metadata_source.children_to_keep.copy
-      @title = I18n.t(:"eoc.#{klass}")
-      @uuid_prefix = uuid_prefix
-
-      exercise_clipboard = Kitchen::Clipboard.new
-
-      chapter.non_introduction_pages.each do |page|
-        sections = page.search("section.#{@klass}")
-
-        sections.each do |exercise_section|
-          exercise_section.first("[data-type='title']")&.trash
-
-          exercise_section.cut(to: exercise_clipboard)
-        end
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        section_selector: "section.#{klass}",
+        append_to: append_to || chapter,
+        include_intro_page: false
+      ) do |exercise_section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: exercise_section)
       end
-
-      return if exercise_clipboard.none?
-
-      @content = exercise_clipboard.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/move_exercises_to_eoc/v2.rb

@@ -4,25 +4,16 @@ module Kitchen::Directions::MoveExercisesToEOC
   # Main difference from v1 is the presence of a section title
   # and some additional wrappers
   class V2
-    renderable
-
     def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
-      @klass = klass
-      @metadata = metadata_source.children_to_keep.copy
-      @title = I18n.t(:"eoc.#{klass}")
-      @uuid_prefix = uuid_prefix
-
       exercise_clipboard = Kitchen::Clipboard.new
 
       chapter.non_introduction_pages.each do |page|
-        sections = page.search("section.#{@klass}")
+        sections = page.search("section.#{klass}")
 
         sections.each do |exercise_section|
-          exercise_section.first("[data-type='title']")&.trash
-
+          Kitchen::Directions::RemoveSectionTitle.v1(section: exercise_section)
           # Get parent page title
           section_title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-
           # Configure section title & wrappers
           exercise_section.prepend(child: section_title)
           exercise_section.wrap('<div class="os-section-area">')
@@ -33,17 +24,19 @@ module Kitchen::Directions::MoveExercisesToEOC
 
       return if exercise_clipboard.none?
 
-      @content = <<~HTML
-        <div class="os-#{@klass}">
+      content = <<~HTML
+        <div class="os-#{klass}">
           #{exercise_clipboard.paste}
         </div>
       HTML
 
-      append_to_element = append_to || chapter
-      @in_composite_chapter = append_to_element[:'data-type'] == 'composite-chapter'
-
-      append_to_element.append(child: render(file:
-        '../../templates/eoc_section_title_template.xhtml.erb'))
+      Kitchen::Directions::EocCompositePageContainer.v1(
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        metadata_source: metadata_source,
+        content: content,
+        append_to: append_to || chapter
+      )
     end
   end
 end

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

@@ -4,46 +4,22 @@ module Kitchen::Directions::MoveExercisesToEOC
   # The difference from v1 is the presence of a section title
   # and from v2 the lack of additional "os-section-area" and os-#{@klass} wrappers
   class V3
-    renderable
-
     def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
-      @klass = klass
-      @metadata = metadata_source.children_to_keep.copy
-      @title = I18n.t(:"eoc.#{klass}")
-      @uuid_prefix = uuid_prefix
-
-      exercise_clipboard = Kitchen::Clipboard.new
-
-      chapter.non_introduction_pages.each do |page|
-        sections = page.search("section.#{@klass}")
-
-        sections.each do |exercise_section|
-          exercise_section.first("[data-type='title']")&.trash
-
-          section_title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-
-          exercise_section.exercises.each do |exercise|
-            exercise.document.pantry(name: :link_text).store(
-              "#{I18n.t(:exercise_label)} #{chapter.count_in(:book)}.#{exercise.count_in(:chapter)}",
-              label: exercise.id
-            )
-          end
-
-          # Configure section title
-          exercise_section.prepend(child: section_title)
-          exercise_section.cut(to: exercise_clipboard)
-        end
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
+        container_key: klass,
+        uuid_key: "#{uuid_prefix}#{klass}",
+        section_selector: "section.#{klass}",
+        append_to: append_to || chapter,
+        include_intro_page: false
+      ) do |exercise_section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: exercise_section)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(
+          page: exercise_section.ancestor(:page)
+        )
+        exercise_section.prepend(child: title)
       end
-
-      return if exercise_clipboard.none?
-
-      @content = exercise_clipboard.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