table_helper 0.1.0 → 0.2.0

data/lib/table_helper/footer.rb

@@ -4,27 +4,29 @@ module TableHelper
   # Represents the header of the table.  In HTML, you can think of this as
   # the <tfoot> tag of the table.
   class Footer < HtmlElement
+    # The table this footer is a part of
+    attr_reader :table
+    
     # The actual footer row
     attr_reader :row
     
-    delegate  :cell,
-                :to => :row
-    
     # Whether or not the footer should be hidden when the collection is
     # empty.  Default is true.
     attr_accessor :hide_when_empty
     
-    def initialize(collection) #:nodoc:
+    delegate :cell, :empty?, :to => :row
+    
+    def initialize(table) #:nodoc:
       super()
       
-      @collection = collection
-      @row = Row.new
+      @table = table
+      @row = Row.new(self)
       @hide_when_empty = true
     end
     
     def html #:nodoc:
       html_options = @html_options.dup
-      html_options[:style] = 'display: none;' if @collection.empty? && hide_when_empty
+      html_options[:style] = "display: none; #{html_options[:style]}".strip if table.empty? && hide_when_empty
       
       content_tag(tag_name, content, html_options)
     end

data/lib/table_helper/header.rb

@@ -1,89 +1,45 @@
 require 'table_helper/row'
 
 module TableHelper
-  # Provides a blank class that can be used to build the columns for a header
-  class HeaderBuilder < BlankSlate #:nodoc:
-    reveal :respond_to?
-    
-    attr_reader :header
-    
-    # Creates a builder for the given header
-    def initialize(header)
-      @header = header
-    end
-    
-    # Proxies all missed methods to the header
-    def method_missing(*args)
-      header.send(*args)
-    end
-    
-    # Defines the accessor method for the given column name.  For example, if
-    # a column with the name :title was defined, then the column would be able
-    # to be read and written like so:
-    # 
-    #   header.title               #=> Accesses the title
-    #   header.title "Page Title"  #=> Creates a new column with "Page Title" as the content
-    def define_column(name)
-      method_name = name.to_s.gsub('-', '_')
-      
-      klass = class << self; self; end
-      klass.class_eval do
-        define_method(method_name) do |*args|
-          header.row.builder.__send__(method_name, *args)
-        end
-      end unless klass.method_defined?(method_name)
-    end
-    
-    # Removes the definition for the given cp;i,m
-    def undef_column(name)
-      klass = class << self; self; end
-      klass.class_eval do
-        remove_method(name.gsub('-', '_'))
-      end
-    end
-  end
-  
   # Represents the header of the table.  In HTML, you can think of this as
   # the <thead> tag of the table.
   class Header < HtmlElement
+    # The table this header is a part of
+    attr_reader :table
+    
     # The actual header row
     attr_reader :row
     
-    # The proxy class used externally to build the actual columns
-    attr_reader :builder
-    
     # Whether or not the header should be hidden when the collection is
     # empty.  Default is true.
     attr_accessor :hide_when_empty
     
-    # Creates a new header for a collection that contains objects of the
-    # given class.
+    delegate :empty?, :to => :row
+    
+    # Creates a new header for the given table.
     # 
     # If the class is known, then the header will be pre-filled with
     # the columns defined in that class (assuming it's an ActiveRecord
     # class).
-    def initialize(collection, klass = nil)
+    def initialize(table)
       super()
       
-      @collection = collection
-      @row = Row.new
-      @builder = HeaderBuilder.new(self)
-      
+      @table = table
+      @row = Row.new(self)
       @hide_when_empty = true
-      @customized = true
       
       # If we know what class the objects in the collection are and we can
       # figure out what columns are defined in that class, then we can
       # pre-fill the header with those columns so that the user doesn't
       # have to
-      klass ||= class_for_collection(collection)
-      if klass && klass.respond_to?(:column_names)
-        klass.column_names.each {|name| column(name)}
-        @customized = false
-      end
+      klass = table.klass
+      column(*klass.column_names.map(&:to_sym)) if klass && klass.respond_to?(:column_names)
+      
+      @customized = false
     end
     
