html-table 1.6.3 → 1.7.1

data/doc/table_row.md

@@ -0,0 +1,114 @@
+## Description
+A Table::Row object represents a single <TR></TR> instance for an HTML
+Table. Although it is nested under Table, it is not a subclass of Table.
+It is, however, a subclass of Array.
+
+## Synopsis
+```ruby
+require "html/table"
+include HTML
+
+table = HTML::Table.new
+
+row1 = Table::Row.new{ |r|
+  r.align   = "left"
+  r.bgcolor = "green"
+  r.content = ["foo","bar","baz"]
+}
+
+row2 = Table::Row.new{ |r|
+  r.align   = "right"
+  r.bgcolor = "blue"
+  r.content = "hello world"
+}
+
+table.push row1, row2
+
+row1.content = "foofoo"
+row1.configure(3){ |d| d.bgcolor = "pink" }
+
+row1.push Table::Row::Header.new{ |h|
+  h.colspan = 2
+  h.content = "This is a table header"
+}
+
+row2.push Table::Row::Header.new{ |h|
+  h.colspan = 2
+  h.content = "This is also a table header"
+}
+
+puts table.html
+#### output ####
+```
+```html
+<table>
+  <tr align='left' bgcolor='green'>
+     <td>foo</td>
+     <td>bar</td>
+     <td>baz</td>
+    <td bgcolor='pink'>foofoo</td>
+     <th colspan=2>This is a table header</th>
+  </tr>
+  <tr align='right' bgcolor='blue'>
+    <td>hello world</td>
+     <th colspan=2>This is also a table header</th>
+  </tr>
+</table>
+```
+
+See the 'examples' directory for more examples.
+
+## Mixins
+Table::Row is a subclass of Array and therefore mixes in Enumerable.  It
+also mixes in Attribute_Handler.
+
+## Class Methods
+```
+Table::Row.new(arg=nil)
+Table::Row.new(arg=nil){ |t| ... }
+```
+
+Creates a new table. You can set attributes for the TableRow by passing a block.
+    
+If `arg` is supplied, it is automatically interpreted to be content.
+This is a shortcut for Table::Row.new{ |r| r.content = '...' }.
+
+## Instance Methods
+`Table::Row#[]=(index, obj)`
+
+Assigns `obj` to index. The `obj` must be a Table::Row::Header or
+Table::Row::Data object, or a TypeError is raised.
+
+Table::Row#content
+Returns the HTML content of the TableRow instance, i.e. the stuff between
+the `<TR>` and `</TR>` tags.
+
+`Table::Row#content=(args)`
+
+Because a Table::Row doesn't store any of its own content, the arguments
+to this method must be a Table::Row::Data object, a Table::Row::Header
+object, or a String (or an array of any of these). In the latter case,
+a single Table::Row::Data object is created for each string.
+
+`Table::Row#html`
+
+Returns the entire HTML content of the TableRow instance.
+
+`Table::Row#push(obj)`
+
+Pushes `obj` onto the Table::Row. The +obj+ must be a Table::Row::Data
+or Table::Row::Header object, or a TypeError is raised.
+
+`Table::Row#unshift(obj)`
+
+Unshifts +obj+ onto the Table::Row. The same rules for push apply
+to unshift as well.
+
+## Notes
+String attributes are quoted. Numeric attributes are not.
+
+Some attributes have type checking. Some check for valid arguments. In
+the latter case, it is case-insensitive.
+
+Using a non-standard extension (e.g. "background") will send a warning to
+STDERR in $VERBOSE (-w) mode.

data/doc/table_row_data.md

