table_helper 0.0.5 → 0.1.0

data/lib/table_helper/body.rb

@@ -1,119 +1,116 @@
 require 'table_helper/body_row'
 
-module PluginAWeek #:nodoc:
-  module TableHelper
-    # Represents the body of the table.  In HTML, you can think of this as
-    # the <tbody> tag of the table.
-    class Body < HtmlElement
-      # If set to :odd or :even, every odd or even-numbered row will have the
-      # class 'alternate' appended to its html attributes, respectively.
-      # Default is nil.
-      attr_accessor :alternate_rows
+module TableHelper
+  # Represents the body of the table.  In HTML, you can think of this as
+  # the <tbody> tag of the table.
+  class Body < HtmlElement
+    # If set to :odd or :even, every odd or even-numbered row will have the
+    # class 'alternate' appended to its html attributes. Default is nil.
+    attr_accessor :alternate_rows
+    
+    # The caption to display in the collection is empty
+    attr_accessor :empty_caption
+    
+    def initialize(collection, header) #:nodoc:
+      super()
       
-      # The caption to display in the collection is empty
-      attr_accessor :empty_caption
+      @collection, @header = collection, header
+      @empty_caption = 'No matches found.'
+    end
+    
+    def alternate_rows=(value) #:nodoc:
+      raise ArgumentError, 'alternate_rows must be set to :odd or :even' if value && ![:odd, :even].include?(value)
+      @alternate_rows = value
+    end
+    
+    # Builds the body of the table.  This includes the actual data that is
+    # generated for each object in the collection.
+    # 
+    # +build+ expects a block that defines the data in each cell.  Each
+    # iteration of the block will provide the object being rendered, the row
+    # within the table that will be built and the index of the object.  For
+    # example,
+    # 
+    #   body.build do |row, post, index|
+    #     row.title     "<div class=\"wrapped\">#{post.title}</div>"
+    #     row.category  post.category.name
+    #   end
+    # 
+    # In addition, to specifying the data, you can also modify the html
+    # options of the row.  For more information on doing this, see the
+    # BodyRow class.
+    # 
+    # If the collection is empty and +empty_caption+ is set on the body,
+    # then the actual body will be replaced by a single row containing the
+    # html that was stored in +empty_caption+.
+    # 
+    # == Default Values
+    # 
+    # Whenever possible, the default value of a cell will be set to the
+    # object's attribute with the same name as the cell.  For example,
+    # if a Post consists of the attribute +title+, then the cell for the
+    # title will be prepopulated with that attribute's value:
+    # 
+    #   body.build do |row, post index|
+    #     row.category post.category.name
+    #   end
+    # 
+    # <tt>row.title</tt> is already set to post.category so there's no need to
+    # manually set the value of that cell.  However, it is always possible
+    # to override the default value like so:
+    # 
+    #   body.build do |row, post, index|
+    #     row.title     link_to(post.title, post_url(post))
+    #     row.category  post.category.name
+    #   end
+    def build(&block)
+      @content = ''
       
-      def initialize(collection, header) #:nodoc:
-        super()
+      # Display nothing if there are no objects to display
+      if @collection.empty? && @empty_caption
+        row = Row.new
+        row[:class] = 'no_content'
         
-        @collection, @header = collection, header
-        @empty_caption = 'No matches found.'
-      end
-      
-      def alternate_rows=(value) #:nodoc:
-        raise ArgumentError, 'alternate_rows must be set to :odd or :even' if value && ![:odd, :even].include?(value)
-        @alternate_rows = value
-      end
-      
-      # Builds the body of the table.  This includes the actual data that is
-      # generated for each object in the collection.
-      # 
-      # build expects a block that defines the data in each cell.  Each
-      # iteration of the block will provide the object being rendered, the row
-      # within the table that will be built and the index of the object.  For
-      # example,
-      # 
-      #   body.build do |row, post, index|
-      #     row.title     "<div class=\"wrapped\">#{post.title}</div>"
-      #     row.category  post.category.name
-      #   end
-      # 
-      # In addition, to specifying the data, you can also modify the html
-      # options of the row.  For more information on doing this, see the
-      # BodyRow class.
-      # 
-      # If the collection is empty and +empty_caption+ is set on the Body,
-      # then the actual body will be replaced by a single row containing the
-      # html that was stored in +empty_caption+.
-      # 
-      # == Default Values
-      # 
-      # Whenever possible, the default value of a cell will be set to the
-      # object's attribute with the same name as the cell.  For example,
-      # if a Post consists of the attribute +title+, then the cell for the
-      # title will be prepopulated with that attribute's value:
-      # 
-      #   body.build do |row, post index|
-      #     row.category post.category.name
-      #   end
-      # 
-      # +row.title+ is already set to post.category so there's no need to
-      # manually set the value of that cell.  However, it is always possible
-      # to override the default value like so:
-      # 
-      #   body.build do |row, post, index|
-      #     row.title     link_to(post.title, post_url(post))
-      #     row.category  post.category.name
-      #   end
-      def build(&block)
-        @content = ''
+        html_options = {}
+        html_options[:colspan] = @header.column_names.size if @header.column_names.size > 1
+        row.cell nil, @empty_caption, html_options
         
