tangofoxtrot-table_helper 0.2.2

data/lib/table_helper/html_element.rb

@@ -0,0 +1,42 @@
+module TableHelper
+  # Represents an HTML element
+  # 
+  # == Modifying HTML options
+  # 
+  # HTML options can normally be specified when creating the element.
+  # However, if they need to be modified after the element has been created,
+  # you can access the properties like so:
+  # 
+  #   r = Row.new
+  #   r[:style] = 'display: none;'
+  # 
+  # or for a cell:
+  # 
+  #   c = Cell.new
+  #   c[:style] = 'display: none;'
+  class HtmlElement
+    include ActionView::Helpers::TagHelper
+    
+    delegate :[], :[]=, :to => '@html_options'
+    
+    def initialize(html_options = {}) #:nodoc:
+      @html_options = html_options.symbolize_keys
+    end
+    
+    # Generates the html representing this element
+    def html
+      content_tag(tag_name, content, @html_options)
+    end
+    
+    private
+      # The name of the element tag to use (e.g. td, th, tr, etc.)
+      def tag_name
+        ''
+      end
+      
+      # The content that will be displayed inside of the tag
+      def content
+        ''
+      end
+  end
+end

data/lib/table_helper/row.rb

@@ -0,0 +1,110 @@
+require 'table_helper/cell'
+
+module TableHelper
+  # Provides a blank class that can be used to build the cells for a row
+  class RowBuilder < BlankSlate #:nodoc:
+    reveal :respond_to?
+    
+    # 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
+    
+    # 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
+    
+    # Creates a new cell with the given name and generates shortcut
+    # accessors for the method.
+    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
+      
+      cell
+    end
+    
+    # The names of all cells in this row
+    def cell_names
+      cells.keys
+    end
+    
+    # Clears all of the current cells from the row
+    def clear
+      # Remove all of the shortcut methods
+      cell_names.each {|name| builder.undef_cell(name)}
+      cells.clear
+    end
+    
+    private
+      def tag_name
+        'tr'
+      end
+      
+      def content
+        cells.values.map(&:html).join
+      end
+  end
+end

data/test/app_root/app/models/person.rb

@@ -0,0 +1,2 @@
+class Person < ActiveRecord::Base
+end

data/test/app_root/db/migrate/001_create_people.rb

@@ -0,0 +1,11 @@
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.string :first_name, :last_name
+    end
+  end
+  
+  def self.down
+    drop_table :people
+  end
+end

data/test/helpers/table_helper_test.rb

@@ -0,0 +1,45 @@
+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'], 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" class="posts ui-collection">
+        <thead>
+          <tr>
+            <th class="post-title" scope="col">Title</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr class="post ui-collection-result">
+            <td class="post-title">first</td>
+          </tr>
+          <tr class="post ui-collection-result">
+            <td class="post-title">second</td>
+          </tr>
+          <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
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+Test::Unit::TestCase.class_eval do
+  private
+    def assert_html_equal(expected, actual)
+      assert_equal expected.strip.gsub(/\n\s*/, ''), actual
+    end
+end

data/test/unit/body_row_test.rb

@@ -0,0 +1,155 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class BodyRowByDefaultTest < Test::Unit::TestCase
+  def setup
+    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
+    assert !@row.alternate
+  end
+  
+  def test_should_have_a_class_name
+    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
+
+class BodyRowTest < Test::Unit::TestCase
+  class Post
+    def title
+      'Default Value'
+    end
+  end
+  
+  def setup
+    table = TableHelper::CollectionTable.new([])
+    header = table.header
+    header.column :title
+    
+    @row = TableHelper::BodyRow.new(Post.new, header)
+  end
+  
+  def test_should_generate_cell_accessors
+    assert_nothing_raised {@row.builder.title}
+  end
+  
+  def test_should_override_default_cell_content_if_cell_specified
+    @row.builder.title 'Hello World'
+    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
+    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="ui-collection-result"></tr>', @row.html
+  end
+end
+
+class BodyRowWithCustomAttributeTest < Test::Unit::TestCase
+  class Post
+    def title
+      'Default Value'
+    end
+  end
+  
+  def setup
+    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="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
+    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="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="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="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
+    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="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

