openstax_kitchen 9.2.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd15ebcb9ead1f1e6301bfc025a93bb3ca7e75d2e412eae3a63d3496574eea5
-  data.tar.gz: 82af5aa1d8151438286f9e6cc21c052f5c7d1549b1966abaf3018f5578fb6f53
+  metadata.gz: 3a071ba6e289c222a7333f401c7d6bd25d6dba9527253b6c6ae123169d9b6425
+  data.tar.gz: 2debc535f61a289f6668019f1eeb5cd639efaf8d49172d668f8b602e02e91b07
 SHA512:
-  metadata.gz: 268bf8bcf65bc1deb38d20e433b503e28eefc0048a5174bb7ea378354354f7c671e88b72378d03ad03ef077f2d15e5870c691bbdec358664e2f5c2c9344a9f33
-  data.tar.gz: ef6c551bb52f90e7bf3301b38879cf2262a62dcc4b91b87c02c4ec944e30f71542dac6b4b3b65763e027737a13fd7b7a77ca86b57366025109b4539eb989f9f4
+  metadata.gz: 6bfeae3a664c95c17249ab32a8bba863091fb1e23f501273fd57d9752688c29ba9877b5a6404393dc88ae993f16af3f89fa768e3984cf81233908ab238b0350a
+  data.tar.gz: '086fa06f8f7eb33f3908c15ba0172a02a1738c943ba87b25245f63626cda51e5163edbece95cdce2ce1907d5815aefd179db7fb7e3a4fe2a7165c623c5120ede'

data/CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [10.0.0] - 2021-07-30
+
+* Add support for baking multipart questions to `BakeNumberedExercise` (minor)
+* Add `has_para` option to `BakeChapterGlossary` for books from Adaptarr (minor)
+* Create `BakeListsWithPara` to remove paragraphs from lists in books created by Adaptarr (minor)
+* Create `Strategy::ContemporaryMath` (minor)
+* Stop `BakeTableBody` from blowing up when table doesn't have an ID (patch)
+* Refactor `MoveExercisesToEOC::V2` & `BakeChapterKeyConcepts` to use `MoveCustomSectionToEocContainer` (minor)
+* Add wrapper support for `MoveCustomSectionToEocContainer` (minor)
+* Create `BakeHandbook` direction (minor)
+* Add `ExampleElement#titles_to_rename` & refactor `BakeExample` (patch)
+* Create `BakeUnitPageTitle` (minor)
+* Fix `BakeExample` to skip baked exercises (patch)
+* Add `FigureElement#figure_to_bake?` (minor)
+* Remove `itemprop` attribute from `BakeChapterSummary` and `BakeFurtherResearch` (major)
+* Fix `NoteElement#title` to exclude nested element titles (patch)
+* Remove `BakeTheorem` (minor)
+* Allow `BakeChapterSolutions` to bake solutions from multiple sections (minor)
+* Add `.os-problem-container` to `BakeFirstElement` selectors (minor)
+* Tweak `BakeExample` to not touch unbaked titles in captions (minor/patch)
+* Tweak `BakeNumberedTables.v1` to cut extra white space (minor)
+
 ## [9.2.0] - 2021-07-19
 
 * Update `BakeFirstElements` to also add the `.has-first-inline-list` class (minor)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openstax_kitchen (9.2.0)
+    openstax_kitchen (10.0.0)
       activesupport
       i18n
       nokogiri

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

@@ -5,12 +5,13 @@ module Kitchen
     # Bake directons for eoc glossary
     #
     module BakeChapterGlossary
-      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil)
+      def self.v1(chapter:, metadata_source:, append_to: nil, uuid_prefix: nil, has_para: false)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
           append_to: append_to,
-          uuid_prefix: uuid_prefix
+          uuid_prefix: uuid_prefix,
+          has_para: has_para
         )
       end
     end

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

@@ -21,9 +21,18 @@ module Kitchen::Directions::BakeChapterGlossary
       attr_reader :sortable
     end
 
-    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '')
+    def bake(chapter:, metadata_source:, append_to: nil, uuid_prefix: '', has_para: false)
       @glossary = []
 
