html-table 1.2.2

data/lib/html/body.rb

@@ -0,0 +1,34 @@
+module HTML
+
+   # This class represents an HTML table body (<tbody>).  It is a
+   # subclass of Table::TableSection.
+   class Table::Body < Table::TableSection
+      @indent_level = 3
+      @end_tags     = true
+
+      # Returns a new Table::Body object.  Optionally takes a block.  If
+      # an argument is provided, it is treated as content.
+      def initialize(arg=nil)
+         @html_begin = "<tbody"
+         @html_end   = "</tbody>"
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Returns a boolean indicating whether or not end tags, </tbody>, are
+      # included for each Body object in the final HTML output.  The
+      # default is true.
+      def self.end_tags?
+         @end_tags
+      end
+      
+      # Sets whether or not end tags are included for each Body object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool,[TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+
+end

data/lib/html/caption.rb

@@ -0,0 +1,40 @@
+module HTML
+
+   # This class represents an HTML Caption.  Despite the name, it is not
+   # a subclass of Table.  Note that end tags for this class are mandatory.
+   class Table::Caption
+      include AttributeHandler
+      include HtmlHandler
+      undef_method :configure
+      @indent_level = 3
+
+      # Returns a new Table::Caption object.  Optionally takes a block.  If
+      # an argument is provided it is treated as content.
+      def initialize(arg=nil)
+         @html_begin = '<caption'
+         @html_body  = ''
+         @html_end   = '</caption>'
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Adds content to the Table::Caption object.
+      def content=(arg)
+         @html_body = arg.to_s
+      end
+      
+      # Returns the number of spaces that tags for this class are indented.
+      # For the Table::Caption 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)
+         raise ArgumentError, "indent level must be >= 0" if num < 0
+         @indent_level = num
+      end
+   end
+
+end

data/lib/html/col.rb

@@ -0,0 +1,33 @@
+module HTML
+   # This class represents an HTML ColGroup column (<col>).  Despite the
+   # name, it is not a subclass of ColGroup or Table.
+   class Table::ColGroup::Col
+      include AttributeHandler
+      include HtmlHandler
+      undef_method :configure, :content
+      @indent_level = 6
+
+      # Creates and returns a new ColGroup object.  Optionally takes a block.
+      # Note that it does not accept an argument - col tags do not have content
+      def initialize
+         @html_begin = '<col'
+         @html_body  = ''
+         @html_end   = ''
+         yield self if block_given?
+      end
+
+      # Returns the indentation level for the tags of this class.  The
+      # default is 6.
+      def self.indent_level
+         @indent_level
+      end
+
+      # Sets the indentation level for the tags of this class.  The default
+      # is 6.
+      def self.indent_level=(num)
+         expect(num,Integer)
+         raise ArgumentError, "num must be >= 0" if num < 0
+         @indent_level = num
+      end
+   end
+end

data/lib/html/colgroup.rb

@@ -0,0 +1,99 @@
+module HTML
+   # This class represents an HTML column group (<colgroup>).  It is a
+   # subclass of Array.  The only elements it may contain are instances
+   # of the ColGroup::Col class.
+   class Table::ColGroup < Array
+      include AttributeHandler
+      include HtmlHandler
+      @indent_level = 3
+      @end_tags     = true
+
+      undef_method :content
+
+      # Returns a new ColGroup object. Optionally takes a block. If an
+      # argument is provided, it is treated as content.
+      def initialize(arg = nil)
+         @html_begin = '<colgroup'
+         @html_body  = ''
+         @html_end   = '</colgroup>'
+         yield self if block_given?
+         self.push(arg) if arg
+      end
+
+      # Returns the indentation level for the tags of this class.  The
+      # default is 3.
+      def self.indent_level
+         @indent_level
+      end
+
+      # Sets the indentation level for the tags of this class.  The default
+      # is 3.
+      def self.indent_level=(num)
+         expect(num,Integer)
+         raise ArgumentError,"indent_level must be >= 0" if num < 0
+         @indent_level = num
+      end
+
+      # This method has been redefined to only allow ColGroup::Col objects
+      # to be assigned.
+      def []=(index,obj)
+         if obj.kind_of?(Array)
+            expect(obj.first,Col) # In case of 0 length Array
+            obj.each{ |o|
+                expect(o,Col)
+            }
+         else
+            expect(obj,Col)
+         end
+         super
+      end
+
+      # This method has been redefined to only allow ColGroup::Col objects
+      # to be pushed onto a ColGroup instance.
+      def push(*args)
+         args.each do |obj|
+            unless obj.kind_of?(Table::ColGroup::Col)
+               msg = "Can only assign Col objects to ColGroup class"
+               msg += ": " + obj.class.to_s
+               raise TypeError, msg
+            end
+            super(obj)
+         end
+      end
+
+      # This method has been redefined to only allow ColGroup::Col objects
+      # to be pushed onto a ColGroup instance.
+      def <<(obj)
+         unless obj.kind_of?(Table::ColGroup::Col)
+            msg = "Can only assign Col objects to ColGroup class"
+            msg += ": " + obj.class.to_s
+            raise TypeError, msg
+         end
+         super(obj)
+      end
+
+      # This method has been redefined to only allow ColGroup::Col objects
+      # to be unshifted onto a ColGroup instance.
+      def unshift(obj)
+         unless obj.kind_of?(Table::ColGroup::Col)
+            msg = "Can only assign Data and Header objects to Row class"
+            raise TypeError, msg
+         end
+         super
+      end   
+      
+      # Returns a boolean indicating whether or not end tags are included for
+      # each ColGroup object in the final HTML output.  The default is true.
+      def self.end_tags?
+         @end_tags
+      end
+
+      # Sets whether or not end tags are included for each ColGroup object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool,[TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+end

