html-table 1.3.2 → 1.3.3

data/CHANGES

@@ -1,3 +1,16 @@
+== 1.3.3 - 5-Feb-2009
+* Added structured_warnings as a requirement. The non standard tags now
+  raise a NonStandardExtensionWarning. These are now _always_ raised whenever
+  used (instead of only in $VERBOSE mode), but the warning can be disabled as
+  you see fit. See the documentation on structured_warnings for more details.
+* Added test-unit 2.x as a requirement.
+* Refactored and renamed the tests.
+* The gem now includes the example files.
+* Added additional rake tasks for the sake of testing individual portions
+  of the html-table library instead of the all or nothing approach I had
+  before.
+* Added rake tasks for running the example programs.
+
 == 1.3.2 - 15-Jul-2008
 * Added to_s and to_str aliases for the html method for all classes.
 * Some documentation updates.

data/MANIFEST

@@ -41,16 +41,16 @@ lib/html/table.rb
 lib/html/tablesection.rb
 lib/html/tag_handler.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
-test/tc_tag_handler.rb
+test/test_attribute_handler.rb
+test/test_body.rb
+test/test_caption.rb
+test/test_col.rb
+test/test_colgroup.rb
+test/test_data.rb
+test/test_head.rb
+test/test_header.rb
+test/test_html_handler.rb
+test/test_row.rb
+test/test_table.rb
+test/test_tablesection.rb
+test/test_tag_handler.rb

data/README

@@ -3,14 +3,17 @@
 
 == Prerequisites
    * Ruby 1.8.0 or later
-   * StrongTyping 2.0.6b or later
+   * strongtyping 2.0.6 or later
+   * structured_warnings 0.1.1 or later
 
 == Installation
+=== Remote
+   gem install html-table
+   
+=== Local
    rake test (optional)
    rake install OR rake gem_install
 
-   Just do 'gem install html-table' for remote installation.
-
 == Synopsis
    require 'html/table'
    include HTML
@@ -83,8 +86,9 @@
    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.
+   Using a non-standard extension (e.g. "background") will emit a
+   NonStandardExtensionWarning. See the documentation for structured_warnings
+   for more information on how to control these.
 
 == Known Bugs
    None that I'm aware of. Please report bugs on the project page at
@@ -93,9 +97,6 @@
 == 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.
 
@@ -105,7 +106,7 @@
    Ruby's
 
 == Copyright
-   (C) 2003-2008 Daniel J. Berger
+   (C) 2003-2009 Daniel J. Berger
    All Rights Reserved
 
 == Warranty
@@ -120,20 +121,20 @@
 
 == Developer's Notes
    Some people might be a little annoyed with the fact that I required Ryan
-   Pavlik's strongtyping library. 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.
+   Pavlik's strongtyping library. 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. I therefore chose to
+   enforce these conventions and 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/Rakefile

@@ -17,8 +17,126 @@ task :install_gem do
    sh "gem install #{file}"
 end
 
+
+namespace 'example' do
+   desc "Run the first simple html-table example"
+   task :simple1 do
+      sh 'ruby -Ilib examples/simple1.rb'
+   end
+
+   desc "Run the second simple html-table example"
+   task :simple2 do
+      sh 'ruby -Ilib examples/simple2.rb'
+   end
+
+   desc "Run the third simple html-table example"
+   task :simple3 do
+      sh 'ruby -Ilib examples/simple3.rb'
+   end
+
+   desc "Run the first intermediate html-table example"
+   task :intermediate1 do
+      sh 'ruby -Ilib examples/intermediate1.rb'
+   end
+
+   desc "Run the second intermediate html-table example"
+   task :intermediate2 do
+      sh 'ruby -Ilib examples/intermediate2.rb'
+   end
+
+   desc "Run the advanced html-table example"
+   task :advanced do
+      sh 'ruby -Ilib examples/advanced.rb'
+   end
+end
+
 Rake::TestTask.new do |t|
-   t.libs << 'lib'
    t.warning = true
-   t.test_files = FileList['test/tc*']
+   t.verbose = true
+end
+
+namespace 'test' do 
+   Rake::TestTask.new('attribute_handler') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_attribute_handler.rb']
+   end
+
+   Rake::TestTask.new('body') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_body.rb']
+   end
+
+   Rake::TestTask.new('caption') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_caption.rb']
+   end
+
+   Rake::TestTask.new('col') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_col.rb']
+   end
+
+   Rake::TestTask.new('colgroup') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_colgroup.rb']
+   end
+
+   Rake::TestTask.new('data') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_data.rb']
+   end
+
+   Rake::TestTask.new('foot') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_foot.rb']
+   end
+
+   Rake::TestTask.new('head') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_head.rb']
+   end
+
+   Rake::TestTask.new('header') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_header.rb']
+   end
+
+   Rake::TestTask.new('html_handler') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_html_handler.rb']
+   end
+
+   Rake::TestTask.new('row') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_row.rb']
+   end
+
+   Rake::TestTask.new('table') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_table.rb']
+   end
+
+   Rake::TestTask.new('tablesection') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_tablesection.rb']
+   end
+
+   Rake::TestTask.new('tag_handler') do |t|
+      t.warning = true
+      t.verbose = true
+      t.test_files = FileList['test/test_tag_handler.rb']
+   end
 end

data/examples/advanced.rb