+      # Use for books created by Adaptarr, where dd contains paragraphs
+      # More info: https://github.com/openstax/kitchen/issues/284
+      if has_para
+        chapter.glossaries.search('dd').each do |description|
+          description_content = description.first('p').text
+          description.replace_children with: description_content
+        end
+      end
+
       chapter.glossaries.search('dl').each do |definition_element|
         @glossary.push(Definition.new(definition_element.cut))
       end

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

@@ -3,29 +3,20 @@
 module Kitchen::Directions::BakeChapterKeyConcepts
   class V1
     def bake(chapter:, metadata_source:, append_to:, 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?
-
-        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: page)
-        key_concepts.each do |key_concept|
-          Kitchen::Directions::RemoveSectionTitle.v1(section: key_concept)
-          key_concept.prepend(child: title)
-          key_concept.wrap("<div class='os-section-area'>")
-          page.search('div.os-section-area').first.cut(to: key_concepts_clipboard)
-        end
-      end
-
-      content = "<div class=\"os-key-concepts\"> #{key_concepts_clipboard.paste} </div>"
-
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
         container_key: 'key-concepts',
         uuid_key: "#{uuid_prefix}key-concepts",
-        metadata_source: metadata_source,
-        content: content,
-        append_to: append_to || chapter
-      )
+        section_selector: 'section.key-concepts',
+        append_to: append_to || chapter,
+        include_intro_page: false,
+        wrap_section: true, wrap_content: true
+      ) do |section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: section)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: section.ancestor(:page))
+        section.prepend(child: title)
+      end
     end
   end
 end

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

@@ -3,8 +3,13 @@
 module Kitchen
   module Directions
     module BakeChapterSolutions
