crushlovely_table_helper 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTliYTQxODQzZWVkMGMzMTI5MmM5NWZjYTkyZDk4MzI5YWJkNzhlMw==
+  data.tar.gz: !binary |-
+    NzY0YTkwMGJmZTk5YzJlMmRjN2NlZTg2ZjdkZmEzM2U2ZmNmNmY1Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDM3ZGYyMzYyMjU5YjQwZDA1YjE4OGZmM2EzMDE1MGM1NDQ1MzZlMDc0Zjlj
+    MTY4ZGY1MDE0MmI4OTk3ODVlNzRiMzgyYTkzNTNmMTk4MDBlMmQyMWVmOThm
+    ODcyNzczNTEwNWE5ZjY2OGFhNzExMTkwNWY4YWNlY2UwZmNkZDg=
+  data.tar.gz: !binary |-
+    M2U2YTg2M2RiZGJmOGU5YzIwYTdiMmM2MTBlMGY1YmEzMWU1NDBmZTFkNjE1
+    NmYwNjFiODVlY2Q0YjI2MGE5ZDRjMmJiZWMzZjMwMGUyYjE1NTJkMWJiYjgy
+    MGUyYTk3NzVlNDBiOTU5MzVhMWY3NjBiYWQwMmUyZmEwZTJiODQ=

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+coverage
+pkg
+rdoc
+test/app_root/log
+test/app_root/script
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.8.7

data/CHANGELOG.rdoc

@@ -0,0 +1,51 @@
+== master
+
+== 0.2.2 / 2010-03-07
+
+* Fix footer failing to render when there are multiple cells [Richard Luther]
+* Fix TableHelper::RowBuilder failing on Ruby 1.9.1
+* Release gems via rake-gemcutter instead of rubyforge
+
+== 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/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+ 
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2010 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/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test table_helper."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = Dir['test/**/*_test.rb']
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test table_helper with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = Dir['test/**/*_test.rb']
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for table_helper."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'table_helper'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
+end

data/Readme.md

@@ -0,0 +1,16 @@
+# Table Helper
+
+**Important**: This gem is not actively maintained and only exists to support the older applications that still use it.  If you're starting a new application, use the excellent [Table Cloth](https://github.com/bobbytables/table_cloth) gem instead.
+
+This is the [Crush + Lovely](http://crushlovely.com) fork of the [Table Helper](http://github.com/pluginaweek/table_helper) gem. This fork contains the following changes:
+
+* Use of `ActiveSupport::SafeBuffer` so table content isn't auto-encoded.
+* Dependencies on Blankslate and Builder since this is being used in Rails apps that don't auto-require them.
+
+## Usage
+
+In your `Gemfile`, do the following:
+
+```
+gem 'crushlovely-table_helper', :require => 'table_helper'
+```

data/crushlovely_table_helper.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'table_helper/version'
+
+Gem::Specification.new do |s|
+  s.name              = "crushlovely_table_helper"
+  s.version           = TableHelper::VERSION
+  s.authors           = ["Aaron Pfeifer", "PJ Kelly"]
+  s.email             = "admin@crushlovely.com"
+  s.homepage          = "https://github.com/crushlovely/table_helper"
+  s.description       = "Adds a helper method for generating HTML tables from collections in Rails. Modifed by Crush + Lovely."
+  s.summary           = "HTML tables from collections in Rails."
+  s.require_paths     = ["lib"]
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- test/*`.split("\n")
+
+  s.add_dependency("blankslate")
+  s.add_dependency("builder")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("plugin_test_helper", ">= 0.3.2")
+end

data/init.rb

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

data/lib/table_helper.rb

@@ -0,0 +1,213 @@
+require 'blankslate'
+require 'builder'
+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

data/lib/table_helper/body.rb

@@ -0,0 +1,113 @@
+require 'table_helper/body_row'
+
+module TableHelper
+  # Represents the body of the table.  In HTML, you can think of this as
+  # the <tbody> tag of the table.
+  class Body < HtmlElement
+    # The css class to apply for all rows in the body
+    cattr_accessor :empty_caption_class
+    @@empty_caption_class = 'ui-collection-empty'
+
+    # The table this body is a part of
+    attr_reader :table
+
+    # If set to :odd or :even, every odd or even-numbered row will have the
+    # alternate class appended to its html attributes. Default is nil.
+    attr_accessor :alternate
+
+    # The caption to display in the collection is empty
+    attr_accessor :empty_caption
+
+    def initialize(table) #:nodoc:
+      super()
+
+      @table = table
+      @empty_caption = 'No matches found.'
+    end
+
+    def alternate=(value) #:nodoc:
+      raise ArgumentError, 'alternate must be set to :odd or :even' if value && ![:odd, :even].include?(value)
+      @alternate = value
+    end
+
+    # Builds the body of the table.  This includes the actual data that is
+    # generated for each object in the collection.
+    #
+    # +each+ expects a block that defines the data in each cell.  Each
+    # iteration of the block will provide the row within the table, the object
+    # being rendered, and the index of the object.  For example,
+    #
+    #   t.rows.each do |row, post, index|
+    #     row.title     "<div class=\"wrapped\">#{post.title}</div>"
+    #     row.category  post.category.name
+    #   end
+    #
+    # In addition, to specifying the data, you can also modify the html
+    # options of the row.  For more information on doing this, see the
+    # BodyRow class.
+    #
+    # If the collection is empty and +empty_caption+ is set on the body,
+    # then the actual body will be replaced by a single row containing the
+    # html that was stored in +empty_caption+.
+    #
+    # == Default Values
+    #
+    # Whenever possible, the default value of a cell will be set to the
+    # object's attribute with the same name as the cell.  For example,
+    # if a Post consists of the attribute +title+, then the cell for the
+    # title will be prepopulated with that attribute's value:
+    #
+    #   t.rows.each do |row, post index|
+    #     row.title post.title
+    #   end
+    #
+    # <tt>row.title</tt> is already set to post.category so there's no need to
+    # manually set the value of that cell.  However, it is always possible
+    # to override the default value like so:
+    #
+    #   t.rows.each do |row, post, index|
+    #     row.title     link_to(post.title, post_url(post))
+    #     row.category  post.category.name
+    #   end
+    def each(&block)
+      @builder = block
+    end
+
+    # Builds a row for an object in the table.
+    #
+    # The provided block should set the values for each cell in the row.
+    def build_row(object, index = table.collection.index(object))
+      row = BodyRow.new(object, self)
+      row.alternate = alternate ? index.send("#{alternate}?") : false
+      @builder.call(row.builder, object, index) if @builder
+      row.html
+    end
+
+    private
+      def tag_name
+        'tbody'
+      end
+
+      def content
+        content = ActiveSupport::SafeBuffer.new
+
+        if table.empty? && @empty_caption
+          # No objects to display
+          row = Row.new(self)
+          row[:class] = empty_caption_class
+
+          html_options = {}
+          html_options[:colspan] = table.header.columns.size if table.header.columns.size > 1
+          row.cell nil, @empty_caption, html_options
+
+          content << row.html
+        else
+          table.collection.each_with_index do |object, i|
+            content << build_row(object, i)
+          end
+        end
+
+        content
+      end
+  end
+end