openstax_kitchen 11.0.0 → 11.1.0

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

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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeIframes
+  class V1
+    def bake(outer_element:)
+      iframes = outer_element.search('iframe')
+      return unless iframes.any?
+
+      iframes.each do |iframe|
+        iframe.wrap('<div class="os-has-iframe" data-type="alternatives">')
+        iframe.add_class('os-is-iframe')
+        link_ref = iframe[:src]
+        next unless link_ref
+
+        iframe = iframe.parent
+        iframe.add_class('os-has-link')
+        iframe.prepend(child:
+          <<~HTML
+            <a class="os-is-link" href="#{link_ref}" target="_window">#{I18n.t(:iframe_link_text)}</a>
+          HTML
+        )
+      end
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeIndex
-      def self.v1(book:)
-        V1.new.bake(book: book)
+      def self.v1(book:, types: %w[main], uuid_prefix: nil)
+        V1.new.bake(book: book, types: types, uuid_prefix: uuid_prefix)
       end
     end
   end

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

@@ -65,7 +65,7 @@ module Kitchen::Directions::BakeIndex
         return -1 if force_first
         return 1 if other.force_first
 
-        name <=> other.name
+        I18n.sort_strings(name, other.name)
       end
 
       protected
@@ -112,9 +112,15 @@ module Kitchen::Directions::BakeIndex
       end
     end
 
-    def bake(book:)
+    def bake(book:, types: %w[main], uuid_prefix: '')
       @metadata_elements = book.metadata.children_to_keep.copy
-      @index = Index.new
+      @uuid_prefix = uuid_prefix
+      @indexes = types.each.with_object({}) do |type, hash|
+        index_name = type == 'main' ? 'term' : type
+        hash[index_name] = Index.new
+      end
+
+      # Numbering of IDs doesn't depend on term type
 
       book.pages.terms.each do |term_element|
         page = term_element.ancestor(:page)
@@ -132,18 +138,44 @@ module Kitchen::Directions::BakeIndex
         add_term_to_index(term_element, page_title)
       end
 
-      book.first('body').append(child: render(file: 'v1.xhtml.erb'))
+      types.each do |type|
+        @container_class = "os-index#{"-#{type}" unless type == 'main'}-container"
+        @uuid_key = "#{uuid_prefix}index#{"-#{type}" unless type == 'main'}"
+        @title = I18n.t("index.#{type}")
+
+        index_name = type == 'main' ? 'term' : type
+        @index = @indexes[index_name]
+
+        book.first('body').append(child: render(file: 'v1.xhtml.erb'))
+      end
     end
 
     def add_term_to_index(term_element, page_title)
-      group_by = I18n.transliterate(term_element.text.strip[0])
+      type =
+        if !term_element.key?('index')
+          'term'
+        elsif term_element['cxlxt:index'] == 'name'
+          'name'
+        elsif term_element['cxlxt:index'] == 'foreign'
+          'foreign'
+        end
+
+      if term_element.key?('reference')
+        term_reference = term_element['cmlnle:reference']
+        group_by = term_reference[0]
+        content = term_reference
+      else
+        group_by = I18n.transliterate(term_element.text.strip[0])
+        content = term_element.text
+      end
+
       group_by = I18n.t(:eob_index_symbols_group) unless group_by.match?(/[[:alpha:]]/)
       term_element['group-by'] = group_by
 
       # Add it to our index object
