html-table 1.7.0 → 1.7.1

data/lib/html/row.rb

@@ -1,188 +1,161 @@
+# The HTML module is a namespace only.
 module HTML
-   class Table::Row < Array
-      include HTML::Mixin::AttributeHandler
-      include HTML::Mixin::HtmlHandler
-
-      @indent_level = 3
-      @end_tags     = true
-
-      # Returns a new Table::Row object.  Optionally takes a block.  If +arg+
-      # is provided it is treated as content.  If +header+ is false, that
-      # content is transformed into a Row::Data object.  Otherwise, it is
-      # converted into a Row::Header object.
-      #
-      # See the # Table::Row#content= method for more information.
-      #--
-      # Note that, despite the name, Row is a subclass of Array, not Table.
-      #
-      def initialize(arg = nil, header = false, &block)
-         @html_begin = '<tr'
-         @html_end   = '</tr>'
-
-         @header = header
-
-         instance_eval(&block) if block_given?
-         self.content = arg if arg
+  # The Table::Row class is a subclass of array that encapsulates an
+  # html table row, i.e. <tr> element.
+  class Table::Row < Array
+    include HTML::Mixin::AttributeHandler
+    include HTML::Mixin::HtmlHandler
+    include HTML::Mixin::StrongTyping
+    extend HTML::Mixin::StrongTyping
+
+    @indent_level = 3
+    @end_tags     = true
+
+    # Gets and sets whether or not content is converted into a Row::Header
+    # object or a Row::Data object.
+    attr_accessor :header
+
+    # Returns a new Table::Row object. Optionally takes a block. If +arg+
+    # is provided it is treated as content. If +header+ is false, that
+    # content is transformed into a Row::Data object. Otherwise, it is
+    # converted into a Row::Header object.
+    #
+    # See the # Table::Row#content= method for more information.
+    #--
+    # Note that, despite the name, Row is a subclass of Array, not Table.
+    #
+    def initialize(arg = nil, header = false, &block)
+      @html_begin = '<tr'
+      @html_end   = '</tr>'
+      @header = header
+      instance_eval(&block) if block_given?
+      self.content = arg if arg
+    end
+
+    # Returns whether or not content is converted into a Row::Header object
+    # (as opposed to a Row::Data object).
+    #
+    def header?
+      @header
+    end
+
+    # Adds content to the Row object.
+    #
+    # Because a Row object doesn't store any of its own content, the
+    # arguments to this method must be a Row::Data object, a Row::Header
+    # object, or a String (or an array of any of these).  In the latter case,
+    # a single Row::Data object is created for each string.
+    #
+    # Examples (with whitespace and newlines removed):
+    #
+    # row = Table::Row.new
+    #
+    # # Same as Table::Row.new('foo')
+    # row.content = 'foo'
+    # row.html => <tr><td>foo</td></tr>
+    #
+    # row.content = [['foo,'bar']]
+    # row.html => <tr><td>foo</td><td>bar</td></tr>
+    #
+    # row.content = Table::Row::Data.new('foo')
+    # row.html => <tr><td>foo</td></tr>
+    #
+    # row.content = Table::Row::Header.new('foo')
+    # row.html => <tr><th>foo</th></tr>
+    #
+    def content=(arg)
+      Array(arg).each do |e|
+        push_content(e)
       end