data/test/unit/body_test.rb

@@ -0,0 +1,299 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class BodyByDefaultTest < Test::Unit::TestCase
+  def setup
+    @table = TableHelper::CollectionTable.new([])
+    @body = TableHelper::Body.new(@table)
+  end
+  
+  def test_should_have_a_table
+    assert_equal @table, @body.table
+  end
+  
+  def test_should_not_alternate
+    assert_nil @body.alternate
+  end
+  
+  def test_should_have_an_empty_caption
+    assert_equal 'No matches found.', @body.empty_caption
+  end
+end
+
+class BodyTest < Test::Unit::TestCase
+  def setup
+    @table = TableHelper::CollectionTable.new([])
+    @body = TableHelper::Body.new(@table)
+  end
+  
+  def test_should_raise_exception_if_invalid_alternate_specified
+    assert_raise(ArgumentError) {@body.alternate = :invalid}
+  end
+  
+  def test_should_not_raise_exception_for_odd_alternate
+    assert_nothing_raised {@body.alternate = :odd}
+    assert_equal :odd, @body.alternate
+  end
+  
+  def test_should_not_raise_exception_for_even_alternate
+    assert_nothing_raised {@body.alternate = :even}
+    assert_equal :even, @body.alternate
+  end
+end
+
+class BodyWithEmptyCollectionTest < Test::Unit::TestCase
+  def setup
+    @table = TableHelper::CollectionTable.new([])
+    @body = TableHelper::Body.new(@table)
+  end
+  
+  def test_should_have_no_content_if_no_empty_caption
+    @body.empty_caption = nil
+    assert_html_equal '<tbody></tbody>', @body.html
+  end
+  
+  def test_should_show_content_if_empty_caption
+    expected = <<-end_str
+      <tbody>
+        <tr class="ui-collection-empty">
+          <td>No matches found.</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  end
+  
+  def test_should_use_custom_empty_caption_class_if_specified
+    original_empty_caption_class = TableHelper::Body.empty_caption_class
+    TableHelper::Body.empty_caption_class = 'ui-collection-empty_caption'
+    
+    expected = <<-end_str
+      <tbody>
+        <tr class="ui-collection-empty_caption">
+          <td>No matches found.</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  ensure
+    TableHelper::Body.empty_caption_class = original_empty_caption_class
+  end
+  
+  def test_should_set_colspan_if_header_has_multiple_columns
+    @table.header :title, :author_name
+    
+    expected = <<-end_str
+      <tbody>
+        <tr class="ui-collection-empty">
+          <td colspan="2">No matches found.</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  end
+end
+
+class BodyWithCollectionTest < Test::Unit::TestCase
+  class Post
+    attr_accessor :title
+    
+    def initialize(title)
+      @title = title
+    end
+  end
+  
+  def setup
+    @collection = [Post.new('first'), Post.new('second'), Post.new('last')]
+    @table = TableHelper::CollectionTable.new(@collection)
+    @table.header :title
+    
+    @body = TableHelper::Body.new(@table)
+  end
+  
+  def test_should_build_row_using_object_location_for_default_index
+    build_post = nil
+    index = nil
+    @body.each {|row, build_post, index|}
+    
+    @collection.each do |post|
+      html = @body.build_row(post) 
+      assert_equal post, build_post
+      assert_equal @collection.index(post), index
+      
+      expected = <<-end_str
+        <tr class="post ui-collection-result">
+          <td class="post-title">#{post.title}</td>
+        </tr>
+      end_str
+      assert_html_equal expected, html
+    end
+  end
+  
+  def test_should_build_row_using_custom_value_for_index
+    post = nil
+    index = nil
+    @body.each {|row, post, index|}
+    
+    html = @body.build_row(@collection.first, 1)
+    assert_equal @collection.first, post
+    assert_equal 1, index
+    
+    expected = <<-end_str
+      <tr class="post ui-collection-result">
+        <td class="post-title">first</td>
+      </tr>
+    end_str
+    assert_html_equal expected, html
+  end
+  
+  def test_should_build_row_with_missing_cells
+    header = @table.header :author_name
+    
+    expected = <<-end_str
+      <tr class="post ui-collection-result">
+        <td class="post-title">first</td>
+        <td class="post-author_name ui-state-empty"></td>
+      </tr>
+    end_str
+    assert_html_equal expected, @body.build_row(@collection.first)
+  end
+  
+  def test_should_build_html
+    expected = <<-end_str
+      <tbody>
+        <tr class="post ui-collection-result">
+          <td class="post-title">first</td>
+        </tr>
+        <tr class="post ui-collection-result">
+          <td class="post-title">second</td>
+        </tr>
+        <tr class="post ui-collection-result">
+          <td class="post-title">last</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  end
+  
+  def test_should_include_custom_attributes_in_body_tag
+    @body[:class] = 'pretty'
+    
+    expected = <<-end_str
+      <tbody class="pretty">
+        <tr class="post ui-collection-result">
+          <td class="post-title">first</td>
+        </tr>
+        <tr class="post ui-collection-result">
+          <td class="post-title">second</td>
+        </tr>
+        <tr class="post ui-collection-result">
+          <td class="post-title">last</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  end
+end
+
+class BodyWithCustomBuilderTest < Test::Unit::TestCase
+  def setup
+    @collection = [Object.new, Object.new, Object.new]
+    @table = TableHelper::CollectionTable.new(@collection)
+    @table.header :index
+    
+    @body = TableHelper::Body.new(@table)
+    @body.each do |row, object, index|
+      row.index index.to_s
+    end
+  end
+  
+  def test_should_use_custom_builder
+    expected = <<-end_str
+      <tbody>
+        <tr class="object ui-collection-result">
+          <td class="object-index">0</td>
+        </tr>
+        <tr class="object ui-collection-result">
+          <td class="object-index">1</td>
+        </tr>
+        <tr class="object ui-collection-result">
+          <td class="object-index">2</td>
+        </tr>
+      </tbody>
+    end_str
+    assert_html_equal expected, @body.html
+  end
+end
+
+class BodyWithAlternatingEvenRowsTest < Test::Unit::TestCase
+  class Post
+    attr_accessor :title
+    
+    def initialize(title)
+      @title = title
+    end
+  end
+  
+  def setup
+    @collection = [Post.new('first'), Post.new('second'), Post.new('last')]
+    table = TableHelper::CollectionTable.new(@collection)
+    table.header :title
+    
+    @body = TableHelper::Body.new(table)
+    @body.alternate = :even
+  end
+  
+  def test_should_alternate_even_row
+    expected = <<-end_str
+      <tr class="post ui-collection-result ui-state-alternate">
+        <td class="post-title">first</td>
+      </tr>
+    end_str
+    assert_html_equal expected, @body.build_row(@collection.first)
+  end
+  
+  def test_should_not_alternate_odd_row
+    expected = <<-end_str
+      <tr class="post ui-collection-result">
+        <td class="post-title">second</td>
+      </tr>
+    end_str
+    assert_html_equal expected, @body.build_row(@collection[1])
+  end
+end
+
+class BodyWithAlternatingOddRowsTest < Test::Unit::TestCase
+  class Post
+    attr_accessor :title
+    
+    def initialize(title)
+      @title = title
+    end
+  end
+  
+  def setup
+    @collection = [Post.new('first'), Post.new('second'), Post.new('last')]
+    table = TableHelper::CollectionTable.new(@collection)
+    table.header :title
+    
+    @body = TableHelper::Body.new(table)
+    @body.alternate = :odd
+  end
+  
+  def test_should_alternate_odd_row
+    expected = <<-end_str
+      <tr class="post ui-collection-result ui-state-alternate">
+        <td class="post-title">second</td>
+      </tr>
+    end_str
+    assert_html_equal expected, @body.build_row(@collection[1])
+  end
+  
+  def test_should_not_alternate_even_row
+    expected = <<-end_str
+      <tr class="post ui-collection-result">
+        <td class="post-title">first</td>
+      </tr>
+    end_str
+    assert_html_equal expected, @body.build_row(@collection.first)
+  end
+end