-    # The current columns in this header, in the order in which they will be built
+    # The current columns in this header, in the order in which they will be
+    # built
     def columns
       row.cells
     end
@@ -95,61 +51,43 @@ module TableHelper
     
     # Clears all of the current columns from the header
     def clear
-      # Remove all of the shortcut methods
-      column_names.each {|name| builder.undef_column(name)}
       row.clear
     end
     
-    # Creates a new column with the specified caption.  Columns must be
-    # defined in the order in which they will be rendered.
-    # 
-    # The caption determines what will be displayed in each cell of the
-    # header (if the header is rendered).  For example,
-    # 
-    #   header.column :title, 'The Title'
-    # 
-    # ...will create a column the displays "The Title" in the cell.
-    # 
-    # = Setting html options
-    # 
-    # In addition to customizing the content of the column, you can also
-    # specify html options like so:
-    # 
-    #   header.column :title, 'The Title', :class => 'pretty'
-    def column(name, *args)
+    # Creates one or more to columns in the header.  This will clear any
+    # pre-existing columns if it is being customized for the first time after
+    # it was initially created.
+    def column(*names)
       # Clear the header row if this is being customized by the user
       unless @customized
         @customized = true
         clear
       end
       
-      column = row.cell(name, *args)
-      column.content_type = :header
-      column[:scope] ||= 'col'
+      # Extract configuration
+      options = names.last.is_a?(Hash) ? names.pop : {}
+      content = names.last.is_a?(String) ? names.pop : nil
+      args = [content, options].compact
       
-      builder.define_column(name)
+      names.collect! do |name|
+        column = row.cell(name, *args)
+        column.content_type = :header
+        column[:scope] ||= 'col'
+        column
+      end
       
-      column
+      names.length == 1 ? names.first : names
     end
     
     # Creates and returns the generated html for the header
     def html
       html_options = @html_options.dup
-      html_options[:style] = 'display: none;' if @collection.empty? && hide_when_empty
+      html_options[:style] = 'display: none;' if table.empty? && hide_when_empty
       
       content_tag(tag_name, content, html_options)
     end
     
     private
-      # Finds the class representing the objects within the collection
-      def class_for_collection(collection)
-        if collection.respond_to?(:proxy_reflection)
-          collection.proxy_reflection.klass
-        elsif !collection.empty?
-          collection.first.class
-        end
-      end
-      
       def tag_name
         'thead'
       end

data/lib/table_helper/html_element.rb

@@ -17,9 +17,7 @@ module TableHelper
   class HtmlElement
     include ActionView::Helpers::TagHelper
     
-    delegate  :[],
-              :[]=,
-                :to => '@html_options'
+    delegate :[], :[]=, :to => '@html_options'
     
     def initialize(html_options = {}) #:nodoc:
       @html_options = html_options.symbolize_keys

data/lib/table_helper/row.rb

@@ -5,8 +5,6 @@ module TableHelper
   class RowBuilder < BlankSlate #:nodoc:
     reveal :respond_to?
     
-    attr_reader :row
-    
     # Creates a builder for the given row
     def initialize(row)
       @row = row
@@ -14,7 +12,7 @@ module TableHelper
     
     # Proxies all missed methods to the row
     def method_missing(*args)
-      row.send(*args)
+      @row.send(*args)
     end
     
     # Defines the builder method for the given cell name.  For example, if
@@ -30,9 +28,9 @@ module TableHelper
       klass.class_eval do
         define_method(method_name) do |*args|
           if args.empty?
-            row.cells[name]
+            @row.cells[name]
           else
-            row.cell(name, *args)
+            @row.cell(name, *args)
           end
         end
       end unless klass.method_defined?(method_name)
@@ -58,9 +56,16 @@ module TableHelper
     # The current cells in this row, in the order in which they will be built
     attr_reader :cells
     