@@ -0,0 +1,100 @@
+## Description
+A Table::Row::Data object represents a single <TD></TD> instance for an HTML
+Table. For purposes of html-table, it also represents a "column".
+
+## Synopsis
+```ruby
+require "html/table"
+require HTML
+
+Table::Row.end_tags = false
+Table::Row::Data.end_tags = false
+
+table = Table.new{ |t| t.border = 1 }
+row = Table::Row.new
+
+col1 = Table::Row::Data.new{ |d|
+  d.abbr    = "test"
+  d.align   = "right"
+  d.content = "hello world"
+}
+
+col2 = Table::Row::Data.new{ |d|
+  d.align   = "center"
+  d.content = "Matz rules!"
+}
+
+col3 = Table::Row::Data.new{ |d|
+  d.align   = "left"
+  d.content = "Foo!"
+}
+
+row.push col1, col2, col3
+
+puts table.html
+```
+
+output:
+
+```html
+<table border=1>
+  <tr>
+    <td abbr='test' align='right'>hello world
+    <td align='center'>Matz rules!
+    <td align='left'>Foo!
+</table>
+```
+
+See the 'examples' directory under 'doc' for more examples.
+
+## Mixins
+Table::Row::Data mixes in Attribute_Handler.    
+
+## Class Methods
+```
+Table::Row::Data.new(arg=nil)
+Table::Row::Data.new(arg=nil){ |t| ... }
+```
+Creates a new table.  You can set attributes for the Table::Row::Data by passing a block.
+   
+If `arg` is supplied, it is automatically interpreted to be content.
+This is a shortcut for Table::Row::Data.new{ |d| d.content = '...' }.
+
+`Table::Row::Data.end_tags`
+
+Returns true or false to indicate whether end tags are included or not.
+
+`Table::Row::Data.end_tags=(bool)`
+
+Sets whether or not end tags are included in the html.
+
+`Table::Row::Data.indent_level`
+Returns the current number of spaces that `<TD>` tags are indented. The default is 6.
+
+`Table::Row::Data.indent_level=(num)`
+
+Sets the number of spaces that `<TD>` tags are indented.
+
+## Instance Methods
+TableData#content
+
+Returns the content of the TableData object, i.e. the stuff between `<TD>` and `</TD>`.
+
+Table::Row::Data#content=(string)
+
+Sets the content for the TableData object, i.e. the stuff between `<TD>` and `</TD>`.
+
+Table::Row::Data#html
+
+Returns all html content for the TableData instance.
+
+## Notes
+The end tags for Table::Row::Data objects are are the same line as the begin tags.
+    
+String attributes are quoted. Numeric attributes are not.
+
+Some attributes have type checking. Some check for valid arguments. In
+the latter case, it is case-insensitive.
+
+Using a non-standard extension (e.g. "background") will send a warning to
+STDERR in $VERBOSE (-w) mode.

data/doc/table_row_header.md

@@ -0,0 +1,6 @@
+## Description
+A Table::Row::Header object represents a single `<TH></TH>` instance for an HTML Table.
+
+## Notes
+The Table::Row::Header class is identical in every way to the
+Table::Row::Data class, except for the begin and end tags.

data/examples/simple1.rb

@@ -9,13 +9,15 @@ require 'html/table'
 include HTML
 
 table = Table.new{ |t|
-   t.content = [
-      %w/foo bar baz/,
-      %w/1 2 3/,
-      %w/hello world/
-   ]
+  t.content = [
+    %w[foo bar baz],
+    %w[1 2 3],
+    %w[hello world]
+  ]
 }
 
+#Table.global_end_tags = false
+
 puts table.html
 
 =begin

data/html-table.gemspec

@@ -2,30 +2,35 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'html-table'
-  spec.version    = '1.6.3'
+  spec.version    = '1.7.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/html-table'
   spec.summary    = 'A Ruby interface for generating HTML tables'
