table-for 2.2.0 → 3.0.0

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem 'rails', ">= 3.0.0"
-gem 'blocks', "~> 2.2.0"
+gem 'blocks', "~> 2.3.0"
 
 group :development do
   gem "rspec-rails", ">= 2.0.0.beta.20"
@@ -12,4 +12,5 @@ group :development do
   gem "with_model", '0.2.6'
   gem "bundler", "~> 1.3.5"
   gem "jeweler", "~> 1.8.4"
+  gem "debugger"
 end

data/Gemfile.lock

@@ -29,10 +29,19 @@ GEM
       i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
-    blocks (2.2.0)
-      blocks
+    blocks (2.3.0)
+      call_with_params
       rails (>= 3.0.0)
     builder (3.0.4)
+    call_with_params (0.0.1)
+      activesupport (>= 3.0.0)
+    columnize (0.3.6)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.1)
     erubis (2.7.0)
     git (1.2.5)
@@ -118,8 +127,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  blocks (~> 2.2.0)
+  blocks (~> 2.3.0)
   bundler (~> 1.3.5)
+  debugger
   jeweler (~> 1.8.4)
   mocha (= 0.10.3)
   rails (>= 3.0.0)

data/README.rdoc

@@ -1,197 +1,150 @@
 = table-for
 
-Table-for is a table builder for a collection of domain objects. It very easily allows the user to specify the columns to render and to override how the table, the header columns, the rows, and the columns are rendered.
+TableFor is a table builder for a collection of domain objects. It very easily allows the user to specify the columns to render and to override how the table, the header columns, the rows, and the columns are rendered.
 
 == Installation
 
-In <b>Rails 3</b>, add this to your Gemfile.
-
-  gem "table-for"
-
-In this example, I'm going to assume the following setup:
-From the console, I have generated a user model with email, first_name, and last_name fields, and generated a scaffold on that model
-  rails g scaffold user email:string first_name:string last_name:string --no-stylesheets
-
-In seeds.rb:
-  User.create! :email => "andrew.hunter@livingsocial.com", :first_name => "Andrew", :last_name => "Hunter"
-  User.create! :email => "todd.fisher@livingsocial.com", :first_name => "Todd", :last_name => "Fisher"
-  User.create! :email => "jon.phillips@livingsocial.com", :first_name => "Jon", :last_name => "Phillips"
-
-In users_controller.rb (index action)
-  @users = User.all
-
-== Sample Usage
-  <%= table_for @users, :table_html => {:style => "border: 1px solid black"},
-                        :sortable => true, :sort_url => users_path,
-                        :row_html => {:class => lambda { cycle('even', 'odd')},
-                                      :id => lambda {|user| "user-#{user.id}"}} do |table| %>
-    <% table.column :edit, :link_label => "Modify" %>
-    <% table.column :show %>
-    <% table.column :email, :label => "Email Address" %>
-    <% table.column :label => "Full Name", :sortable => false, :header_html => {:style => "color:orange"} do |user| %>
-      <%= "#{user.first_name} #{user.last_name}" %>
-    <% end %>
-    <% table.column :delete, :confirm => "Are you sure?" %>
-  <% end %>
-
-== Specifying the Columns to Use
-  <%= table_for @users do |table| %>
-    <% table.column :email %>
-    <% table.column :first_name %>
-    <% table.column :last_name %>
-  <% end %>
-
-Here, each column will send its respective column name to the user object: user.send(:email), user.send(:first_name), user.send(:last_name),
-to determine what data to output in each column.
-
-== Specifying the Label to Use for a Column
-  <%= table_for @users do |table| %>
-    <% table.column :email, :label => "Email Address" %>
-  <% end %>
-
-== Overriding the Default Way of Rendering a Column
-  <%= table_for @users do |table| %>
-    <% table.column :name do |user| %>
-      <%= "#{user.first_name} #{user.last_name}" %>
-    <% end %>
-  <% end %>
-
-  <!-- Or, since the name of the column is no longer used to figure out what data to render: -->
-  <%= table_for @users do |table| %>
-    <% table.column :full_name do |user| %>
-      <%= "#{user.first_name} #{user.last_name}" %>
-    <% end %>
-  <% end %>
-
-  <!-- Or the block name could be removed altogether and replaced with a label: -->
-  <%= table_for @users do |table| %>
-    <% table.column :label => "Full Name" do |user| %>
+In <b>Rails 3 or Rails 4</b>, add this to your Gemfile.
+
+  gem "table-for", :git => "git@github.com:hunterae/table-for.git"
+
+== Example
+The following example is purposely complex (in many cases, there are easier ways to do what is shown) in order to show a wide range of features that TableFor is capable of:
+
+  <%= table_for @users, :table_html => { :class => "table table-hover table-bordered" },
+                        :sortable => true,
+                        :sort_url => sort_admin_users_path,
+                        :link_namespace => :admin,
+                        :data_row_html => {
+                          :class => lambda { cycle('success', 'error', 'warning', 'info')},
+                          :id => lambda { |user| "user-#{user.id}" }} do |table| %>
+    <% table.column :data => "Modify", :link_action => :edit %>
+    <% table.column :data => "Show", :link_url => lambda { |user| admin_user_path(user) } %>
+    <% table.column :data => "Show 2.0", :link => true %>
+    <% table.column :email, :header => "Email Address" %>
+    <% table.column :first_name, :formatter => :downcase %>
+    <% table.column :last_name, :formatter => Proc.new { |last_name| last_name.upcase } %>
+    <% table.column :created_at, :formatter => [:strftime, "%m/%d/%y %I:%M %p"] %>
+    <% table.column :updated_at,
+                    :header => Proc.new {
+                      content_tag(:span, :class => "badge badge-success") do
+                        "Last Updated"
+                      end
+                    },
+                    :sortable => false,
+                    :header_column_html => { :style => "background-color:orange" },
+                    :data => Proc.new { time_ago_in_words table.current_row.updated_at } %>
+    <% table.column :full_name, :header => "Full Name", :order => "last_name, first_name" do |user| %>
       <%= "#{user.first_name} #{user.last_name}" %>
     <% end %>
