table_helper 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,5 +1,11 @@
 *SVN*
 
+*0.0.4* (June 15th, 2008)
+
+* Support cell/column names that conflict with existing method names on the Row/Header classes
+
+* Avoid string evaluation for dynamic methods
+
 *0.0.3* (June 1st, 2008)
 
 * Remove dependency on set_or_append

data/README

@@ -158,4 +158,3 @@ To run against a specific version of Rails:
 == Dependencies
 
 * Rails 2.0 or later
-* set_or_append[http://wiki.pluginaweek.org/Set_or_append]

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'table_helper'
-PKG_VERSION        = '0.0.3'
+PKG_VERSION        = '0.0.4'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 

data/lib/table_helper/body.rb

@@ -94,7 +94,7 @@ module PluginAWeek #:nodoc:
         row = BodyRow.new(object, @header)
         row.alternate = alternate_rows ? index.send("#{@alternate_rows}?") : false
         
-        yield row, object, index if block_given?
+        yield row.builder, object, index if block_given?
         
         row.html
       end

data/lib/table_helper/body_row.rb

@@ -44,7 +44,7 @@ module PluginAWeek #:nodoc:
           if object.respond_to?(column)
             cell(column, object.send(column))
           else
-            define_cell_accessor(column)
+            builder.define_cell(column)
           end
         end
       end

data/lib/table_helper/cell.rb

@@ -34,7 +34,7 @@ module PluginAWeek #:nodoc:
       # 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}" if ![:data, :header].include?(value)
+        raise ArgumentError, "content_type must be set to :data or :header, was: #{value.inspect}" unless [:data, :header].include?(value)
         @content_type = value
       end
       

data/lib/table_helper/collection_table.rb

@@ -36,7 +36,7 @@ module PluginAWeek #:nodoc:
         @body.build # Build with the defaults
         
         elements = []
-        elements << @header if @options[:header]
+        elements << @header.builder if @options[:header]
         elements << @body
         elements << @footer if @options[:footer]
         

data/lib/table_helper/header.rb

@@ -2,11 +2,56 @@ require 'table_helper/row'
 
 module PluginAWeek #:nodoc:
   module TableHelper
+    # Provides a blank class that can be used to build the columns for a header
+    class HeaderBuilder < BlankSlate
+      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 actual header row
-      attr_reader   :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.
@@ -23,6 +68,7 @@ module PluginAWeek #:nodoc:
         
         @collection = collection
         @row = Row.new
+        @builder = HeaderBuilder.new(self)
         
         @hide_when_empty = true
         @customized = true
@@ -38,11 +84,23 @@ module PluginAWeek #:nodoc:
         end
       end
       
+      # The current columns in this header, in the order in which they will be built
+      def columns
+        row.cells
+      end
+      
       # Gets the names of all of the columns being displayed in the table
       def column_names
         row.cell_names
       end
       
+      # 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.
       # 
@@ -61,37 +119,16 @@ module PluginAWeek #:nodoc:
       #   header.column :title, 'The Title', :class => 'pretty'
       def column(name, *args)
         # Clear the header row if this is being customized by the user
-        if !@customized
+        unless @customized
           @customized = true
-          
-          # Remove all of the shortcut methods
-          column_names.each do |column|
-            klass = class << self; self; end
-            klass.class_eval do
-              remove_method(column)
-            end
-          end
-          
-          @row.clear
+          clear
         end
         
-        column = @row.cell(name, *args)
+        column = row.cell(name, *args)
         column.content_type = :header
         column[:scope] ||= 'col'
         
-        # Define a shortcut method to the cell
-        name = name.to_s.gsub('-', '_')
-        unless respond_to?(name)
-          instance_eval <<-end_eval
-            def #{name}(*args)
-              if args.empty?
-                @row.#{name}
-              else
-                @row.#{name}(*args)
-              end
-            end
-          end_eval
-        end
+        builder.define_column(name)
         
         column
       end
@@ -105,14 +142,7 @@ module PluginAWeek #:nodoc:
       end
       
       private
-        def tag_name
-          'thead'
-        end
-        
-        def content
-          @row.html
-        end
-        
+        # Finds the class representing the objects within the collection
         def class_for_collection(collection)
           if collection.respond_to?(:proxy_reflection)
             collection.proxy_reflection.klass
@@ -120,6 +150,14 @@ module PluginAWeek #:nodoc:
             collection.first.class
           end
         end
+        
+        def tag_name
+          'thead'
+        end
+        
+        def content
+          @row.html
+        end
     end
   end
 end

data/lib/table_helper/row.rb

@@ -2,13 +2,68 @@ require 'table_helper/cell'
 
 module PluginAWeek #:nodoc:
   module TableHelper
+    # Provides a blank class that can be used to build the cells for a row
+    class RowBuilder < BlankSlate
+      reveal :respond_to?
+      
+      attr_reader :row
+      
+      # Creates a builder for the given row
+      def initialize(row)
+        @row = row
+      end
+      
+      # Proxies all missed methods to the row
+      def method_missing(*args)
+        row.send(*args)
+      end
+      
+      # Defines the builder method for the given cell name.  For example, if
+      # a cell with the name :title was defined, then the cell would be able
+      # to be read and written like so:
+      # 
+      #   row.title               #=> Accesses the title
+      #   row.title "Page Title"  #=> Creates a new cell with "Page Title" as the content
+      def define_cell(name)
+        method_name = name.gsub('-', '_')
+        
+        klass = class << self; self; end
+        klass.class_eval do
+          define_method(method_name) do |*args|
+            if args.empty?
+              row.cells[name]
+            else
+              row.cell(name, *args)
+            end
+          end
+        end unless klass.method_defined?(method_name)
+      end
+      
+      # Removes the definition for the given cell
+      def undef_cell(name)
+        method_name = name.gsub('-', '_')
+        
+        klass = class << self; self; end
+        klass.class_eval do
+          remove_method(method_name)
+        end
+      end
+    end
+    
     # Represents a single row within a table.  A row can consist of either
     # data cells or header cells.
     class Row < HtmlElement
+      # The proxy class used externally to build the actual cells
+      attr_reader :builder
+      
+      # The current cells in this row, in the order in which they will be built
+      attr_reader :cells
+      
       def initialize #:nodoc:
         super
         
         @cells = ActiveSupport::OrderedHash.new
+        @builder = RowBuilder.new(self)
       end
       
       # Creates a new cell with the given name and generates shortcut
@@ -17,55 +72,31 @@ module PluginAWeek #:nodoc:
         name = name.to_s if name
         
         cell = Cell.new(name, *args)
-        @cells[name] = cell
-        
-        define_cell_accessor(name) if name && !respond_to?(name)
+        cells[name] = cell
+        builder.define_cell(name) if name
         
         cell
       end
       
       # The names of all cells in this row
       def cell_names
-        @cells.keys
+        cells.keys
       end
       
       # Clears all of the current cells from the row
       def clear
-        cell_names.each do |name|
-          klass = class << self; self; end
-          klass.class_eval do
-            remove_method(name)
-          end
-        end
-        
-        @cells.clear
+        # Remove all of the shortcut methods
+        cell_names.each {|name| builder.undef_cell(name)}
+        cells.clear
       end
       
       private
-        # Defines the accessor method for the given cell name.  For example, if
-        # a cell with the name :title was defined, then the cell would be able
-        # to be read and written like so:
-        # 
-        #   row.title               #=> Accesses the title
-        #   row.title "Page Title"  #=> Creates a new cell with "Page Title" as the content
-        def define_cell_accessor(name)
-          instance_eval <<-end_eval
-            def #{name.gsub('-', '_')}(*args)
-              if args.empty?
-                @cells[#{name.inspect}]
-              else
-                cell(#{name.inspect}, *args)
-              end
-            end
-          end_eval
-        end
-        
         def tag_name
           'tr'
         end
         
         def content
-          @cells.values.map(&:html).join
+          cells.values.map(&:html).join
         end
     end
   end

data/test/body_row_test.rb

@@ -29,11 +29,11 @@ class BodyRowTest < Test::Unit::TestCase
   end
   
   def test_should_generate_cell_accessors
-    assert @row.respond_to?(:title)
+    assert_nothing_raised {@row.builder.title}
   end
   
   def test_should_override_default_cell_content_if_cell_specified
-    @row.title 'Hello World'
+    @row.builder.title 'Hello World'
     assert_equal '<tr class="row"><td class="title">Hello World</td></tr>', @row.html
   end
 end
@@ -64,7 +64,7 @@ class BodyRowWithCustomAttributeTest < Test::Unit::TestCase
   end
   
   def test_should_use_attribute_values_as_cell_content
-    @row.author_name 'John Doe'
+    @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
   end
 end
@@ -82,12 +82,12 @@ class BodyRowWithMissingCellsTest < Test::Unit::TestCase
   end
   
   def test_should_skip_missing_cells_if_colspan_replaces_missing_cells
-    @row.title 'Hello World', :colspan => 2
+    @row.builder.title 'Hello World', :colspan => 2
     assert_equal '<tr class="row"><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.title 'Hello World'
+    @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
   end
 end

data/test/header_builder_test.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class HeaderBuilderByDefaultTest < Test::Unit::TestCase
+  def setup
+    @header = PluginAWeek::TableHelper::Header.new([])
+    @builder = PluginAWeek::TableHelper::HeaderBuilder.new(@header)
+  end
+  
+  def test_should_forward_missing_calls_to_row
+    assert_equal '<thead style="display: none;"><tr></tr></thead>', @builder.html
+  end
+end
+
+class HeaderBuilderWithColumnsTest < Test::Unit::TestCase
+  def setup
+    @header = PluginAWeek::TableHelper::Header.new([])
+    @header.row.cell 'first-name'
+    
+    @builder = PluginAWeek::TableHelper::HeaderBuilder.new(@header)
+    @builder.define_column('first-name')
+  end
+  
+  def test_should_create_column_reader
+    assert_nothing_raised {@builder.first_name}
+  end
+  
+  def test_should_read_column_without_arguments
+    assert_instance_of PluginAWeek::TableHelper::Cell, @builder.first_name
+  end
+  
+  def test_should_write_cell_with_arguments
+    @builder.first_name 'Your Name'
+    assert_equal '<td class="first-name">Your Name</td>', @header.row.cells['first-name'].html
+  end
+end
+
+class RowBuilderAfterUndefiningAColumnTest < Test::Unit::TestCase
+  def setup
+    @header = PluginAWeek::TableHelper::Header.new([])
+    @builder = PluginAWeek::TableHelper::HeaderBuilder.new(@header)
+    @builder.define_column('first-name')
+    @builder.undef_column('first-name')
+  end
+  
+  def test_should_not_have_cell_reader
+    assert_raise(NoMethodError) {@builder.first_name}
+  end
+end

data/test/header_test.rb

@@ -56,11 +56,11 @@ class HeaderTest < Test::Unit::TestCase
   def test_should_create_column_readers_if_column_names_found
     header = PluginAWeek::TableHelper::Header.new([], Post)
     
-    assert header.respond_to?(:title)
-    assert_instance_of PluginAWeek::TableHelper::Cell, header.title
+    assert_nothing_raised {header.builder.title}
+    assert_instance_of PluginAWeek::TableHelper::Cell, header.builder.title
     
-    assert header.respond_to?(:author_name)
-    assert_instance_of PluginAWeek::TableHelper::Cell, header.author_name
+    assert_nothing_raised {header.builder.title}
+    assert_instance_of PluginAWeek::TableHelper::Cell, header.builder.author_name
   end
   
   def test_should_create_column_reader_when_column_is_created
@@ -68,33 +68,33 @@ class HeaderTest < Test::Unit::TestCase
     header.column :title
     
     assert_equal ['title'], header.column_names
-    assert_instance_of PluginAWeek::TableHelper::Cell, header.title
+    assert_instance_of PluginAWeek::TableHelper::Cell, header.builder.title
   end
   
   def test_should_set_column_scope
     header = PluginAWeek::TableHelper::Header.new([])
     header.column :title
-    assert_equal 'col', header.title[:scope]
+    assert_equal 'col', header.columns['title'][:scope]
   end
   
   def test_should_allow_html_options_to_be_specified_for_new_columns
     header = PluginAWeek::TableHelper::Header.new([])
     header.column :title, 'Title', :class => 'pretty'
-    assert_equal 'title pretty', header.title[:class]
+    assert_equal 'title pretty', header.columns['title'][:class]
   end
   
   def test_should_use_column_name_for_default_content
     header = PluginAWeek::TableHelper::Header.new([])
     header.column :title
-    assert_equal '<th class="title" scope="col">Title</th>', header.title.html
+    assert_equal '<th class="title" scope="col">Title</th>', header.columns['title'].html
   end
   
   def test_should_sanitize_column_names
     header = PluginAWeek::TableHelper::Header.new([])
     header.column 'the-title'
     
-    assert header.respond_to?(:the_title)
-    assert_instance_of PluginAWeek::TableHelper::Cell, header.the_title
+    assert_nothing_raised {header.builder.the_title}
+    assert_instance_of PluginAWeek::TableHelper::Cell, header.builder.the_title
   end
   
   def test_should_clear_existing_columns_when_first_column_is_created
@@ -103,8 +103,8 @@ class HeaderTest < Test::Unit::TestCase
     
     header.column :created_on
     
-    assert !header.respond_to?(:title)
-    assert !header.respond_to?(:author_name)
+    assert_raise(NoMethodError) {header.builder.title}
+    assert_raise(NoMethodError) {header.builder.author_name}
     assert_equal ['created_on'], header.column_names
   end
   
@@ -139,6 +139,26 @@ class HeaderTest < Test::Unit::TestCase
   end
 end
 
+class HeaderWithConflictingColumnNamesTest < Test::Unit::TestCase
+  def setup
+    @header = PluginAWeek::TableHelper::Header.new([])
+    @header.column 'id'
+  end
+  
+  def test_should_be_able_to_read_cell
+    assert_instance_of PluginAWeek::TableHelper::Cell, @header.builder.id
+  end
+  
+  def test_should_be_able_to_write_to_cell
+    @header.builder.id '1'
+    assert_instance_of PluginAWeek::TableHelper::Cell, @header.builder.id
+  end
+  
+  def test_should_be_able_to_clear
+    assert_nothing_raised {@header.clear}
+  end
+end
+
 class HeaderWithEmptyCollectionTest < Test::Unit::TestCase
   def setup
     @header = PluginAWeek::TableHelper::Header.new([])

data/test/row_builder_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RowBuilderByDefaultTest < Test::Unit::TestCase
+  def setup
+    @row = PluginAWeek::TableHelper::Row.new
+    @builder = PluginAWeek::TableHelper::RowBuilder.new(@row)
+  end
+  
+  def test_should_forward_missing_calls_to_row
+    assert_equal '<tr></tr>', @builder.html
+  end
+end
+
+class RowBuilderWithCellsTest < Test::Unit::TestCase
+  def setup
+    @row = PluginAWeek::TableHelper::Row.new
+    @builder = PluginAWeek::TableHelper::RowBuilder.new(@row)
+    @builder.define_cell('first-name')
+  end
+  
+  def test_should_create_cell_reader
+    assert_nothing_raised {@builder.first_name}
+  end
+  
+  def test_should_read_cell_without_arguments
+    @row.cells['first-name'] = PluginAWeek::TableHelper::Cell.new('first-name')
+    assert_instance_of PluginAWeek::TableHelper::Cell, @builder.first_name
+  end
+  
+  def test_should_write_cell_with_arguments
+    @builder.first_name 'Your Name'
+    assert_equal '<td class="first-name">Your Name</td>', @row.cells['first-name'].html
+  end
+end
+
+class RowBuilderAfterUndefiningACellTest < Test::Unit::TestCase
+  def setup
+    @row = PluginAWeek::TableHelper::Row.new
+    @builder = PluginAWeek::TableHelper::RowBuilder.new(@row)
+    @builder.define_cell('first-name')
+    @builder.undef_cell('first-name')
+  end
+  
+  def test_should_not_have_cell_reader
+    assert_raise(NoMethodError) {@builder.first_name}
+  end
+end

data/test/row_test.rb

@@ -10,44 +10,52 @@ class RowByDefaultTest < Test::Unit::TestCase
   end
   
   def test_should_not_have_any_cells
+    assert @row.cells.empty?
+  end
+  
+  def test_should_not_have_any_cell_names
     assert_equal [], @row.cell_names
   end
+  
+  def test_should_have_a_builder
+    assert_not_nil @row.builder
+  end
 end
 
-
 class RowTest < Test::Unit::TestCase
   def setup
     @row = PluginAWeek::TableHelper::Row.new
   end
   
-  def test_should_create_reader_after_building_cell
+  def test_should_create_cell_reader_after_building_cell
     @row.cell :name
-    assert @row.respond_to?(:name)
-    assert_instance_of PluginAWeek::TableHelper::Cell, @row.name
+    assert_nothing_raised {@row.builder.name}
+    assert_instance_of PluginAWeek::TableHelper::Cell, @row.builder.name
   end
   
   def test_should_use_cell_name_for_class_name
     @row.cell :name
-    assert_equal 'name', @row.name[:class]
+    assert_equal 'name', @row.cells['name'][:class]
   end
   
   def test_should_sanitize_cell_name_for_reader_method
     @row.cell 'the-name'
     
-    assert @row.respond_to?(:the_name)
-    assert_instance_of PluginAWeek::TableHelper::Cell, @row.the_name
+    @row.builder.the_name
+    assert_nothing_raised {@row.builder.the_name}
+    assert_instance_of PluginAWeek::TableHelper::Cell, @row.builder.the_name
   end
   
   def test_should_use_unsanitized_cell_name_for_cell_class
     @row.cell 'the-name'
     assert_equal ['the-name'], @row.cell_names
-    assert_equal 'the-name', @row.the_name[:class]
+    assert_equal 'the-name', @row.cells['the-name'][:class]
   end
   
   def test_should_allow_html_options_when_building_cell
     @row.cell :name, 'Name', :class => 'pretty'
     
-    assert_equal 'name pretty', @row.name[:class]
+    assert_equal 'name pretty', @row.cells['name'][:class]
   end
 end
 
@@ -87,10 +95,10 @@ class RowWithCellsTest < Test::Unit::TestCase
   end
   
   def test_should_create_new_cell_if_cell_already_exists
-    old_cell = @row.name
+    old_cell = @row.cells['name']
     
     @row.cell :name
-    assert_not_same old_cell, @row.name
+    assert_not_same old_cell, @row.cells['name']
   end
   
   def test_should_be_able_to_read_cell_after_clearing
@@ -98,7 +106,7 @@ class RowWithCellsTest < Test::Unit::TestCase
     @row.cell :name
     
     assert_equal ['name'], @row.cell_names
-    assert @row.respond_to?(:name)
+    assert_nothing_raised {@row.builder.name}
   end
 end
 
@@ -113,3 +121,23 @@ class RowWithMultipleCellsTest < Test::Unit::TestCase
     assert_equal '<tr><td class="name">Name</td><td class="location">Location</td></tr>', @row.html
   end
 end
+
+class RowWithConflictingCellNamesTest < Test::Unit::TestCase
+  def setup
+    @row = PluginAWeek::TableHelper::Row.new
+    @row.cell :id
+  end
+  
+  def test_should_be_able_to_read_cell
+    assert_instance_of PluginAWeek::TableHelper::Cell, @row.cells['id']
+  end
+  
+  def test_should_be_able_to_write_to_cell
+    @row.builder.id '1'
+    assert_instance_of PluginAWeek::TableHelper::Cell, @row.cells['id']
+  end
+  
+  def test_should_be_able_to_clear
+    assert_nothing_raised {@row.clear}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: table_helper
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire: table_helper
 bindir: bin
 cert_chain: []
 
-date: 2008-06-01 00:00:00 -04:00
+date: 2008-06-15 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -33,10 +33,12 @@ files:
 - lib/table_helper/cell.rb
 - lib/table_helper/body_row.rb
 - test/header_test.rb
+- test/header_builder_test.rb
 - test/collection_table_test.rb
 - test/test_helper.rb
 - test/row_test.rb
 - test/footer_test.rb
+- test/row_builder_test.rb
 - test/body_row_test.rb
 - test/cell_test.rb
 - test/html_element_test.rb
@@ -75,9 +77,11 @@ specification_version: 2
 summary: Adds a helper method for generating HTML tables from collections
 test_files: 
 - test/header_test.rb
+- test/header_builder_test.rb
 - test/collection_table_test.rb
 - test/row_test.rb
 - test/footer_test.rb
+- test/row_builder_test.rb
 - test/body_row_test.rb
 - test/cell_test.rb
 - test/html_element_test.rb