-      @index.add_term(
+      @indexes[type].add_term(
         Term.new(
-          text: term_element.text,
+          text: content,
           id: term_element.id,
           group_by: group_by,
           page_title: page_title.gsub(/\n/, '')

data/lib/kitchen/directions/bake_index/v1.xhtml.erb

@@ -1,9 +1,9 @@
-<div class="os-eob os-index-container " data-type="composite-page" data-uuid-key="index">
+<div class="os-eob <%= @container_class %>" data-type="composite-page" data-uuid-key="<%= @uuid_key %>">
   <h1 data-type="document-title">
-    <span class="os-text"><%= I18n.t(:eob_index_title) %></span>
+    <span class="os-text"><%= @title %></span>
   </h1>
   <div data-type="metadata" style="display: none;">
-    <h1 data-type="document-title" itemprop="name"><%= I18n.t(:eob_index_title) %></h1>
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
     <%= @metadata_elements.paste %>
   </div>
   <% @index.sections.each do |section| %>

data/lib/kitchen/directions/bake_injected_exercise.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeInjectedExercise
+  def self.v1(exercise:)
+    V1.new.bake(exercise: exercise)
+  end
+
+  class V1
+    def bake(exercise:)
+      context = exercise.search('div[data-type="exercise-context"]')&.first
+      return unless context
+
+      # link replacement is done by BakeLinkPlaceholders
+      link = context.first('a').cut
+      context.replace_children(with: "#{I18n.t(:context_lead_text)}#{link.paste}")
+    end
+  end
+end

data/lib/kitchen/directions/bake_injected_exercise_question.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeInjectedExerciseQuestion
+  def self.v1(question:, number:, only_number_solution: false)
+    V1.new.bake(question: question, number: number, only_number_solution: only_number_solution)
+  end
+
+  class V1
+    def bake(question:, number:, only_number_solution:)
+      id = question.id
+
+      # Store label in pantry
+      unless only_number_solution
+        label_number = "#{question.ancestor(:chapter).count_in(:book)}.#{number}"
+        question.target_label(label_text: 'exercise', custom_content: label_number)
+      end
+
+      # Synthesize multiple choice solution
+      if question.answers
+        case question.answers[:type]
+        when 'a'
+          alphabet = *('a'..'z')
+        else
+          raise('Unsupported list type for multiple choice options')
+        end
+        letter_answers = question.correct_answer_letters(alphabet)
+      end
+      if letter_answers.present?
+        question.append(child:
+          <<~HTML
+            <div data-type="question-solution">#{letter_answers.join(', ')}</div>
+          HTML
+        )
+      end
+
+      # Bake question
+      unless only_number_solution
+        problem_number = "<span class='os-number'>#{number}</span>"
+        if question.solution
+          problem_number = "<a class='os-number' href='##{id}-solution'>#{number}</a>"
+        end
+      end
+
+      question.prepend(child:
+        <<~HTML
+          #{problem_number unless only_number_solution}
+          #{"<span class='os-divider'>. </span>" unless only_number_solution}
+          <div class="os-problem-container">
+            #{question.stimulus&.cut&.paste}
+            #{question.stem.cut.paste}
+            #{question.answers&.cut&.paste}
+          </div>
+        HTML
+      )
+
+      # Bake solution
+      solution = question.solution
+      return unless solution
+
+      question.add_class('os-hasSolution')
+      solution.id = "#{id}-solution"
+      solution.replace_children(with:
+        <<~HTML
+          <a class='os-number' href='##{id}'>#{number}</a>
+          <span class='os-divider'>. </span>
+          <div class="os-solution-container">#{solution.children}</div>
+        HTML
+      )
+    end
+  end
+end

data/lib/kitchen/directions/bake_link_placeholders.rb

@@ -5,12 +5,25 @@ module Kitchen
     # Bake directions for link placeholders
     #
     module BakeLinkPlaceholders
-      def self.v1(book:)
+      def self.v1(book:, cases: false)
         book.search('a').each do |anchor|
           next unless anchor.text == '[link]'
 
+          label_case = anchor['cmlnle:case']
           id = anchor[:href][1..-1]
-          replacement = book.pantry(name: :link_text).get(id)
+
+          if cases
+            pantry_name = if anchor.key?('case')
+                            "#{label_case}_link_text"
+                          else
+                            'nominative_link_text'
+                          end
+
+            replacement = book.pantry(name: pantry_name).get(id)
+          else
+            replacement = book.pantry(name: :link_text).get(id)
+          end
+
           if replacement.present?
             anchor.replace_children(with: replacement)
           else

data/lib/kitchen/directions/bake_lists_with_para.rb

@@ -3,13 +3,13 @@
 module Kitchen
   module Directions
     # Bakes lists with paragraphs
-    # Should be used for books created by Adaptarr to put list text directly to <li>
+    # Should be used for books created by Adaptarr to put list content directly to <li>
     #
     module BakeListsWithPara
       def self.v1(book:)
         book.search('li').each do |item|
-          item_content = item.first('p')&.text
-          item.replace_children with: item_content unless item_content.nil?
+          item_para = item.first('p')&.cut
+          item.replace_children with: item_para.children unless item_para.nil?
         end
       end
     end

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

@@ -3,19 +3,19 @@
 module Kitchen
   module Directions
     module BakeAutotitledNotes
-      def self.v1(book:, classes:)
+      def self.v1(book:, classes:, bake_subtitle: true, cases: false)
         book.notes.each do |note|
           next unless (note.classes & classes).any?
 
-          bake_note(note: note)
+          bake_note(note: note, bake_subtitle: bake_subtitle, cases: cases)
         end
       end
 
-      def self.bake_note(note:)
-        BakeNoteIFrames.v1(note: note)
+      def self.bake_note(note:, bake_subtitle:, cases: false)
+        Kitchen::Directions::BakeIframes.v1(outer_element: note)
         note.wrap_children(class: 'os-note-body')
 
-        BakeNoteSubtitle.v1(note: note)
+        BakeNoteSubtitle.v1(note: note, cases: cases) if bake_subtitle
 
         note.prepend(child:
           <<~HTML

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

@@ -3,14 +3,18 @@
 module Kitchen
   module Directions
     module BakeNoteSubtitle
-      def self.v1(note:)
+      def self.v1(note:, cases: false)
         title = note.title&.cut
 
         return unless title
 
         # Store label information
         note_label = title.children
-        note.pantry(name: :link_text).store note_label, label: note.id
+        if cases
+          note.target_label(label_text: 'note', custom_content: note_label.to_s, cases: cases)
+        else
+          note.target_label(custom_content: note_label.to_s)
+        end
 
         title.name = 'h4'
         title.add_class('os-subtitle')

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

@@ -3,8 +3,8 @@
 module Kitchen
   module Directions
     module BakeNumberedNotes
-      def self.v1(book:, classes:)
-        V1.new.bake(book: book, classes: classes)
+      def self.v1(book:, classes:, cases: false)
+        V1.new.bake(book: book, classes: classes, cases: cases)
       end
 
       def self.v2(book:, classes:)
@@ -21,6 +21,8 @@ module Kitchen
       # Used by V1, V2, V3
       def self.bake_note_exercise(note:, exercise:, divider: ' ', suppress_solution: false)
         exercise.add_class('unnumbered')
+        number = note.first('.os-number').text.gsub(/#/, '')
+
         # bake problem
         exercise.problem.wrap_children('div', class: 'os-problem-container')
         exercise.search('[data-type="commentary"]').each(&:trash)
@@ -33,11 +35,19 @@ module Kitchen
         else
           BakeNumberedExercise.bake_solution_v1(
             exercise: exercise,
-            number: note.first('.os-number').text.gsub(/#/, ''),
+            number: number,
             divider: divider
           )
         end
       end
+
+      def self.bake_note_injected_question(note:, question:)
+        question.add_class('unnumbered')
+        number = note.first('.os-number').text.gsub(/#/, '')
+        Kitchen::Directions::BakeInjectedExerciseQuestion.v1(
+          question: question, number: number, only_number_solution: true
+        )
+      end
     end
   end
 end

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

@@ -1,37 +1,41 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeNumberedNotes
-
-  class V1
-    def bake(book:, classes:)
-      classes.each do |klass|
-        book.chapters.notes("$.#{klass}").each do |note|
-          bake_note(note: note)
-          note.exercises.each do |exercise|
-            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise)
+module Kitchen::Directions
+  module BakeNumberedNotes
+    class V1
+      def bake(book:, classes:, cases: false)
+        classes.each do |klass|
+          book.chapters.pages.notes("$.#{klass}").each do |note|
+            bake_note(note: note, cases: cases)
+            note.exercises.each do |exercise|
+              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise)
+            end
+            note.injected_questions.each do |question|
+              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+            end
           end
         end
       end
-    end
 
-    def bake_note(note:)
-      note.wrap_children(class: 'os-note-body')
+      def bake_note(note:, cases: false)
+        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
-          <h3 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>
-          </h3>
-        HTML
-      )
+        chapter_count = note.ancestor(:chapter).count_in(:book)
+        note_count = note.count_in(:chapter)
+        note.prepend(child:
+          <<~HTML
+            <h3 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>
+            </h3>
+          HTML
+        )
 
-      return unless note['use-subtitle']
+        return unless note['use-subtitle']
 
-      Kitchen::Directions::BakeNoteSubtitle.v1(note: note)
+        BakeNoteSubtitle.v1(note: note, cases: cases)
+      end
     end
   end
 end

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

@@ -1,22 +1,27 @@
 # frozen_string_literal: true
 
-module Kitchen::Directions::BakeNumberedNotes
-  class V2
-    def bake(book:, classes:)
-      classes.each do |klass|
-        book.chapters.pages.notes("$.#{klass}").each do |note|
-          note.wrap_children(class: 'os-note-body')
-          note_count = note.count_in(:page)
-          note.prepend(child:
-            <<~HTML
-              <h3 class="os-title">
-                <span class="os-title-label">#{note.autogenerated_title}</span>
-                <span class="os-number">##{note_count}</span>
-              </h3>
-            HTML
-          )
-          note.exercises.each do |exercise|
-            Kitchen::Directions::BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise, divider: '. ')
+module Kitchen::Directions
+  module BakeNumberedNotes
+    class V2
+      def bake(book:, classes:)
+        classes.each do |klass|
+          book.chapters.pages.notes("$.#{klass}").each do |note|
+            note.wrap_children(class: 'os-note-body')
+            note_count = note.count_in(:page)
+            note.prepend(child:
+              <<~HTML
+                <h3 class="os-title">
+                  <span class="os-title-label">#{note.autogenerated_title}</span>
+                  <span class="os-number">##{note_count}</span>
+                </h3>
+              HTML
+            )
+            note.exercises.each do |exercise|
+              BakeNumberedNotes.bake_note_exercise(note: note, exercise: exercise, divider: '. ')
+            end
+            note.injected_questions.each do |question|
+              BakeNumberedNotes.bake_note_injected_question(note: note, question: question)
+            end
           end
         end
       end