-    def initialize #:nodoc:
-      super
+    # The parent element for this row
+    attr_reader :parent
+    
+    delegate :empty?, :to => :cells
+    delegate :table, :to => :parent
+    
+    def initialize(parent) #:nodoc:
+      super()
       
+      @parent = parent
       @cells = ActiveSupport::OrderedHash.new
       @builder = RowBuilder.new(self)
     end
@@ -70,6 +75,10 @@ module TableHelper
     def cell(name, *args)
       name = name.to_s if name
       
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:namespace] = table.object_name
+      args << options
+      
       cell = Cell.new(name, *args)
       cells[name] = cell
       builder.define_cell(name) if name

data/test/helpers/table_helper_test.rb

@@ -3,33 +3,41 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 class TableHelperTest < ActionView::TestCase
   tests TableHelper
   
+  class Post
+  end
+  
   def test_should_build_collection_table
-    html = collection_table(['first', 'second', 'last']) do |header, body|
-      header.column :title
-      
-      body.build do |row, post_title, index|
+    html = collection_table(['first', 'second', 'last'], Post) do |t|
+      t.header :title
+      t.rows.each do |row, post_title, index|
         row.title post_title
       end
+      t.footer :total, t.collection.length
     end
     
     expected = <<-end_str
-      <table cellpadding="0" cellspacing="0">
+      <table cellpadding="0" cellspacing="0" class="posts ui-collection">
         <thead>
           <tr>
-            <th class="title" scope="col">Title</th>
+            <th class="post-title" scope="col">Title</th>
           </tr>
         </thead>
         <tbody>
-          <tr class="row">
-            <td class="title">first</td>
+          <tr class="post ui-collection-result">
+            <td class="post-title">first</td>
           </tr>
-          <tr class="row">
-            <td class="title">second</td>
+          <tr class="post ui-collection-result">
+            <td class="post-title">second</td>
           </tr>
-          <tr class="row">
-            <td class="title">last</td>
+          <tr class="post ui-collection-result">
+            <td class="post-title">last</td>
           </tr>
         </tbody>
+        <tfoot>
+          <tr>
+            <td class="post-total">3</td>
+          </tr>
+        </tfoot>
       </table>
     end_str
     assert_html_equal expected, html

data/test/unit/body_row_test.rb

@@ -2,8 +2,13 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 class BodyRowByDefaultTest < Test::Unit::TestCase
   def setup
-    header = TableHelper::Header.new([])
-    @row = TableHelper::BodyRow.new(Object.new, header)
+    table = TableHelper::CollectionTable.new([])
+    @header = TableHelper::Header.new(table)
+    @row = TableHelper::BodyRow.new(Object.new, @header)
+  end
+  
+  def test_should_have_a_parent
+    assert_equal @header, @row.parent
   end
   
   def test_should_not_alternate
@@ -11,7 +16,17 @@ class BodyRowByDefaultTest < Test::Unit::TestCase
   end
   
   def test_should_have_a_class_name
-    assert_equal 'row', @row[:class]
+    assert_equal 'ui-collection-result', @row[:class]
+  end
+  
+  def test_should_use_custom_result_class_if_specified
+    original_result_class = TableHelper::BodyRow.result_class
+    TableHelper::BodyRow.result_class = 'ui-collection-item'
+    
+    row = TableHelper::BodyRow.new(Object.new, @header)
+    assert_equal 'ui-collection-item', row[:class]
+  ensure
+    TableHelper::BodyRow.result_class = original_result_class
   end
 end
 
@@ -23,8 +38,10 @@ class BodyRowTest < Test::Unit::TestCase
   end
   
   def setup
-    header = TableHelper::Header.new([])
+    table = TableHelper::CollectionTable.new([])
+    header = table.header
     header.column :title
+    
     @row = TableHelper::BodyRow.new(Post.new, header)
   end
   
@@ -34,18 +51,33 @@ class BodyRowTest < Test::Unit::TestCase
   
   def test_should_override_default_cell_content_if_cell_specified
     @row.builder.title 'Hello World'
