Merge pull request #409 from openstax/algebra-1-recipe

Algebra 1 recipe

Author: TylerZeroMaster

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* Add `suppress_solution_title` to `bake_numbered_exercise`
+* Add recipe for `algebra-1`
+* Add support for offsets in `ElementBase.os_number`
 * Support `unit-closer` pages in TOC
 * Fix iframes links for Polish books
 * Create `number_parts` method in `ElementBase`

lib/kitchen/chapter_element.rb

@@ -36,6 +36,14 @@ def title
       first!("./*[@data-type = 'document-title']")
     end
 
+    # Returns the title's text regardless of whether the title has been baked
+    #
+    # @return [String]
+    #
+    def title_text
+      title.children.one? ? title.text : title.first('.os-text').text
+    end
+
     # Returns the introduction page
     #
     # @return [Element, nil]

lib/kitchen/directions/bake_numbered_exercise/v1.rb

@@ -51,6 +51,7 @@ def bake(exercise:, number:, options:)
             exercise: exercise,
             number: number,
             solution_stays_put: options[:solution_stays_put],
+            with_title: !options[:suppress_solution_title],
             in_appendix: in_appendix
           )
         end
@@ -65,17 +66,25 @@ def bake(exercise:, number:, options:)
       )
     end
 
-    def bake_solution(exercise:, number:, solution_stays_put:, divider: '. ', in_appendix: false)
+    # rubocop:disable Metrics/ParameterLists
+    def bake_solution(exercise:,
+                      number:,
+                      solution_stays_put:,
+                      with_title: true,
+                      divider: '. ',
+                      in_appendix: false)
       solution = exercise.solution
       if solution_stays_put
         solution.wrap_children(class: 'os-solution-container')
-        solution.prepend(child:
-          <<~HTML
-            <h4 class="solution-title" data-type="title">
-              <span class="os-text">#{I18n.t(:solution)}</span>
-            </h4>
-          HTML
-        )
+        if with_title
+          solution.prepend(child:
+            <<~HTML
+              <h4 class="solution-title" data-type="title">
+                <span class="os-text">#{I18n.t(:solution)}</span>
+              </h4>
+            HTML
+          )
+        end
         return
       end
 
@@ -94,5 +103,6 @@ def bake_solution(exercise:, number:, solution_stays_put:, divider: '. ', in_app
         HTML
       )
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

lib/kitchen/directions/bake_toc.rb

@@ -2,19 +2,53 @@
 
 module Kitchen
   module Directions
+    # rubocop:disable Metrics/ModuleLength
     module BakeToc
       def self.v1(book:, options: { cases: false })
         options.reverse_merge!(
           cases: false,
-          numbering_options: { mode: :chapter_page, separator: '.' }
+          numbering_options: { mode: :chapter_page, separator: '.' },
+          controller: {
+            get_chapter_toc_title: nil,
+            get_unit_toc_title: nil
+          }
         )
+        controller = options[:controller]
+        @toc_title_for_unit =
+          if controller[:get_unit_toc_title].nil?
+            lambda do |unit|
+              number = unit.os_number(options[:numbering_options])
+              <<~HTML
+                <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span>#{number}</span>
+                <span class="os-divider"> </span>
+                <span data-type="" itemprop="" class="os-text">#{unit.title_text}</span>
+              HTML
+            end
+          else
+            controller[:get_unit_toc_title]
+          end
+
+        @toc_title_for_chapter =
+          if controller[:get_chapter_toc_title].nil?
+            lambda do |chapter|
+              number = chapter.os_number(options[:numbering_options])
+              <<~HTML
+                <span class="os-number"><span class="os-part-text">#{I18n.t("chapter#{'.nominative' \
+                if options[:cases]}")} </span>#{number}</span>
+                <span class="os-divider"> </span>
+                <span class="os-text" data-type="" itemprop="">#{chapter.title.first!('.os-text').text}</span>
+              HTML
+            end
+          else
+            controller[:get_chapter_toc_title]
+          end
 
         li_tags = book.body.element_children.map do |element|
           case element
           when UnitElement
-            li_for_unit(element, options)
+            li_for_unit(element)
           when ChapterElement
-            li_for_chapter(element, options)
+            li_for_chapter(element)
           when PageElement, CompositePageElement
             li_for_page(element)
           when CompositeChapterElement
@@ -31,7 +65,7 @@ def self.v1(book:, options: { cases: false })
         )
       end
 
-      def self.li_for_unit(unit, options)
+      def self.li_for_unit(unit)
         chapters = unit.element_children.only(ChapterElement)
         pages = unit.element_children.only(PageElement).to_a
         after_chapter = pages.filter(&:is_unit_closer?)
@@ -40,13 +74,11 @@ def self.li_for_unit(unit, options)
         <<~HTML
           <li cnx-archive-uri="" cnx-archive-shortid="" class="os-toc-unit" data-toc-type="unit">
             <a href="#">
