openstax_kitchen 3.2.0 → 6.0.0

data/.github/config.yml

@@ -1,14 +0,0 @@
-# See https://github.com/openstax/staxly#plugins for more options for this file
-changelog:
-  # See https://github.com/mikz/probot-changelog for details
-
-  # The filename of the CHANGELOG that needs to be updated in every PullRequest
-  filename: CHANGELOG.md
-
-  # (optional) when files matching these patterns are changed then disallow merging
-  # until the CHANGELOG is updated.
-  # If this pattern is not included then **all** Pull Requests require an edit to 
-  # the CHANGELOG file
-  
-  # include:
-  #   - /^src\//

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

@@ -1,9 +0,0 @@
-<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

@@ -1,11 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-# 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_glossary.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    # Bake directons for eoc glossary
-    #
-    module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:, append_to: nil)
-        metadata_elements = metadata_source.children_to_keep.copy
-
-        definitions = chapter.glossaries.search('dl').cut
-        definitions.sort_by! do |definition|
-          [definition.first('dt').text.downcase, definition.first('dd').text.downcase]
-        end
-
-        chapter.glossaries.trash
-
-        return if definitions.none?
-
-        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">
-                <span class="os-text">#{I18n.t(:eoc_key_terms_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_key_terms_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{definitions.paste}
-            </div>
-          HTML
-        )
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-<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_review/chapter_review.xhtml.erb

@@ -1,9 +0,0 @@
-<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/v1.rb

@@ -1,13 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-<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>

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module BakeExercises
-      def self.v1(book:)
-        warn 'WARNING! deprecated direction used: BakeExecises'
-        V1.new.bake(book: book)
-      end
-    end
-  end
-end

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

@@ -1,169 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::BakeExercises
-  class V1
-    renderable
-    def bake(book:)
-      metadata_elements = book.metadata.children_to_keep.copy
-
-      solutions_clipboards = []
-
-      book.chapters.each do |chapter|
-        exercise_clipboard = Kitchen::Clipboard.new
-        solution_clipboard = Kitchen::Clipboard.new
-        solutions_clipboards.push(solution_clipboard)
-
-        chapter.non_introduction_pages.each do |page|
-          exercise_section = page.exercises
-          exercise_section.titles.first&.trash
-
-          bake_exercise_section_title(
-            exercise_section: exercise_section, page: page, chapter: chapter)
-
-          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
-            )
-            bake_exercise_in_place(exercise: exercise)
-            exercise.solution&.cut(to: solution_clipboard)
-          end
-
-          exercise_section.cut(to: exercise_clipboard)
-        end
-
-        next if exercise_clipboard.none?
-
-        chapter.append(child:
-          <<~HTML
-            <div class="os-eoc os-exercises-container" data-type="composite-page" data-uuid-key=".exercises">
-              <h2 data-type="document-title">
-                <span class="os-text">#{I18n.t(:eoc_exercises_title)}</span>
-              </h2>
-              <div data-type="metadata" style="display: none;">
-                <h1 data-type="document-title" itemprop="name">#{I18n.t(:eoc_exercises_title)}</h1>
-                #{metadata_elements.paste}
-              </div>
-              #{exercise_clipboard.paste}
-            </div>
-          HTML
-        )
-      end
-
-      # Store a paste here to use at end so that uniquifyied IDs match legacy baking
-      eob_metadata = metadata_elements.paste
-      solutions = solutions_clipboards.map.with_index do |solution_clipboard, index|
-        <<~HTML
-          <div class="os-eob os-solution-container" data-type="composite-page" data-uuid-key=".solution#{index + 1}">
-            <h2 data-type="document-title">
-              <span class="os-text">#{I18n.t(:chapter)} #{index + 1}</span>
-            </h2>
-            <div data-type="metadata" style="display: none;">
-              <h1 data-type="document-title" itemprop="name">#{I18n.t(:chapter)} #{index + 1}</h1>
-              #{metadata_elements.paste}
-            </div>
-            #{solution_clipboard.paste}
-          </div>
-        HTML
-      end
-
-      return if solutions.none?
-
-      book.body.append(child:
-        <<~HTML
-          <div class="os-eob os-solution-container" data-type="composite-chapter" data-uuid-key=".solution">
-            <h1 data-type="document-title" id="composite-chapter-1">
-              <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>
-              #{eob_metadata}
-            </div>
-            #{solutions.join("\n")}
-          </div>
-        HTML
-      )
-    end
-
-    def bake_exercise_section_title(exercise_section:, chapter:, page:)
-      exercise_section_title = page.title.copy
-      exercise_section_title.name = 'h3'
-      exercise_section_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="">#{exercise_section_title.children}</span>
-      HTML
-      )
-      exercise_section.prepend(child:
-        <<~HTML
-          <a href="##{page.title.id}">
-            #{exercise_section_title.paste}
-          </a>
-        HTML
-      )
-    end
-
-    def bake_exercise_in_place(exercise:)
-      # Bake an exercise in place going from:
-      #
-      # <div data-type="exercise" id="exerciseId">
-      #   <div data-type="problem" id="problemId">
-      #     Problem Content
-      #   </div>
-      #   <div data-type="solution" id="solutionId">
-      #     Solution Content
-      #   </div>
-      # </div>
-      #
-      # to
-      #
-      # <div data-type="exercise" id="exerciseId" class="os-hasSolution">
-      #   <div data-type="problem" id="problemId">
-      #     <a class="os-number" href="#exerciseId-solution">1</a>
-      #     <span class="os-divider">. </span>
-      #     <div class="os-problem-container ">
-      #       Problem Content
-      #     </div>
-      #   </div>
-      #   <div data-type="solution" id="exerciseId-solution">
-      #     <a class="os-number" href="#exerciseId">1</a>
-      #     <span class="os-divider">. </span>
-      #     <div class="os-solution-container ">
-      #       Solution Content
-      #     </div>
-      #   </div>
-      # </div>
-      #
-      # If there is no solution, don't add the 'os-hasSolution' class and don't
-      # link the number.
-
-      problem = exercise.problem
-      solution = exercise.solution
-      count_in = exercise.count_in(:chapter)
-      problem_number = "<span class='os-number'>#{count_in}</span>"
-
-      if solution.present?
-        solution.id = "#{exercise.id}-solution"
-
-        exercise.add_class('os-hasSolution')
-        problem_number = "<a href='##{solution.id}' class='os-number'>#{count_in}</a>"
-
-        solution.replace_children(with:
-          <<~HTML
-            <a class="os-number" href="##{exercise.id}">#{count_in}</a>
-            <span class="os-divider">. </span>
-            <div class="os-solution-container ">#{solution.children}</div>
-          HTML
-        )
-      end
-
-      problem.replace_children(with:
-        <<~HTML
-          #{problem_number}
-          <span class="os-divider">. </span>
-          <div class="os-problem-container ">#{problem.children}</div>
-        HTML
-      )
-    end
-  end
-end