-  <% end %>
-
-== Specifying Sortability
-  <!-- Globally: -->
-  <%= table_for @users, :sortable => true, :sort_url => users_path do |table| %>
-    <% table.column :id, :sortable => false %>
-    <% table.column :email %>
-    <% table.column :name, :order => "first_name,last_name" do |user| %>
-      <%= "#{user.first_name} #{user.last_name}" %>
+    <% table.header :full_name do |column, options| %>
+      <%= table.header_sort_link(column, options) do %>
+        <span class="label label-important">FULL NAME</span>
+      <% end %>
     <% end %>
-  <% end %>
-
-  <!-- Column by column basis: -->
-  <%= table_for @users, :sort_url => users_path do |table| %>
-    <% table.column :id %>
-    <% table.column :email, :sortable => true %>
-    <% table.column :name, :order => "first_name,last_name", :sortable => true do |user| %>
-      <%= "#{user.first_name} #{user.last_name}" %>
+    <% table.column :data => "Delete", :link_method => :delete, :link_confirm => "Are you sure?" %>
+    <% table.footer do %>
+      <div class="pull-right">
+        <%= will_paginate @users %>
+      </div>
     <% end %>
   <% end %>
 
-== Specifying the Table HTML
-  <%= table_for @users, :table_html => {:class => "table-for-table", :style => "border:1px solid black"} %>
-
-== Specifying the Row HTML
-  <!-- Header row -->
-  <%= table_for @users, :header_row_html => {:style => "background-color:blue", :class => "table-header"} do |table| %>
-    <% table.column :email %>
-  <% end %>
-
-  <!-- Data rows -->
-  <%= table_for @users, :row_html => {:style => "background-color:blue",
-                                      :class => lambda {"table-row #{cycle('even', 'odd')}"},
-                                      :id => lambda {|user| "user-#{user.id}"}} do |table| %>
-    <% table.column :email %>
-  <% end %>
-
-== Specifying the Column HTML
-  <!-- Header columns -->
-  <%= table_for @users, :header_html => {:class => lambda {|column| "header-column #{column.name}"} } do |table| %>
-    <!-- Override this columns' header's html -->
-    <% table.column :email, :header_html => {:style => "color: red"} %>
-    <% table.column :first_name %>
-    <% table.column :last_name %>
-  <% end %>
-
-  <!-- Data columns -->
-  <%= table_for @users, :column_html => {:class => lambda {|column| "data-column #{column.name}"} } do |table| %>
-    <!-- Override this column's html -->
-    <% table.column :email, :column_html => {:style => "background-color: red"} %>
-    <% table.column :first_name %>
-    <% table.column :last_name %>
-  <% end %>
-
-== Using Show, Edit, and Delete Columns
-  <%= table_for @users do |table| %>
-    <!-- Standard show link -->
-    <% table.column :show %>
-
-    <!-- Specify the controller action for the show link (used for generating the link) -->
-    <% table.column :show, :action => :display %>
-
-    <!-- Standard edit link -->
-    <% table.column :edit %>
-
-    <!-- Specify the text for the edit link -->
-    <% table.column :edit, :link_label => "Modify" %>
-
-    <!-- Specify the url for the edit link -->
-    <% table.column :edit, :url => lambda {|user| edit_user_path(user) } %>
-
-    <!-- Specify the controller action for the edit link (used for generating the link) -->
-    <% table.column :edit, :action => :modify %>
-
-    <!-- Specify the scope for the edit link (i.e. for nested resources) -->
-    <% table.column :edit, :scope => :admin %>
-
-    <!-- Specify the confirmation message for the confirm link -->
-    <% table.column :delete, :confirm => "Are you sure???" %>
-  <% end %>
+Produces (with Twitter Bootstrap):
+
+{<img src="https://raw.github.com/hunterae/table-for/master/example_table.png">}[http://example.com]
+
+For detailed instructions on how to run this example, along with comments on every line of the above table, check out the {Example Details}[https://github.com/hunterae/table-for/blob/master/example.rdoc].
+
+== table_for options
+The first argument to the table_for call will always be the array of domain objects. The second argument is a hash
+and is optional. It is any combination of the following options:
+
+sortable::
+  (defaults to false)
+  Sets whether all columns are sortable by default.
+  If this field is set to true, each column header will be generated as a link.
+sort_url::
+  (defaults to "")
+  Sets the url for the header column links. This will only affect columns that are sortable.
+link_namespace::
+  (defaults to nil)
+  Sets the default namespace for any links generated in the columns.
+  For example, a link_namespace of admin would try to build links within the admin namespace in the routes.
+  This can be specified as a string, an array, a domain object, or a symbol,
+  i.e. :link_namespace => [:admin, @post, :comments]
+table_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the table element,
+  i.e. :table_html => { :id => "my-table", :class => "table table-bordered", :cellpadding => 2 }.
+thead_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the thead element,
+  i.e. :thead_html => { :id => "thead-id" }
+  Note: If TableFor.render_thead_element is set to false, the thead surrounding element for the
+  header row will not be rendered.
+header_row_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the header row (tr) element,
+  i.e. :header_row_html => { :style => 'color: orange' }
+header_column_html::
+  (defaults to {})
+  Hash to specify the styles, classes, id, and other attributes applied to the header column (th) element.
+  The values in this hash can each be a string or a Proc that takes (optionally) the column object as a parameter
+  i.e. :header_column => { :style => "font-weight: bold" }, or :header_column => { :class => Proc.new {|column| "#{column.name}_header" } }
+tbody_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the tbody element,
+  i.e. :tbody_html => { :id => "body-id" }
+  Note: If TableFor.render_tbody_element is set to false, the tbody surrounding element for the
+  table data rows will not be rendered.
+data_row_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to each data row element (tr).
+  The values in this hash can each be a string or a Proc that takes (optionally) the current record as a parameter
+  i.e. :data_row_html => { :class => lambda { cycle('success', 'error', 'warning', 'info')}, :id => lambda { |user| "user-#{user.id}" } }
+data_column_html::
+  (defaults to {})
+  Hash to specify the styles, classes, id, and other attributes applied to the header column (th) element.
+  The values in this hash can each be a string or a Proc that takes (optionally) the current_record and (also optionally) the column object as parameters
+  i.e. :data_column_html => { :style => "font-weight: bold", :id => Proc.new {|record, column| "record-#{record.id}-#{column.name}" } }
+tfoot_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the tfoot element,
+  i.e. :tfoot_html => { :id => "tfoot-id" }
+  Note: If TableFor.render_tfoot_element is set to false, the tfoot surrounding element for the
+  footer row will not be rendered.
+footer_row_html::
+  (defaults to nil)
+  Hash to specify the styles, classes, id, and other attributes applied to the footer row (tr) element,
+  i.e. :footer_row_html => { :style => 'color: orange' }
+footer_column_html::
+  TODO
+
+== table_for column options
+data:: TODO
+header:: TODO
+formatter:: TODO
+sortable:: TODO
+sort_url:: TODO
+order:: TODO
+link_url:: TODO
+link_action:: TODO
+link_method:: TODO
+link_confirm:: TODO
+link_html::
+link:: TODO
+data_column_html:: TODO
+header_column_html:: TODO
+
+== table_for header options
+TODO
+
+== table_for footer options
+TODO
+
+== table_for configuration
+TODO
 
 == Using "Before" and "After" hooks
-  <!-- Adding a table footer -->
-  <%= table_for @users do |table| %>
-    <% table.column :email %>
-    <% table.define :footer do %>
-      <tfoot><tr><td colspan="<%= table.columns.length %>">My Footer</td></tr></tfoot>
-    <% end %>
-  <% end %>
-
-  <!-- Evaluating an expression before each row renders -->
-  <%= table_for @users do |table| %>
-    <% table.before :row do |user| %>
-      <!-- Perform some calculation -->
-      <% @evaluated_data = user.do_some_method %>
-    <% end %>
-    <% table.column :label => "First Column" do |user| %>
-      <!-- Use the stored value in some way -->
-      <%= @evaluated_data.method_1 %>
-    <% end %>
-    <% table.column :label => "Second Column" do |user| %>
-      <!-- Use the stored value in some other way -->
-      <%= @evaluated_data.method_2 %>
-    <% end %>
-  <% end %>
-
-  <!-- Adding a row before all the data rows -->
-  <%= table_for @users do |table| %>
-    <% table.before :rows do %>
-      <tr><td colspan="<%= table.columns.length %>">My First Row</td></tr>
-    <% end %>
-    <% table.column :email %>
-  <% end %>
-
-== Changing the Default Way table_for Renders
-  <!-- Don't render thead and tbody tags -->
-  <%= table_for @users do |table| %>
-    <% table.define :table do |options| %>
-      <%= content_tag :table, options[:table_html] do %>
-        <!-- Instead of table.render :header, do this -->
-        <%= table.render :header_row %>
-        <!-- Instead of table.render :body, do this -->
-        <%= table.render :rows %>
-      <% end %>
-    <% end %>
-    <% table.column :email %>
-  <% end %>
+TODO

data/VERSION

@@ -1 +1 @@
-2.2.0
+3.0.0

data/app/views/table_for/_table_for.html.erb

@@ -1,14 +1,18 @@
 <% table.define :table do |options| %>
-  <%= content_tag :table, table_for_table_html(options) do %>
+  <%= content_tag :table, table.table_html(options) do %>
     <%= table.render :header %>
     <%= table.render :body %>
-    <%# Purposely no default implementation for the tfoot block given, since most tables do not have footers. Block provided to for easy hook to add a footer %>
+    <%# Purposely no default implementation for the tfoot block given, since most tables do not have footers (provided to for easy hook to add a footer). %>
     <%= table.render :footer %>
   <% end %>
 <% end %>
 
 <% table.define :header do |options| %>
-  <%= content_tag :thead, options[:thead_html] do %>
+  <% if TableFor.render_thead_element %>
+    <%= content_tag :thead, options[:thead_html] do %>
+      <%= table.render :header_row %>
+    <% end %>
+  <% else %>
     <%= table.render :header_row %>
   <% end %>
 <% end %>
@@ -20,65 +24,64 @@
 <% end %>
 
 <% table.define :header_column do |column, options| %>
-  <%= content_tag :th, table_for_header_html(column, options) do %>
+  <%= content_tag :th, table.header_column_html(column, options) do %>
     <%= table.render "#{column.name}_header", column, column.options %>
   <% end %>
 <% end %>
 
-<%# Define header blocks for the edit, show, and delete columns (i.e. we want those columns to display with a blank header) %>
-<% [:edit, :show, :delete].each do |action| %>
-  <% table.define "#{action}_header", :label => false, :order => :id do |column, options| %>
-    <%= table_for_header_cell_data(column, options) %>
-  <% end %>
-<% end %>
-
 <%# Define a header block for each column, named using that column's name with the word "_header" appended to it %>
 <% table.define lambda {|column| "#{column.name}_header" }, :collection => table.columns do |column, options| %>
-  <%= table_for_header_cell_data(column, options) %>
+  <%= table.header_cell_content(column, options) %>
 <% end %>
 
 <% table.define :body do |options| %>
-  <%= content_tag :tbody, options[:tbody_html] do %>
-    <%= table.render :row, :collection => records %>
+  <% if TableFor.render_tbody_element %>
+    <%= content_tag :tbody, options[:tbody_html] do %>
+      <%= table.render :data_row, :collection => records %>
+    <% end %>
+  <% else %>
+    <%= table.render :data_row, :collection => records %>
   <% end %>
 <% end %>
 
-<% table.define :row do |record, options| %>
+<% table.define :data_row do |record, options| %>
   <% table.set_current_record(record) %>
-  <%= content_tag :tr, call_each_hash_value_if_proc(options[:row_html], record) do %>
-    <%= table.render :column, record, :collection => table.columns %>
+  <%= content_tag :tr, table.call_each_hash_value_with_params(options[:data_row_html], record) do %>
+    <%= table.render :data_column, record, :collection => table.columns %>
   <% end %>
 <% end %>
 
-<% table.define :column do |column, record, options| %>
-  <%= content_tag :td, call_each_hash_value_if_proc(options[:column_html], record, column) do %>
+<% table.define :data_column do |column, record, options| %>
+  <%= content_tag :td, table.call_each_hash_value_with_params(options[:data_column_html], record, column) do %>
     <%= table.render column.name, record, column, column.options %>
   <% end %>
 <% end %>
 
-<% table.define :edit, :action => :edit, :link_label => "Edit" do |record, column, options| %>
-  <% url = options[:url] ? call_if_proc(options[:url], record) : [options[:action], options[:scope], record].flatten %>
-  <% link_name = options[:link_field] ? record.send(options[:link_field]) : options[:link_label] %>
-  <%= link_to call_if_proc(link_name, record), url, options[:link_html] %>
+<%# Define a block for each column, named using that column's name %>
+<% table.define lambda {|column| column.name }, :collection => table.columns, :link_html => {} do |record, column, options| %>
+  <%= table.cell_content(record, column, options) %>
 <% end %>
 
-<% table.define :show, :action => nil, :link_label => "Show" do |record, column, options| %>
-  <% url = options[:url] ? call_if_proc(options[:url], record) : [options[:action], options[:scope], record].flatten %>
-  <% link_name = options[:link_field] ? record.send(options[:link_field]) : options[:link_label] %>
-  <%= link_to call_if_proc(link_name, record), url, options[:link_html] %>
-<% end %>
+<% table.define :footer do |options| %>
+  <% if TableFor.render_tfoot_element %>
+    <%= content_tag :tfoot, options[:tfoot_html] do %>
+      <%= table.render :footer_row %>
+    <% end %>
+  <% else %>
+    <%= table.render :footer_row %>
+  <% end %>
+<% end if table.defined?(:footer_content) %>
 
-<% table.define :delete, :action => nil, :link_html => {}, :link_label => "Delete" do |record, column, options| %>
-  <% url = options[:url] ? call_if_proc(options[:url], record) : [options[:action], options[:scope], record].flatten %>
-  <% confirm = options[:confirm] ? options[:confirm] : "Are you sure you want to delete this #{record.class.to_s.titleize}?" %>
-  <% method = options[:method] ? options[:method] : "delete" %>
-  <% link_name = options[:link_field] ? record.send(options[:link_field]) : options[:link_label] %>
-  <%= link_to call_if_proc(link_name, record), url, {:method => method, :confirm => confirm}.merge(options[:link_html]) %>
-<% end %>
+<% table.define :footer_row do |options| %>
+  <%= content_tag :tr, options[:footer_row_html] do %>
+    <%= table.render :footer_column %>
+  <% end %>
+<% end if table.defined?(:footer_content) %>
 
-<%# Define a block for each column, named using that column's name %>
-<% table.define lambda {|column| column.name }, :collection => table.columns do |record, column, options| %>
-  <%= table_for_cell_data(record, column, options) %>
-<% end %>
+<% table.define :footer_column do |options| %>
+  <%= content_tag :td, {:colspan => table.columns.length}.merge(table.blocks[:footer_content].options[:footer_column_html] || {}) do %>
+    <%= table.render :footer_content %>
+  <% end %>
+<% end if table.defined?(:footer_content) %>
 
 <%= table.render :table %>