html-table 1.3.2 → 1.3.3

data/examples/intermediate2.rb

@@ -0,0 +1,62 @@
+##############################################################################
+# intermediate2.rb
+#
+# A slightly more advanced HTML Table.  This time we'll add some attributes,
+# add a few rows both implicitly and explicitly, then configure it
+# after-the-fact.  We'll also play with Captions and Headers and generally
+# do things slightly different that intermdiate1.rb.
+#
+# You can run this via the "example:intermediate2" rake task.
+##############################################################################
+require 'html/table'
+include HTML
+
+table = Table.new
+table.border = 1
+table.cellpadding = 5
+
+caption = Table::Caption.new
+caption.content = "This is a caption!"
+
+row1 = Table::Row.new
+row2 = Table::Row.new
+
+row1.bgcolor = "red"
+row2.bgcolor = "blue"
+
+d1 = Table::Row::Data.new{ |d| d.content = "foo" }
+d2 = Table::Row::Data.new{ |d| d.content = "bar" }
+d3 = Table::Row::Data.new{ |d| d.content = "baz" }
+
+row1[0..2] = d1, d2, d3
+
+d4 = Table::Row::Data.new{ |d| d.content = "hello" }
+d5 = Table::Row::Data.new{ |d| d.content = "world" }
+
+h1 = Table::Row::Header.new
+h1.content = "This is a header"
+h1.colspan = 2
+
+row2.unshift h1
+row2.push d4, d5
+
+table.push row1, row2
+table.push caption # automatically bumped to row 0
+
+puts table.html
+
+=begin
+<table border=1 cellpadding=5>
+   <caption>This is a caption!</caption>
+   <tr bgcolor='red'>
+      <td>foo</td>
+      <td>bar</td>
+      <td>baz</td>
+   </tr>
+   <tr bgcolor='blue'>
+      <th colspan=2>This is a header</th>
+      <td>hello</td>
+      <td>world</td>
+   </tr>
+</table>
+=end

data/examples/intermediate3.rb

@@ -0,0 +1,46 @@
+#######################################################################
+# intermediate3.rb
+#
+# This example demonstrates some intermediate features, including the
+# DSL style syntax and physical tag handling.
+#
+# You can run this example via the "example:intermediate3" rake task.
+#######################################################################
+require 'html/table'
+include HTML
+
+# You can set physical tags inline using block syntax...
+table = Table.new do
+   align    'left'
+   bgcolor  'red'
+   header   [['header1', 'header2']]
+   content  [['foo', 'bar']]
+   content  [['baz', 'blah']] do
+      underline true
+      tt        true
+   end
+end
+
+# Or you can do it this way
+table[1][0].content.bold   = true
+table[1][1].content.italic = true
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<table align='left' bgcolor='red'>
+   <tr>
+      <th>header1</th>
+      <th>header2</th>
+   </tr>
+   <tr>
+      <td><b>foo</b></td>
+      <td><i>bar</i></td>
+   </tr>
+   <tr>
+      <td><tt><u>baz</u></tt></td>
+      <td><tt><u>blah</u></tt></td>
+   </tr>
+</table>
+=end

data/examples/simple1.rb

@@ -0,0 +1,39 @@
+#######################################################################
+# simple1.rb
+#
+# Very plain HTML Table with rows and data implicitly created.
+#
+# You can run this example via the "example:sample1" rake task.
+#######################################################################
+require 'html/table'
+include HTML
+
+table = Table.new{ |t|
+   t.content = [
+      %w/foo bar baz/,
+      %w/1 2 3/,
+      %w/hello world/
+   ]
+}
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<table>
+   <tr>
+      <td>foo</td>
+      <td>bar</td>
+      <td>baz</td>
+   </tr>
+   <tr>
+      <td>1</td>
+      <td>2</td>
+      <td>3</td>
+   </tr>
+   <tr>
+      <td>hello</td>
+      <td>world</td>
+   </tr>
+</table>
+=end

