openstax_kitchen 2.0.0 → 4.1.0

data/lib/kitchen/selectors/standard_1.rb

@@ -1,10 +1,31 @@
+# frozen_string_literal: true
+
 module Kitchen
   module Selectors
+    # A specific set of selectors
+    #
     class Standard1 < Base
 
+      # Create a new instance
+      #
       def initialize
+        super
         self.title_in_page              = "./*[@data-type = 'document-title']"
         self.title_in_introduction_page = "./*[@data-type = 'document-title']"
+        self.page_summary               = 'section.summary'
+        self.reference                  = '.reference'
+        self.chapter                    = "div[data-type='chapter']"
+        self.page                       = "div[data-type='page']"
+        self.note                       = "div[data-type='note']"
+        self.term                       = "span[data-type='term']"
+        self.table                      = 'table'
+        self.figure                     = 'figure'
+        self.metadata                   = "div[data-type='metadata']"
+        self.composite_page             = "div[data-type='composite-page']"
+        self.composite_chapter          = "div[data-type='composite-chapter']"
+        self.example                    = "div[data-type='example']"
+        self.exercise                   = "div[data-type='exercise']"
+        self.unit                       = "div[data-type='unit']"
       end
 
     end

data/lib/kitchen/table_element.rb

@@ -1,35 +1,83 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # An element for a table
+  #
   class TableElement < ElementBase
 
+    # Creates a new +TableElement+
+    #
+    # @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: TableElementEnumerator,
-            short_type: :table)
+            enumerator_class: TableElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :table
     end
 
+    # Returns an element for the title row, if present
+    #
+    # @return [Element, nil]
+    #
     def title_row
       top_titled? ? first('thead').first('tr') : nil
     end
 
+    # Returns the title nodes in the first title row element
+    #
+    # @return [Nokogiri::XML::NodeSet] Unusual to return the raw Nokogiri nodes!
+    #
     def title
-      title_row&.first('th').children
+      # TODO: replace +children+ with +element_children+?
+      title_row&.first('th')&.children
     end
 
+    # Returns true if the table has a title at the top
+    #
+    # @return [Boolean]
+    #
     def top_titled?
       has_class?('top-titled')
     end
 
+    # Returns true if the table is unnumbered
+    #
+    # @return [Boolean]
+    #
     def unnumbered?
       has_class?('unnumbered')
     end
 
-    def caption
-      first("caption")
+    # Returns true if the table is unstyled
+    #
+    # @return [Boolean]
+    #
+    def unstyled?
+      has_class?('unstyled')
     end
 
-    def self.is_the_element_class_for?(node)
-      node.name == "table"
+    # Returns true if the table has a column header
+    #
+    # @return [Boolean]
+    #
+    def column_header?
+      has_class?('column-header')
+    end
+
+    # Returns an element for the table caption, if present
+    #
+    # @return [Element, nil]
+    #
+    def caption
+      first('caption')
     end
 
   end

data/lib/kitchen/table_element_enumerator.rb

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # An enumerator for table elements
+  #
   class TableElementEnumerator < ElementEnumeratorBase
 
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "table", # TODO get from config?
+        default_css_or_xpath: Selector.named(:table),
         sub_element_class: TableElement,
         enumerator_class: self
       )

data/lib/kitchen/templates/eob_section_title_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eob os-<%=@klass%>-container" data-type="composite-page" data-uuid-key="<%=@uuid_prefix%><%=@klass%>">
+  <h1 data-type="document-title">
+    <span class="os-text"><%= @title %></span>
+  </h1>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/templates/eoc_section_title_template.xhtml.erb

@@ -0,0 +1,10 @@
+<div class="os-eoc os-<%=@klass%>-container" data-type="composite-page" data-uuid-key="<%=@uuid_prefix%><%=@klass%>">
+  <<%= @in_composite_chapter ? 'h3' : 'h2' %> data-type="<%= @in_composite_chapter ? 'title' : 'document-title' %>">
+    <span class="os-text"><%= @title %></span>
+  </<%= @in_composite_chapter ? 'h3' : 'h2' %>>
+  <div data-type="metadata" style="display: none;">
+    <h1 data-type="document-title" itemprop="name"><%= @in_composite_chapter ? I18n.t(:eoc_composite_metadata_title) : @title %></h1>
+    <%= @metadata.paste %>
+  </div>
+  <%= @content %>
+</div>

data/lib/kitchen/term_element.rb

@@ -1,15 +1,26 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # An element for a term
+  #
   class TermElement < ElementBase
 
+    # Creates a new +TermElement+
+    #
+    # @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: TermElementEnumerator,
-            short_type: :term)
+            enumerator_class: TermElementEnumerator)
     end
 
-    def self.is_the_element_class_for?(node)
-      node['data-type'] == "term"
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :term
     end
 
   end

data/lib/kitchen/term_element_enumerator.rb

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # An enumerator for term elements
+  #
   class TermElementEnumerator < ElementEnumeratorBase
 
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
     def self.factory
       ElementEnumeratorFactory.new(
-        default_css_or_xpath: "span[data-type='term']", # TODO get from config?
+        default_css_or_xpath: Selector.named(:term),
         sub_element_class: TermElement,
         enumerator_class: self
       )

data/lib/kitchen/transliterations.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Kitchen
   # These are added to every translation locale, including the `test` locale
   # set by `stub_locales`.  When we sort strings with accent marks, we use
   # `ActiveSupport::Inflector.transliterate` to ensure that the sorting is
   # sensible.  This method does not know about Greek characters by default so
   # we teach it about them by adding the rules below to the i18n configuration.