-              <span class="os-number"><span class="os-part-text">#{I18n.t(:unit)} </span>#{unit.count_in(:book)}</span>
-              <span class="os-divider"> </span>
-              <span data-type="" itemprop="" class="os-text">#{unit.title_text}</span>
+              #{@toc_title_for_unit.call(unit)}
             </a>
             <ol class="os-unit">
               #{before_chapter.map { |page| li_for_page(page) }.join("\n")}
-              #{chapters.map { |chapter| li_for_chapter(chapter, options) }.join("\n")}
+              #{chapters.map { |chapter| li_for_chapter(chapter) }.join("\n")}
               #{after_chapter.map { |page| li_for_page(page) }.join("\n")}
             </ol>
           </li>
@@ -68,22 +100,19 @@ def self.li_for_composite_chapter(composite_chapter)
         HTML
       end
 
-      def self.li_for_chapter(chapter, options)
+      def self.li_for_chapter(chapter)
         chapter_children = chapter.element_children.map do |child|
           if child.instance_of?(PageElement) || child.instance_of?(CompositePageElement)
             li_for_page(child)
           elsif child.instance_of?(CompositeChapterElement)
             li_for_composite_chapter(child)
           end
         end.join("\n")
-        number = chapter.os_number(options[:numbering_options])
+
         <<~HTML
           <li class="os-toc-chapter" cnx-archive-shortid="" cnx-archive-uri="" data-toc-type="chapter">
             <a href="##{chapter.title.id}">
-              <span class="os-number"><span class="os-part-text">#{I18n.t("chapter#{'.nominative' \
-              if options[:cases]}")} </span>#{number}</span>
-              <span class="os-divider"> </span>
-              <span class="os-text" data-type="" itemprop="">#{chapter.title.first!('.os-text').text}</span>
+              #{@toc_title_for_chapter.call(chapter)}
             </a>
             <ol class="os-chapter">
               #{chapter_children}
@@ -162,4 +191,5 @@ def self.li_for_page(page)
       end
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

lib/kitchen/element_base.rb

@@ -381,26 +381,30 @@ def count_in(ancestor_type)
     #   :unit_chapter_page unit level, chapter level, and page level
     # @return [Array<integer>] an array of numbers ordered hierarchically
     #
-    def number_parts(mode)
+    def number_parts(mode, unit_offset:, chapter_offset:, page_offset:)
       case mode
       when :chapter_page
         case data_type
         when 'chapter'
-          [count_in(:book)]
+          [count_in(:book) + chapter_offset]
+        when 'unit'
+          [count_in(:book) + unit_offset]
         else
-          [ancestor(:chapter).count_in(:book), count_in(:chapter)]
+          [ancestor(:chapter).count_in(:book) + chapter_offset, count_in(:chapter) + page_offset]
         end
       when :unit_chapter_page
         case data_type
         when 'chapter'
           unit = ancestor(:unit)
-          [unit.count_in(:book), count_in(:unit)]
+          [unit.count_in(:book) + unit_offset, count_in(:unit) + chapter_offset]
         when 'unit'
-          [count_in(:book)]
+          [count_in(:book) + unit_offset]
         else
           unit = ancestor(:unit)
           chapter = ancestor(:chapter)
-          [unit.count_in(:book), chapter.count_in(:unit), count_in(:chapter)]
+          [unit.count_in(:book) + unit_offset,
+           chapter.count_in(:unit) + chapter_offset,
+           count_in(:chapter) + page_offset]
         end
       else
         # Further levels of nesting are not currently supported because of how
@@ -419,9 +423,18 @@ def number_parts(mode)
     def os_number(options={})
       options.reverse_merge!(
         mode: :chapter_page,
-        separator: '.'
+        separator: '.',
+        unit_offset: 0,
+        chapter_offset: 0,
+        page_offset: 0
+      )
+      parts = number_parts(
+        options[:mode],
+        unit_offset: options[:unit_offset],
+        chapter_offset: options[:chapter_offset],
+        page_offset: options[:page_offset]
       )
-      number_parts(options[:mode]).join(options[:separator])
+      parts.join(options[:separator])
     end
 
     # Track that a sub element found by the given query has been counted

lib/kitchen/page_element.rb

@@ -75,7 +75,7 @@ def is_introduction?
       @is_introduction ||= has_class?('introduction')
     end
 
-    # Returns true if this page is a unit closer
+    # Returns true if this page appears after all chapters in a unit
     #
     # @return [Boolean]
     #

lib/recipes/algebra-1/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  chapter: Lesson
+  eoc:
+    chapter-review: Chapter Review
+    key-terms: Key Terms
+  notes:
+    chapter-objectives: Chapter Objectives
+    general-strategies: General Strategies
+    link-to-learning: Link to Learning
+    mini-lesson-question: Mini Lesson Question
+    self-check: Self Check
+    try: Try it