data/examples/simple2.rb

@@ -0,0 +1,47 @@
+#######################################################################
+# simple2.rb
+#
+# Very plain HTML Table with rows explicitly created and data
+# elements implicitly created. We also remove the end tags
+# and capitalize the HTML tags and attributes.
+#
+# You can run this sample via the "example:simple2" rake task.
+#######################################################################
+require 'html/table'
+include HTML
+
+Table.html_case = "upper"
+Table::Row.end_tags = false
+Table::Row::Data.end_tags = false
+
+table = Table.new
+tr1 = Table::Row.new
+tr2 = Table::Row.new
+tr3 = Table::Row.new
+
+tr1.content = "foo", "bar", "baz"
+tr2.content = 1,2,3
+tr3.content = %w/hello world/
+
+table.push(tr1,tr2,tr3)
+
+table[0][1].align = "left"
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<TABLE>
+   <TR>
+      <TD>foo
+      <TD ALIGN='LEFT'>bar
+      <TD>baz
+   <TR>
+      <TD>1
+      <TD>2
+      <TD>3
+   <TR>
+      <TD>hello
+      <TD>world
+</TABLE>
+=end

data/examples/simple3.rb

@@ -0,0 +1,41 @@
+#######################################################################
+# simple3.rb
+#
+# Very plain HTML Table with rows and data implicitly created. This
+# script passes an argument to the constructor, which is automatically
+# interpreted as content.
+#
+# You can run this script via the "example:simple3" rake task.
+#######################################################################
+require 'html/table'
+include HTML
+
+m = [
+   ['foo', 'bar', 'baz'],
+   [1, 2, 3],
+   ['hello', 'world']
+]
+
+table = Table.new(m)
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<table>
+   <tr>
+      <td>foo</td>
+      <td>bar</td>
+      <td>baz</td>
+   </tr>
+   <tr>
+      <td>1</td>
+      <td>2</td>
+      <td>3</td>
+   </tr>
+   <tr>
+      <td>hello</td>
+      <td>world</td>
+   </tr>
+</table>
+=end

data/html-table.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
    gem.name         = 'html-table'
-   gem.version      = '1.3.2'
+   gem.version      = '1.3.3'
    gem.author       = 'Daniel J. Berger'
    gem.email        = 'djberg96@gmail.com'
    gem.homepage     = 'http://shards.rubyforge.org'
@@ -12,14 +12,16 @@ spec = Gem::Specification.new do |gem|
    gem.description  = 'A Ruby interface for generating HTML tables'
    gem.test_files   = Dir['test/*.rb']
    gem.has_rdoc     = true
-   gem.files = Dir['lib/html/*'] + Dir['[A-Z]*']  + Dir['test/*'] + Dir['doc/*']
+   gem.files = Dir['lib/html/*'] + Dir['[A-Z]*'] + Dir['examples/*.rb'] + Dir['test/*'] + Dir['doc/*']
    gem.files.reject! { |fn| fn.include? 'CVS' }
    gem.extra_rdoc_files = ['README', 'CHANGES'] + Dir['doc/*.rdoc']
    gem.require_path = 'lib'
    gem.add_dependency('strongtyping')
+   gem.add_dependency('test-unit')
+   gem.add_dependency('structured_warnings')
 end
 
 if $0 == __FILE__
-   Gem.manage_gems
+   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
    Gem::Builder.new(spec).build
 end

data/lib/html/attribute_handler.rb

@@ -48,10 +48,8 @@ module AttributeHandler
 
    def background=(url)
       raise TypeError unless url.kind_of?(String)
-      if $VERBOSE
-         msg =  "'background' is a non-standard extension"
-         STDERR.puts msg
-      end
+      msg =  "'background' is a non-standard extension"
+      warn NonStandardExtensionWarning, msg
       @background = url
       modify_html("background", url)
    end
@@ -93,10 +91,8 @@ module AttributeHandler
 
    def bordercolor=(color)
       @bordercolor = color