-
+  #
   TRANSLITERATIONS = {
     i18n: {
       transliterate: {
         rule: {
-          σ: "σ",
-          Δ: "Δ",
-          π: "π",
+          σ: 'σ',
+          Δ: 'Δ',
+          π: 'π'
         }
       }
     }
-  }
+  }.freeze
 end

data/lib/kitchen/type_casting_element_enumerator.rb

@@ -1,6 +1,15 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # An enumerator that detects the element type as it iterates and returns specific,
+  # different element classes based on that type.
+  #
   class TypeCastingElementEnumerator < ElementEnumeratorBase
 
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
     def self.factory
       ElementEnumeratorFactory.new(
         enumerator_class: self,
@@ -8,12 +17,19 @@ module Kitchen
       )
     end
 
+    # Returns a new enumerator that returns only the specified element classes within the
+    # scope of this enumerator.
+    #
+    # @param element_classes [Array<ElementBase>] the element classes to limit iteration to
+    # @return [TypeCastingElementEnumerator]
+    #
     def only(*element_classes)
       element_classes.flatten!
 
       TypeCastingElementEnumerator.new do |block|
-        self.each do |element|
+        each do |element|
           next unless element_classes.include?(element.class)
+
           block.yield(element)
         end
       end

data/lib/kitchen/unit_element.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An element for a unit
+  #
+  class UnitElement < ElementBase
+
+    # Creates a new +UnitElement+
+    #
+    # @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: UnitElementEnumerator)
+    end
+
+    # Returns the short type
+    # @return [Symbol]
+    #
+    def self.short_type
+      :unit
+    end
+
+    # Get the title in the immediate children, not the one in the metadata.  Could use
+    # CSS of ":not([data-type='metadata']) >
+    #         [data-type='document-title'], [data-type='document-title']"
+    # but xpath is shorter
+    # @return [Element]
+    #
+    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
+
+  end
+end

data/lib/kitchen/unit_element_enumerator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kitchen
+  # An enumerator for unit elements
+  #
+  class UnitElementEnumerator < ElementEnumeratorBase
+
+    # Returns a factory for this enumerator
+    #
+    # @return [ElementEnumeratorFactory]
+    #
+    def self.factory
+      ElementEnumeratorFactory.new(
+        default_css_or_xpath: Selector.named(:unit),
+        sub_element_class: UnitElement,
+        enumerator_class: self
+      )
+    end
+  end
+end

data/lib/kitchen/utils.rb

@@ -1,19 +1,16 @@
+# frozen_string_literal: true
+
 module Kitchen
+  # Utility methods
+  #
   module Utils
-
+    # A standard way to convert a search path to an element type
+    #
+    # @param search_path [String, Array<String>] selectors
+    # @return [String]
+    #
     def self.search_path_to_type(search_path)
-      [search_path].flatten.join(",")
+      [search_path].flatten.join(',')
     end
-
-    def self.normalized_xhtml_string(xml_thing_with_to_s)
-      doc = Nokogiri::XML(xml_thing_with_to_s.to_s) do |config|
-        config.noblanks
-      end
-
-      doc.alphabetize_attributes!
-
-      doc.to_xhtml(indent: 2)
-    end
-
   end
 end

data/lib/kitchen/version.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# A library for modifying the structure of OpenStax book XML.
+#
 module Kitchen
-  VERSION = "2.0.0"
+  VERSION = '4.1.0'
 end

data/lib/locales/en.yml

@@ -2,20 +2,31 @@ en:
   figure: Figure
   table_label: Table
   appendix: Appendix
+  theorem: Theorem
+  solution: Solution
+  chapter_outline: Chapter Outline
+  toc_title: Contents
   example_label: Example
   exercise_label: Exercise
+  equation: Equation
+  chapter: Chapter
+  unit: Unit
+  checkpoint: Checkpoint
+  chapter_review: Chapter Review
+  learning_objectives: Learning Objectives
   stepwise_step_label: Step
+  references: References
+  eoc_chapter_review: Chapter Review
   eoc_key_terms_title: Key Terms
   eoc_summary_title: Summary
   eoc_exercises_title: Exercises
+  eoc_composite_metadata_title: Chapter Review
   eoc_answer_key_title: Answer Key
+  eoc_key_concepts: Key Concepts
   eoc_key_equations: Key Equations
+  eoc_suggested_reading: Suggestions for Further Study
+  eoc_further_research_title: Further Research
   eob_index_title: Index
   eob_index_symbols_group: Symbols
-  notes:
-    link-to-learning: Link to Learning
-    sciences-interconnect: How Sciences Interconnect
-    chemistry:
-      link-to-learning: Link to Learning
-      everyday-life: Chemistry in Everyday Life
-      chemist-portrait: Portrait of a Chemist
+  review_exercises: Review Exercises
+  section_exercises: ! 'Section %{number} Exercises'

data/lib/locales/pl.yml

@@ -0,0 +1,24 @@
+pl:
+  figure: Rysunek
+  table_label: Tabela
+  appendix: Dodatek
+  theorem: Twierdzenie
+  solution: Rozwiązanie
+  chapter_outline: Treść rozdziału
+  toc_title: Spis treści
+  example_label: Przykład
+  exercise_label: Ćwiczenie
+  equation: Równanie
+  chapter: Rozdział
+  unit: Część
+  chapter_review: Podsumowanie rozdziału
+  learning_objectives: Cel dydaktyczny
+  stepwise_step_label: Krok
+  eoc_chapter_review: Podsumowanie rozdziału
+  eoc_key_terms_title: Kluczowe pojęcia
+  eoc_summary_title: Podsumowanie
+  eoc_answer_key_title: Rozwiązania zadań
+  eoc_key_equations: Najważniejsze wzory
+  eob_index_title: Skorowidz rzeczowy
+  eob_index_symbols_group: Symbole
+