data/lib/html/data.rb

@@ -0,0 +1,56 @@
+module HTML
+
+   # This class represents HTML table data, <td>.  Despite the name
+   # it is not a subclass of Table::Row or Table.
+   class Table::Row::Data
+      include AttributeHandler
+      include HtmlHandler
+      undef_method :configure
+      @indent_level = 6
+      @end_tags     = true
+
+      # Creates and returns a Data object.  Optionally takes a block.  If
+      # an argument is provided, it is treated as content.
+      def initialize(arg = nil)
+         @html_begin = '<td'
+         @html_body  = ''
+         @html_end   = '</td>'
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Adds content to the Table::Row::Data object.
+      def content=(arg)
+         @html_body = arg.to_s
+      end
+
+      # Returns the indentation level for the tags of this class.  The
+      # default is 6.
+      def self.indent_level
+         @indent_level
+      end
+
+      # Sets the indentation level for the tags of this class.  The default
+      # is 6.
+      def self.indent_level=(num)
+         expect(num,Integer)
+         raise ArgumentError,"indent_level must be >= 0" if num < 0
+         @indent_level = num
+      end
+
+      # Returns a boolean indicating whether or not end tags, </td>, are
+      # included for each Data object in the final HTML output.  The
+      # default is true.
+      def self.end_tags?
+         @end_tags
+      end
+
+      # Sets whether or not end tags are included for each Data object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool,[TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+end

data/lib/html/foot.rb

@@ -0,0 +1,43 @@
+module HTML
+
+   # This class represents an HTML table foot (<tfoot>).  It is a
+   # subclass of Table::TableSection.  It is a singleton class.
+   class Table::Foot < Table::TableSection
+      private_class_method :new
+      @@foot        = nil
+      @indent_level = 3
+      @end_tags     = true
+
+      # This is our constructor for Foot objects because it is a singleton
+      # class.  Optionally, a block may be provided.  If an argument is 
+      # provided it is treated as content.
+      def self.create(arg=nil, &block)
+         @@foot = new(arg,&block) unless @@foot
+         @@foot
+      end      
+      
+      # Called by create() instead of new().  This initializes the Foot class.
+      def initialize(arg, &block)
+         @html_begin = "<tfoot"
+         @html_end   = "</tfoot>"
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Returns a boolean indicating whether or not end tags, </tfoot>, are
+      # included for each Foot object in the final HTML output.  The
+      # default is true.
+      def self.end_tags?
+         @end_tags
+      end
+      
+      # Sets whether or not end tags are included for each Foot object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool, [TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+
+end

data/lib/html/head.rb

@@ -0,0 +1,42 @@
+module HTML
+   
+   # This class represents an HTML table head (<thead>).  It is a
+   # subclass of Table::TableSection.  It is a singleton class.
+   class Table::Head < Table::TableSection
+      private_class_method :new
+      @@head = nil
+      @indent_level = 3
+      @end_tags     = true
+
+      # This is our constructor for Head objects because it is a singleton
+      # class.  Optionally, a block may be provided.  If an argument is 
+      # provided it is treated as content.
+      def self.create(arg=nil,&block)
+         @@head = new(arg,&block) unless @@head
+         @@head
+      end      
+
+      # Called by create() instead of new().  This initializes the Head class.
+      def initialize(arg,&block)
+         @html_begin = "<thead"
+         @html_end   = "</thead>"
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Returns a boolean indicating whether or not end tags, </thead>, are
+      # included for each Head object in the final HTML output.  The
+      # default is true.
+      def self.end_tags?
+         @end_tags
+      end
+      
+      # Sets whether or not end tags are included for each Head object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool,[TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+end