-        # Display nothing if there are no objects to display
-        if @collection.empty? && @empty_caption
-          row = Row.new
-          row[:class] = 'no_content'
-          
-          html_options = {}
-          html_options[:colspan] = @header.column_names.size if @header.column_names.size > 1
-          row.cell nil, @empty_caption, html_options
-          
-          @content << row.html
-        else
-          @collection.each_with_index do |object, i|
-            @content << build_row(object, i, &block)
-          end
+        @content << row.html
+      else
+        @collection.each_with_index do |object, i|
+          @content << build_row(object, i, &block)
         end
-        
-        @content
       end
       
-      # Builds a row for an object in the table.
-      # 
-      # The provided block should set the values for each cell in the row.
-      def build_row(object, index = @collection.index(object), &block)
-        row = BodyRow.new(object, @header)
-        row.alternate = alternate_rows ? index.send("#{@alternate_rows}?") : false
-        
-        yield row.builder, object, index if block_given?
-        
-        row.html
-      end
+      @content
+    end
+    
+    # Builds a row for an object in the table.
+    # 
+    # The provided block should set the values for each cell in the row.
+    def build_row(object, index = @collection.index(object), &block)
+      row = BodyRow.new(object, @header)
+      row.alternate = alternate_rows ? index.send("#{@alternate_rows}?") : false
       
-      def html #:nodoc:
-        html_options = @html_options.dup
-        html_options[:class] = (html_options[:class].to_s + ' alternate').strip if alternate_rows 
-        
-        content_tag(tag_name, content, html_options)
-      end
+      yield row.builder, object, index if block_given?
       
-      private
-        def tag_name
-          'tbody'
-        end
-        
-        def content
-          @content
-        end
+      row.html
     end
+    
+    def html #:nodoc:
+      html_options = @html_options.dup
+      html_options[:class] = (html_options[:class].to_s + ' alternate').strip if alternate_rows 
+      
+      content_tag(tag_name, content, html_options)
+    end
+    
+    private
+      def tag_name
+        'tbody'
+      end
+      
+      def content
+        @content
+      end
   end
 end

data/lib/table_helper/body_row.rb

@@ -1,86 +1,70 @@
 require 'table_helper/row'
 
-module PluginAWeek #:nodoc:
-  module TableHelper
-    # Represents a single row within the body of a table.  The row can consist
-    # of either data cells or header cells. 
-    # 
-    # == Borders
-    # 
-    # Each row has an optional special border row that can be generated either
-    # immediately before or immediately after this row.  A separate border row
-    # is usually used when you cannot express borders in the css of the row
-    # containing the data (e.g. dotted borders in Internet Explorer).
-    # 
-    # To modify the properties of the border, you can access +row.border+ like
-    # so:
-    # 
-    #   r = BodyRow.new
-    #   r.border_type = :before
-    #   r.border[:style] = 'color: #ff0000;'
-    # 
-    # == Alternating rows
-    # 
-    # Alternating rows can be automated by setting the +alternate+ property.
-    # For example,
-    # 
-    #   r = BodyRow.new
-    #   r.alternate = true
-    class BodyRow < Row
-      # True if this is an alternating row, otherwise false.  Default is false.
-      attr_accessor :alternate
+module TableHelper
+  # Represents a single row within the body of a table.  The row can consist
+  # of either data cells or header cells. 
+  # 
+  # == Alternating rows
+  # 
+  # Alternating rows can be automated by setting the +alternate+ property.
+  # For example,
+  # 
+  #   r = BodyRow.new
+  #   r.alternate = true
+  class BodyRow < Row
+    # True if this is an alternating row, otherwise false.  Default is false.
+    attr_accessor :alternate
+    
+    def initialize(object, header) #:nodoc:
+      super()
       
-      def initialize(object, header) #:nodoc:
-        super()
-        
-        @header = header
-        @alternate = false
-        @html_options[:class] = ('row ' + @html_options[:class].to_s).strip
+      @header = header
+      @alternate = false
+      @html_options[:class] = ('row ' + @html_options[:class].to_s).strip
+      
+      # For each column defined in the table, see if we can prepopulate the
+      # cell based on the data in the object.  If not, we can at least
+      # provide shortcut accessors to the cell
+      @header.column_names.each do |column|
+        if object.respond_to?(column)
+          cell(column, object.send(column))
+        else
+          builder.define_cell(column)
+        end
+      end
+    end
+    
+    # Generates the html for this row in additional to the border row
+    # (if specified)
+    def html
+      original_options = @html_options.dup
+      @html_options[:class] = (@html_options[:class].to_s + ' alternate').strip if alternate
+      html = super
+      @html_options = original_options
+      html
+    end
+    
+    private
+      # Builds the row's cells based on the order of the columns in the
+      # header.  If a cell cannot be found for a specific column, then a blank
+      # cell is rendered.
+      def content
+        number_to_skip = 0 # Keeps track of the # of columns to skip
         
