openstax_kitchen 11.0.0 → 11.1.0

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

@@ -1,29 +1,34 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeNumberedNotes
-  class V3
-    # for the try it notes, must be called AFTER bake_exercises
-    def bake(book:, classes:, suppress_solution: true)
-      classes.each do |klass|
-        book.chapters.notes("$.#{klass}").each do |note|
-          note.wrap_children(class: 'os-note-body')
-          previous_example = note.previous
-          os_number = previous_example&.first('.os-number')&.children&.to_s
+module Kitchen::Directions
+  module BakeNumberedNotes
+    class V3
+      # for the try it notes, must be called AFTER bake_exercises
+      def bake(book:, classes:, suppress_solution: true)
+        classes.each do |klass|
+          book.chapters.pages.notes("$.#{klass}").each do |note|
+            note.wrap_children(class: 'os-note-body')
+            previous_example = note.previous
+            os_number = previous_example&.first('.os-number')&.children&.to_s
 
-          note.prepend(child:
-            <<~HTML
-              <h3 class="os-title">
-                <span class="os-title-label">#{note.autogenerated_title}</span>
-                <span class="os-number">#{os_number}</span>
-              </h3>
-            HTML
-          )
-
-          note.title&.trash
-          note.exercises.each do |exercise|
-            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(
-              note: note, exercise: exercise, divider: '. ', suppress_solution: suppress_solution
+            note.prepend(child:
+              <<~HTML
+                <h3 class="os-title">
+                  <span class="os-title-label">#{note.autogenerated_title}</span>
+                  <span class="os-number">#{os_number}</span>
+                </h3>
+              HTML
             )
+
+            note.title&.trash
+            note.exercises.each do |exercise|
+              BakeNumberedNotes.bake_note_exercise(
+                note: note, exercise: exercise, divider: '. ', suppress_solution: suppress_solution
+              )
+            end
+            note.injected_questions.each do |question|
+              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+            end
           end
         end
       end

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

@@ -3,9 +3,10 @@
 module Kitchen
   module Directions
     module BakeNumberedExercise
-      def self.v1(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
+      def self.v1(exercise:, number:, suppress_solution_if: false,
+                  note_suppressed_solutions: false, cases: false)
         V1.new.bake(exercise: exercise, number: number, suppress_solution_if: suppress_solution_if,
-                    note_suppressed_solutions: note_suppressed_solutions)
+                    note_suppressed_solutions: note_suppressed_solutions, cases: cases)
       end
 
       def self.bake_solution_v1(exercise:, number:, divider: '. ')

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

@@ -2,14 +2,15 @@
 
 module Kitchen::Directions::BakeNumberedExercise
   class V1
-    def bake(exercise:, number:, suppress_solution_if: false, note_suppressed_solutions: false)
+    def bake(exercise:, number:, suppress_solution_if: false,
+             note_suppressed_solutions: false, cases: false)
       problem = exercise.problem
       solution = exercise.solution
 
-      exercise.pantry(name: :link_text).store(
-        "#{I18n.t(:exercise_label)} #{exercise.ancestor(:chapter).count_in(:book)}.#{number}",
-        label: exercise.id
-      )
+      # Store label information
+      label_number = "#{exercise.ancestor(:chapter).count_in(:book)}.#{number}"
+      exercise.target_label(label_text: 'exercise', custom_content: label_number, cases: cases)
+
       problem_number = "<span class='os-number'>#{number}</span>"
 
       suppress_solution =
@@ -37,25 +38,6 @@ module Kitchen::Directions::BakeNumberedExercise
           <div class="os-problem-container">#{problem.children}</div>
         HTML
       )
-
-      # Bake multipart questions
-      multipart_questions = problem.search('div.question-stem')
-      return unless multipart_questions.count > 1
-
-      multipart_clipboard = Kitchen::Clipboard.new
-      multipart_questions.each do |question|
-        question.wrap('<li>')
-        question = question.parent
-        question.cut(to: multipart_clipboard)
-      end
-
-      problem.first('div.question-stimulus, div.exercise-stimulus').append(sibling:
-        <<~HTML
-          <ol type="a">
-            #{multipart_clipboard.paste}
-          </ol>
-        HTML
-      )
     end
 
     def bake_solution(exercise:, number:, divider: '. ')

data/lib/kitchen/directions/bake_numbered_table/bake_table_body.rb

@@ -36,12 +36,12 @@ module Kitchen
           end
         end
 
-        def bake(table:, number:)
+        def bake(table:, number:, cases: false)
           table.remove_attribute('summary')
           table.wrap(%(<div class="os-table">))
 