-
-      # Returns whether or not content is converted into a Row::Header object
-      # (as opposed to a Row::Data object).
-      #
-      def header?
-         @header
-      end
-
-      # Sets whether or not content is converted into a Row::Header object
-      # or a Row::Data object.
-      #
-      def header=(bool)
-         @header = bool
+    end
+
+    # Returns the number of spaces that tags for this class are indented.
+    # For the Row class, the indention level defaults to 3.
+    #
+    def self.indent_level
+      @indent_level
+    end
+
+    # Sets the number of spaces that tags for this class are indented.
+    #
+    def self.indent_level=(num)
+      expect(num, Integer)
+      raise ArgumentError, "Indent level must be non-negative" if num < 0
+      @indent_level = num
+    end
+
+    # Returns true or false, depending on whether or not the end tags for
+    # this class, </tr>, are included for each row or not. By default, this
+    # is set to true.
+    #
+    def self.end_tags?
+      @end_tags
+    end
+
+    # Sets the behavior for whether or not the end tags for this class,
+    # </tr>, are included for each row or not. Only true and false are
+    # valid arguments.
+    #
+    def self.end_tags=(bool)
+      expect(bool, [TrueClass, FalseClass])
+      @end_tags = bool
+    end
+
+    # This method has been redefined to only allow certain classes to be
+    # accepted as arguments.  Specifically, they are Data and Header. An
+    # Array is also valid, but only if it only includes Data or Header objects.
+    #
+    def []=(index, obj)
+      objs = obj.is_a?(Array) ? obj : [obj]
+      objs.each { |o| expect(o, [Data, Header]) }
+      super
+    end
+
+    # This method has been redefined to only allow certain classes to be
+    # accepted as arguments. Specifically, they are String, Integer, Data,
+    # and Header.
+    #
+    # A plain string or number pushed onto a Row is automatically
+    # converted to a Data object.
+    #
+    def push(*args)
+      args.each { |obj| super(convert_content(obj)) }
+    end
+
+    # This method has been redefined to only allow certain classes to be
+    # accepted as arguments. The rules are the same as they are for Row#push.
+    #
+    def <<(obj)
+      super(convert_content(obj))
+    end
+
+    # This method has been redefined to only allow certain classes to be
+    # accepted as arguments. The rules are the same as they are for Row#push.
+    #
+    def unshift(obj)
+      super(convert_content(obj))
+    end
+
+    alias to_s html
+    alias to_str html
+
+    private
+
+    def push_content(e)
+      if e.is_a?(Table::Row::Data) || e.is_a?(Table::Row::Header)
+        push(e)
+      else
+        push(@header ? Table::Row::Header.new(e) : Table::Row::Data.new(e))
       end
-
-      # Adds content to the Row object.
-      #
-      # Because a Row object doesn't store any of its own content, the
-      # arguments to this method must be a Row::Data object, a Row::Header
-      # object, or a String (or an array of any of these).  In the latter case,
-      # a single Row::Data object is created for each string.
-      #
-      # Examples (with whitespace and newlines removed):
-      #
-      # row = Table::Row.new
-      #
-      # # Same as Table::Row.new('foo')
-      # row.content = 'foo'
-      # row.html => <tr><td>foo</td></tr>
-      #
-      # row.content = [['foo,'bar']]
-      # row.html => <tr><td>foo</td><td>bar</td></tr>
-      #
-      # row.content = Table::Row::Data.new('foo')
-      # row.html => <tr><td>foo</td></tr>
-      #
-      # row.content = Table::Row::Header.new('foo')
-      # row.html => <tr><th>foo</th></tr>
-      #
-      def content=(arg)
-         case arg
-            when String
-               if @header
-                  self.push(Table::Row::Header.new(arg))
-               else
-                  self.push(Table::Row::Data.new(arg))
-               end
-            when Array
-               arg.each{ |e|
-                  if e.kind_of?(Table::Row::Data) || e.kind_of?(Table::Row::Header)
-                     self.push(e)
-                  else
-                     if @header
-                        self.push(Table::Row::Header.new(e))
-                     else
-                        self.push(Table::Row::Data.new(e))
-                     end
-                  end
-               }
-            else
-               self.push(arg)
-         end
-      end
-
-      # Returns the number of spaces that tags for this class are indented.
-      # For the Row class, the indention level defaults to 3.
-      #
-      def self.indent_level
-         @indent_level
+    end
+
+    def convert_content(obj)
+      if obj.is_a?(String) || obj.is_a?(Integer)
+        Table::Row::Data.new(obj.to_s)
+      else
+        expect(obj, [Data, Header])
+        obj
       end