-      if $VERBOSE
-         msg =  "'bordercolor' is a non-standard extension"
-         STDERR.puts msg
-      end
+      msg =  "'bordercolor' is a non-standard extension"
+      warn NonStandardExtensionWarning, msg
       modify_html("bordercolor", color)
    end
 
@@ -108,10 +104,8 @@ module AttributeHandler
 
    def bordercolordark=(color)
       @bordercolordark = color
-      if $VERBOSE
-         msg = "'bordercolordark' is a non-standard extension"
-         STDERR.puts msg
-      end
+      msg = "'bordercolordark' is a non-standard extension"
+      warn NonStandardExtensionWarning, msg
       modify_html("bordercolordark", color)
    end
 
@@ -123,10 +117,8 @@ module AttributeHandler
 
    def bordercolorlight=(color)
       @bordercolorlight = color
-      if $VERBOSE
-         msg = "'bordercolorlight' is a non-standard extension"
-         STDERR.puts msg
-      end
+      msg = "'bordercolorlight' is a non-standard extension"
+      warn NonStandardExtensionWarning, msg
       modify_html("bordercolorlight", @bordercolorlight)
    end
 

data/lib/html/table.rb

@@ -3,21 +3,28 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'attribute_handler'
 require 'html_handler'
 require 'strongtyping'
+require 'structured_warnings'
 include StrongTyping
 
+# Warning raised if a non-standard extension is used.
+class NonStandardExtensionWarning < Warning; end
+
+# Please, think of the children before using the blink tag.
+class BlinkWarning < Warning; end
+
 module HTML
    class Table < Array
       include AttributeHandler
       include HtmlHandler
 
       # The version of this library
-      VERSION = '1.3.2'
+      VERSION = '1.3.3'
 
       # The indentation level for the <table> and </table> tags
-      @indent_level     = 0
+      @indent_level = 0
 
       # The default character case used for printing output
-      @html_case        = 'lower'
+      @html_case = 'lower'
 
       # Determines whether or not end tags will be included in printed output
       @@global_end_tags = true
@@ -150,7 +157,7 @@ module HTML
       # valid arguments to this method are 'upper' or 'lower'.
       #
       def self.html_case=(arg)
-         expect(arg,String)
+         expect(arg, String)
          arg.downcase!
          unless arg == "upper" || arg == "lower"
             msg = "Argument to html_case() must be 'upper' or 'lower'"

data/lib/html/tag_handler.rb

@@ -35,9 +35,7 @@ module TagHandler
    end
    
    def blink=(bool)
-      if $VERBOSE
-         STDERR.puts("The 'blink' tag is very annoying.  Please reconsider.")
-      end
+      warn BlinkWarning, "The 'blink' tag is very annoying. Please reconsider."
       handle_physical_tag('blink', bool)
       @blink = bool
    end

data/test/{tc_attribute_handler.rb → test_attribute_handler.rb}

@@ -1,30 +1,50 @@
 ############################################################################
-# tc_attribute_handler.rb
+# test_attribute_handler.rb
 #
 # Test suite for the AttributeHandler module. For these tests, we'll use an
 # instance of the Table class where the module has been mixed in.
 ############################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'html/table'
 include HTML
 
 class TC_AttributeHandler < Test::Unit::TestCase
+   def self.startup
+      NonStandardExtensionWarning.disable
+   end
+
    def setup
       @table = Table.new(['foo',1,'bar'])
    end
    
-   def test_abbr
+   def test_abbr_basic
       assert_respond_to(@table, :abbr)
       assert_respond_to(@table, :abbr=)
+   end
+
+   def test_abbr
       assert_nothing_raised{ @table.abbr }
+      assert_nil(@table.abbr)
       assert_nothing_raised{ @table.abbr = 'foo' }
+      assert_equal('foo', @table.abbr)
    end
    
-   def test_align
+   def test_align_basic
       assert_respond_to(@table, :align)
       assert_respond_to(@table, :align=)