-          table_label = "#{I18n.t(:table_label)} #{number}"
-          table.pantry(name: :link_text).store table_label, label: table.id if table.id
+          # Store label information
+          table.target_label(label_text: 'table', custom_content: number, cases: cases)
 
           if table.top_titled?
             custom_table = CustomBody.new(table: table,

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

@@ -3,12 +3,12 @@
 module Kitchen
   module Directions
     module BakeNumberedTable
-      def self.v1(table:, number:, always_caption: false)
-        V1.new.bake(table: table, number: number, always_caption: always_caption)
+      def self.v1(table:, number:, always_caption: false, cases: false)
+        V1.new.bake(table: table, number: number, always_caption: always_caption, cases: cases)
       end
 
-      def self.v2(table:, number:)
-        V2.new.bake(table: table, number: number)
+      def self.v2(table:, number:, cases: false)
+        V2.new.bake(table: table, number: number, cases: cases)
       end
     end
   end

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

@@ -3,8 +3,8 @@
 module Kitchen::Directions::BakeNumberedTable
   class V1
 
-    def bake(table:, number:, always_caption: false)
-      Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number)
+    def bake(table:, number:, always_caption: false, cases: false)
+      Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number, cases: cases)
 
       # TODO: extra spaces added here to match legacy implementation, but probably not meaningful?
       new_caption = ''
@@ -31,7 +31,7 @@ module Kitchen::Directions::BakeNumberedTable
       table.append(sibling:
         <<~HTML
           <div class="os-caption-container">
-            <span class="os-title-label">#{I18n.t(:table_label)} </span>
+            <span class="os-title-label">#{I18n.t("table#{'.nominative' if cases}")} </span>
             <span class="os-number">#{number}</span>
             <span class="os-divider"> </span>#{caption_title}
             <span class="os-divider"> </span>#{new_caption}

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

@@ -5,8 +5,8 @@ module Kitchen::Directions::BakeNumberedTable
   # V2 caption titles are nested within an .os-caption span
   class V2
 
-    def bake(table:, number:)
-      Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number)
+    def bake(table:, number:, cases: false)
+      Kitchen::Directions::BakeTableBody::V1.new.bake(table: table, number: number, cases: cases)
 
       caption = ''
       if table&.caption&.first("span[data-type='title']") && !table.top_captioned?
