table_helper 0.0.5 → 0.1.0

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,29 +1,30 @@
-*SVN*
+== master
 
-*0.0.5* (June 22nd, 2008)
+== 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* (June 15th, 2008)
+== 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* (June 1st, 2008)
+== 0.0.3 / 2008-06-01
 
 * Remove dependency on set_or_append
 
-*0.0.2* (May 5th, 2008)
+== 0.0.2 / 2008-05-05
 
 * Updated documentation
 
-*0.0.1* (August 18th, 2007)
+== 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/{README → README.rdoc}

@@ -4,21 +4,21 @@
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Table_helper
-
 API
 
 * http://api.pluginaweek.org/table_helper
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13290-table_helper
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/table_helper
+* http://github.com/pluginaweek/table_helper
 
 Source
 
-* http://svn.pluginaweek.org/trunk/table_helper
+* git://github.com/pluginaweek/table_helper.git
 
 == Description
 
@@ -140,8 +140,8 @@ these types of tables by DRYing much of the html being generated.
 
 === Caveat Emptor
 
-See the API for more information on syntax and options.  You should only use
-table_helper if it fits the needs of your application.  Remember one of the key
+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.
@@ -149,7 +149,7 @@ 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://wiki.pluginaweek.org/Plugin_test_helper]
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 

data/Rakefile