-      def self.v1(chapter:, metadata_source:, uuid_prefix: '')
-        V1.new.bake(chapter: chapter, metadata_source: metadata_source, uuid_prefix: uuid_prefix)
+      def self.v1(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
+        V1.new.bake(
+          chapter: chapter,
+          metadata_source: metadata_source,
+          uuid_prefix: uuid_prefix,
+          classes: classes
+        )
       end
     end
   end

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

@@ -2,20 +2,22 @@
 
 module Kitchen::Directions::BakeChapterSolutions
   class V1
-    def bake(chapter:, metadata_source:, uuid_prefix: '')
+    def bake(chapter:, metadata_source:, uuid_prefix: '', classes: %w[free-response])
       solutions_clipboard = Kitchen::Clipboard.new
 
-      chapter.search('section.free-response').each do |free_response_question|
-        exercises = free_response_question.exercises
-        # must run AFTER .free-response notes are baked
+      classes.each do |klass|
+        chapter.search("section.#{klass}").each do |question|
+          exercises = question.exercises
+          # must run AFTER the other sections are baked
 
-        next if exercises.none?
+          next if exercises.none?
 
-        exercises.each do |exercise|
-          solution = exercise.solution
-          next unless solution.present?
+          exercises.each do |exercise|
+            solution = exercise.solution
+            next unless solution.present?
 
-          solution.cut(to: solutions_clipboard)
+            solution.cut(to: solutions_clipboard)
+          end
         end
       end
 

data/lib/kitchen/directions/bake_chapter_summary.rb

@@ -26,7 +26,6 @@ module Kitchen
             summary.first("[data-type='title']")&.trash # get rid of old title if exists
             title = EocSectionTitleLinkSnippet.v1(page: page)
             summary.prepend(child: title)
-            summary.first('h3')[:itemprop] = 'name'
             summary.cut(to: summaries)
           end
 

data/lib/kitchen/directions/bake_example.rb

@@ -20,18 +20,14 @@ module Kitchen
                .pantry(name: :link_text)
                .store("#{I18n.t(:example_label)} #{number}", label: example.id)
 
-        example.titles.each do |title|
-          if title.parent.has_class?('os-caption-container') || \
-             title.parent.has_class?('os-caption')
-            next
-          end
-
+        example.titles_to_rename.each do |title|
           title.name = 'h4'
         end
 
         example.exercises.each do |exercise|
+          next if exercise.baked?
+
           if (problem = exercise.problem)
-            problem.titles.each { |title| title.name = 'h4' }
             problem.wrap_children(class: 'os-problem-container')
           end
 

data/lib/kitchen/directions/bake_first_elements.rb

@@ -19,11 +19,12 @@ module Kitchen
         end
 
         # add first-inline-element class
-        inline_list = within&.first('div.os-solution-container > ol[type="1"]:first-child')
-        return unless inline_list
-
-        inline_list.add_class('first-inline-list-element')
-        inline_list.parent.add_class('has-first-inline-list-element')
+        inline_selector = 'div.os-solution-container > ol[type="1"]:first-child,' \
+                           'div.os-problem-container > ol[type="1"]:first-child'
+        within.search(inline_selector).each do |inline_list|
+          inline_list.add_class('first-inline-list-element')
+          inline_list.parent.add_class('has-first-inline-list-element')
+        end
       end
     end
   end

data/lib/kitchen/directions/bake_further_research.rb

@@ -26,7 +26,6 @@ module Kitchen
             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
         end
       end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    module BakeHandbook
+      def self.v1(book:, title_element: 'h1')
+        V1.new.bake(book: book, title_element: title_element)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeHandbook
+  class V1
+    def bake(book:, title_element:)
+      book.pages('$.handbook').each do |page|
+        page.titles.each do |title|
+          title.replace_children(with:
+            <<~HTML
+              <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+            HTML
+          )
+          title.name = title_element
+        end
+
+        # Create Outline Title
+        outline_html = <<~HTML
+          <div class="os-handbook-outline">
+            <h3 class="os-title">#{I18n.t(:handbook_outline_title)}</h3>
+          </div>
+        HTML
+        page.title.append(sibling: outline_html)
+
+        bake_first_section_title_and_objectives(page: page)
+        fix_nested_section_headers(page: page)
+      end
+    end
+
+    # Bake Handbook First Section Title
+    def bake_first_section_title_and_objectives(page:)
+      outline_items_html = []
+      page.search('> section').each do |section|
+        first_section_title = section.titles.first
+        first_section_title.replace_children(with:
+          <<~HTML
+            <span class="os-part-text">H</span>
+            <span class="os-number">#{section.count_in(:page)}</span>
+            <span class="os-divider">. </span>
+            <span class="os-text">#{first_section_title.text}</span>
+          HTML
+        )
+        first_section_title.name = 'h2'
+
+        outline_item_html = <<~HTML
+          <div class="os-handbook-objective">
+            <a class="os-handbook-objective" href="##{first_section_title[:id]}">
+              #{first_section_title.children}
+            </a>
+          </div>
+        HTML
+        outline_items_html.push(outline_item_html)
+      end
+      page.search('.os-handbook-outline').first.append(child:
+        <<~HTML
+          #{outline_items_html.join}
+        HTML
+      )
+    end
+
+    def fix_nested_section_headers(page:)
+      page.search('section').each do |section|
+        section_data_depth = section[:'data-depth']
+        case section_data_depth
+        when '2'
+          section.titles.first.name = 'h3'
+        when '3'
+          section.titles.first.name = 'h4'
+        when '4'
+          section.titles.first.name = 'h5'
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/directions/bake_lists_with_para.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Directions
+    # Bakes lists with paragraphs
+    # Should be used for books created by Adaptarr to put list text 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?
+        end
+      end
+    end
+  end
+end

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

@@ -37,6 +37,25 @@ 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

@@ -10,7 +10,7 @@ module Kitchen
         table.wrap(%(<div class="os-table">))
 
         table_label = "#{I18n.t(:table_label)} #{number}"
-        table.pantry(name: :link_text).store table_label, label: table.id
+        table.pantry(name: :link_text).store table_label, label: table.id if table.id
 
         if table.top_titled?
           table.parent.add_class('os-top-titled-container')

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

@@ -16,7 +16,7 @@ module Kitchen::Directions::BakeNumberedTable
         HTML
       end
 
-      if (caption = table.caption&.cut)
+      if (caption = table.caption&.cut) && !caption&.children&.to_s&.blank?
         new_caption = <<~HTML
           \n<span class="os-caption">#{caption.children}</span>
         HTML

data/lib/kitchen/directions/bake_toc.rb

@@ -28,6 +28,8 @@ module Kitchen
 
       def self.li_for_unit(unit)
         chapters = unit.element_children.only(ChapterElement)
+        pages = unit.element_children.only(PageElement)
+
         <<~HTML
           <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit">
             <a href="#">
@@ -36,6 +38,7 @@ module Kitchen
               <span data-type itemprop class="os-text">#{unit.title_text}</span>
             </a>
             <ol class="os-unit">
+              #{pages.map { |page| li_for_page(page) }.join("\n")}
               #{chapters.map { |chapter| li_for_chapter(chapter) }.join("\n")}
             </ol>
           </li>
@@ -92,6 +95,10 @@ module Kitchen
               'os-toc-preface'
             elsif page.is_handbook?
               'os-toc-handbook'
+            elsif page.has_ancestor?(:unit) && !
+                  page.has_ancestor?(:chapter) && !
+                  page.has_ancestor?(:composite_chapter)
+              'os-toc-unit-page'
             else
               raise "do not know what TOC class to use for page with classes #{page.classes}"
             end

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

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::BakeUnitPageTitle
+  class V1
+    def bake(book:)
+      book.units.pages.each do |page|
+        compose_unit_page_title(page: page)
+      end
+    end
+
+    def compose_unit_page_title(page:)
+      title = page.title
+      title.name = 'h2'
+      title.replace_children(with:
+        <<~HTML
+          <span data-type="" itemprop="" class="os-text">#{title.text}</span>
+        HTML
+      )
+    end
+  end
+end

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

@@ -18,7 +18,8 @@ module Kitchen
       # @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)
+                  section_selector:, append_to: nil, include_intro_page: true,
+                  wrap_section: false, wrap_content: false)
         V1.new.bake(
           chapter: chapter,
           metadata_source: metadata_source,
@@ -26,7 +27,9 @@ module Kitchen
           uuid_key: uuid_key,
           section_selector: section_selector,
           append_to: append_to || chapter,
-          include_intro_page: include_intro_page
+          include_intro_page: include_intro_page,
+          wrap_section: wrap_section,
+          wrap_content: wrap_content
         ) do |section|
           yield section if block_given?
         end

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

