html-table 1.2.2

data/CHANGES

@@ -0,0 +1,72 @@
+== 1.2.2 - 17-Jun-2005
+* Each class now defines its own content= method (rather than a generic module
+  method that handles it).  Internal change only.
+* The Head, Foot and Body classes now use the inherited version of content=
+  method, instead of defining them individually (which they should have
+  been doing all along).
+* Made the README and CHANGES file rdoc friendly.
+* Removed the .rd and html files under the 'doc' directory.  All of those
+  files have been made rdoc friendly and been given .rdoc extensions.
+* Some $LOAD_PATH setup changes for the test suite.
+
+== 1.2.1 - 26-Oct-2004
+* Documentation additions to make the code rdoc friendly.
+* Minor typo/bug fix in the background method of the AttributeHandler module.
+* Added an assertion to the test suite, mostly to make tc_all.rb work
+  correctly (one test was causing other tests to fail due to a global
+  setting that was made in a previous test).
+
+== 1.2.0 - 8-Aug-2004
+* Added the global_end_tags= class method for the Table class.  This allows
+  you to configure you want end tags or not for all classes, rather than
+  having to configure each class individually.  Note that classes which
+  require end tags are unaffected.
+* Added handling for '<<' for those classes where it was appropriate (i.e.
+  any class that also used 'push').
+* Minor update in the Table::Row#unshift method.
+* Modified the border= method in the AttributeHandler module to accept true
+  or false as arguments.  I had forgotten that you could specify 'border' as
+  an attribute without a value.
+* Yet more tests.
+
+== 1.1.0 - 6-Aug-2004
+* Modified the constructors for all of the classes that can contain content
+  to accept an optional argument. If present it is assumed to be content.
+* Fixed a bug/feature in Table::Row where it didn't allow you to add or
+  delete Fixnums.  Henceforth, Fixnum's are stringified.
+* The Table::ColGroup class no longer has the content or content= methods.
+  This was illegal in 1.0.0 as well but it now raises a NoMethodError instead.
+* Added many more tests, including tests for attribute handlers and html
+  handlers.
+* Made the modify_html method in the HtmlHandler module private.  This should
+  have no affect on your code.
+* Added another simple sample program under doc/examples.
+* Documentation updates.
+
+== 1.0.0 - 23-May-2004
+* No API changes - same as 0.0.4 but now officially declared "stable".  The
+  only change that was made is that each class is now in its own file.
+
+== 0.0.4 - 16-May-2004 (Beta4)
+* Prerequisites now include Ruby 1.8.0 or later and the StrongTyping package from
+  Ryan Pavlik.
+* More stringent type checking added using the StrongTyping package.
+* Bug in Table::Foot class corrected.
+* Minor name change for included modules (AttributeHandler, HtmlHandler).
+* Many more tests added
+
+== 0.0.3 - 9-Jul-2003 (Beta3)
+* Added html_case() class method for those who want their HTML tags in upper
+  case
+* Fixed up the docs, added the html docs to the core distro
+* Added some config info to table.rb so that this package works as expected
+  after installation
+
+== 0.0.2 - 5-Jul-2003 (Beta2)
+* API completely rewritten
+* End tags and indentation level now configurable
+* Added all remaining tag types (caption, colgroup, col, tbody, tfoot and
+  thead)
+
+== 0.0.1 11-Jun-2003 (Beta1)
+* Initial Release

data/MANIFEST

@@ -0,0 +1,41 @@
+MANIFEST
+CHANGES
+README
+install.rb
+
+doc/attributes.rdoc
+doc/table_body.rdoc
+doc/table_caption.rdoc
+doc/table_colgroup.rdoc
+doc/table_colgroup_col.rdoc
+doc/table_foot.rdoc
+doc/table_head.rdoc
+doc/table_row_data.rdoc
+doc/table_row_header.rdoc
+doc/table_row.rdoc
+doc/table.rdoc
+
+doc/examples/advanced.rb
+doc/examples/intermediate1.rb
+doc/examples/intermediate2.rb
+doc/examples/simple1.rb
+doc/examples/simple2.rb
+doc/examples/simple3.rb
+
+lib/html/attribute_handler.rb
+lib/html/html_handler.rb
+lib/html/table.rb
+
+test/ts_all.rb
+test/tc_attribute_handler.rb
+test/tc_body.rb
+test/tc_caption.rb
+test/tc_col.rb
+test/tc_colgroup.rb
+test/tc_data.rb
+test/tc_head.rb
+test/tc_header.rb
+test/tc_html_handler.rb
+test/tc_row.rb
+test/tc_table.rb
+test/tc_tablesection.rb

data/README