@@ -3,46 +3,54 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'table_helper'
-PKG_VERSION        = '0.0.5'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'table_helper'
+  s.version           = '0.1.0'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Adds a helper method for generating HTML tables from collections'
+  
+  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 table_helper plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the table_helper plugin.'
+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    = 'TableHelper'
+  rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  s.platform        = Gem::Platform::RUBY
-  s.summary         = 'Adds a helper method for generating HTML tables from collections'
-  
-  s.files           = FileList['{lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
-  s.require_path    = 'lib'
-  s.autorequire     = 'table_helper'
-  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'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -51,14 +59,14 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  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'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -71,10 +79,10 @@ task :release => [:gem, :package] do
   ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/lib/table_helper.rb

@@ -1,182 +1,180 @@
 require 'table_helper/collection_table'
 
-module PluginAWeek #:nodoc:
-  # Provides a set of methods for turning a collection into a table.
-  # 
-  # == 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.
-  # 
-  # Support 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:
-  # 
-  #   <%= collection_table Person.find(:all) %>
-  # 
-  # ...is compiled to (formatted here for the sake of sanity):
-  # 
-  #   <table cellpadding="0" cellspacing="0">
-  #   <thead>
-  #     <tr>
-  #       <th class="first_name" scope="col">First Name</th>
-  #       <th class="last_name" scope="col">Last Name</th>
-  #       <th class="company_id" scope="col">Company</th>
-  #       <th class="role" scope="col">Role</th>
-  #     </tr>
-  #   </thead>
-  #   <tbody>
-  #     <tr class="row">
-  #       <td class="first_name">John</td>
-  #       <td class="last_name">Doe</td>
-  #       <td class="company_id">1</td>
-  #       <td class="role">President</td>
-  #     </tr>
-  #     <tr class="row">
-  #       <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 |header, body|
-  #       header.column :title
-  #       header.column :category
-  #       header.column :author
-  #       header.column :publish_date, 'Date<br \>Published'
-  #       header.column :num_comments, '# Comments'
-  #       header.column :num_trackbacks, '# Trackbacks'
-  #       
-  #       body.alternate = true
-  #       body.build do |row, post, index|
-  #         row.category       post.category.name
-  #         row.author         post.author.name
-  #         row.publish_date   time_ago_in_words(post.published_on)
-  #         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" id="posts">
-  #   <thead>
-  #     <tr>
-  #       <th class="title" scope="col">Title</th>
-  #       <th class="category" scope="col">Category</th>
-  #       <th class="author" scope="col">Author</th>
-  #       <th class="publish_date" scope="col">Date<br \>Published</th>
-  #       <th class="num_comments" scope="col"># Comments</th>
-  #       <th class="num_trackbacks" scope="col"># Trackbacks</th>
-  #     </tr>
-  #   </thead>
-  #   <tbody class="alternate">
-  #     <tr class="row">
-  #       <td class="title">Open-source projects: The good, the bad, and the ugly</td>
-  #       <td class="category">General</td>
-  #       <td class="author">John Doe</td>
-  #       <td class="publish_date">23 days</td>
-  #       <td class="num_comments">-</td>
-  #       <td class="num_trackbacks">-</td>
-  #     </tr>
-  #     <tr class="row alternate">
-  #       <td class="title">5 reasons you should care about Rails</td>
-  #       <td class="category">Rails</td><td class="author">John Q. Public</td>
-  #       <td class="publish_date">21 days</td>
-  #       <td class="num_comments">-</td>
-  #       <td class="num_trackbacks">-</td>
-  #     </tr>
-  #     <tr class="row">
-  #       <td class="title">Deprecation: Stop digging yourself a hole</td>
-  #       <td class="category">Rails</td>
-  #       <td class="author">Jane Doe</td>
-  #       <td class="publish_date">17 days</td>
-  #       <td class="num_comments">-</td>
-  #       <td class="num_trackbacks">-</td>
-  #     </tr>
-  #     <tr class="row alternate">
-  #       <td class="title">Jumpstart your Rails career at RailsConf 2007</td>
-  #       <td class="category">Conferences</td>
-  #       <td class="author">Jane Doe</td>
-  #       <td class="publish_date">4 days</td>
-  #       <td class="num_comments">-</td>
-  #       <td class="num_trackbacks">-</td>
-  #     </tr>
-  #     <tr class="row">
-  #       <td class="title">Getting some REST</td>
-  #       <td class="category">Rails</td>
-  #       <td class="author">John Doe</td>
-  #       <td class="publish_date">about 18 hours</td>
-  #       <td class="num_comments">-</td>
-  #       <td class="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, :footer => true) do |header, body, footer|
-  #       header.column :title
-  #       header.column :category
-  #       header.column :author
-  #       header.column :publish_date, 'Date<br \>Published'
-  #       header.column :num_comments, '# Comments'
-  #       header.column :num_trackbacks, '# Trackbacks'
-  #       
-  #       body.alternate = true
-  #       body.build do |row, post, index|
-  #         row.category       post.category.name
-  #         row.author         post.author.name
-  #         row.publish_date   time_ago_in_words(post.published_on)
-  #         row.num_comments   post.comments.empty? ? '-' : post.comments.size
-  #         row.num_trackbacks post.trackbacks.empty? ? '-' : post.trackbacks.size
-  #       end
-  #       
-  #       footer.cell :num_comments, @posts.inject(0) {|sum, post| sum += post.comments.size}
-  #       footer.cell :num_trackbacks, @posts.inject(0) {|sum, post| sum += post.trackbacks.size}
-  #     end
-  #   %>
-  module TableHelper
-    # Creates a new table based on the given collection
-    # 
-    # Configuration options:
-    # 
-    # * +class+ - Specify the type of objects expected in the collection if it can't be guessed from its contents.
-    # * +header+ - Specify if a header (thead) should be built into the table.  Default is true.
-    # * +footer+ - Specify if a footer (tfoot) should be built into the table.  Default is false.
-    def collection_table(collection, options = {}, html_options = {}, &block)
-      table = CollectionTable.new(collection, options, html_options)
-      table.build(&block)
-      table.html
-    end
+# Provides a set of methods for turning a collection into a table.
+# 
+# == 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">
+#   <thead>
+#     <tr>
+#       <th class="first_name" scope="col">First Name</th>
+#       <th class="last_name" scope="col">Last Name</th>
+#       <th class="company_id" scope="col">Company</th>
+#       <th class="role" scope="col">Role</th>
+#     </tr>
+#   </thead>
+#   <tbody>
+#     <tr class="row">
+#       <td class="first_name">John</td>
+#       <td class="last_name">Doe</td>
+#       <td class="company_id">1</td>
+#       <td class="role">President</td>
+#     </tr>
+#     <tr class="row">
+#       <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 |header, body|
+#       header.column :title
+#       header.column :category
+#       header.column :author
+#       header.column :publish_date, 'Date<br \>Published'
+#       header.column :num_comments, '# Comments'
+#       header.column :num_trackbacks, '# Trackbacks'
+#       
+#       body.alternate = true
+#       body.build do |row, post, index|
+#         row.category       post.category.name
+#         row.author         post.author.name
+#         row.publish_date   time_ago_in_words(post.published_on)
+#         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" id="posts">
+#   <thead>
+#     <tr>
+#       <th class="title" scope="col">Title</th>
+#       <th class="category" scope="col">Category</th>
+#       <th class="author" scope="col">Author</th>
+#       <th class="publish_date" scope="col">Date<br \>Published</th>
+#       <th class="num_comments" scope="col"># Comments</th>
+#       <th class="num_trackbacks" scope="col"># Trackbacks</th>
+#     </tr>
+#   </thead>
+#   <tbody class="alternate">
+#     <tr class="row">
+#       <td class="title">Open-source projects: The good, the bad, and the ugly</td>
+#       <td class="category">General</td>
+#       <td class="author">John Doe</td>
+#       <td class="publish_date">23 days</td>
+#       <td class="num_comments">-</td>
+#       <td class="num_trackbacks">-</td>
+#     </tr>
+#     <tr class="row alternate">
+#       <td class="title">5 reasons you should care about Rails</td>
+#       <td class="category">Rails</td><td class="author">John Q. Public</td>
+#       <td class="publish_date">21 days</td>
+#       <td class="num_comments">-</td>
+#       <td class="num_trackbacks">-</td>
+#     </tr>
+#     <tr class="row">
+#       <td class="title">Deprecation: Stop digging yourself a hole</td>
+#       <td class="category">Rails</td>
+#       <td class="author">Jane Doe</td>
+#       <td class="publish_date">17 days</td>
+#       <td class="num_comments">-</td>
+#       <td class="num_trackbacks">-</td>
+#     </tr>
+#     <tr class="row alternate">
+#       <td class="title">Jumpstart your Rails career at RailsConf 2007</td>
+#       <td class="category">Conferences</td>
+#       <td class="author">Jane Doe</td>
+#       <td class="publish_date">4 days</td>
+#       <td class="num_comments">-</td>
+#       <td class="num_trackbacks">-</td>
+#     </tr>
+#     <tr class="row">
+#       <td class="title">Getting some REST</td>
+#       <td class="category">Rails</td>
+#       <td class="author">John Doe</td>
+#       <td class="publish_date">about 18 hours</td>
+#       <td class="num_comments">-</td>
+#       <td class="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, :footer => true) do |header, body, footer|
+#       header.column :title
+#       header.column :category
+#       header.column :author
+#       header.column :publish_date, 'Date<br \>Published'
+#       header.column :num_comments, '# Comments'
+#       header.column :num_trackbacks, '# Trackbacks'
+#       
+#       body.alternate = true
+#       body.build do |row, post, index|
+#         row.category       post.category.name
+#         row.author         post.author.name
+#         row.publish_date   time_ago_in_words(post.published_on)
+#         row.num_comments   post.comments.empty? ? '-' : post.comments.size
+#         row.num_trackbacks post.trackbacks.empty? ? '-' : post.trackbacks.size
+#       end
+#       
+#       footer.cell :num_comments, @posts.inject(0) {|sum, post| sum += post.comments.size}
+#       footer.cell :num_trackbacks, @posts.inject(0) {|sum, post| sum += post.trackbacks.size}
+#     end
+#   %>
+module TableHelper
+  # Creates a new table based on the objects in the given collection
+  # 
+  # Configuration options:
+  # 
+  # * +class+ - Specify the type of objects expected in the collection if it can't be guessed from its contents.
+  # * +header+ - Specify if a header (thead) should be built into the table.  Default is true.
+  # * +footer+ - Specify if a footer (tfoot) should be built into the table.  Default is false.
+  def collection_table(collection, options = {}, html_options = {}, &block)
+    table = CollectionTable.new(collection, options, html_options)
+    table.build(&block)
+    table.html
   end
 end
 
 ActionController::Base.class_eval do
-  helper PluginAWeek::TableHelper
+  helper TableHelper
 end