html-table 1.2.2

data/doc/table_body.rdoc

@@ -0,0 +1,9 @@
+== Description
+   A Table::Body object represents a single <TBODY></TBODY> instance for an
+   HTML Table.
+== Notes
+   In virtually every respect the Table::Body class is identical to
+   the Table or Table::Row class.  Unlike Table::Foot or Table::Head, there
+   can be more than one instance (i.e. it's not a singleton class).
+    
+   A Table::Body contains Table::Row objects.

data/doc/table_caption.rdoc

@@ -0,0 +1,9 @@
+== Description
+   A Table::Caption object represents a single <CAPTION></CAPTION> instance
+   for an HTML Table.
+== Notes
+   The Table::Caption class is virtually identical to the Table::Row::Data
+   class.  There is one important behavioral difference, however.  First,
+   there can only be one Table::Caption.  If you attempt to add a second one,
+   it will merely overwrite the existing one.  Second, a Table::Caption is
+   always bumped to index 0.

data/doc/table_colgroup.rdoc

@@ -0,0 +1,8 @@
+== Description
+   A Table::ColGroup object represents a single <COLGROUP></COLGROUP>
+   instance for an HTML Table.
+
+== Notes
+   In virtually every respect the Table::ColGroup class is identical to the
+   Table::Row class.  The only difference, beyond the begin and end tags, is
+   that a ColGroup may only contain instances of the Col class.

data/doc/table_colgroup_col.rdoc

@@ -0,0 +1,9 @@
+== Description
+   A Table::ColGroup::Col object represents a single <COL> instance for an
+   HTML Table.
+
+== Notes
+   In virtually every respect the Table::ColGroup::Col class is identical to
+   the Table::Row::Data class.  The only differences are that a
+   Table::ColGroup::Col instance does not contain any content, nor does it
+   include an end tag.

data/doc/table_foot.rdoc

@@ -0,0 +1,8 @@
+== Description
+   A Table::Foot object represents a single <TFOOT></TFOOT> instance for an
+   HTML Table.
+== Notes
+   In virtually every respect the Table::Foot class is identical to
+   the Table or Table::Row class.  There is one significant difference.
+   The Table::Foot class is a singleton.  There can be only one
+   Table::Foot instance per table.

data/doc/table_head.rdoc

@@ -0,0 +1,11 @@
+== Description
+   A Table::Head object represents a single <THEAD></THEAD> instance for an
+   HTML Table.
+
+== Notes
+   In virtually every respect the Table::Head class is identical to
+   the Table or Table::Row class.  There are two significant differences.
+   First, the Table::Head class is a singleton.  There can be only one
+   Table::Head instance per table.  Second, if an instance of Table::Head
+   is added to a table, it will be automatically be put at index 0 (or 1
+   if a Table::Caption exists).

data/doc/table_row.rdoc

@@ -0,0 +1,105 @@
+= 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
+   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 ####
+   <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.rdoc

@@ -0,0 +1,92 @@
+== 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
+   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 ####
+   <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.rdoc

@@ -0,0 +1,7 @@
+== 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/lib/html/attribute_handler.rb

@@ -0,0 +1,308 @@
+# This 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
+      @abbr
+   end
+
+   def abbr=(string)
+     @abbr = string
+     modify_html("abbr",string)
+   end
+
+   def align
+      @align
+   end
+
+   def align=(position)
+      valid = %w/top bottom left center right/
+      raise ArgumentError unless valid.include?(position.downcase)
+      @align = position
+      modify_html("align",position)
+   end
+
+   def axis
+      @axis
+   end
+
+   def axis=(string)
+     @axis = string
+     modify_html("axis",string)
+   end
+
+   def background
+      @background
+   end
+
+   def background=(url)
+      raise TypeError unless url.kind_of?(String)
+      if $VERBOSE
+         msg =  "'background' is a non-standard extension"
+         STDERR.puts msg
+      end
+      @background = url
+      modify_html("background",url)
+   end
+
+   def bgcolor
+      @bgcolor
+   end
+
+   def bgcolor=(color)
+      @bgcolor = color
+      modify_html("bgcolor",color)
+   end
+
+   def border
+      @border
+   end
+
+   # 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)
+      end
+   end
+
+   def bordercolor
+      @bordercolor
+   end
+
+   def bordercolor=(color)
+      @bordercolor = color
+      if $VERBOSE
+         msg =  "'bordercolor' is a non-standard extension"
+         STDERR.puts msg
+      end
+      modify_html("bordercolor",color)
+   end
+
+   def bordercolordark
+      @bordercolordark
+   end
+
+   def bordercolordark=(color)
+      @bordercolordark = color
+      if $VERBOSE
+         msg = "'bordercolordark' is a non-standard extension"
+         STDERR.puts msg
+      end
+      modify_html("bordercolordark",color)
+   end
+
+   def bordercolorlight
+      @bordercolorlight
+   end
+
+   def bordercolorlight=(color)
+      @bordercolorlight = color
+      if $VERBOSE
+         msg = "'bordercolorlight' is a non-standard extension"
+         STDERR.puts msg
+      end
+      modify_html("bordercolorlight",@bordercolorlight)
+   end
+
+   def cellpadding
+      @cellpadding
+   end
+
+   def cellpadding=(num)
+      raise ArgumentError if num.to_i < 0
+      @cellpadding = num.to_i
+      modify_html("cellpadding",@cellpadding)
+   end
+
+   def cellspacing
+      @cellspacing
+   end
+
+   def cellspacing=(num)
+      raise ArgumentError if num.to_i < 0
+      @cellspacing = num.to_i
+      modify_html("cellspacing",@cellspacing)
+   end
+
+   def char
+      @char
+   end
+
+   def char=(character)
+      raise ArgumentError if character.to_s.length > 1
+      @char = character.to_s
+      modify_html("char",character.to_s)
+   end
+
+   def charoff
+      @charoff
+   end
+
+   def charoff=(offset)
+      raise ArgumentError if offset.to_i < 0
+      @charoff = offset
+      modify_html("charoff",offset)
+   end
+   
+   def col
+      @col
+   end
+
+   def col=(num)
+      raise ArgumentError if num.to_i < 0
+      @col = num.to_i
+      modify_html("col",@col)
+   end
+
+   def colspan
+      @colspan
+   end
+
+   def colspan=(span)
+      raise ArgumentError if span.to_i < 0
+      @colspan = span.to_i
+      modify_html("colspan",@colspan)
+   end
+
+   # Allows you to configure various attributes by row or row + column.
+   def configure(row,col=nil,&block)
+      if col
+         begin
+            yield self[row][col]
+         rescue NameError
+            msg = "No column to configure in a " + self.class.to_s + " class"
+            raise ArgumentError, msg
+         end
+      else
+         yield self[row]
+      end
+   end
+
+   # Returns the HTML content (i.e. text)
+   def content
+      @html_body
+   end
+
+   def frame
+      @frame
+   end
+
+   def frame=(type)
+      valid = %w/border void above below hsides lhs rhs vsides box/
+      raise ArgumentError unless valid.include?(type.downcase)
+      @frame = type
+      modify_html("frame",@frame)
+   end
+
+   def height
+      @height
+   end
+
+   def height=(num)
+      raise ArgumentError if num.to_i < 0
+      @height = num.to_i
+      modify_html("height",@height)
+   end
+
+   def hspace
+      @hspace
+   end
+
+   def hspace=(num)
+      raise ArgumentError if num.to_i < 0
+      @hspace = num.to_i
+      modify_html("hspace",@hspace)
+   end
+
+   def nowrap
+      @nowrap
+   end
+
+   def nowrap=(bool)
+      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
+         raise TypeError
+      end
+      @nowrap = bool
+      modify_html("nowrap",@nowrap)
+   end
+
+   def rowspan
+      @rowspan
+   end
+
+   def rowspan=(num)
+      raise ArgumentError if num.to_i < 0
+      @rowspan = num.to_i
+      modify_html("rowspan",@rowspan)
+   end
+
+   def rules
+      @rules
+   end
+
+   def rules=(edges)
+      valid = %w/all groups rows cols none/
+      raise ArgumentError unless valid.include?(edges.to_s.downcase)
+      @rules = edges
+      modify_html("rules",@rules)
+   end
+
+   def span
+      @span
+   end
+
+   def span=(num)
+      raise ArgumentError if num.to_i < 0
+      @span = num.to_i
+      modify_html("span",@span)
+   end
+
+   def summary
+      @summary
+   end
+
+   def summary=(string)
+      @summary = string.to_s
+      modify_html("summary",@summary)
+   end
+
+   def valign
+      @valign
+   end
+
+   def valign=(position)
+      valid = %w/top center bottom baseline/
+      raise ArgumentError unless valid.include?(position.to_s.downcase)
+      @valign = position
+      modify_html("valign",@valign)
+   end
+
+   def vspace=(num)
+      raise ArgumentError if num.to_i < 0
+      @vspace = num.to_i
+      modify_html("vspace",@vspace)
+   end
+
+   def vspace
+      @vspace
+   end
+
+   def width
+      @width
+   end
+
+   def width=(num)
+      if num =~ /%/
+         @width = num
+      else
+         raise ArgumentError if num.to_i < 0
+         @width = num.to_i
+      end
+      modify_html("width",@width)
+   end
+end