data/lib/kitchen/directions/bake_notes/bake_notes.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module BakeNotes
-      def self.v1(book:)
-        warn 'WARNING! deprecated direction used: BakeNotes'
-
-        book.notes('$:not(.checkpoint):not(.theorem)').each do |note|
-          title = note.title&.cut
-
-          note.wrap_children(class: 'os-note-body')
-
-          if title
-            if note.indicates_autogenerated_title?
-              note.prepend(child:
-                <<~HTML
-                  <h3 class="os-title" data-type="title">
-                    <span class="os-title-label">#{note.autogenerated_title}</span>
-                  </h3>
-                HTML
-              )
-
-              title.name = 'h4'
-              title.add_class('os-subtitle')
-              title.wrap_children('span', class: 'os-subtitle-label')
-              note.first!('.os-note-body').prepend(child: title.raw)
-            else
-              title.name = 'h3'
-              title.add_class('os-title')
-              title.wrap_children('span', data_type: '', id: title.id, class: 'os-title-label')
-              title.remove_attribute('id')
-              note.prepend(child: title.raw)
-            end
-          else
-            note.prepend(child:
-              <<~HTML
-                <h3 class="os-title" data-type="title">
-                  <span class="os-title-label">#{note.autogenerated_title}</span>
-                </h3>
-              HTML
-            )
-          end
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/directions/bake_notes/bake_numbered_notes.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen
-  module Directions
-    module BakeNumberedNotes
-      def self.v1(book:, classes:)
-        classes.each do |klass|
-          book.chapters.notes("$.#{klass}").each do |note|
-            bake_note(note: note)
-            bake_note_exercise(note: note)
-          end
-        end
-      end
-
-      def self.bake_note(note:)
-        note.wrap_children(class: 'os-note-body')
-
-        chapter_count = note.ancestor(:chapter).count_in(:book)
-        note_count = note.count_in(:chapter)
-        note.prepend(child:
-          <<~HTML
-            <div class="os-title">
-              <span class="os-title-label">#{note.autogenerated_title}</span>
-              <span class="os-number">#{chapter_count}.#{note_count}</span>
-              <span class="os-divider"> </span>
-            </div>
-          HTML
-        )
-
-        return unless note['use-subtitle']
-
-        BakeNoteSubtitle.v1(note: note)
-      end
-
-      def self.bake_note_exercise(note:)
-        exercise = note.exercises.first
-        return unless exercise
-
-        exercise.add_class('unnumbered')
-        # bake problem
-        exercise.problem.wrap_children('div', class: 'os-problem-container')
-        exercise.problem.first('strong')&.trash
-        exercise.search('[data-type="commentary"]').each(&:trash)
-        solution = exercise.solution
-        return unless solution
-
-        # bake solution in place
-        exercise.add_class('os-hasSolution')
-        solution[:id] = "#{exercise[:id]}-solution"
-        solution_number = note.first('.os-number').text
-        solution.replace_children(with:
-          <<~HTML
-            <a class="os-number" href="##{exercise[:id]}">#{solution_number}</a>
-            <span class="os-divider"> </span>
-            <div class="os-solution-container">
-              #{solution.children}
-            </div>
-          HTML
-        )
-      end
-    end
-  end
-end