html-table 1.7.0 → 1.7.1

data/html-table.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'html-table'
-  spec.version    = '1.7.0'
+  spec.version    = '1.7.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -12,20 +12,25 @@ Gem::Specification.new do |spec|
   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.4.0')
 
   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
 

data/lib/html/data.rb

@@ -1,3 +1,4 @@
+# The HTML module serves as a namespace only.
 module HTML
 
   # This class represents HTML table data, <td>.  Despite the name
@@ -6,6 +7,7 @@ module HTML
   class Table::Row::Data
     include HTML::Mixin::AttributeHandler
     include HTML::Mixin::HtmlHandler
+    extend HTML::Mixin::StrongTyping
 
     undef_method :configure
 
@@ -42,7 +44,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
 

data/lib/html/foot.rb

@@ -1,49 +1,57 @@
+require 'singleton'
+
+# The HTML module serves as a namespace only.
 module HTML
 
-   # This class represents an HTML table foot (<tfoot>).  It is a
-   # subclass of Table::TableSection.  It is a singleton class.
-   #
-   class Table::Foot < Table::TableSection
-      private_class_method :new
-
-      @@foot        = nil
-      @indent_level = 3
-      @end_tags     = true
-
-      # This is our constructor for Foot objects because it is a singleton
-      # class.  Optionally, a block may be provided.  If an argument is 
-      # provided it is treated as content.
-      #
-      def self.create(arg=nil, &block)
-         @@foot = new(arg, &block) unless @@foot
-         @@foot
-      end      
-      
-      # Called by create() instead of new().  This initializes the Foot class.
-      #
-      def initialize(arg, &block)
-         @html_begin = "<tfoot"
-         @html_end   = "</tfoot>"
-         instance_eval(&block) if block_given?
-         self.content = arg if arg
-      end
-      
-      # Returns a boolean indicating whether or not end tags, </tfoot>, are
-      # included for each Foot 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 Foot 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
-   end
+  # This class represents an HTML table foot (<tfoot>). It is a
+  # subclass of Table::TableSection. It is a singleton class.
+  #
+  class Table::Foot < Table::TableSection
+    include Singleton
+    extend HTML::Mixin::StrongTyping
+
+    @indent_level = 3
+    @end_tags     = true
+
+    # This is our constructor for Foot objects because it is a singleton
+    # class. Optionally, a block may be provided. If an argument is
+    # provided it is treated as content.
+    #
+    def self.create(arg = nil, &block)
+      instance(arg, &block)
+    end
+
+    # Part of the singleton interface.
+    #
+    def self.instance(arg = nil, &block)
+      @instance ||= new(arg, &block)
+    end
+
+    # Called by create() instead of new(). This initializes the Foot class.
+    #
+    def initialize(arg, &block)
+      @html_begin = '<tfoot'
+      @html_end   = '</tfoot>'
+      super(&block)
+      self.content = arg if arg
+    end
+
+    # Returns a boolean indicating whether or not end tags, </tfoot>, are
+    # included for each Foot 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 Foot 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
+  end
 
 end

data/lib/html/head.rb

@@ -1,49 +1,56 @@
+require 'singleton'
+
+# The HTML module serves only as a namespace.
 module HTML
-   
-   # This class represents an HTML table head (<thead>).  It is a
-   # subclass of Table::TableSection.  It is a singleton class.
-   #
-   class Table::Head < Table::TableSection
-      private_class_method :new
-
-      @@head = nil
-
-      @indent_level = 3
-      @end_tags     = true
-
-      # This is our constructor for Head objects because it is a singleton
-      # class.  Optionally, a block may be provided.  If an argument is 
-      # provided it is treated as content.
-      #
-      def self.create(arg=nil, &block)
-         @@head = new(arg, &block) unless @@head
-         @@head
-      end      
-
-      # Called by create() instead of new().  This initializes the Head class.
-      #
-      def initialize(arg, &block)
-         @html_begin = "<thead"
-         @html_end   = "</thead>"
-         instance_eval(&block) if block_given?
-         self.content = arg if arg
-      end
-      
-      # Returns a boolean indicating whether or not end tags, </thead>, are
-      # included for each Head 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 Head 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
-   end
+
+  # This class represents an HTML table head (<thead>). It is a
+  # subclass of Table::TableSection. It is a singleton class.
+  #
+  class Table::Head < Table::TableSection
+    include Singleton
+    extend HTML::Mixin::StrongTyping
+
+    @indent_level = 3
+    @end_tags     = true
+
+    # This is our constructor for Head objects because it is a singleton
+    # class. Optionally, a block may be provided. If an argument is
+    # provided it is treated as content.
+    #
+    def self.create(arg = nil, &block)
+      instance(arg, &block)
+    end
+
+    # Part of the singleton interface.
+    #
+    def self.instance(arg = nil, &block)
+      @instance ||= new(arg, &block)
+    end
+
+    # Called by create() instead of new(). This initializes the Head class.
+    #
+    def initialize(arg, &block)
+      @html_begin = '<thead'
+      @html_end   = '</thead>'
+      super(&block)
+      self.content = arg if arg
+    end
+
+    # Returns a boolean indicating whether or not end tags, </thead>, are
+    # included for each Head 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 Head 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
+  end
 end