+   end
+
+   def test_align
       assert_nothing_raised{ @table.align }
+      assert_nil(@table.align)
       assert_nothing_raised{ @table.align = 'center' }
+      assert_equal('center', @table.align)
+   end
+
+   def test_align_expected_errors
       assert_raises(ArgumentError){ @table.align = 'foo' }
    end
    
@@ -35,42 +55,68 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_nothing_raised{ @table.axis = 'foo' }
    end
    
-   def test_background
+   def test_background_basic
       assert_respond_to(@table, :background)
       assert_respond_to(@table, :background=)
+   end
+
+   def test_background
       assert_nothing_raised{ @table.background }
+      assert_nil(@table.background)
       assert_nothing_raised{ @table.background = 'foo' }
+      assert_equal('foo', @table.background)
+   end
+
+   def test_background_expected_errors
       assert_raises(TypeError){ @table.background = 1 }
    end
    
-   def test_bgcolor
+   def test_bgcolor_basic
       assert_respond_to(@table, :bgcolor)
       assert_respond_to(@table, :bgcolor=)
+   end
+
+   def test_bgcolor
       assert_nothing_raised{ @table.bgcolor }
+      assert_nil(@table.bgcolor)
       assert_nothing_raised{ @table.bgcolor = 'foo' }
+      assert_equal('foo', @table.bgcolor)
    end
-   
-   def test_border
+
+   def test_border_basic
       assert_respond_to(@table, :border)
       assert_respond_to(@table, :border=)
+   end
+
+   def test_border
       assert_nothing_raised{ @table.border }
       assert_nothing_raised{ @table.border = 2 }
       assert_nothing_raised{ @table.border = true }
       assert_nothing_raised{ @table.border = false }
    end
    
-   def test_bordercolor
+   def test_bordercolor_basic
       assert_respond_to(@table, :bordercolor)
       assert_respond_to(@table, :bordercolor=)
+   end
+
+   def test_bordercolor
       assert_nothing_raised{ @table.bordercolor }
+      assert_nil(@table.bordercolor)
       assert_nothing_raised{ @table.bordercolor = 'foo' }
+      assert_equal('foo', @table.bordercolor)
    end
    
-   def test_bordercolordark
+   def test_bordercolordark_basic
       assert_respond_to(@table, :bordercolordark)
       assert_respond_to(@table, :bordercolordark=)
+   end
+
+   def test_bordercolordark
       assert_nothing_raised{ @table.bordercolordark }
+      assert_nil(@table.bordercolordark)
       assert_nothing_raised{ @table.bordercolordark = 'foo' }
+      assert_equal('foo', @table.bordercolordark)
    end
    
    def test_bordercolorlight
@@ -85,6 +131,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :cellpadding=)
       assert_nothing_raised{ @table.cellpadding }
       assert_nothing_raised{ @table.cellpadding = 1 }
+   end
+
+   def test_cellpadding_expected_errors
       assert_raises(ArgumentError){ @table.cellpadding = -1 }
    end  
    
@@ -93,6 +142,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :cellspacing=)
       assert_nothing_raised{ @table.cellspacing }
       assert_nothing_raised{ @table.cellspacing = 1 }
+   end
+
+   def test_cellspacing_expected_errors
       assert_raises(ArgumentError){ @table.cellspacing = -1 }
    end
    
@@ -101,6 +153,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :char=)
       assert_nothing_raised{ @table.char }
       assert_nothing_raised{ @table.char = 'x' }
+   end
+
+   def test_char_expected_errors
       assert_raises(ArgumentError){ @table.char = 'xx' }
    end
    
@@ -109,6 +164,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :charoff=)
       assert_nothing_raised{ @table.charoff }
       assert_nothing_raised{ @table.charoff = 1 }
+   end
+
+   def test_charoff_expected_errors
       assert_raises(ArgumentError){ @table.charoff = -1 }
    end
 
