html-table 1.7.0 → 1.7.1

data/lib/html/header.rb

@@ -1,3 +1,4 @@
+# The HTML module serves as a namespace only.
 module HTML
 
   # This class represents an HTML table header (<th>).  Despite the name
@@ -6,6 +7,7 @@ module HTML
   class Table::Row::Header
     include HTML::Mixin::AttributeHandler
     include HTML::Mixin::HtmlHandler
+    extend HTML::Mixin::StrongTyping
 
     undef_method :configure
 
@@ -41,8 +43,8 @@ module HTML
     # is 6.
     #
     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
 
@@ -58,7 +60,7 @@ module HTML
     # valid arguments.
     #
     def self.end_tags=(bool)
-      expect(bool,[TrueClass,FalseClass])
+      expect(bool, [TrueClass, FalseClass])
       @end_tags = bool
     end
   end

data/lib/html/mixin/attribute_handler.rb

@@ -1,11 +1,14 @@
-# This module creates methods for each of the various attributes associated
-# with HTML tables.  In some cases validation is done on the setters.
-#--
+##########################################################################
 # The seemingly redundant writer methods were left here for backwards
 # compatibility and for those who may not prefer the DSL.
-#
+##########################################################################
+
+# The HTML module serves as a namespace only.
 module HTML
+  # The Mixin module serves as a namespace to prevent collisions.
   module Mixin
+    # The AttributeHandler module creates methods for each of the various attributes
+    # associated with HTML tables. In some cases validation is done on the setters.
     module AttributeHandler
       def abbr(string = nil)
         @abbr ||= nil
@@ -15,7 +18,7 @@ module HTML
 
       def abbr=(string)
         @abbr = string
-        modify_html("abbr", string)
+        modify_html('abbr', string)
       end
 
       def align(position = nil)
@@ -25,10 +28,10 @@ module HTML
       end
 
       def align=(position)
-        valid = %w/top bottom left center right/
+        valid = %w[top bottom left center right]
         raise ArgumentError unless valid.include?(position.downcase)
         @align = position
-        modify_html("align", position)
+        modify_html('align', position)
       end
 
       def axis(string = nil)
@@ -39,7 +42,7 @@ module HTML
 
       def axis=(string)
         @axis = string
-        modify_html("axis", string)
+        modify_html('axis', string)
       end
 
       def background(url = nil)
@@ -49,11 +52,11 @@ module HTML
       end
 
       def background=(url)
-        raise TypeError unless url.kind_of?(String)
-        msg =  "'background' is a non-standard extension"
+        raise TypeError unless url.is_a?(String)
+        msg = "'background' is a non-standard extension"
         warn NonStandardExtensionWarning, msg
         @background = url
-        modify_html("background", url)
+        modify_html('background', url)
       end
 
       def bgcolor(color = nil)
@@ -64,7 +67,7 @@ module HTML
 
       def bgcolor=(color)
         @bgcolor = color
-        modify_html("bgcolor", color)
+        modify_html('bgcolor', color)
       end
 
       def border(num = nil)
@@ -75,13 +78,14 @@ module HTML
 
       # Allow either true/false or an integer
       def border=(num)
-        if num.kind_of?(TrueClass)
-          modify_html("border", true)
-        elsif num.kind_of?(FalseClass)
-          # Do nothing
-        else
-          @border = num.to_i
-          modify_html("border", num.to_i)
+        case num
+          when TrueClass
+            modify_html('border', true)
+          when FalseClass
+            # Do nothing
+          else
+            @border = num.to_i
+            modify_html('border', num.to_i)
         end
       end
 
@@ -93,9 +97,9 @@ module HTML
 
       def bordercolor=(color)
         @bordercolor = color
-        msg =  "'bordercolor' is a non-standard extension"
+        msg = "'bordercolor' is a non-standard extension"
         warn NonStandardExtensionWarning, msg
-        modify_html("bordercolor", color)
+        modify_html('bordercolor', color)
       end
 
       def bordercolordark(color = nil)
@@ -108,7 +112,7 @@ module HTML
         @bordercolordark = color
         msg = "'bordercolordark' is a non-standard extension"
         warn NonStandardExtensionWarning, msg
-        modify_html("bordercolordark", color)
+        modify_html('bordercolordark', color)
       end
 
       def bordercolorlight(color = nil)
