tangofoxtrot-table_helper 0.2.2

data/CHANGELOG.rdoc

@@ -0,0 +1,45 @@
+== master
+
+== 0.2.1 / 2009-04-25
+
+* Automatically determine the colspan for the last footer to match the number of headers
+* Fix default headers including all model columns when using :select in the collection query
+
+== 0.2.0 / 2009-04-25
+
+* Reorganize documentation
+* Allow css classes to be customized
+* Use the jQuery UI css naming convention
+* Allow multiple headers to be created at once
+* No longer allow pre-existing headers to be customized (instead must re-define all headers)
+* Remove :header / :footer options
+* Simplify public interface
+
+== 0.1.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+* Update tests to use ActionView::TestCase
+
+== 0.0.5 / 2008-06-22
+
+* Remove log files from gems
+
+== 0.0.4 / 2008-06-15
+
+* Support cell/column names that conflict with existing method names on the Row/Header classes
+* Avoid string evaluation for dynamic methods
+
+== 0.0.3 / 2008-06-01
+
+* Remove dependency on set_or_append
+
+== 0.0.2 / 2008-05-05
+
+* Updated documentation
+
+== 0.0.1 / 2007-08-18
+
+* Add README documentation
+* Add gem dependency on set_or_append
+* Refactor test method names
+* Convert dos newlines to unix newlines

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Aaron Pfeifer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,171 @@
+= table_helper
+
++table_helper+ adds a helper method for generating HTML tables from collections.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/table_helper
+
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13290-table_helper
+
+Development
+
+* http://github.com/pluginaweek/table_helper
+
+Source
+
+* git://github.com/pluginaweek/table_helper.git
+
+== Description
+
+Tables of summary data for ActiveRecord models are often formatted in the same
+way by creating a header indicating the attribute and a body containing the
+data from each record in separate rows.  table_helper makes it easier to create
+these types of tables by DRYing much of the html being generated.
+
+== Usage
+
+=== Basic Example
+
+  <%= collection_table Person.find(:all) %>
+
+...is compiled to (formatted here for the sake of sanity):
+
+  <table cellpadding="0" cellspacing="0" class="people ui-collection">
+  <thead>
+    <tr>
+      <th class="person-first_name" scope="col">First Name</th>
+      <th class="person-last_name" scope="col">Last Name</th>
+      <th class="person-company_id" scope="col">Company</th>
+      <th class="person-role" scope="col">Role</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class="person ui-collection-result">
+      <td class="person-first_name">John</td>
+      <td class="person-last_name">Doe</td>
+      <td class="person-company_id">1</td>
+      <td class="person-role">President</td>
+    </tr>
+    <tr class="person ui-collection-result">
+      <td class="person-first_name">Jane</td>
+      <td class="person-last_name">Doe</td>
+      <td class="person-company_id">1</td>
+      <td class="person-role">Vice-President</td>
+    </tr>
+  </tbody>
+  <table>
+
+=== Advanced Example
+
+  <%=
+    collection_table(@posts, :id => 'posts', :class => 'summary') do |t|
+      t.header :title
+      t.header :category
+      t.header :author
+      t.header :publish_date, 'Date<br \>Published'
+      t.header :num_comments, '# Comments'
+      t.header :num_trackbacks, '# Trackbacks'
+      
+      t.rows.alternate = :odd
+      t.rows.each do |row, post, index|
+        # Notice there's no need to explicitly define the title
+        row.category       post.category.name
+        row.author         post.author.name
+        row.publish_date   time_ago_in_words(post.published_at)
+        row.num_comments   post.comments.empty? ? '-' : post.comments.size
+        row.num_trackbacks post.trackbacks.empty? ? '-' : post.trackbacks.size
+      end
+      
+      t.footer :num_comments, @posts.inject(0) {|sum, post| sum += post.comments.size}
+      t.footer :num_trackbacks, @posts.inject(0) {|sum, post| sum += post.trackbacks.size}
+    end
+  %>
+
+...is compiled to (formatted here for the sake of sanity):
+
+  <table cellpadding="0" cellspacing="0" class="summary posts ui-collection" id="posts">
+  <thead>
+    <tr>
+      <th class="post-title" scope="col">Title</th>
+      <th class="post-category" scope="col">Category</th>
+      <th class="post-author" scope="col">Author</th>
+      <th class="post-publish_date" scope="col">Date<br \>Published</th>
+      <th class="post-num_comments" scope="col"># Comments</th>
+      <th class="post-num_trackbacks" scope="col"># Trackbacks</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class="post ui-collection-result">
+      <td class="post-title">Open-source projects: The good, the bad, and the ugly</td>
+      <td class="post-category">General</td>
+      <td class="post-author">John Doe</td>
+      <td class="post-publish_date">23 days</td>
+      <td class="post-num_comments">-</td>
+      <td class="post-num_trackbacks">-</td>
+    </tr>
+    <tr class="post ui-collection-result ui-state-alternate">
+      <td class="post-title">5 reasons you should care about Rails</td>
+      <td class="post-category">Rails</td>
+      <td class="post-author">John Q. PUblic</td>
+      <td class="post-publish_date">21 days</td>
+      <td class="post-num_comments">-</td>
+      <td class="post-num_trackbacks">-</td>
+    </tr>
+    <tr class="post ui-collection-result">
+      <td class="post-title">Deprecation: Stop digging yourself a hole</td>
+      <td class="post-category">Rails</td>
+      <td class="post-author">Jane Doe</td>
+      <td class="post-publish_date">17 days</td>
+      <td class="post-num_comments">-</td>
+      <td class="post-num_trackbacks">-</td>
+    </tr>
+    <tr class="post ui-collection-result ui-state-alternate">
+      <td class="post-title">Jumpstart your Rails career at RailsConf 2007</td>
+      <td class="post-category">Conferences</td>
+      <td class="post-author">Jane Doe</td>
+      <td class="post-publish_date">4 days</td>
+      <td class="post-num_comments">-</td>
+      <td class="post-num_trackbacks">-</td>
+    </tr>
+    <tr class="post ui-collection-result">
+      <td class="post-title">Getting some REST</td>
+      <td class="post-category">Rails</td>
+      <td class="post-author">John Doe</td>
+      <td class="post-publish_date">about 18 hours</td>
+      <td class="post-num_comments">-</td>
+      <td class="post-num_trackbacks">-</td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td class="post-num_comments">0</td>
+      <td class="post-num_trackbacks" colspan="5">0</td>
+    </tr>
+  </tfoot>
+  </table>
+
+=== Caveat Emptor
+
+See the API for more information on syntax, options, and examples.  You should only
+use table_helper if it fits the needs of your application.  Remember one of the key
+principles of Rails, KISS (Keep It Simple Stupid).  table_helper works really
+well when you need to quickly output several of these types of summary tables.
+If this is not the case, you may want to stick to using actual html.
+
+== Testing
+
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
+
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
+== Dependencies
+
+* Rails 2.0 or later

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'table_helper'
+  s.version           = '0.2.2'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Adds a helper method for generating HTML tables from collections in Rails'
+  s.description       = s.summary
+  
+  s.files             = FileList['{lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['test/app_root/{log,log/*,script,script/*}']
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test the #{spec.name} plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = spec.test_files
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = spec.name
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem.'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
+end
+
+desc 'Publish the API documentation.'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new.configure
+  ruby_forge.login
+  
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'table_helper'

data/lib/table_helper.rb

@@ -0,0 +1,211 @@
+require 'table_helper/collection_table'
+
+# Provides a set of methods for turning a collection into a table
+module TableHelper
+  # Generates a new table for the given collection.
+  # 
+  # == Basic Example
+  # 
+  # This example shows the most basic usage of +collection_table+ which takes
+  # information about a collection, the objects in them, the columns defined
+  # for the class, and generates a table based on that.
+  # 
+  # Suppose you have a table generated by a migration like so:
+  # 
+  #   class CreatePeople < ActiveRecord::Base
+  #     def self.up
+  #       create_table do |t|
+  #         t.string :first_name
+  #         t.string :last_name
+  #         t.integer :company_id
+  #         t.string :role
+  #       end
+  #     end
+  #   end
+  # 
+  # ...then invoking the helper within a view:
+  # 
+  #   <%= collection_table Person.find(:all) %>
+  # 
+  # ...is compiled to (formatted here for the sake of sanity):
+  # 
+  #   <table cellpadding="0" cellspacing="0" class="posts ui-collection">
+  #   <thead>
+  #     <tr>
+  #       <th class="person-first_name" scope="col">First Name</th>
+  #       <th class="person-last_name" scope="col">Last Name</th>
+  #       <th class="person-company_id" scope="col">Company</th>
+  #       <th class="person-role" scope="col">Role</th>
+  #     </tr>
+  #   </thead>
+  #   <tbody>
+  #     <tr class="person ui-collection-result">
+  #       <td class="person-first_name">John</td>
+  #       <td class="person-last_name">Doe</td>
+  #       <td class="person-company_id">1</td>
+  #       <td class="person-role">President</td>
+  #     </tr>
+  #     <tr class="person ui-collection-result">
+  #       <td class="first_name">Jane</td>
+  #       <td class="last_name">Doe</td>
+  #       <td class="company_id">1</td>
+  #       <td class="role">Vice-President</td>
+  #     </tr>
+  #   </tbody>
+  #   <table>
+  # 
+  # == Advanced Example
+  # 
+  # This example below shows how +collection_table+ can be customized to show
+  # specific headers, content, and footers.
+  # 
+  #   <%=
+  #     collection_table(@posts, :id => 'posts', :class => 'summary') do |t|
+  #       t.header :title
+  #       t.header :category
+  #       t.header :author
+  #       t.header :publish_date, 'Date<br \>Published'
+  #       t.header :num_comments, '# Comments'
+  #       t.header :num_trackbacks, '# Trackbacks'
+  #       
+  #       t.rows.alternate = :odd
+  #       t.rows.each do |row, post, index|
+  #         row.category       post.category.name
+  #         row.author         post.author.name
+  #         row.publish_date   time_ago_in_words(post.published_at)
+  #         row.num_comments   post.comments.empty? ? '-' : post.comments.size
+  #         row.num_trackbacks post.trackbacks.empty? ? '-' : post.trackbacks.size
+  #       end
+  #     end
+  #   %>
+  # 
+  # ...is compiled to (formatted here for the sake of sanity):
+  # 
+  #   <table cellpadding="0" cellspacing="0" class="summary posts ui-collection" id="posts">
+  #   <thead>
+  #     <tr>
+  #       <th class="post-title" scope="col">Title</th>
+  #       <th class="post-category" scope="col">Category</th>
+  #       <th class="post-author" scope="col">Author</th>
+  #       <th class="post-publish_date" scope="col">Date<br \>Published</th>
+  #       <th class="post-num_comments" scope="col"># Comments</th>
+  #       <th class="post-num_trackbacks" scope="col"># Trackbacks</th>
+  #     </tr>
+  #   </thead>
+  #   <tbody>
+  #     <tr class="post ui-collection-result">
+  #       <td class="post-title">Open-source projects: The good, the bad, and the ugly</td>
+  #       <td class="post-category">General</td>
+  #       <td class="post-author">John Doe</td>
+  #       <td class="post-publish_date">23 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #     <tr class="post ui-collection-result ui-state-alternate">
+  #       <td class="post-title">5 reasons you should care about Rails</td>
+  #       <td class="post-category">Rails</td>
+  #       <td class="author">John Q. Public</td>
+  #       <td class="post-publish_date">21 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #     <tr class="post ui-collection-result">
+  #       <td class="post-title">Deprecation: Stop digging yourself a hole</td>
+  #       <td class="post-category">Rails</td>
+  #       <td class="post-author">Jane Doe</td>
+  #       <td class="post-publish_date">17 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #     <tr class="post ui-collection-result ui-state-alternate">
+  #       <td class="post-title">Jumpstart your Rails career at RailsConf 2007</td>
+  #       <td class="post-category">Conferences</td>
+  #       <td class="post-author">Jane Doe</td>
+  #       <td class="post-publish_date">4 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #     <tr class="post ui-collection-result">
+  #       <td class="post-title">Getting some REST</td>
+  #       <td class="post-category">Rails</td>
+  #       <td class="post-author">John Doe</td>
+  #       <td class="post-publish_date">about 18 hours</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #   </tbody>
+  #   </table>
+  # 
+  # == Creating footers
+  # 
+  # Footers allow you to show some sort of summary information based on the
+  # data displayed in the body of the table.  Below is an example:
+  # 
+  #   <%
+  #     collection_table(@posts) do |t|
+  #       t.header :title
+  #       t.header :category
+  #       t.header :author
+  #       t.header :publish_date, 'Date<br \>Published'
+  #       t.header :num_comments, '# Comments'
+  #       t.header :num_trackbacks, '# Trackbacks'
+  #       
+  #       t.rows.alternate = :odd
+  #       t.rows.each do |row, post, index|
+  #         row.category       post.category.name
+  #         row.author         post.author.name
+  #         row.publish_date   time_ago_in_words(post.published_at)
+  #         row.num_comments   post.comments.empty? ? '-' : post.comments.size
+  #         row.num_trackbacks post.trackbacks.empty? ? '-' : post.trackbacks.size
+  #       end
+  #       
+  #       t.footer :num_comments, @posts.inject(0) {|sum, post| sum += post.comments.size}
+  #       t.footer :num_trackbacks, @posts.inject(0) {|sum, post| sum += post.trackbacks.size}
+  #     end
+  #   %>
+  # 
+  # ...is compiled to:
+  # 
+  #   <table cellpadding="0" cellspacing="0" class="posts ui-collection">
+  #   <thead>
+  #     <tr>
+  #       <th class="post-title" scope="col">Title</th>
+  #       <th class="post-category" scope="col">Category</th>
+  #       <th class="post-author" scope="col">Author</th>
+  #       <th class="post-publish_date" scope="col">Date<br \>Published</th>
+  #       <th class="post-num_comments" scope="col"># Comments</th>
+  #       <th class="post-num_trackbacks" scope="col"># Trackbacks</th>
+  #     </tr>
+  #   </thead>
+  #   <tbody>
+  #     <tr class="post ui-collection-result">
+  #       <td class="post-title">Open-source projects: The good, the bad, and the ugly</td>
+  #       <td class="post-category">General</td>
+  #       <td class="post-author">John Doe</td>
+  #       <td class="post-publish_date">23 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #     <tr class="post ui-collection-result ui-state-alternate">
+  #       <td class="post-title">5 reasons you should care about Rails</td>
+  #       <td class="post-category">Rails</td><td class="author">John Q. Public</td>
+  #       <td class="post-publish_date">21 days</td>
+  #       <td class="post-num_comments">-</td>
+  #       <td class="post-num_trackbacks">-</td>
+  #     </tr>
+  #   </tbody>
+  #   <tfoot>
+  #     <tr>
+  #       <td class="post-num_comments">0</td>
+  #       <td class="post-num_trackbacks" colspan="5">0</td>
+  #     </tr>
+  #   </tfoot>
+  #   <table>
+  def collection_table(collection, klass = nil, html_options = {}, &block)
+    CollectionTable.new(collection, klass, html_options, &block).html
+  end
+end
+
+ActionController::Base.class_eval do
+  helper TableHelper
+end