-
-      # Sets the number of spaces that tags for this class are indented.
-      #
-      def self.indent_level=(num)
-         expect(num, Integer)
-         raise ArgumentError if num < 0
-         @indent_level = num
-      end
-
-      # Returns true or false, depending on whether or not the end tags for
-      # this class, </tr>, are included for each row or not. By default, this
-      # is set to true.
-      #
-      def self.end_tags?
-         @end_tags
-      end
-
-      # Sets the behavior for whether or not the end tags for this class,
-      # </tr>, are included for each row or not.  Only true and false are
-      # valid arguments.
-      #
-      def self.end_tags=(bool)
-         expect(bool,[TrueClass,FalseClass])
-         @end_tags = bool
-      end
-
-      # This method has been redefined to only allow certain classes to be
-      # accepted as arguments.  Specifically, they are Data and Header.  An
-      # Array is also valid, but only if it only includes Data or Header
-      # objects.
-      #
-      def []=(index, obj)
-         if obj.kind_of?(Array)
-            obj.each{ |o| expect(o, [Data, Header]) }
-         else
-            expect(obj, [Data, Header])
-         end
-         super
-      end
-
-      # This method has been redefined to only allow certain classes to be
-      # accepted as arguments.  Specifically, they are String, Integer,
-      # Data and Header.
-      #
-      # A plain string or number pushed onto a Row is automatically
-      # converted to a Data object.
-      #
-      def push(*args)
-         args.each do |obj|
-            if obj.kind_of?(String) || obj.kind_of?(Integer)
-               td = Table::Row::Data.new(obj.to_s)
-               super(td)
-               next
-            else
-               expect(obj, [Data, Header])
-            end
-            super(obj)
-         end
-      end
-
-      # This method has been redefined to only allow certain classes to be
-      # accepted as arguments.  The rules are the same as they are for
-      # Row#push.
-      #
-      def <<(obj)
-         if obj.kind_of?(String) || obj.kind_of?(Integer)
-            td = Table::Row::Data.new(obj.to_s)
-            super(td)
-         else
-            expect(obj, [Data, Header])
-         end
-         super(obj)
-      end
-
-      # This method has been redefined to only allow certain classes to be
-      # accepted as arguments.  The rules are the same as they are for
-      # Row#push.
-      #
-      def unshift(obj)
-         if obj.kind_of?(String) || obj.kind_of?(Integer)
-            td = Table::Row::Data.new(obj.to_s)
-            super(td)
-         else
-            expect(obj,[Data,Header])
-         end
-         super(obj)
-      end
-
-      alias to_s html
-      alias to_str html
-   end
+    end
+  end
 end

data/lib/html/table.rb

@@ -2,7 +2,6 @@ require_relative 'mixin/attribute_handler'
 require_relative 'mixin/html_handler'
 require_relative 'mixin/strongtyping'
 require 'structured_warnings'
-include HTML::Mixin::StrongTyping
 
 # Warning raised if a non-standard extension is used.
 class NonStandardExtensionWarning < StructuredWarnings::StandardWarning; end
@@ -10,6 +9,9 @@ class NonStandardExtensionWarning < StructuredWarnings::StandardWarning; end
 # Please, think of the children before using the blink tag.
 class BlinkWarning < StructuredWarnings::StandardWarning; end
 
+# Used by the strongtyping mixin.
+class ArgumentTypeError < ArgumentError; end
+
 # The HTML module serves as a namespace only.
 module HTML
 
@@ -18,9 +20,11 @@ module HTML
   class Table < Array
     include HTML::Mixin::AttributeHandler
     include HTML::Mixin::HtmlHandler
+    include HTML::Mixin::StrongTyping
+    extend HTML::Mixin::StrongTyping
 
     # The version of the html-table library
-    VERSION = '1.7.0'.freeze
+    VERSION = '1.7.1'.freeze
 
     # The indentation level for the <table> and </table> tags
     @indent_level = 0
@@ -29,7 +33,7 @@ module HTML
     @html_case = 'lower'
 
     # Determines whether or not end tags will be included in printed output
-    @@global_end_tags = true
+    @global_end_tags = true
 
     # Returns a new Table object. Optionally takes a block which is
     # eval'd if provided. If an argument is provided it is interpreted as
@@ -94,9 +98,9 @@ module HTML
       self.content = arg if arg
 
       # Assume html_options are attributes
-      html_options.each{ |key, val|
-        self.send("#{key}=", val)
-      }
+      html_options.each do |key, val|
+        send("#{key}=", val)
+      end
     end
 
     # Adds content to the table. How this method behaves depends on the
@@ -108,8 +112,8 @@ module HTML
     # object is created, with the string as the content.
     #
     def content=(arg)