@@ -121,7 +125,7 @@ module HTML
         @bordercolorlight = color
         msg = "'bordercolorlight' is a non-standard extension"
         warn NonStandardExtensionWarning, msg
-        modify_html("bordercolorlight", @bordercolorlight)
+        modify_html('bordercolorlight', @bordercolorlight)
       end
 
       def cellpadding(num = nil)
@@ -133,7 +137,7 @@ module HTML
       def cellpadding=(num)
         raise ArgumentError if num.to_i < 0
         @cellpadding = num.to_i
-        modify_html("cellpadding", @cellpadding)
+        modify_html('cellpadding', @cellpadding)
       end
 
       def cellspacing(num = nil)
@@ -145,7 +149,7 @@ module HTML
       def cellspacing=(num)
         raise ArgumentError if num.to_i < 0
         @cellspacing = num.to_i
-        modify_html("cellspacing", @cellspacing)
+        modify_html('cellspacing', @cellspacing)
       end
 
       def char(character = nil)
@@ -157,7 +161,7 @@ module HTML
       def char=(character)
         raise ArgumentError if character.to_s.length > 1
         @char = character.to_s
-        modify_html("char", character.to_s)
+        modify_html('char', character.to_s)
       end
 
       def charoff(offset = nil)
@@ -169,7 +173,7 @@ module HTML
       def charoff=(offset)
         raise ArgumentError if offset.to_i < 0
         @charoff = offset
-        modify_html("charoff", offset)
+        modify_html('charoff', offset)
       end
 
       # Returns the CSS class. The trailing underscore is necessary in order
@@ -198,7 +202,7 @@ module HTML
       def col=(num)
         raise ArgumentError if num.to_i < 0
         @col = num.to_i
-        modify_html("col", @col)
+        modify_html('col', @col)
       end
 
       def colspan(span = nil)
@@ -210,17 +214,17 @@ module HTML
       def colspan=(span)
         raise ArgumentError if span.to_i < 0
         @colspan = span.to_i
-        modify_html("colspan", @colspan)
+        modify_html('colspan', @colspan)
       end
 
       # Allows you to configure various attributes by row or row + column.
       #
-      def configure(row, col=nil, &block)
+      def configure(row, col = nil)
         if col
           begin
             yield self[row][col]
           rescue NameError
-            msg = "No column to configure in a " + self.class.to_s + " class"
+            msg = "No column to configure in a #{self.class} class"
             raise ArgumentError, msg
           end
         else
@@ -235,15 +239,15 @@ module HTML
           when String
             self.content = Table::Content.new(arg, &block)
           when Array
-            arg.each{ |e|
-              if e.kind_of?(Array)
+            arg.each do |e|
+              if e.is_a?(Array)
                 row = Table::Row.new
-                e.each{ |element| row.push(Table::Content.new(element, &block)) }
-                self.push(row)
+                e.each { |element| row.push(Table::Content.new(element, &block)) }
+                push(row)
               else
                 self.content = Table::Content.new(e, &block)
               end
-            }
+            end
           else
             self.content = arg if arg
         end
@@ -259,10 +263,10 @@ module HTML
       end
 
       def frame=(type)
-        valid = %w/border void above below hsides lhs rhs vsides box/
+        valid = %w[border void above below hsides lhs rhs vsides box]
         raise ArgumentError unless valid.include?(type.downcase)
         @frame = type
-        modify_html("frame", @frame)
+        modify_html('frame', @frame)
       end
 
       def height(num = nil)
@@ -274,7 +278,7 @@ module HTML
       def height=(num)
         raise ArgumentError if num.to_i < 0
         @height = num.to_i
-        modify_html("height", @height)
+        modify_html('height', @height)
       end
 
       def hspace(num = nil)
@@ -286,7 +290,7 @@ module HTML
       def hspace=(num)
         raise ArgumentError if num.to_i < 0
         @hspace = num.to_i
-        modify_html("hspace", @hspace)
+        modify_html('hspace', @hspace)
       end
 
       def nowrap(bool = nil)
@@ -296,11 +300,11 @@ module HTML
       end
 
       def nowrap=(bool)
-        unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
-           raise TypeError
+        unless bool.is_a?(TrueClass) || bool.is_a?(FalseClass)
+          raise TypeError
         end
         @nowrap = bool
-        modify_html("nowrap", @nowrap)
+        modify_html('nowrap', @nowrap)
       end
 
       def rowspan(num = nil)