@@ -0,0 +1,128 @@
+##############################################################################
+# advanced1.rb
+#
+# For this example we'll use every feature I can think of to come up with
+# the example found in "HTML: The Definitive Guide", pp. 395-396 (O'Reilly
+# & Associates, 3rd ed).
+#
+# You can run this example via the 'example:advanced' rake task.
+##############################################################################
+require 'html/table'
+include HTML
+
+Table::Row::Data.end_tags   = false
+Table::Row::Header.end_tags = false
+
+# Demonstrates the DSL style syntax
+table = Table.new do
+   border      1
+   cellspacing 0
+   cellpadding 0
+   rules       'groups'
+end
+
+# Demonstrates the use of setters after object creation
+caption = Table::Caption.new
+caption.align = "bottom"
+caption.content = "Kumquat versus a poked eye, by gender"
+
+thead = Table::Head.create
+tbody = Table::Body.new
+tfoot = Table::Foot.create
+
+# Add a row with a td and th, then configure after the fact.
+thead.push Table::Row.new{ |r|
+   r.content = Table::Row::Data.new, Table::Row::Header.new
+}
+
+# And again, longhand
+hrow = Table::Row.new
+h1 = Table::Row::Header.new('Eating Kumquats')
+h2 = Table::Row::Header.new('Poke In The Eye')
+hrow.push h1, h2
+thead.push hrow
+
+# Configure a row after the fact
+thead.configure(0,0){ |d|
+   d.colspan = 2
+   d.rowspan = 2
+}
+
+thead.configure(0,1){ |h|
+   h.colspan = 2
+   h.align   = "center"
+   h.content = "Preference"
+}
+
+# Ugly, but just to show you that it's possible
+tbody.push(
+   Table::Row.new{ |r|
+      r.align = "center"
+      r.content = 
+         Table::Row::Header.new{ |h|
+            h.rowspan = 2
+            h.content = "Gender"
+         },
+         Table::Row::Header.new{ |h| h.content = "Male" },
+         "73%",
+         "27%"
+   }
+)
+
+brow = Table::Row.new{ |r| r.align = "center" }
+bheader = Table::Row::Header.new('Female')
+brow.push(bheader,"16%","84%")
+
+tbody.push(brow)
+
+frow = Table::Row.new{ |r|
+   r.content = Table::Row::Data.new{ |d|
+      d.colspan = 4
+      d.align   = "center"
+      d.content = "Note: eye pokes did not result in permanent injury"
+   }
+}
+
+tfoot[0] = frow
+
+table.push thead, tbody, tfoot
+
+# caption is added last, but does the right thing
+table.push caption
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<table border=1 cellspacing=0 cellpadding=0 rules='groups'>
+   <caption align='bottom'>Kumquat versus a poked eye, by gender</caption>
+   <thead>
+   <tr>
+      <td colspan=2 rowspan=2>
+      <th colspan=2 align='center'>Preference
+   </tr>
+   <tr>
+      <th>Eating Kumquats
+      <th>Poke In The Eye
+   </tr>
+   </thead>
+   <tbody>
+   <tr align='center'>
+      <th rowspan=2>Gender
+      <th>Male
+      <td>73%
+      <td>27%
+   </tr>
+   <tr align='center'>
+      <th>Female
+      <td>16%
+      <td>84%
+   </tr>
+   </tbody>
+   <tfoot>
+   <tr>
+      <td colspan=4 align='center'>Note: eye pokes did not result in permanent injury
+   </tr>
+   </tfoot>
+</table>
+=end

data/examples/intermediate1.rb

@@ -0,0 +1,72 @@
+##############################################################################
+# intermediate1.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.
+#
+# You can run this via the "example:intermediate1" rake task.
+##############################################################################
+require 'html/table'
+include HTML
+
+# Create a table, add two rows implicitly
+table = Table.new{ |t|
+   t.border  = 1
+   t.align   = "left"
+   t.content = [
+      ["foo","bar","baz"],
+      [1,2]
+   ]
+}
+
+# Create a Table::Row object with one Data object added implicitly
+row1 = Table::Row.new{ |r|
+   r.bgcolor = "red"
+   r.nowrap = true
+   r.content = "test"
+}
+
+# Create a Table::Row object, add a Data object explicitly (with some
+# configuration to boot)
+row2 = Table::Row.new{ |r|
+   r.bgcolor = "blue"
+   r.align = "right"
+   r.content = Table::Row::Data.new{ |d|
+      d.content = "hello world!"
+      d.abbr = "test abbr"
+   }
+}
+
+# Add the rows explicitly to the table
+table.push row1, row2
+
+# Let's configure the row that contains "foo","bar","baz"
+# Remember, row and column counts start at 0, not 1
+table.configure(0){ |r|
+   r.bgcolor = "green"
+   r.align   = "right"
+}
+
+puts table.html
+
+=begin
+### OUTPUT ###
+<table border=1 align='left'>
+   <tr bgcolor='green' align='right'>
+      <td>foo</td>
+      <td>bar</td>
+      <td>baz</td>
+   </tr>
+   <tr>
+      <td>1</td>
+      <td>2</td>
+   </tr>
+   <tr bgcolor='red' nowrap>
+      <td>test</td>
+   </tr>
+   <tr bgcolor='blue' align='right'>
+      <td abbr='test abbr'>hello world!</td>
+   </tr>
+</table>
+=end