-      if arg.kind_of?(Array)
-        arg.each{ |e| self << Table::Row.new(e) }
+      if arg.is_a?(Array)
+        arg.each { |e| self << Table::Row.new(e) }
       else
         self << Table::Row.new(arg)
       end
@@ -128,8 +132,8 @@ module HTML
     # object.
     #
     def header=(arg)
-      if arg.kind_of?(Array)
-        arg.each{ |h| self << Table::Row.new(h, true) }
+      if arg.is_a?(Array)
+        arg.each { |h| self << Table::Row.new(h, true) }
       else
         self << Table::Row::Header.new(arg)
       end
@@ -139,18 +143,18 @@ module HTML
     # turned on or off, respectively.
     #
     def self.global_end_tags?
-      @@global_end_tags
+      @global_end_tags
     end
 
-    # Sets the end tag class variable.  This is used to set whether or not
-    # to include optional end tags in the final HTML output.  The argument
-    # sent to this method must be true or false.  The default value is true.
+    # Sets the end tag class variable. This is used to set whether or not
+    # to include optional end tags in the final HTML output. The argument
+    # sent to this method must be true or false. The default value is true.
     #
     # Note that mandatory end tags are unaffected by this setting.
     #
     def self.global_end_tags=(bool)
       expect(bool, [TrueClass, FalseClass])
-      @@global_end_tags = bool
+      @global_end_tags = bool
     end
 
     # Returns either "lower" or "upper", indicating the case of all HTML
@@ -160,13 +164,13 @@ module HTML
       @html_case
     end
 
-    # Sets the case of all HTML tags to either lower or upper.  The only
+    # Sets the case of all HTML tags to either lower or upper. The only
     # valid arguments to this method are 'upper' or 'lower'.
     #
     def self.html_case=(arg)
       expect(arg, String)
       arg.downcase!
-      unless arg == "upper" || arg == "lower"
+      unless %w[upper lower].include?(arg)
         msg = "Argument to html_case() must be 'upper' or 'lower'"
         raise ArgumentError, msg
       end
@@ -187,7 +191,7 @@ module HTML
     #
     def self.indent_level=(num)
       expect(num, Integer)
-      raise ArgumentError, "indent level must be >= 0" if num < 0
+      raise ArgumentError, 'indent level must be >= 0' if num < 0
       @indent_level = num
     end
 
@@ -200,30 +204,30 @@ module HTML
     # only be assigned to index 0, or index 1 if a Caption already exists.
     # A Foot may only be assigned as the last element.
     #
-    def []=(index,obj)
+    def []=(index, obj)
       expect(obj, [Caption, ColGroup, Body, Foot, Head, Row])
 
       # Only allow Caption objects at index 0
-      if index != 0 && obj.kind_of?(HTML::Table::Caption)
-        msg = "CAPTION can only be added at index 0"
+      if index != 0 && obj.is_a?(HTML::Table::Caption)
+        msg = 'CAPTION can only be added at index 0'
         raise ArgumentError, msg
       end
 
       # Only allow Head objects at index 0 or 1
-      if obj.kind_of?(HTML::Table::Head)
-        if self[0].kind_of?(HTML::Table::Caption) && index != 1
-          msg = "THEAD must be at index 1 when Caption is included"
+      if obj.is_a?(HTML::Table::Head)
+        if self[0].is_a?(HTML::Table::Caption) && index != 1
+          msg = 'THEAD must be at index 1 when Caption is included'
           raise ArgumentError, msg
         end
 
-        if !self[0].kind_of?(HTML::Table::Caption) && index != 0
-          msg = "THEAD must be at index 0 when no Caption is included"
+        if !self[0].is_a?(HTML::Table::Caption) && index != 0
+          msg = 'THEAD must be at index 0 when no Caption is included'
           raise ArgumentError, msg
         end
       end
 
-      if obj.kind_of?(HTML::Table::Foot) && index != -1
-        msg = "FOOT must be last element"
+      if obj.is_a?(HTML::Table::Foot) && index != -1
+        msg = 'FOOT must be last element'
         raise ArgumentError, msg
       end
 
@@ -242,29 +246,27 @@ module HTML
     # element, or the second element if a Caption already exists.
     #
     def push(*args)