@@ -0,0 +1,137 @@
+== Description
+   An interface for generating HTML Tables with Ruby.
+
+== Prerequisites
+   * Ruby 1.8.0 or later
+   * StrongTyping 2.0.6b or later
+
+== Installation
+=== Manual Installation
+   ruby test/ts_all.rb (optional)
+   ruby install.rb
+=== Gem Installation, Local
+   ruby test/ts_all.rb (optional)
+   ruby html-table.gemspec
+   gem install html-table-<version>.gem
+=== Gem Installation, Remote
+   gem install html-table
+
+== Synopsis
+   require "html/table"
+   include HTML
+
+   table = HTML::Table.new{ |t|
+      t.border  = 1
+      t.bgcolor = "red"
+   }
+
+   table.push Table::Row.new{ |r|
+      r.align   = "left"
+      r.bgcolor = "green"
+      r.content = ["foo","bar","baz"]
+   }
+
+   row = Table::Row.new{ |r|
+      r.align   = "right"
+      r.bgcolor = "blue"
+      r.content = "hello world"
+   }
+
+   table[1] = row
+
+   puts table.html
+
+   # Output
+   <table border=1 bgcolor='red'>
+      <tr align='left' bgcolor='green'>  # row 0
+         <td>foo</td>                    # column 0
+         <td>bar</td>                    # column 1
+         <td>baz</td>                    # column 2
+      </tr>
+      <tr align='right' bgcolor='blue'>  # row 1
+         <td>hello world</td>            # column 0
+      </tr>
+   </table>
+
+   See the 'examples' directory under 'doc' for more examples.
+
+== Mixins
+   Table is a subclass of Array, and therefore mixes in Enumerable.  The
+   push, unshift and []= methods have been modified.  See below for details.    
+   
+   Table also mixes in Attribute_Handler which provides methods for adding
+   attributes to each of the tag types.  See attributes.rd2 for more details.
+
+== Notes
+   A Table consists of Table::Row, Table::Caption, Table::ColGroup,
+   Table::Body, Table::Foot, Table::Head and Table::Row objects.
+
+   Table::Row objects in turn consist of Table::Row::Data and
+   Table::Row::Header objects.
+
+   Table::ColGroup objects consist of Table::ColGroup::Col
+   objects.
+
+   Table::Head, Table::Body and Table::Foot objects consist
+   of Table::Row objects.
+    
+   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.  See the documentation on
+   specific methods for more details.
+
+   Using a non-standard extension (e.g. "background") will send a warning to
+   STDERR in $VERBOSE (-w) mode.
+
+== Known Bugs
+   None that I'm aware of.  Please report bugs on the project page at
+   http://ruby-miscutils.sf.net.
+
+== Future Plans
+   Documentation improvements (include inline links to other files).
+
+   Allow standard html tags to be added to elements as appropriate, such
+   as <B>, <I>, etc.
+
+== Acknowledgements
+   Anthony Peacock, for giving me ideas with his HTML::Table Perl module.
+
+   Holden Glova and Culley Harrelson for API suggestions and comments.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2003, 2004 Daniel J. Berger
+   All Rights Reserved
+
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (irc.freenode.net)
+
+== Developer's Notes
+   Some people might be a little annoyed with the fact that I required Ryan
+   Pavlik's strongtyping package.  I'm not a big fan of strong typing myself. So,
+   why did I do this?
+
+   Normally when creating code, you setup your own rules as far as what is allowed
+   as an argument.  You publish the API, set up a good set of tests, and don't
+   bother worrying about types because you figure people can read the API and
+   won't go out of their way to break it.  You certainly don't worry about it
+   yourself because you're used to dynamic languages and find that you don't need
+   the strong typing training wheels after all (right?).
+
+   However, HTML tables have a predefined set of rules as far as what content is
+   valid, and where it's placed in order to be HTML 4.0 compliant.  For example,
+   if a caption is included, it should be at the 'top' of your table syntax, you
+   can only have one foot section, and so on.  So, I chose to enforce these
+   conventions and/or rules in Ruby via Ryan's module.  I could have lived
+   without it, and instead chose to do a plethora of "kind_of?" checks.  However,
+   Ryan's package is both faster and required less typing on my part.

data/doc/attributes.rdoc