@@ -124,6 +182,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :col=)
       assert_nothing_raised{ @table.col }
       assert_nothing_raised{ @table.col = 1 }
+   end
+
+   def test_col_expected_errors
       assert_raises(ArgumentError){ @table.col = -1 }
    end
    
@@ -132,6 +193,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :colspan=)
       assert_nothing_raised{ @table.colspan }
       assert_nothing_raised{ @table.colspan = 1 }
+   end
+
+   def test_colspan_expected_errors
       assert_raises(ArgumentError){ @table.colspan = -1 }
    end
    
@@ -139,6 +203,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :configure)
       assert_nothing_raised{ @table.configure(0){} }
       assert_nothing_raised{ @table.configure(0,0){} }
+   end
+
+   def test_configure_expected_errors
       assert_raises(ArgumentError){ @table.configure(0,0,0){} }
    end
    
@@ -166,6 +233,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :frame=)
       assert_nothing_raised{ @table.frame }
       assert_nothing_raised{ @table.frame = 'below' }
+   end
+
+   def test_frame_expected_errors
       assert_raises(ArgumentError){ @table.frame = 'foo' }
    end
    
@@ -174,6 +244,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :height=)
       assert_nothing_raised{ @table.height }
       assert_nothing_raised{ @table.height = 1 }
+   end
+
+   def test_height_expected_errors
       assert_raises(ArgumentError){ @table.height = -1 }
    end
    
@@ -182,6 +255,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :hspace=)
       assert_nothing_raised{ @table.hspace }
       assert_nothing_raised{ @table.hspace = 1 }
+   end
+
+   def test_hspace_expected_errors
       assert_raises(ArgumentError){ @table.hspace = -1 }
    end
    
@@ -190,6 +266,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :nowrap=)
       assert_nothing_raised{ @table.nowrap }
       assert_nothing_raised{ @table.nowrap = false }
+   end
+
+   def test_nowrap_expected_errors
       assert_raises(TypeError){ @table.nowrap = 'foo' }
    end
    
@@ -198,6 +277,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :rowspan=)
       assert_nothing_raised{ @table.rowspan }
       assert_nothing_raised{ @table.rowspan = 1 }
+   end
+
+   def test_rowspan_expected_errors
       assert_raises(ArgumentError){ @table.rowspan = -1 }
    end
    
@@ -206,6 +288,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :rules=)
       assert_nothing_raised{ @table.rules }
       assert_nothing_raised{ @table.rules = 'all' }
+   end
+
+   def test_rules_expected_errors
       assert_raises(ArgumentError){ @table.rules = 'foo' }
    end
    
@@ -214,6 +299,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :span=)
       assert_nothing_raised{ @table.span }
       assert_nothing_raised{ @table.span = 1 }
+   end
+
+   def test_span_expected_errors
       assert_raises(ArgumentError){ @table.span = -1 }
    end
 
@@ -237,6 +325,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :valign=)
       assert_nothing_raised{ @table.valign }
       assert_nothing_raised{ @table.valign = 'center' }
+   end
+
+   def test_valign_expected_errors
       assert_raises(ArgumentError){ @table.valign = 'foo' }
    end
    
@@ -245,6 +336,9 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_respond_to(@table, :vspace=)
       assert_nothing_raised{ @table.vspace }
       assert_nothing_raised{ @table.vspace = 1 }
+   end
+
+   def test_vspace_expected_errors
       assert_raises(ArgumentError){ @table.vspace = -1 }
    end
    
@@ -254,10 +348,17 @@ class TC_AttributeHandler < Test::Unit::TestCase
       assert_nothing_raised{ @table.width}
       assert_nothing_raised{ @table.width = 10 }
       assert_nothing_raised{ @table.width = '5%' }
+   end
+
+   def test_width_expected_errors
       assert_raises(ArgumentError){ @table.width = -1 }
    end
    
    def teardown
       @table = nil
    end
+
+   def self.shutdown
+      NonStandardExtensionWarning.enable
+   end
 end