@@ -312,7 +316,7 @@ module HTML
       def rowspan=(num)
         raise ArgumentError if num.to_i < 0
         @rowspan = num.to_i
-        modify_html("rowspan", @rowspan)
+        modify_html('rowspan', @rowspan)
       end
 
       def rules(edges = nil)
@@ -322,10 +326,10 @@ module HTML
       end
 
       def rules=(edges)
-        valid = %w/all groups rows cols none/
+        valid = %w[all groups rows cols none]
         raise ArgumentError unless valid.include?(edges.to_s.downcase)
         @rules = edges
-        modify_html("rules", @rules)
+        modify_html('rules', @rules)
       end
 
       def span(num = nil)
@@ -337,7 +341,7 @@ module HTML
       def span=(num)
         raise ArgumentError if num.to_i < 0
         @span = num.to_i
-        modify_html("span", @span)
+        modify_html('span', @span)
       end
 
       def style(string = nil)
@@ -348,7 +352,7 @@ module HTML
 
       def style=(string)
         @style = string.to_s
-        modify_html("style", @style)
+        modify_html('style', @style)
       end
 
       def summary(string = nil)
@@ -359,7 +363,7 @@ module HTML
 
       def summary=(string)
         @summary = string.to_s
-        modify_html("summary", @summary)
+        modify_html('summary', @summary)
       end
 
       def valign(position = nil)
@@ -369,10 +373,10 @@ module HTML
       end
 
       def valign=(position)
-        valid = %w/top center bottom baseline/
+        valid = %w[top center bottom baseline]
         raise ArgumentError unless valid.include?(position.to_s.downcase)
         @valign = position
-        modify_html("valign", @valign)
+        modify_html('valign', @valign)
       end
 
       def vspace(num = nil)
@@ -384,7 +388,7 @@ module HTML
       def vspace=(num)
         raise ArgumentError if num.to_i < 0
         @vspace = num.to_i
-        modify_html("vspace", @vspace)
+        modify_html('vspace', @vspace)
       end
 
       def width(num = nil)
@@ -400,7 +404,7 @@ module HTML
           raise ArgumentError if num.to_i < 0
           @width = num.to_i
         end
-        modify_html("width", @width)
+        modify_html('width', @width)
       end
     end
   end

data/lib/html/mixin/html_handler.rb

@@ -1,31 +1,33 @@
+# The HTML module serves as a namespace only.
 module HTML
+  # The Mixin module is a namespace for html-table mixins.
   module Mixin
+    # The HtmlHandler module is the library for generating html output.
     module HtmlHandler
-
-      $upper = false
-
       # Used on HTML attributes. It creates proper HTML text based on the argument
-      # type.  A string looks like "attr='text'", a number looks like "attr=1",
+      # type. A string looks like "attr='text'", a number looks like "attr=1",
       # while a true value simply looks like "attr" (no equal sign).
       #--
       # This is private method.
       #
