html-table 1.2.2 → 1.3.0

data/CHANGES

@@ -1,3 +1,20 @@
+== 1.3.0 - 2-Aug-2006
+* Added support for DSL style syntax, i.e. the ability to omit the explicit
+  receiver in block form.
+* The content method now creates a Table::Content object behind the scenes
+  (a subclass of String) and allows physical tags to generated on the fly
+  via a block.
+* Added support for physical tags for content, e.g. <b>, <i> etc.  See the
+  documentation for more details.
+* Added the 'style' and 'class_' attribute handlers for you CSS lovers.
+* Added the 'data' alias for the 'content' method.
+* Added the 'header' method to the Table class so that you can explicitly
+  generate <th> content instead of <td> content if you prefer.
+* The .html method now accepts an optional boolean that can be used to
+  disable formatting.  If set to true, the output will not include newlines
+  or spaces between the tags (i.e. it will give you a single long string).
+* Some comment additions and tweaks.
+
 == 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.

data/MANIFEST

@@ -6,6 +6,7 @@ install.rb
 doc/attributes.rdoc
 doc/table_body.rdoc
 doc/table_caption.rdoc
+doc/table_content.rdoc
 doc/table_colgroup.rdoc
 doc/table_colgroup_col.rdoc
 doc/table_foot.rdoc
@@ -18,13 +19,26 @@ doc/table.rdoc
 doc/examples/advanced.rb
 doc/examples/intermediate1.rb
 doc/examples/intermediate2.rb
+doc/examples/intermediate3.rb
 doc/examples/simple1.rb
 doc/examples/simple2.rb
 doc/examples/simple3.rb
 
 lib/html/attribute_handler.rb
+lib/html/body.rb
+lib/html/caption.rb
+lib/html/col.rb
+lib/html/colgroup.rb
+lib/html/content.rb
+lib/html/data.rb
+lib/html/foot.rb
+lib/html/head.rb
+lib/html/header.rb
 lib/html/html_handler.rb
+lib/html/row.rb
 lib/html/table.rb
+lib/html/tablesection.rb
+lib/html/tag_handler.rb
 
 test/ts_all.rb
 test/tc_attribute_handler.rb
@@ -39,3 +53,4 @@ test/tc_html_handler.rb
 test/tc_row.rb
 test/tc_table.rb
 test/tc_tablesection.rb
+test/tc_tag_handler.rb

data/README

@@ -20,11 +20,18 @@
    require "html/table"
    include HTML
 
+   # Explicit syntax
    table = HTML::Table.new{ |t|
       t.border  = 1
       t.bgcolor = "red"
    }
 
+   # Implicit syntax
+   table = HTML::Table.new do
+      border   1
+      bgcolor 'red'
+   end
+
    table.push Table::Row.new{ |r|
       r.align   = "left"
       r.bgcolor = "green"
@@ -103,7 +110,7 @@
    Ruby's
 
 == Copyright
-   (C) 2003, 2004 Daniel J. Berger
+   (C) 2003-2006 Daniel J. Berger
    All Rights Reserved
 
 == Warranty

data/doc/table_content.rdoc

@@ -0,0 +1,15 @@
+== Description
+   A Table::Content is a wrapper for content used for Table::Row::Data and
+   Table::Row::Header objects.  Although it can be instantiated directly, in
+   practice it is autogenerated for you.
+
+== Notes
+   Table::Content is a subclass of String and was mostly created in order
+   to support a DSL style syntax as well as physical tags.
+
+== Synopsis
+   content = Table::Content.new('my content') do
+      bold        true
+      italics     true
+      underline   true
+   end

data/lib/html/attribute_handler.rb

@@ -1,17 +1,22 @@
 # 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 style.
+#
 module AttributeHandler
-   def abbr
+   def abbr(string = nil)
+      self.abbr = string if string
       @abbr
    end
 
    def abbr=(string)
      @abbr = string
-     modify_html("abbr",string)
+     modify_html("abbr", string)
    end
 
-   def align
+   def align(position = nil)
+      self.align = position if position
       @align
    end
 
@@ -19,19 +24,21 @@ module AttributeHandler
       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
+   def axis(string = nil)
+      self.axis = string if string
       @axis
    end
 
    def axis=(string)
      @axis = string
-     modify_html("axis",string)
+     modify_html("axis", string)
    end
 
-   def background
+   def background(url = nil)
+      self.background = url if url
       @background
    end
 
@@ -42,35 +49,38 @@ module AttributeHandler
          STDERR.puts msg
       end
       @background = url
-      modify_html("background",url)
+      modify_html("background", url)
    end
 
-   def bgcolor
+   def bgcolor(color = nil)
+      self.bgcolor = color if color
       @bgcolor
    end
 
    def bgcolor=(color)
       @bgcolor = color
-      modify_html("bgcolor",color)
+      modify_html("bgcolor", color)
    end
 
-   def border
+   def border(num = nil)
+      self.border = num if num
       @border
    end
 
    # Allow either true/false or an integer
    def border=(num)
       if num.kind_of?(TrueClass)
-         modify_html("border",true)
+         modify_html("border", true)
       elsif num.kind_of?(FalseClass)
          # Do nothing
       else
          @border = num.to_i
-         modify_html("border",num.to_i)
+         modify_html("border", num.to_i)
       end
    end
 
-   def bordercolor
+   def bordercolor(color = nil)
+      self.bordercolor = color if color
       @bordercolor
    end
 
@@ -80,10 +90,11 @@ module AttributeHandler
          msg =  "'bordercolor' is a non-standard extension"
          STDERR.puts msg
       end
-      modify_html("bordercolor",color)
+      modify_html("bordercolor", color)
    end
 
-   def bordercolordark
+   def bordercolordark(color = nil)
+      self.bordercolordark = color if color
       @bordercolordark
    end
 
@@ -93,10 +104,11 @@ module AttributeHandler
          msg = "'bordercolordark' is a non-standard extension"
          STDERR.puts msg
       end
-      modify_html("bordercolordark",color)
+      modify_html("bordercolordark", color)
    end
 
-   def bordercolorlight
+   def bordercolorlight(color = nil)
+      self.bordercolorlight = color if color
       @bordercolorlight
    end
 
@@ -106,71 +118,94 @@ module AttributeHandler
          msg = "'bordercolorlight' is a non-standard extension"
          STDERR.puts msg
       end
-      modify_html("bordercolorlight",@bordercolorlight)
+      modify_html("bordercolorlight", @bordercolorlight)
    end
 
-   def cellpadding
+   def cellpadding(num = nil)
+      self.cellpadding = num if num
       @cellpadding
    end
 
    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
+   def cellspacing(num = nil)
+      self.cellspacing = num if num
       @cellspacing
    end
 
    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
+   def char(character = nil)
+      self.char = character if character
       @char
    end
 
    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
+   def charoff(offset = nil)
+      self.charoff = offset if offset
       @charoff
    end
 
    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
+   # to avoid conflict with the 'class' keyword.
+   #
+   def class_(klass = nil)
+      self.class_ = klass if klass
+      @class
+   end
+
+   # Returns the CSS class.  The trailing underscore is necessary in order
+   # to avoid conflict with the 'class' keyword.
+   #
+   def class_=(klass)
+      modify_html('class', klass)
+      @class = klass
    end
    
-   def col
+   def col(num = nil)
+      self.col = num if num
       @col
    end
 
    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
+   def colspan(span = nil)
+      self.colspan = span if span
       @colspan
    end
 
    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, &block)
       if col
          begin
             yield self[row][col]