@@ -0,0 +1,143 @@
+== Description
+   A list of attributes handled by html-table.  Each of the writers has a
+   corresponding reader unless otherwise stated.
+
+== Attributes
+abbr=(string)
+   Sets the value for the abbr attribute.
+
+align=(string)
+   Sets the align attribute.  Valid arguments are 'left', 'center' and
+   'right'.  An ArgumentError is raised if an invalid argument is passed.
+
+axis=(string)
+   Sets the value for the axis attribute.
+
+background=(url)
+   Sets the background attribute.  The url must be a String or a TypeError
+   is raised.  This is a non-standard extension.
+
+bgcolor=(color)
+   Sets the color for the bgcolor attribute.  Hex values should still be
+   quoted, e.g. "#F80000".
+
+border=(num)
+   Sets the value for the border attribute.
+
+bordercolor=(color)
+   Sets the color for the bordercolor attribute.  This is a non-standard
+   extension.
+
+bordercolordark=(color)
+   Sets the color for the bordercolordark attribute.  This is a non-standard
+   extension.
+
+bordercolorlight=(color)
+   Sets the color for the bordercolorlight attribute.  This is a non-standard
+   extension.
+
+cellpadding=(num)
+   Sets the value for the cellpadding attribute.  Raises an ArgumentError if
+   num.to_i is less than 0.
+
+cellspacing=(num)
+   Sets the value for the cellspacing attribute.  Raises an ArgumentError if
+   num.to_i is less than 0.
+
+char=(character)
+   Sets the value for the char attribute.  An ArgumentError is raised if the
+   argument passed has a length greater than 1 (i.e. it may only be a char).
+
+charoff=(value)
+   Sets the value for the charoff attribute.
+
+colspan=(num)
+   Sets the colspan attribute.
+
+content=(*args)
+   The behavior of this method varies largely based on the type of instance
+   that invokes it.  Here are the rules for each +arg+ in +args+:
+    
+   +Table+:
+    
+   If +arg+ is a Row, Head, Foot, Body or ColGroup object, it is
+   pushed onto the table.  If +arg+ is a string, one Row object with
+   one one Data object is pushed onto the Table.  If +arg+ is an Array,
+   one Row object is created and each element of the array is pushed
+   onto that Row.
+    
+   +Table::Row+:
+    
+   If +arg+ is a Header or Data object, it is pushed onto the Row.  If
+   +arg+ is a String, it is created as a single Data object.  Attempts
+   to assign any other type will raise a TypeError.
+       
+   +Table::Head, Table::Foot, Table::Body+:
+    
+   Behave identically to Table::Row except that they accept Table::Row
+   objects as well.
+       
+   +Table::ColGroup+:
+    
+   Behaves identically to Table::Row except that it only accepts Col objects.
+       
+   +Table::Col+:
+    
+   This method is undefined for Table::Col, because they do not accept
+   content.
+       
+   +Table::Data and Table::Header+:
+    
+   Sets the text string for the Data or Header object.  Arrays are join'd.
+   Any other type raises a TypeError.  
+
+frame=(type)
+   Sets the value for the frame attribute.  Valid values are border, void,
+   above, below, hsides, lhs, rhs, vsides, and box.  An ArgumentError is
+   raised if an invalid type is detected.
+
+height=(num)
+   Sets the value for the height attribute.  Raises an ArgumentError if
+   num.to_i is less than 0.
+
+hspace=(num)
+   Sets the value for the hspace attribute.  Raises an ArgumentError if
+   num.to_i is less than 0.
+
+nowrap=(bool)
+   Sets the value for the nowrap attribute.  Setting it to true means it will
+   be included as an attribute for the Table object.  The default is false
+   (i.e. not included).
+
+rowspan=(num)
+   Sets the value for the rowspan attribute.
+
+rules=(edges)
+   Sets the value for the rules attribute.  Valid values are all, groups,
+   rows, cols, or none.  An ArgumentError is raised if an invalid edges value
+   is detected.
+
+scope=(scope)
+   Sets the value for the scope attribute.  Valid values for +scope+ are
+   row, col, rowgroup or colgroup.  An ArgumentError is raised if an invalid
+   scope value is passed.
+
+span=(num)
+   Sets the span attribute.  If num.to_i is less than 0, and ArgumentError
+   is raised.
+
+summary=(string)
+   Sets the value for the summary attribute.
+
+valign=(position)
+   Sets the value for the valign attribute.  Valid values are top, center,
+   bottom, and baseline.  This is a non-standard extension.
+
+vspace=(num)
+   Sets the value for the vspace attribute.  This is a non-standard
+   extension.
+
+width=(num)
+   Sets the value for the width attribute.  If num is in 'x%' format, it
+   is retained as a string.  If num is a Fixnum (or stringified number), an
+   ArgumentError is raised if num.to_i is less than 0.

data/doc/table.rdoc