data/lib/html/header.rb

@@ -0,0 +1,56 @@
+module HTML
+
+   # This class represents an HTML table header (<th>).  Despite the name
+   # it is not a subclass of Table or Table::Row.
+   class Table::Row::Header
+      include AttributeHandler
+      include HtmlHandler
+      undef_method :configure
+      @indent_level = 6
+      @end_tags = true
+
+      # Creates and returns a new Header object.  Optionally takes a block.
+      # If an argument is provided, it is treated as content.
+      def initialize(arg = nil)
+         @html_begin = '<th'
+         @html_body  = ''
+         @html_end   = '</th>'
+         yield self if block_given?
+         self.content = arg if arg
+      end
+      
+      # Adds content to the Table::Row::Header object.
+      def content=(arg)
+         @html_body = arg.to_s
+      end
+
+      # Returns the indentation level for the tags of this class.  The
+      # default is 6.
+      def self.indent_level
+         @indent_level
+      end
+
+      # Sets the indentation level for the tags of this class.  The default
+      # is 6.
+      def self.indent_level=(num)
+         expect(num,Integer)
+         raise ArgumentError,"indent_level must be >= 0" if num < 0
+         @indent_level = num
+      end
+
+      # Returns a boolean indicating whether or not end tags are included for
+      # each Header object in the final HTML output.  The default is true.
+      def self.end_tags?
+         @end_tags
+      end
+
+      # Sets whether or not end tags are included for each Header object in
+      # the final HTML output.  The default is true.  Only true or false are
+      # valid arguments.
+      def self.end_tags=(bool)
+         expect(bool,[TrueClass,FalseClass])
+         @end_tags = bool
+      end
+   end
+
+end

data/lib/html/html_handler.rb

@@ -0,0 +1,94 @@
+module HtmlHandler
+
+   $upper = false
+   
+   # 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).
+   def modify_html(attribute,arg=nil)
+      if @html_begin.scan(/\b#{attribute}\b/).empty?
+         if arg.kind_of?(Fixnum)
+            @html_begin << " #{attribute}=#{arg}"
+         elsif arg.kind_of?(TrueClass)
+            @html_begin << " #{attribute}"
+         else
+            @html_begin << " #{attribute}='#{arg}'"
+         end
+      else
+         if arg.kind_of?(Fixnum)
+            @html_begin.gsub!(/#{attribute}=\d+/,"#{attribute}=#{arg}")
+         elsif arg.kind_of?(FalseClass)
+            @html_begin.gsub!(/#{attribute}/,'')
+         else
+            @html_begin.gsub!(/#{attribute}=['\w\.]+/,"#{attribute}='#{arg}'")
+         end
+      end
+   end
+
+   # 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 self.class.respond_to?(:html_case)
+         $upper = true if self.class.html_case == "upper"
+      end
+      
+      if $upper
+         @html_begin.upcase!
+         @html_end.upcase!
+      end
+      
+      ilevel = 0
+      
+      if 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
+      else
+         html << @html_body
+      end
+
+      #####################################################################
+      # Add end tags, or not, depending on whether the class supports the
+      # end_tags class method.  Those that don't have an end_tags class
+      # method necessarily means that the end tag must be included.
+      #
+      # The Table.global_end_tags method overrides the individual class
+      # preferences with regards to end tags.
+      #####################################################################
+      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?
+            else
+               html << "\n" + ' ' * ilevel + @html_end
+            end
+         else
+            unless self.class.respond_to?(:end_tags?)
+               html << "\n" + ' ' * ilevel + @html_end
+            end
+         end
+      else
+         if Table.global_end_tags?
+            if self.class.respond_to?(:end_tags?)
+               html << @html_end if self.class.end_tags?
+            else
+               html << @html_end
+            end
+         else
+            unless self.class.respond_to?(:end_tags?)
+               html << @html_end
+            end
+         end
+      end
+
+      return html
+   end
+   
+   private :modify_html
+end