@@ -19,7 +19,7 @@ module Kitchen::Directions::BakeNumberedTable
       table.append(sibling:
         <<~HTML
           <div class="os-caption-container">
-            <span class="os-title-label">#{I18n.t(:table_label)} </span>
+            <span class="os-title-label">#{I18n.t("table#{'.nominative' if cases}")} </span>
             <span class="os-number">#{number}</span>
             <span class="os-divider"> </span>
             #{caption}

data/lib/kitchen/directions/bake_toc.rb

@@ -103,7 +103,7 @@ module Kitchen
               raise "do not know what TOC class to use for page with classes #{page.classes}"
             end
           when CompositePageElement
-            if page.is_index?
+            if page.is_index? || page.is_index_of_type?
               'os-toc-index'
             elsif page.is_citation_reference?
               'os-toc-reference'

data/lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_exercise_section.rb

@@ -8,13 +8,7 @@ module Kitchen::Directions::MoveSolutionsFromExerciseSection
 
   class V1
     def bake(chapter:, append_to:, section_class:, title_number:)
-      solutions_clipboard = Kitchen::Clipboard.new
-      chapter.search("section.#{section_class}").exercises.each do |exercise|
-        solution = exercise.solution
-        next unless solution
-
-        solution.cut(to: solutions_clipboard)
-      end
+      solutions_clipboard = chapter.search("section.#{section_class}").solutions.cut
 
       return if solutions_clipboard.items.empty?
 

data/lib/kitchen/directions/move_solutions_to_answer_key/move_solutions_from_numbered_note.rb

@@ -7,13 +7,7 @@ module Kitchen::Directions::MoveSolutionsFromNumberedNote
 
   class V1
     def bake(chapter:, append_to:, note_class:)
-      solutions_clipboard = Kitchen::Clipboard.new
-      chapter.notes("$.#{note_class}").exercises.each do |exercise|
-        solution = exercise.solution
-        next unless solution
-
-        solution.cut(to: solutions_clipboard)
-      end
+      solutions_clipboard = chapter.notes("$.#{note_class}").solutions.cut
 
       return if solutions_clipboard.items.empty?
 

data/lib/kitchen/directions/move_solutions_to_answer_key/strategies/contemporary_math.rb

@@ -17,6 +17,23 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
         Kitchen::Directions::MoveSolutionsFromNumberedNote.v1(
           chapter: chapter, append_to: append_to, note_class: 'your-turn'
         )
+
+        # Bake section exercises
+        chapter.non_introduction_pages.each do |page|
+          number = "#{chapter.count_in(:book)}.#{page.count_in(:chapter)}"
+          Kitchen::Directions::MoveSolutionsFromExerciseSection.v1(
+            chapter: page, append_to: append_to, section_class: 'section-exercises',
+            title_number: number
+          )
+        end
+
+        # Bake other exercise sections
+        classes = %w[chapter-review chapter-test]
+        classes.each do |klass|
+          Kitchen::Directions::MoveSolutionsFromExerciseSection.v1(
+            chapter: chapter, append_to: append_to, section_class: klass
+          )
+        end
       end
     end
   end

data/lib/kitchen/element_base.rb

@@ -67,6 +67,9 @@ module Kitchen
     # @!method remove_attribute
     #   Removes an attribute from the element
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#remove_attribute-instance_method Nokogiri::XML::Node#remove_attribute
+    # @!method key?(attribute)
+    #   Returns true if attribute is set
+    #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#key%3F-instance_method Nokogiri::XML::Node#key?(attribute)
     # @!method classes
     #   Gets the element's classes
     #   @see https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node#classes-instance_method Nokogiri::XML::Node#classes
@@ -81,7 +84,7 @@ module Kitchen
     #   @return Object
     def_delegators :@node, :name=, :name, :[], :[]=, :add_class, :remove_class,
                    :text, :wrap, :children, :to_html, :remove_attribute,
-                   :classes, :path, :inner_html=
+                   :key?, :classes, :path, :inner_html=
 
     # @!method config
     #   Get the config for this element's document
@@ -722,11 +725,44 @@ module Kitchen
       end
     end
 
+    # Creates labels for links to inside elements
+    # like Figures, Tables, Equations, Exercises, Notes.
+    #
+    # @param label_text [String] label of the element defined in yml file.
+    #   (e.g. "Figure", "Table", "Equation")
+    # @param custom_content [String] might be numbering of the element or text
+    #   copied from content (e.g. note title)
+    # @param cases [Boolean] true if labels should use grammatical cases
+    #   (used in Polish books)
+    # @return [Pantry]
+    #
+    def target_label(label_text: nil, custom_content: nil, cases: false)
+      if cases
+        cases = %w[nominative genitive dative accusative instrumental locative vocative]
+        element_labels = {}
+
+        cases.each do |label_case|
+          element_labels[label_case] = "#{I18n.t("#{label_text}.#{label_case}")} #{custom_content}"
+
+          element_label_case = element_labels[label_case]
+
+          pantry(name: "#{label_case}_link_text").store element_label_case, label: id if id
+        end
+      else
+        element_label = if label_text
+                          "#{I18n.t(label_text.to_s)} #{custom_content}"
+                        else
+                          custom_content
+                        end
+        pantry(name: :link_text).store element_label, label: id if id
+      end
+    end
+
     # @!method pages
     #   Returns a pages enumerator
     def_delegators :as_enumerator, :pages, :chapters, :terms, :figures, :notes, :tables, :examples,
                    :metadatas, :non_introduction_pages, :units, :titles, :exercises, :references,
-                   :composite_pages, :composite_chapters
+                   :composite_pages, :composite_chapters, :solutions, :injected_questions
 
     # Returns this element as an enumerator (over only one element, itself)
     #

data/lib/kitchen/element_enumerator_base.rb

@@ -283,6 +283,41 @@ module Kitchen
       chain_to(MetadataElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
     end
 
+    # Returns an enumerator that iterates through solutions 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 solutions(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(SolutionElementEnumerator, css_or_xpath: css_or_xpath, only: only, except: except)
+    end
+
+    # Returns an enumerator that iterates through injected questions 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 injected_questions(css_or_xpath=nil, only: nil, except: nil)
+      block_error_if(block_given?)
+      chain_to(InjectedQuestionElementEnumerator,
+               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/injected_question_element.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for an example
+  #
+  class InjectedQuestionElement < ElementBase
+
+    # Creates a new +InjectedQuestionElement+
+    #
+    # @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: InjectedQuestionElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :injected_question
+    end
+
+    # Returns the question stimulus as an element.
+    #
+    # @return [Element]
+    #
+    def stimulus
+      first('div[data-type="question-stimulus"]')
+    end
+
+    # Returns the question stem as an element.
+    #
+    # @return [Element]
+    #
+    def stem
+      first('div[data-type="question-stem"]')
+    end
+
+    # Returns the list of answers as an element.
+    #
+    # @return [Element]
+    #
+    def answers
+      first("ol[data-type='question-answers']")
+    end
+
+    # Returns the solution element.
+    #
+    # @return [Element]
+    #
+    def solution
+      first("div[data-type='question-solution']")
+    end
+
+    # Returns the answer correctness given an alphabet
+    #
+    # @return [Array]
+    #
+    def correct_answer_letters(alphabet)
+      answers.search('li[data-type="question-answer"]').each_with_index.map \
+        do |answer, index|
+        answer[:'data-correctness'] == '1.0' ? alphabet[index] : nil
+      end.compact
+    end
+
+    # Returns or creates the question's id
+    #
+    # @return [String]
+    #
+    def id
+      self[:id] ||= "auto_#{ancestor(:page).id.gsub(/page_/, '')}_#{self[:'data-id']}"
+    end
+  end
+end