-  spec.test_files = Dir['test/*.rb']
+  spec.test_files = Dir['spec/*.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['README.rdoc', 'CHANGES.rdoc'] + Dir['doc/*.rdoc']
+  spec.extra_rdoc_files  = ['README.md', 'CHANGES.md', 'MANIFEST.md'] + Dir['doc/*.md']
 
-  spec.add_dependency('structured_warnings', '~> 0.3.0')
+  spec.add_dependency('structured_warnings', '~> 0.4.0')
 
-  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('rake')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/html-table',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/html-table/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/html-table/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/html-table/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/html-table',
-    'wiki_uri'          => 'https://github.com/djberg96/html-table/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/html-table',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/html-table/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/html-table/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://djberg96.github.io/html-table',
+    'source_code_uri'       => 'https://github.com/djberg96/html-table',
+    'wiki_uri'              => 'https://github.com/djberg96/html-table/wiki',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/html-table',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96'
   }
 
   spec.description = <<-EOF

data/lib/html/body.rb

@@ -1,9 +1,11 @@
+# The HTML module serves as a namespace only.
 module HTML
-
   # This class represents an HTML table body (<tbody>).  It is a
   # subclass of Table::TableSection.
   #
   class Table::Body < Table::TableSection
+    extend HTML::Mixin::StrongTyping
+
     @indent_level = 3
     @end_tags     = true
 
@@ -11,12 +13,12 @@ module HTML
     # an argument is provided, it is treated as content.
     #
     def initialize(arg = nil, &block)
-      @html_begin = "<tbody"
-      @html_end   = "</tbody>"
-      instance_eval(&block) if block_given?
+      @html_begin = '<tbody'
+      @html_end   = '</tbody>'
+      super(&block)
       self.content = arg if arg
     end
-      
+
     # Returns a boolean indicating whether or not end tags, </tbody>, are
     # included for each Body object in the final HTML output.  The
     # default is true.
@@ -24,13 +26,13 @@ module HTML
     def self.end_tags?
       @end_tags
     end
-      
+
     # Sets whether or not end tags are included for each Body object in
     # the final HTML output.  The default is true.  Only true or false are
     # valid arguments.
     #
     def self.end_tags=(bool)
-      expect(bool,[TrueClass, FalseClass])
+      expect(bool, [TrueClass, FalseClass])
       @end_tags = bool
     end
   end

data/lib/html/caption.rb

@@ -1,3 +1,4 @@
+# The HTML module serves as a namespace only.
 module HTML
 
   # This class represents an HTML Caption.  Despite the name, it is not
@@ -6,6 +7,7 @@ module HTML
   class Table::Caption
     include HTML::Mixin::AttributeHandler
     include HTML::Mixin::HtmlHandler
+    extend HTML::Mixin::StrongTyping
 
     undef_method :configure
     @indent_level = 3
@@ -38,8 +40,8 @@ module HTML
     # 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 >= 0" if num < 0
+      expect(num, Integer)
+      raise ArgumentError, 'indent level must be >= 0' if num < 0
       @indent_level = num
     end
 

data/lib/html/col.rb

@@ -1,41 +1,44 @@
+# The HTML module serves as a namespace only.
 module HTML
-   # This class represents an HTML ColGroup column (<col>).  Despite the
-   # name, it is not a subclass of ColGroup or Table.
-   #
-   class Table::ColGroup::Col
-      include HTML::Mixin::AttributeHandler
-      include HTML::Mixin::HtmlHandler
 
-      undef_method :configure, :content
-      @indent_level = 6
+  # This class represents an HTML ColGroup column (<col>).  Despite the
+  # name, it is not a subclass of ColGroup or Table.
+  #
+  class Table::ColGroup::Col
+    include HTML::Mixin::AttributeHandler
+    include HTML::Mixin::HtmlHandler
+    extend HTML::Mixin::StrongTyping
 
-      # Creates and returns a new ColGroup object.  Optionally takes a block.
-      # Note that it does not accept an argument - col tags do not have content.
-      #
-      def initialize(&block)
-         @html_begin = '<col'
-         @html_body  = ''
-         @html_end   = ''
-         instance_eval(&block) if block_given?
-      end
+    undef_method :configure, :content
+    @indent_level = 6
 
-      # Returns the indentation level for the tags of this class.  The
-      # default is 6.
-      #
-      def self.indent_level
-         @indent_level
-      end
+    # Creates and returns a new ColGroup object.  Optionally takes a block.
+    # Note that it does not accept an argument - col tags do not have content.
+    #
+    def initialize(&block)
+      @html_begin = '<col'
+      @html_body  = ''
+      @html_end   = ''
+      instance_eval(&block) if block_given?
+    end
 
-      # Sets the indentation level for the tags of this class.  The default
-      # is 6.
-      #
-      def self.indent_level=(num)
-         expect(num,Integer)
-         raise ArgumentError, "num must be >= 0" if num < 0
-         @indent_level = num
-      end
+    # Returns the indentation level for the tags of this class.  The
+    # default is 6.
+    #
+    def self.indent_level
+      @indent_level
+    end
 
-      alias to_s html
-      alias to_str html
-   end
+    # Sets the indentation level for the tags of this class.  The default
+    # is 6.
+    #
+    def self.indent_level=(num)
+      expect(num, Integer)
+      raise ArgumentError, 'num must be >= 0' if num < 0
+      @indent_level = num
+    end
+
+    alias to_s html
+    alias to_str html
+  end
 end

data/lib/html/colgroup.rb

@@ -1,113 +1,106 @@
+# The HTML module serves as a namespace only.
 module HTML
-   # This class represents an HTML column group (<colgroup>).  It is a
-   # subclass of Array.  The only elements it may contain are instances
-   # of the ColGroup::Col class.
-   #
-   class Table::ColGroup < Array
-      include HTML::Mixin::AttributeHandler
-      include HTML::Mixin::HtmlHandler
 
-      @indent_level = 3
-      @end_tags     = true
+  # This class represents an HTML column group (<colgroup>).  It is a
+  # subclass of Array.  The only elements it may contain are instances
+  # of the ColGroup::Col class.
+  #
+  class Table::ColGroup < Array
+    include HTML::Mixin::AttributeHandler
+    include HTML::Mixin::HtmlHandler
+    include HTML::Mixin::StrongTyping
+    extend HTML::Mixin::StrongTyping
 
-      undef_method :content
+    @indent_level = 3
+    @end_tags     = true
 
-      # Returns a new ColGroup object. Optionally takes a block. If an
-      # argument is provided, it is treated as content.
-      #
-      def initialize(arg = nil, &block)
-         @html_begin = '<colgroup'
-         @html_body  = ''
-         @html_end   = '</colgroup>'
-         instance_eval(&block) if block_given?
-         self.push(arg) if arg
-      end
+    undef_method :content
 
-      # Returns the indentation level for the tags of this class.  The
-      # default is 3.
-      #
-      def self.indent_level
-         @indent_level
-      end
+    # Returns a new ColGroup object. Optionally takes a block. If an
+    # argument is provided, it is treated as content.
+    #
+    def initialize(arg = nil, &block)
+      @html_begin = '<colgroup'
+      @html_body  = ''
+      @html_end   = '</colgroup>'
+      super(&block)
+      push(arg) if arg
+    end
 
-      # Sets the indentation level for the tags of this class.  The default
-      # is 3.
-      #
-      def self.indent_level=(num)
-         expect(num,Integer)
-         raise ArgumentError,"indent_level must be >= 0" if num < 0
-         @indent_level = num
-      end
+    # Returns the indentation level for the tags of this class.  The
+    # default is 3.
+    #
+    def self.indent_level
+      @indent_level
+    end
 
-      # This method has been redefined to only allow ColGroup::Col objects
-      # to be assigned.
-      #
-      def []=(index,obj)
-         if obj.kind_of?(Array)
-            expect(obj.first,Col) # In case of 0 length Array
-            obj.each{ |o|
-                expect(o,Col)
-            }
-         else
-            expect(obj,Col)
-         end
-         super
-      end
+    # Sets the indentation level for the tags of this class.  The default
+    # is 3.
+    #
+    def self.indent_level=(num)
+      expect(num, Integer)
+      raise ArgumentError, 'indent_level must be >= 0' if num < 0
+      @indent_level = num
+    end
 
-      # This method has been redefined to only allow ColGroup::Col objects
-      # to be pushed onto a ColGroup instance.
-      #
-      def push(*args)
-         args.each do |obj|
-            unless obj.kind_of?(Table::ColGroup::Col)
-               msg = "Can only assign Col objects to ColGroup class"
-               msg += ": " + obj.class.to_s
-               raise TypeError, msg
-            end
-            super(obj)
-         end
+    # This method has been redefined to only allow ColGroup::Col objects
+    # to be assigned.
+    #
+    def []=(index, obj)
+      if obj.is_a?(Array)
+        expect(obj.first, Col) # In case of 0 length Array
+        obj.each do |o|
+          expect(o, Col)
+        end
+      else
+        expect(obj, Col)
       end
+      super
+    end
 
-      # This method has been redefined to only allow ColGroup::Col objects
-      # to be pushed onto a ColGroup instance.
-      #
-      def <<(obj)
-         unless obj.kind_of?(Table::ColGroup::Col)
-            msg = "Can only assign Col objects to ColGroup class"
-            msg += ": " + obj.class.to_s
-            raise TypeError, msg
-         end
-         super(obj)
+    # This method has been redefined to only allow ColGroup::Col objects
+    # to be pushed onto a ColGroup instance.
+    #
+    def push(*args)
+      args.each do |obj|
+        expect(obj, Table::ColGroup::Col)
+        super(obj)
       end
+    end
 
-      # This method has been redefined to only allow ColGroup::Col objects
-      # to be unshifted onto a ColGroup instance.
-      #
-      def unshift(obj)
-         unless obj.kind_of?(Table::ColGroup::Col)
-            msg = "Can only assign Data and Header objects to Row class"
-            raise TypeError, msg
-         end
-         super
-      end
+    # This method has been redefined to only allow ColGroup::Col objects
+    # to be pushed onto a ColGroup instance.
+    #
+    def <<(obj)
+      expect(obj, Table::ColGroup::Col)
+      super
+    end
 
-      # Returns a boolean indicating whether or not end tags are included for
-      # each ColGroup object in the final HTML output.  The default is true.
-      #
-      def self.end_tags?
-         @end_tags
-      end
+    # This method has been redefined to only allow ColGroup::Col objects
+    # to be unshifted onto a ColGroup instance.
+    #
+    def unshift(obj)
+      expect(obj, Table::ColGroup::Col)
+      super
+    end
 
-      # Sets whether or not end tags are included for each ColGroup object in
-      # the final HTML output.  The default is true.  Only true or false are
-      # valid arguments.
-      #
-      def self.end_tags=(bool)
-         expect(bool,[TrueClass,FalseClass])
-         @end_tags = bool
-      end
+    # Returns a boolean indicating whether or not end tags are included for
+    # each ColGroup object in the final HTML output.  The default is true.
+    #
+    def self.end_tags?
+      @end_tags
+    end
+
+    # Sets whether or not end tags are included for each ColGroup object in
+    # the final HTML output.  The default is true.  Only true or false are
+    # valid arguments.
+    #
+    def self.end_tags=(bool)
+      expect(bool, [TrueClass, FalseClass])
+      @end_tags = bool
+    end
 
-      alias to_s html
-      alias to_str html
-   end
+    alias to_s html
+    alias to_str html
+  end
 end

data/lib/html/content.rb

@@ -1,12 +1,9 @@
-########################################################################
-# content.rb
-#
-# This class handles content for Table::Row::Data, Table::Row::Header,
-# and Table::Row::Caption objects.
-########################################################################
 require_relative 'mixin/tag_handler'
 
+# The HTML module is a namespace only.
 module HTML
+  # The Table::Content class handles content for Table::Row::Data,
+  # Table::Row::Header, and Table::Row::Caption objects.
   class Table::Content < String
     include HTML::Mixin::TagHandler