html-table 1.2.2 → 1.3.0

data/lib/html/html_handler.rb

@@ -5,6 +5,9 @@ module HtmlHandler
    # Used on HTML attributes. It creates proper HTML text based on the argument
    # type.  A string looks like "attr='text'", a number looks like "attr=1",
    # while a true value simply looks like "attr" (no equal sign).
+   #--
+   # This is private method.
+   #
    def modify_html(attribute,arg=nil)
       if @html_begin.scan(/\b#{attribute}\b/).empty?
          if arg.kind_of?(Fixnum)
@@ -27,7 +30,12 @@ module HtmlHandler
 
    # Returns the HTML text for the current object.  Indentation and end tag
    # options are optional, based on the settings of the classes themselves.
-   def html
+   #
+   # If +formatting+ is false, then formatting and whitespace is not applied
+   # and you will get a single, very long string.  Note that case is still
+   # honored.
+   #
+   def html(formatting = true)
       if self.class.respond_to?(:html_case)
          $upper = true if self.class.html_case == "upper"
       end
@@ -39,16 +47,20 @@ module HtmlHandler
       
       ilevel = 0
       
-      if self.class.respond_to?(:indent_level)
+      if formatting && self.class.respond_to?(:indent_level)
          ilevel = self.class.indent_level
       end
-      
+
       html          = ' ' * ilevel + @html_begin[0..-1]
       len           = html.length
       html[len,len] = '>'
 
       if self.kind_of?(Array)
-         html << self.map{ |e| "\n" + e.html.to_s }.join
+         if formatting
+            html << self.map{ |e| "\n" + e.html(formatting).to_s }.join
+         else
+            html << self.map{ |e| e.html(formatting).to_s }.join
+         end
       else
          html << @html_body
       end
@@ -64,13 +76,27 @@ module HtmlHandler
       if self.kind_of?(Array)
          if Table.global_end_tags?
             if self.class.respond_to?(:end_tags?)
-               html << "\n" + ' ' * ilevel + @html_end if self.class.end_tags?
+               if formatting
+                  if self.class.end_tags?
+                     html << "\n" + (' ' * ilevel) + @html_end
+                  end
+               else
+                  html << (' ' * ilevel) + @html_end if self.class.end_tags?
+               end
             else
-               html << "\n" + ' ' * ilevel + @html_end
+               if formatting
+                  html << "\n" + (' ' * ilevel) + @html_end
+               else
+                  html << (' ' * ilevel) + @html_end
+               end
             end
          else
             unless self.class.respond_to?(:end_tags?)
-               html << "\n" + ' ' * ilevel + @html_end
+               if formatting
+                  html << "\n" + (' ' * ilevel) + @html_end
+               else
+                  html << (' ' * ilevel) + @html_end
+               end
             end
          end
       else

data/lib/html/row.rb

@@ -2,19 +2,42 @@ module HTML
    class Table::Row < Array
       include AttributeHandler
       include HtmlHandler
+
       @indent_level = 3
       @end_tags     = true
 
-      # Returns a new Table::Row object.  Optionally takes a block.  If an
-      # argument is provided, it is treated as content.
+      # Returns a new Table::Row object.  Optionally takes a block.  If +arg+
+      # is provided it is treated as content.  If +header+ is false, that
+      # content is transformed into a Row::Data object.  Otherwise, it is
+      # converted into a Row::Header object.
       #
+      # See the # Table::Row#content= method for more information.
+      #--
       # Note that, despite the name, Row is a subclass of Array, not Table.
-      def initialize(arg=nil)
+      #
+      def initialize(arg = nil, header = false, &block)
          @html_begin = '<tr'
          @html_end   = '</tr>'
-         yield self if block_given?
+
+         @header = header
+
+         instance_eval(&block) if block_given?
          self.content = arg if arg
       end
+
+      # Returns whether or not content is converted into a Row::Header object
+      # (as opposed to a Row::Data object).
+      #
+      def header?
+         @header
+      end
+
+      # Sets whether or not content is converted into a Row::Header object
+      # or a Row::Data object.
+      #
+      def header=(bool)
+         @header = bool
+      end
       
       # Adds content to the Row object.
       #
@@ -22,33 +45,60 @@ module HTML
       # arguments to this method must be a Row::Data object, a Row::Header
       # object, or a String (or an array of any of these).  In the latter case,
       # a single Row::Data object is created for each string.
+      #
+      # Examples (with whitespace and newlines removed):
+      #
+      # row = Table::Row.new
+      #
+      # # Same as Table::Row.new('foo')
+      # row.content = 'foo'
+      # row.html => <tr><td>foo</td></tr>
+      #
+      # row.content = [['foo,'bar']]
+      # row.html => <tr><td>foo</td><td>bar</td></tr>
+      #
+      # row.content = Table::Row::Data.new('foo')
+      # row.html => <tr><td>foo</td></tr>
+      #
+      # row.content = Table::Row::Header.new('foo')
+      # row.html => <tr><th>foo</th></tr>
+      #
       def content=(arg)
-         if arg.kind_of?(String)
-            td = Table::Row::Data.new(arg)
-            self.push(td)
-         elsif arg.kind_of?(Array)
-            arg.each{ |e|
-               if e.kind_of?(Table::Row::Data) || e.kind_of?(Table::Row::Header)
-                  self.push(e)
+         case arg
+            when String
+               if @header
+                  self.push(Table::Row::Header.new(arg))
                else
-                  td = Table::Row::Data.new(e)
-                  self.push(td)
+                  self.push(Table::Row::Data.new(arg))
                end
-            }
-         else
-            self.push(arg)
+            when Array
+               arg.each{ |e|
+                  if e.kind_of?(Table::Row::Data) || e.kind_of?(Table::Row::Header)
+                     self.push(e)
+                  else
+                     if @header
+                        self.push(Table::Row::Header.new(e))
+                     else
+                        self.push(Table::Row::Data.new(e))
+                     end
+                  end
+               }
+            else
+               self.push(arg)
          end
       end
 
       # Returns the number of spaces that tags for this class are indented.
       # For the Row class, the indention level defaults to 3.
+      #
       def self.indent_level
          @indent_level
       end
 
       # Sets the number of spaces that tags for this class are indented.
+      #
       def self.indent_level=(num)
-         expect(num,Integer)
+         expect(num, Integer)
          raise ArgumentError if num < 0
          @indent_level = num
       end
@@ -56,6 +106,7 @@ module HTML
       # Returns true or false, depending on whether or not the end tags for
       # this class, </tr>, are included for each row or not. By default, this
       # is set to true.
+      #
       def self.end_tags?
          @end_tags
       end
@@ -63,6 +114,7 @@ module HTML
       # Sets the behavior for whether or not the end tags for this class,
       # </tr>, are included for each row or not.  Only true and false are
       # valid arguments.
+      #
       def self.end_tags=(bool)
          expect(bool,[TrueClass,FalseClass])
          @end_tags = bool
@@ -72,11 +124,12 @@ module HTML
       # accepted as arguments.  Specifically, they are Data and Header.  An
       # Array is also valid, but only if it only includes Data or Header
       # objects.
-      def []=(index,obj)
+      #
+      def []=(index, obj)
          if obj.kind_of?(Array)
-            obj.each{ |o| expect(o,[Data,Header]) }
+            obj.each{ |o| expect(o, [Data, Header]) }
          else   
-            expect(obj,[Data,Header])
+            expect(obj, [Data, Header])
          end
          super
       end
@@ -87,6 +140,7 @@ module HTML
       #
       # A plain string or number pushed onto a Row is automatically
       # converted to a Data object.
+      #
       def push(*args)
          args.each do |obj|
             if obj.kind_of?(String) || obj.kind_of?(Fixnum)
@@ -94,7 +148,7 @@ module HTML
                super(td)
                next
             else
-               expect(obj,[Data,Header])
+               expect(obj, [Data, Header])
             end
             super(obj)
          end
@@ -103,12 +157,13 @@ module HTML
       # This method has been redefined to only allow certain classes to be
       # accepted as arguments.  The rules are the same as they are for
       # Row#push.
+      #
       def <<(obj)
          if obj.kind_of?(String) || obj.kind_of?(Fixnum)
             td = Table::Row::Data.new(obj.to_s)
             super(td)
          else
-            expect(obj,[Data,Header])
+            expect(obj, [Data, Header])
          end
          super(obj)
       end
@@ -116,8 +171,9 @@ module HTML
       # This method has been redefined to only allow certain classes to be
       # accepted as arguments.  The rules are the same as they are for
       # Row#push.
+      #
       def unshift(obj)
-            if obj.kind_of?(String) || obj.kind_of?(Fixnum)
+         if obj.kind_of?(String) || obj.kind_of?(Fixnum)
             td = Table::Row::Data.new(obj.to_s)
             super(td)
          else

data/lib/html/table.rb

@@ -12,18 +12,22 @@ module HTML
    class Table < Array
       include AttributeHandler
       include HtmlHandler
-      VERSION           = "1.2.2"
+
+      VERSION           = '1.3.0'
+
       @indent_level     = 0
-      @html_case        = "lower"
+      @html_case        = 'lower'
+
       @@global_end_tags = true
 
       # Returns a new Table object.  Optionally takes a block.
       # If an argument is provided, it is interpreted as content.
-      def initialize(arg = nil)
+      #
+      def initialize(arg = nil, &block)
          @html_begin = '<table'
          @html_body  = ''
          @html_end   = '</table>'
-         yield self if block_given?
+         instance_eval(&block) if block
          self.content = arg if arg
       end
       
@@ -34,20 +38,38 @@ module HTML
       # 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.
+      #
       def content=(arg)
          if arg.kind_of?(Array)
-            arg.each{ |e|
-               tr = Table::Row.new(e)
-               self.push(tr)
-            }
+            arg.each{ |e| self << Table::Row.new(e) }
+         else
+            self << Table::Row.new(arg)
+         end
+      end
+
+      alias data= content=
+
+      # A shortcut for creating Table::Row::Header objects in the constructor
+      # using the DSL style syntax.
+      #
+      def header(arg = nil)
+         self.header = arg if arg
+      end
+
+      # Adds a Table::Row::Header object (or an Array of them) to the Table
+      # object.
+      #
+      def header=(arg)
+         if arg.kind_of?(Array)
+            arg.each{ |h| self << Table::Row.new(h, true) }
          else
-            tr = Table::Row.new(arg)
-            self.push(tr)
+            self << Table::Row::Header.new(arg)
          end
       end
 
       # Returns true or false, depending on whether or not end tags have been
       # turned on or off, respectively.
+      #
       def self.global_end_tags?
          @@global_end_tags
       end
@@ -57,19 +79,22 @@ module HTML
       # sent to this method must be true or false.  The default value is true.
       #
       # Note that mandatory end tags are unaffected by this setting.
+      #
       def self.global_end_tags=(bool)
-         expect(bool,[TrueClass,FalseClass])
+         expect(bool, [TrueClass, FalseClass])
          @@global_end_tags = bool
       end
       
       # Returns either "lower" or "upper", indicating the case of all HTML
       # tags in the final output.
+      #
       def self.html_case
          @html_case
       end
       
       # Sets the case of all HTML tags to either lower or upper.  The only
       # valid arguments to this method are 'upper' or 'lower'.
+      #
       def self.html_case=(arg)
          expect(arg,String)
          arg.downcase!
@@ -85,13 +110,15 @@ module HTML
       #
       # Note that each class has its own default indentation level (a multiple
       # of 3).
+      #
       def self.indent_level
          @indent_level
       end
 
       # Sets the number of spaces that tags for this class are indented.
+      #
       def self.indent_level=(num)
-         expect(num,Integer)
+         expect(num, Integer)
          raise ArgumentError,"indent level must be >= 0" if num < 0
          @indent_level = num
       end
@@ -104,8 +131,9 @@ module HTML
       # In addition, a Caption can only be assigned to index 0.  A Head can
       # only be assigned to index 0, or index 1 if a Caption already exists.
       # A Foot may only be assigned as the last element.
+      #
       def []=(index,obj)
-         expect(obj,[Caption,ColGroup,Body,Foot,Head,Row])
+         expect(obj, [Caption, ColGroup, Body, Foot, Head, Row])
 
          # Only allow Caption objects at index 0
          if index != 0 && obj.kind_of?(HTML::Table::Caption)
@@ -134,40 +162,39 @@ module HTML
       
       # This method has been redefined to only allow certain subclasses to
       # be accepted as arguments.  Specifically, only Caption, ColGroup,
-      # Body, Foot, Head, Row and Row::Data objects may be pushed onto a
-      # Table.
+      # Body, Foot, Head, Row, Row::Data and Row::Header objects may be
+      # pushed onto a Table.
       #
       # Pushing a Data or Header object onto a Table object creates its own
       # row for each.  If a Caption object is pushed onto the Table, it will
       # automatically be bumped to the first element.  If a Head object is
       # pushed onto the Table, it is automatically bumped to the first
       # element, or the second element if a Caption already exists.
+      #
       def push(*args)
          args.each{ |obj|
-            expect(obj,[Caption,ColGroup,Body,Foot,Head,Row,Row::Data])
-
-            # Pushing Data or Header objects onto a Table directly gives them
-            # each their own row.
-            if obj.kind_of?(HTML::Table::Row::Data)
-               tr = HTML::Table::Row.new(obj)
-               self.push(tr)           
-            # Caption objects are always the first row   
-            elsif obj.kind_of?(HTML::Table::Caption)
-               if self[0].kind_of?(HTML::Table::Caption)
-                  self[0] = obj
+            expect(obj, [Caption, ColGroup, Body, Foot, Head,
+               Row, Row::Data, Row::Header]
+            )
+
+            case obj
+               when Table::Row::Data, Table::Row::Header
+                  self.push(Table::Row.new(obj))
+               when Table::Caption
+                  if self[0].kind_of?(Table::Caption)
+                     self[0] = obj
+                  else
+                     self.unshift(obj)
+                  end
+               when Table::Head
+                  if self[0].kind_of?(Table::Caption)
+                     self.unshift(obj)
+                     self[0],self[1] = self[1],self[0]
+                  else
+                     self.unshift(obj)
+                  end
                else
-                  self.unshift(obj)
-               end
-            # Head objects are always at row 0 or 1   
-            elsif obj.kind_of?(HTML::Table::Head)
-               if self[0].kind_of?(HTML::Table::Caption)
-                  self.unshift(obj)
-                  self[0],self[1] = self[1],self[0]
-               else
-                  self.unshift(obj)
-               end
-            else
-               super(obj)
+                  super(obj)
             end
          }
       end
@@ -176,45 +203,46 @@ module HTML
       # be accepted as arguments.
       #
       # The restrictions and behavior are identical to the push() method.
+      #
       def <<(obj)
-         expect(obj,[Caption,ColGroup,Body,Foot,Head,Row,Row::Data])
-
-         # Pushing Data or Header objects onto a Table directly gives them
-         # each their own row.
-         if obj.kind_of?(HTML::Table::Row::Data)
-            tr = HTML::Table::Row.new(obj)
-            self.push(tr)
-         # Caption objects are always the first row   
-         elsif obj.kind_of?(HTML::Table::Caption)
-            if self[0].kind_of?(HTML::Table::Caption)
-               self[0] = obj
-            else
-               self.unshift(obj)
-            end
-         # Head objects are always at row 0 or 1   
-         elsif obj.kind_of?(HTML::Table::Head)
-            if self[0].kind_of?(HTML::Table::Caption)
-               self.unshift(obj)
-               self[0],self[1] = self[1],self[0]
+         expect(obj, [Caption, ColGroup, Body, Foot,
+            Head, Row, Row::Data, Row::Header]
+         )
+
+         case obj
+            when Table::Row::Data, Table::Row::Header # Each get their own row
+               self << Table::Row.new(obj)
+            when Table::Caption                       # Always the first row
+               if self[0].kind_of?(Table::Caption)
+                  self[0] = obj
+               else
+                  self.unshift(obj)
+               end
+            when Table::Head                          # Always at row 0 or 1
+               if self[0].kind_of?(Table::Caption)
+                  self.unshift(obj)
+                  self[0], self[1] = self[1], self[0]
+               else
+                  self.unshift(obj)
+               end
             else
-               self.unshift(obj)
-            end
-         else
-            super(obj)
+               super(obj)
          end
       end
 
       # This method has been redefined to only allow certain subclasses to
       # be unshifted onto a Table object.  Specifically, they are Caption,
       # ColGroup, Body, Foot, Head and Row.
+      #
       def unshift(obj)
-         expect(obj,[Caption,ColGroup,Body,Foot,Head,Row])
+         expect(obj, [Caption, ColGroup, Body, Foot, Head, Row])
          super
       end
 
    end
 end
 
+require "content"
 require "caption"
 require "colgroup"
 require "col"