@@ -5,20 +5,36 @@
 module Kitchen::Directions::MoveCustomSectionToEocContainer
   class V1
     def bake(chapter:, metadata_source:, container_key:, uuid_key:,
-             section_selector:, append_to:, include_intro_page:, &block)
+             section_selector:, append_to:, include_intro_page:, wrap_section:, wrap_content:,
+             &block)
       section_clipboard = Kitchen::Clipboard.new
       pages = include_intro_page ? chapter.pages : chapter.non_introduction_pages
       sections = pages.search(section_selector)
       sections.each(&block)
+      if wrap_section
+        sections.each { |section| section.wrap('<div class="os-section-area">') }
+        sections = pages.search('div.os-section-area')
+      end
       sections.cut(to: section_clipboard)
 
       return if section_clipboard.none?
 
+      content = \
+        if wrap_content
+          <<~HTML
+            <div class="os-#{container_key}">
+              #{section_clipboard.paste}
+            </div>
+          HTML
+        else
+          section_clipboard.paste
+        end
+
       Kitchen::Directions::EocCompositePageContainer.v1(
         container_key: container_key,
         uuid_key: uuid_key,
         metadata_source: metadata_source,
-        content: section_clipboard.paste,
+        content: content,
         append_to: append_to || chapter
       )
     end

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

@@ -5,38 +5,20 @@ module Kitchen::Directions::MoveExercisesToEOC
   # and some additional wrappers
   class V2
     def bake(chapter:, metadata_source:, klass:, append_to: nil, uuid_prefix: '.')
-      exercise_clipboard = Kitchen::Clipboard.new
-
-      chapter.non_introduction_pages.each do |page|
-        sections = page.search("section.#{klass}")
-
-        sections.each do |exercise_section|
-          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">')
-          exercise_section = exercise_section.parent
-          exercise_section.cut(to: exercise_clipboard)
-        end
-      end
-
-      return if exercise_clipboard.none?
-
-      content = <<~HTML
-        <div class="os-#{klass}">
-          #{exercise_clipboard.paste}
-        </div>
-      HTML
-
-      Kitchen::Directions::EocCompositePageContainer.v1(
+      Kitchen::Directions::MoveCustomSectionToEocContainer.v1(
+        chapter: chapter,
+        metadata_source: metadata_source,
         container_key: klass,
         uuid_key: "#{uuid_prefix}#{klass}",
-        metadata_source: metadata_source,
-        content: content,
-        append_to: append_to || chapter
-      )
+        section_selector: "section.#{klass}",
+        append_to: append_to || chapter,
+        include_intro_page: false,
+        wrap_section: true, wrap_content: true
+      ) do |section|
+        Kitchen::Directions::RemoveSectionTitle.v1(section: section)
+        title = Kitchen::Directions::EocSectionTitleLinkSnippet.v1(page: section.ancestor(:page))
+        section.prepend(child: title)
+      end
     end
   end
 end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Kitchen::Directions::MoveSolutionsToAnswerKey