@@ -183,12 +218,32 @@ module AttributeHandler
       end
    end
 
-   # Returns the HTML content (i.e. text)
-   def content
+   # Returns the HTML content (i.e. text).
+   #
+   def content(arg = nil, &block)
+      case arg
+         when String
+            self.content = Table::Content.new(arg, &block)
+         when Array
+            arg.each{ |e|
+               if e.kind_of?(Array)
+                  row = Table::Row.new
+                  e.each{ |element| row.push(Table::Content.new(element, &block)) }
+                  self.push(row)
+               else
+                  self.content = Table::Content.new(e, &block)
+               end
+            }
+         else
+            self.content = arg if arg
+      end
       @html_body
    end
 
-   def frame
+   alias data content
+
+   def frame(type = nil)
+      self.frame = type if type
       @frame
    end
 
@@ -196,30 +251,33 @@ module AttributeHandler
       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
+   def height(num = nil)
+      self.height = num if num
       @height
    end
 
    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
+   def hspace(num = nil)
+      self.hspace = num if num
       @hspace
    end
 
    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
+   def nowrap(bool = nil)
+      self.nowrap = bool if bool
       @nowrap
    end
 
@@ -228,20 +286,22 @@ module AttributeHandler
          raise TypeError
       end
       @nowrap = bool
-      modify_html("nowrap",@nowrap)
+      modify_html("nowrap", @nowrap)
    end
 
-   def rowspan
+   def rowspan(num = nil)
+      self.rowspan = num if num
       @rowspan
    end
 
    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
+   def rules(edges = nil)
+      self.rules = edges if edges
       @rules
    end
 
@@ -249,29 +309,42 @@ module AttributeHandler
       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
+   def span(num = nil)
+      self.span = num if num
       @span
    end
 
    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)
+      self.style = string if string
+      @style
    end
 
-   def summary
+   def style=(string)
+      @style = string.to_s
+      modify_html("style", @style)
+   end
+
+   def summary(string = nil)
+      self.summary = string if string
       @summary
    end
 
    def summary=(string)
       @summary = string.to_s
-      modify_html("summary",@summary)
+      modify_html("summary", @summary)
    end
 
-   def valign
+   def valign(position = nil)
+      self.valign = position if position
       @valign
    end
 
@@ -279,20 +352,22 @@ module AttributeHandler
       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)
+      self.vspace = num if num
+      @vspace
    end
 
    def vspace=(num)
       raise ArgumentError if num.to_i < 0
       @vspace = num.to_i
-      modify_html("vspace",@vspace)
-   end
-
-   def vspace
-      @vspace
+      modify_html("vspace", @vspace)
    end
 
-   def width
+   def width(num = nil)
+      self.width = num if num
       @width
    end
 
@@ -303,6 +378,6 @@ module AttributeHandler
          raise ArgumentError if num.to_i < 0
          @width = num.to_i
       end
-      modify_html("width",@width)
+      modify_html("width", @width)
    end
 end