-    assert_equal '<tr class="row"><td class="title">Hello World</td></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"><td class="title">Hello World</td></tr>', @row.html
+  end
+end
+
+class BodyRowWithTableObjectNameTest < Test::Unit::TestCase
+  def setup
+    table = TableHelper::CollectionTable.new([], Object)
+    header = table.header
+    
+    @row = TableHelper::BodyRow.new(Object.new, header)
+  end
+  
+  def test_should_include_object_name_in_class
+    assert_equal 'object ui-collection-result', @row[:class]
   end
 end
 
 class BodyRowWithNoColumnsTest < Test::Unit::TestCase
   def setup
-    header = TableHelper::Header.new([])
+    table = TableHelper::CollectionTable.new([])
+    header = table.header
+    
     @row = TableHelper::BodyRow.new(Object.new, header)
   end
   
   def test_should_not_build_cells
-    assert_equal '<tr class="row"></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"></tr>', @row.html
   end
 end
 
@@ -57,49 +89,67 @@ class BodyRowWithCustomAttributeTest < Test::Unit::TestCase
   end
   
   def setup
-    header = TableHelper::Header.new([])
+    table = TableHelper::CollectionTable.new([])
+    header = table.header
     header.column :title
     header.column :author_name
+    
     @row = TableHelper::BodyRow.new(Post.new, header)
   end
   
   def test_should_use_attribute_values_as_cell_content
     @row.builder.author_name 'John Doe'
-    assert_equal '<tr class="row"><td class="title">Default Value</td><td class="author_name">John Doe</td></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"><td class="title">Default Value</td><td class="author_name">John Doe</td></tr>', @row.html
   end
 end
 
 class BodyRowWithMissingCellsTest < Test::Unit::TestCase
   def setup
-    header = TableHelper::Header.new([])
+    table = TableHelper::CollectionTable.new([])
+    header = table.header
     header.column :title
     header.column :author_name
+    
     @row = TableHelper::BodyRow.new(Object.new, header)
   end
   
   def test_should_build_missing_cells_if_cells_not_specified
-    assert_equal '<tr class="row"><td class="title empty"></td><td class="author_name empty"></td></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"><td class="title ui-state-empty"></td><td class="author_name ui-state-empty"></td></tr>', @row.html
   end
   
   def test_should_skip_missing_cells_if_colspan_replaces_missing_cells
     @row.builder.title 'Hello World', :colspan => 2
-    assert_equal '<tr class="row"><td class="title" colspan="2">Hello World</td></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"><td class="title" colspan="2">Hello World</td></tr>', @row.html
   end
   
   def test_should_not_skip_missing_cells_if_colspan_doesnt_replace_missing_cells
     @row.builder.title 'Hello World'
-    assert_equal '<tr class="row"><td class="title">Hello World</td><td class="author_name empty"></td></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result"><td class="title">Hello World</td><td class="author_name ui-state-empty"></td></tr>', @row.html
   end
 end
 
 class BodyRowAlternatingTest < Test::Unit::TestCase
   def setup
-    header = TableHelper::Header.new([])
-    @row = TableHelper::BodyRow.new(Object.new, header)
+    table = TableHelper::CollectionTable.new([])
+    @header = table.header
+    
+    @row = TableHelper::BodyRow.new(Object.new, @header)
     @row.alternate = true
   end
   
   def test_should_add_alternate_class
-    assert_equal '<tr class="row alternate"></tr>', @row.html
+    assert_equal '<tr class="ui-collection-result ui-state-alternate"></tr>', @row.html
+  end
+  
+  def test_should_use_custom_altenrate_class_if_specified
+    original_alternate_class = TableHelper::BodyRow.alternate_class
+    TableHelper::BodyRow.alternate_class = 'ui-row-alternate'
+    
+    row = TableHelper::BodyRow.new(Object.new, @header)
+    row.alternate = true
+    
+    assert_equal '<tr class="ui-collection-result ui-row-alternate"></tr>', @row.html
+  ensure
+    TableHelper::BodyRow.alternate_class = original_alternate_class
   end
 end