+  module Strategies
+    class ContemporaryMath
+      def bake(chapter:, append_to:)
+        solutions_clipboard = Kitchen::Clipboard.new
+        chapter.notes('$.your-turn').exercises.each do |exercise|
+          solution = exercise.solution
+          next unless solution
+
+          # Hacky numbering fix
+          number = exercise.ancestor(:note).count_in(:chapter)
+          solution.first('a.os-number').inner_html = number.to_s
+          solution.first('span.os-divider').inner_html = '. '
+          solution.cut(to: solutions_clipboard)
+        end
+        title = <<~HTML
+          <h3 data-type="title">
+            <span class="os-title-label">#{I18n.t(:'notes.your-turn')}</span>
+          </h3>
+        HTML
+        append_solution_area(title: title, solutions: solutions_clipboard,
+                             append_to: append_to)
+      end
+
+      def append_solution_area(title:, solutions:, append_to:)
+        append_to = append_to.add_child(
+          <<~HTML
+            <div class="os-solution-area">
+              #{title}
+            </div>
+          HTML
+        ).first
+
+        append_to.add_child(solutions.paste)
+      end
+    end
+  end
+end

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

@@ -2,11 +2,16 @@
 
 module Kitchen::Directions::MoveSolutionsToAnswerKey
   class V1
-    def bake(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {}, solutions_plural: true)
+    # rubocop:disable Metrics/ParameterLists
+    # This direction may need refactoring to simplify parameters
+    def bake(chapter:, metadata_source:, strategy:, append_to:, strategy_options: {},
+             solutions_plural: true)
       strategy =
         case strategy
         when :calculus
           Strategies::Calculus.new
+        when :contemporary_math
+          Strategies::ContemporaryMath.new
         when :uphysics
           Strategies::UPhysics.new
         when :precalculus
@@ -34,5 +39,6 @@ module Kitchen::Directions::MoveSolutionsToAnswerKey
       )
       strategy.bake(chapter: chapter, append_to: append_to.last_element)
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

data/lib/kitchen/example_element.rb

@@ -27,9 +27,15 @@ module Kitchen
     #
     # @return [ElementEnumerator]
     #
-    def titles
-      search("[data-type='title']")
+    def titles_to_rename
+      titles(except: \
+        lambda do |title|
+          title.parent.has_class?('os-caption-container') || \
+          title.parent.has_class?('os-caption') || \
+          title.parent.name == 'caption' || \
+          title.parent[:'data-type'] == 'note'
+        end
+      )
     end
-
   end
 end

data/lib/kitchen/exercise_element.rb

@@ -38,5 +38,13 @@ module Kitchen
     def solution
       first("div[data-type='solution']")
     end
+
+    # Returns whether the exercise has been baked
+    #
+    # @return [Boolean]
+    #
+    def baked?
+      search('div.os-problem-container').any?
+    end
   end
 end

data/lib/kitchen/figure_element.rb

@@ -47,5 +47,16 @@ module Kitchen
       parent.name == 'figure'
     end
 
+    # Returns true unless the figure is a subfigure or has the 'unnumbered' class,
+    # unless the figure has both the 'unnumbered' and the 'splash' classes.
+    #
+    # @return [Boolean]
+    #
+    def figure_to_bake?
+      return false if subfigure? || (has_class?('unnumbered') && !has_class?('splash'))
+
+      true
+    end
+
   end
 end

data/lib/kitchen/note_element.rb

@@ -29,7 +29,14 @@ module Kitchen
     #
     def title
       block_error_if(block_given?)