-        # For each column defined in the table, see if we can prepopulate the
-        # cell based on the data in the object.  If not, we can at least
-        # provide shortcut accessors to the cell
+        html = ''
         @header.column_names.each do |column|
-          if object.respond_to?(column)
-            cell(column, object.send(column))
+          number_to_skip -= 1 and next if number_to_skip > 0
+          
+          if cell = @cells[column]
+            number_to_skip = (cell[:colspan] || 1) - 1
           else
-            builder.define_cell(column)
+            cell = Cell.new(column, '', :class => 'empty')
           end
+          
+          html << cell.html
         end
-      end
-      
-      # Generates the html for this row in additional to the border row
-      # (if specified)
-      def html
-        original_options = @html_options.dup
-        @html_options[:class] = (@html_options[:class].to_s + ' alternate').strip if alternate
-        html = super
-        @html_options = original_options
+        
         html
       end
-      
-      private
-        # Builds the row's cells based on the order of the columns in the
-        # header.  If a cell cannot be found for a specific column, then a blank
-        # cell is rendered.
-        def content
-          number_to_skip = 0 # Keeps track of the # of columns to skip
-          
-          html = ''
-          @header.column_names.each do |column|
-            number_to_skip -= 1 and next if number_to_skip > 0
-            
-            if cell = @cells[column]
-              number_to_skip = (cell[:colspan] || 1) - 1
-            else
-              cell = Cell.new(column, '', :class => 'empty')
-            end
-            
-            html << cell.html
-          end
-          
-          html
-        end
-    end
   end
 end

data/lib/table_helper/cell.rb

@@ -1,51 +1,49 @@
-module PluginAWeek #:nodoc:
-  module TableHelper
-    # Represents a single cell within a table.  This can either be a regular
-    # data cell (td) or a header cell (th).  By default, all cells will have
-    # their column name appended to the cell's class attribute.
-    # 
-    # == Creating data cells
-    # 
-    #   Cell.new(:author, 'John Doe').build
-    # 
-    # ...would generate the following tag:
-    # 
-    #   <td class="author">John Doe</td>
-    # 
-    # == Creating header cells
-    # 
-    #   c = Cell.new(:author, 'Author Name')
-    #   c.content_type = :header
-    #   c.build
-    # 
-    # ...would generate the following tag:
-    # 
-    #   <th class="author">Author Name</th>
-    class Cell < HtmlElement
-      def initialize(class_name, content = class_name.to_s.titleize, html_options = {}) #:nodoc
-        super(html_options)
-        
-        @content = content
-        @html_options[:class] = ("#{class_name} " + @html_options[:class].to_s).strip if class_name
-        
-        self.content_type = :data
-      end
+module TableHelper
+  # Represents a single cell within a table.  This can either be a regular
+  # data cell (td) or a header cell (th).  By default, all cells will have
+  # their column name appended to the cell's class attribute.
+  # 
+  # == Creating data cells
+  # 
+  #   Cell.new(:author, 'John Doe').build
+  # 
+  # ...would generate the following tag:
+  # 
+  #   <td class="author">John Doe</td>
+  # 
+  # == Creating header cells
+  # 
+  #   c = Cell.new(:author, 'Author Name')
+  #   c.content_type = :header
+  #   c.build
+  # 
+  # ...would generate the following tag:
+  # 
+  #   <th class="author">Author Name</th>
+  class Cell < HtmlElement
+    def initialize(class_name, content = class_name.to_s.titleize, html_options = {}) #:nodoc
+      super(html_options)
       
-      # Indicates what type of content will be stored in this cell.  This can
-      # either be set to either :data or :header.
-      def content_type=(value)
-        raise ArgumentError, "content_type must be set to :data or :header, was: #{value.inspect}" unless [:data, :header].include?(value)
-        @content_type = value
-      end
+      @content = content
+      @html_options[:class] = ("#{class_name} " + @html_options[:class].to_s).strip if class_name
       
-      private
-        def tag_name
-          @content_type == :data ? 'td' : 'th'
-        end
-        
-        def content
-          @content
-        end
+      self.content_type = :data
+    end
+    
+    # Indicates what type of content will be stored in this cell.  This can
+    # be set to either :data or :header.
+    def content_type=(value)
+      raise ArgumentError, "content_type must be set to :data or :header, was: #{value.inspect}" unless [:data, :header].include?(value)
+      @content_type = value
     end
+    
+    private
+      def tag_name
+        @content_type == :data ? 'td' : 'th'
+      end
+      
+      def content
+        @content
+      end
   end
 end