-      def modify_html(attribute,arg=nil)
+      def modify_html(attribute, arg = nil)
         if @html_begin.scan(/\b#{attribute}\b/).empty?
-          if arg.kind_of?(Integer)
-            @html_begin << " #{attribute}=#{arg}"
-          elsif arg.kind_of?(TrueClass)
-            @html_begin << " #{attribute}"
-          else
-            @html_begin << " #{attribute}='#{arg}'"
+          case arg
+            when Integer
+              @html_begin << " #{attribute}=#{arg}"
+            when TrueClass
+              @html_begin << " #{attribute}"
+            else
+              @html_begin << " #{attribute}='#{arg}'"
           end
         else
-          if arg.kind_of?(Integer)
-            @html_begin.gsub!(/#{attribute}=\d+/,"#{attribute}=#{arg}")
-          elsif arg.kind_of?(FalseClass)
-            @html_begin.gsub!(/#{attribute}/,'')
-          else
-            @html_begin.gsub!(/#{attribute}=['\w\.]+/,"#{attribute}='#{arg}'")
+          case arg
+            when Integer
+              @html_begin.gsub!(/#{attribute}=\d+/, "#{attribute}=#{arg}")
+            when FalseClass
+              @html_begin.gsub!(/#{attribute}/, '')
+            else
+              @html_begin.gsub!(/#{attribute}=['\w.]+/, "#{attribute}='#{arg}'")
           end
         end
       end
@@ -38,11 +40,7 @@ module HTML
       # honored.
       #
       def html(formatting = true)
-        if self.class.respond_to?(:html_case)
-          $upper = true if self.class.html_case == "upper"
-        end
-
-        if $upper
+        if HTML::Table.html_case == 'upper'
           @html_begin.upcase!
           @html_end.upcase!
         end
@@ -53,15 +51,15 @@ module HTML
           ilevel = self.class.indent_level
         end
 
-        html          = ' ' * ilevel + @html_begin[0..-1]
+        html          = (' ' * ilevel) + @html_begin[0..]
         len           = html.length
-        html[len,len] = '>'
+        html[len, len] = '>'
 
-        if self.kind_of?(Array)
+        if is_a?(Array)
           if formatting
-            html << self.map{ |e| "\n" + e.html(formatting).to_s }.join
+            html << map { |e| "\n#{e.html(formatting)}" }.join
           else
-            html << self.map{ |e| e.html(formatting).to_s }.join
+            html << map { |e| e.html(formatting).to_s }.join
           end
         else
           html << @html_body
@@ -75,29 +73,29 @@ module HTML
         # The Table.global_end_tags method overrides the individual class
         # preferences with regards to end tags.
         #####################################################################
-        if self.kind_of?(Array)
+        if is_a?(Array)
           if HTML::Table.global_end_tags?
             if self.class.respond_to?(:end_tags?)
               if formatting
                 if self.class.end_tags?
-                  html << "\n" + (' ' * ilevel) + @html_end
+                  html << ("\n" << (' ' * ilevel) << @html_end)
                 end
               else
-                html << (' ' * ilevel) + @html_end if self.class.end_tags?
+                html << ((' ' * ilevel) << @html_end) if self.class.end_tags?
               end
             else
               if formatting
-                html << "\n" + (' ' * ilevel) + @html_end
+                html << ("\n" << (' ' * ilevel) << @html_end)
               else
-                html << (' ' * ilevel) + @html_end
+                html << ((' ' * ilevel) << @html_end)
               end
             end
           else
             unless self.class.respond_to?(:end_tags?)
               if formatting
-                html << "\n" + (' ' * ilevel) + @html_end
+                html << ("\n" << (' ' * ilevel) << @html_end)
               else
-                html << (' ' * ilevel) + @html_end
+                html << ((' ' * ilevel) << @html_end)
               end
             end
           end
@@ -115,7 +113,7 @@ module HTML
           end
         end
 
-        return html
+        html
       end
 
       private :modify_html

data/lib/html/mixin/strongtyping.rb

@@ -1,16 +1,16 @@
-# A pure-ruby replacement for strongtyping gem
-
+# The HTML module serves as a namespace only.
 module HTML
+  # The Mixin module serves as a namespace only to prevent collisions.
   module Mixin
+    # The StrongTyping module is a pure Ruby replacement for the strongtyping gem.
     module StrongTyping
-      class ArgumentTypeError < ArgumentError; end
-
       def expect(arg, allowed_types)
         return true if Array(allowed_types).any? do |klass|
-          arg.kind_of?(klass)
+          arg.is_a?(klass)
         end
 
-        raise ArgumentTypeError.new("#{arg} must be of type #{allowed_types}")
+        # Defined in table.rb
+        raise ArgumentTypeError, "#{arg} must be of type #{allowed_types}"
       end
     end
   end

data/lib/html/mixin/tag_handler.rb

@@ -5,8 +5,12 @@
 # Only used for Table::Content objects, which are in turn used by
 # Table::Row::Data, Table::Row::Header and Table::Caption.
 ###################################################################
+
+# The HTML module serves as a namespace only.
 module HTML
+  # The Mixin module serves as a namespace only.
   module Mixin
+    # The TagHandler module implements handling for standard html physical tags.
     module TagHandler
       def bold(bool = nil)
         @bold ||= nil
@@ -115,9 +119,9 @@ module HTML
         end_tag = "</#{tag}>"
 
         if bool
-          self.replace(begin_tag << self << end_tag)
+          replace(begin_tag << self << end_tag)
         else
-          self.replace(self.gsub(/#{begin_tag}|#{end_tag}/,''))
+          replace(gsub(/#{begin_tag}|#{end_tag}/, ''))
         end
       end
     end