-      first("[data-type='title']")
+      note_body = first('div.os-note-body')
+      first_child = note_body ? note_body.element_children[0] : element_children[0]
+
+      if first_child[:'data-type'] == 'title'
+        first_child
+      elsif first_child&.element_children&.[](0)&.[](:'data-type') == 'title'
+        first_child.element_children[0]
+      end
     end
 
     # Returns true if the note's title is autogenerated

data/lib/kitchen/page_element.rb

@@ -103,14 +103,6 @@ module Kitchen
       first!('section.exercises')
     end
 
-    # Returns the key concepts
-    #
-    # @return [Element]
-    #
-    def key_concepts
-      search('section.key-concepts')
-    end
-
     # Returns the free response questions
     #
     # @return [Element]

data/lib/kitchen/version.rb

@@ -3,5 +3,5 @@
 # A library for modifying the structure of OpenStax book XML.
 #
 module Kitchen
-  VERSION = '9.2.0'
+  VERSION = '10.0.0'
 end

data/lib/locales/en.yml

@@ -27,6 +27,7 @@ en:
   review_exercises: Review Exercises
   section_exercises: ! 'Section %{number} Exercises'
   iframe_link_text: Click to view content
+  handbook_outline_title: Outline
   eoc:
     glossary: Key Terms
     key-equations: Key Equations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_kitchen
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 10.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -274,11 +274,14 @@ files:
 - lib/kitchen/directions/bake_free_response/main.rb
 - lib/kitchen/directions/bake_free_response/v1.rb
 - lib/kitchen/directions/bake_further_research.rb
+- lib/kitchen/directions/bake_handbook/main.rb
+- lib/kitchen/directions/bake_handbook/v1.rb
 - lib/kitchen/directions/bake_index/main.rb
 - lib/kitchen/directions/bake_index/v1.rb
 - lib/kitchen/directions/bake_index/v1.xhtml.erb
 - lib/kitchen/directions/bake_inline_lists.rb
 - lib/kitchen/directions/bake_link_placeholders.rb
+- lib/kitchen/directions/bake_lists_with_para.rb
 - lib/kitchen/directions/bake_math_in_paragraph.rb
 - lib/kitchen/directions/bake_non_introduction_pages.rb
 - lib/kitchen/directions/bake_notes/bake_autotitled_notes.rb
@@ -303,9 +306,9 @@ files:
 - lib/kitchen/directions/bake_references/v2.rb
 - lib/kitchen/directions/bake_stepwise.rb
 - lib/kitchen/directions/bake_suggested_reading.rb
-- lib/kitchen/directions/bake_theorem/main.rb
-- lib/kitchen/directions/bake_theorem/v1.rb
 - lib/kitchen/directions/bake_toc.rb
+- lib/kitchen/directions/bake_unit_page_title/main.rb
+- lib/kitchen/directions/bake_unit_page_title/v1.rb
 - lib/kitchen/directions/bake_unit_title/main.rb
 - lib/kitchen/directions/bake_unit_title/v1.rb
 - lib/kitchen/directions/bake_unnumbered_tables.rb
@@ -326,6 +329,7 @@ files:
 - lib/kitchen/directions/move_exercises_to_eoc/v3.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/main.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/strategies/calculus.rb
+- lib/kitchen/directions/move_solutions_to_answer_key/strategies/contemporary_math.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/strategies/default.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/strategies/precalculus.rb
 - lib/kitchen/directions/move_solutions_to_answer_key/strategies/uphysics.rb

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

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

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Kitchen::Directions::BakeTheorem
-  class V1
-    def bake(theorem:, number:)
-      theorem['use-subtitle'] = true
-      new_subtitle = theorem.title.cut
-
-      theorem.wrap_children(class: 'os-note-body')
-      note_body = theorem.first('.os-note-body')
-
-      note_body.prepend(sibling:
-        <<~HTML
-          <div class="os-title">
-            <span class="os-title-label">#{I18n.t(:theorem)} </span>
-            <span class="os-number">#{number}</span>
-            <span class="os-divider"> </span>
-          </div>
-        HTML
-      )
-
-      new_subtitle.name = 'h4'
-      new_subtitle.add_class('os-subtitle')
-      new_subtitle.children.wrap('<span class="os-subtitle-label">')
-      note_body.prepend(child: new_subtitle.paste)
-    end
-  end
-end