-      args.each{ |obj|
+      args.each do |obj|
         expect(obj, [Caption, ColGroup, Body, Foot, Head, Row, Row::Data, Row::Header])
 
         case obj
           when Table::Row::Data, Table::Row::Header
-            self.push(Table::Row.new(obj))
+            push(Table::Row.new(obj))
           when Table::Caption
-            if self[0].kind_of?(Table::Caption)
+            if self[0].is_a?(Table::Caption)
               self[0] = obj
             else
-              self.unshift(obj)
+              unshift(obj)
             end
           when Table::Head
-            if self[0].kind_of?(Table::Caption)
-              self.unshift(obj)
-              self[0],self[1] = self[1],self[0]
-            else
-              self.unshift(obj)
+            unshift(obj)
+            if self[0].is_a?(Table::Caption)
+              self[0], self[1] = self[1], self[0]
             end
           else
             super(obj)
         end
-      }
+      end
     end
 
     # This method has been redefined to only allow certain subclasses to
@@ -279,20 +281,18 @@ module HTML
         when Table::Row::Data, Table::Row::Header # Each get their own row
           self << Table::Row.new(obj)
         when Table::Caption                       # Always the first row
-          if self[0].kind_of?(Table::Caption)
+          if self[0].is_a?(Table::Caption)
             self[0] = obj
           else
-            self.unshift(obj)
+            unshift(obj)
           end
         when Table::Head                          # Always at row 0 or 1
-          if self[0].kind_of?(Table::Caption)
-            self.unshift(obj)
+          unshift(obj)
+          if self[0].is_a?(Table::Caption)
             self[0], self[1] = self[1], self[0]
-          else
-            self.unshift(obj)
           end
         else
-          super(obj)
+          super
       end
     end
 

data/lib/html/tablesection.rb

@@ -1,48 +1,53 @@
+# The HTML module serves as a namespace only.
 module HTML
-   # Superclass for THEAD, TBODY, TFOOT
-   #
-   class Table::TableSection < Array
-      include HTML::Mixin::AttributeHandler
-      include HTML::Mixin::HtmlHandler
-
-      def initialize(&block)
-         instance_eval(&block) if block_given?
-      end
-
-      # Adds a Table::Row object as content. The +arg+ is passed as the value
-      # to the Table::Row constructor.
-      #
-      def content=(arg)
-         tr = Table::Row.new(arg)
-         self.push(tr)
-      end
-
-      def self.indent_level
-         @indent_level
-      end
-
-      def self.indent_level=(num)
-         expect(num, Integer)
-         raise ArgumentError, "indent_level must be >= 0" if num < 0
-         @indent_level = num
-      end
-
-      def []=(index,obj)
-         expect(obj,Table::Row)
-         super
-      end
-
-      def push(*args)
-         args.each{ |obj| expect(obj,Table::Row) }
-         super
-      end
-
-      def unshift(obj)
-         expect(obj,Table::Row)
-         super
-      end
-
-      alias to_s html
-      alias to_str html
-   end
+
+  # Superclass for THEAD, TBODY, TFOOT
+  #
+  class Table::TableSection < Array
+    include HTML::Mixin::AttributeHandler
+    include HTML::Mixin::HtmlHandler
+    include HTML::Mixin::StrongTyping
+    extend HTML::Mixin::StrongTyping
+
+    def initialize(&block)
+      super
+      instance_eval(&block) if block_given?
+    end
+
+    # Adds a Table::Row object as content. The +arg+ is passed as the value
+    # to the Table::Row constructor.
+    #
+    def content=(arg)
+      tr = Table::Row.new(arg)
+      push(tr)
+    end
+
+    def self.indent_level
+      @indent_level
+    end
+
+    def self.indent_level=(num)
+      expect(num, Integer)
+      raise ArgumentError, 'indent_level must be >= 0' if num < 0
+      @indent_level = num
+    end
+
+    def []=(index, obj)
+      expect(obj, Table::Row)
+      super
+    end
+
+    def push(*args)
+      args.each { |obj| expect(obj, Table::Row) }
+      super
+    end
+
+    def unshift(obj)
+      expect(obj, Table::Row)
+      super
+    end
+
+    alias to_s html
+    alias to_str html
+  end
 end