@@ -0,0 +1,157 @@
+== Description
+   An interface for generating HTML Tables with Ruby.
+
+== Synopsis
+   require "html/table"
+   include HTML
+
+   table = HTML::Table.new{ |t|
+      t.border  = 1
+      t.bgcolor = "red"
+   }
+
+   table.push Table::Row.new{ |r|
+      r.align   = "left"
+      r.bgcolor = "green"
+      r.content = ["foo","bar","baz"]
+   }
+
+   row = Table::Row.new{ |r|
+      r.align   = "right"
+      r.bgcolor = "blue"
+      r.content = "hello world"
+   }
+
+   table[1] = row
+
+   puts table.html
+
+   #### output ####
+   <table border=1 bgcolor='red'>
+      <tr align='left' bgcolor='green'>  # row 0
+         <td>foo</td>                    # column 0
+         <td>bar</td>                    # column 1
+         <td>baz</td>                    # column 2
+      </tr>
+      <tr align='right' bgcolor='blue'>  # row 1
+         <td>hello world</td>            # column 0
+      </tr>
+   </table>
+
+   See the 'examples' directory for more examples.
+
+== Mixins
+   Table is a sublcass of Array, and therefore mixes in Enumerable.  The
+   push, unshift and []= methods have been modified.  See below for details.    
+    
+   Table also mixes in Attribute_Handler which provides methods for adding
+   attributes to each of the tag types.  See attributes.rdoc for more details.
+
+== Constants
+VERSION
+    The current version number (a String).  This serves as the VERSION number
+    for the entire html-table package.
+
+== Class Methods
+Table.new(arg=nil)
+Table.new(arg=nil){ |t| ... }
+   Creates a new Table instance.  You can set attributes for the Table by
+   passing a block.
+    
+   If +arg+ is supplied, it is automatically interpreted to be content. This
+   is a shortcut for Table.new{ |t| t.content = '...' }.
+
+Table.global_end_tags?
+   Returns the value of the global_end_tags class variable.  By default,
+   this is true.
+
+Table.global_end_tags=(true|false)
+   Sets the global_end_tags class variable.  This determines class-wide, for
+   those classes where end tags are optional, whether or not end tags are
+   included in the final html.  Classes where end tags are not optional are
+   not affected.
+    
+   If set to false, this overrides individual class end tags settings.
+
+== Instance Methods
+Table#[]=(index, object)
+   Assigns +object+ to +index+. There are restrictions to the data
+   types that you can assign to a Table instance.  They include Caption,
+   ColGroup, Body, Foot, Head and Row.  You cannot assign a slice (yet).
+
+Table#configure(row_num, col_num=0){ |td_object| block }
+   Configures column +col_num+ at row +row_num+, using a block to set
+   options.  If only +row_num+ is specified, then you'll be configuring
+   only the row. Generally speaking, that means you'll be configure a
+   Table::Row and not a Data or Header object.
+
+Table#content
+   Returns the HTML content.
+
+Table#content=(arg)
+   Adds data to the Table. The +arg+ may be a Table::Row object, an
+   Array of Table::Row objects, an Array of Array's, an Array of Strings,
+   or a single String.  In the last two cases, a single Table::Row with a
+   single Table::Row::Data object is created, with the string as the content.
+
+Table#html
+   Returns the entire HTML content for the Table Object.  This is what you
+   want to print when you're done creating your Table.
+
+Table#push(obj)
+    Pushes +obj+ onto the Table, where +obj+ must be a Row, Caption,
+    ColGroup, Body, Foot or Head object.  Also note that the Caption and Head
+    objects will automatically put themselves at row 0 (or possibly 1, in the
+    case of a Head object where a Caption already exists).
+
+Table#unshift(obj)
+    Unshifts +obj+ onto the Table.  The same rules apply to unshift as
+    they do to push.
+
+== Notes
+    A Table consists of Table::Row, Table::Caption, Table::ColGroup,
+    Table::Body, Table::Foot, Table::Head and Table::Row objects.  Table::Row
+    objects in turn consist of Table::Row::Data and Table::Row::Header
+    objects.  Table::ColGroup objects consist of Table::ColGroup::Col
+    objects.  Table::Head, Table::Body and Table::Foot objects consist
+    of Table::Row objects.
+    
+    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.  See the documentation on
+    specific methods for more details.
+
+    Using a non-standard extension (e.g. "background") will send a warning to
+    STDERR in $VERBOSE (-w) mode.
+
+== Known Bugs
+    None that I'm aware of.  Please report bugs on the project page at
+    http://www.rubyforge.org/projects/shards.
+
+== Future Plans
+   Allow standard html tags to be added to elements as appropriate, such
+   as <B>, <I>, etc.
+
+   CSS support.
+
+== Acknowledgements
+   Anthony Peacock, for giving me ideas with his HTML::Table Perl module.
+   Holden Glova and Culley Harrelson for API suggestions and comments.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2003-2005 Daniel J. Berger
+   All Rights Reserved
+
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel J. Berger
+   djberg96 at yahoo dot com
+   imperator on IRC (irc.freenode.net)