tabletastic 0.1.0 → 0.1.1

data/README.rdoc

@@ -126,11 +126,10 @@ will produce html like:
 For even greater flexibility, you can pass +data+ a block:
 
   <% table_for(@posts) do |t| %>
-    <% t.data do %>
+    <% t.data :actions => :all do %>
       <%= t.cell(:title, :cell_html => {:class => "titlestring"}) %>
       <%= t.cell(:body, :heading => "Content") {|p| truncate(p.body, 30)} %>
       <%= t.cell(:author) {|p| p.author && link_to(p.author.name, p.author) } %>
-      <%= t.cell(:edit, :heading => '') {|p| link_to "Edit", edit_post_path(p) } %>
     <% end -%>
   <% end %>
 
@@ -143,6 +142,8 @@ will product html like:
         <th>Content</th>
         <th>Author</th>
         <th></th>
+        <th></th>
+        <th></th>
       </tr>
     </thead>
     <tbody>
@@ -152,9 +153,15 @@ will product html like:
         <td>
           <a href="/authors/1">Jim Bean</a>
         </td>
-        <td>
+        <td class="actions show_link">
+          <a href="/posts/1">Show</a>
+        </td>
+        <td class="actions edit_link">
           <a href="/posts/1/edit">Edit</a>
         </td>
+        <td class="actions destroy_link">
+          <a href="/posts/1/edit">Destroy</a> <!-- inline javascript omitted -->
+        </td>
       </tr>
       <tr class="post even" id="post_2">
         <td class="titlestring">Second Post</td>
@@ -162,17 +169,29 @@ will product html like:
         <td>
           <a href="/authors/2">Jack Daniels</a>
         </td>
-        <td>
+        <td class="actions show_link">
+          <a href="/posts/2">Show</a>
+        </td>
+        <td class="actions edit_link">
           <a href="/posts/2/edit">Edit</a>
         </td>
+        <td class="actions destroy_link">
+          <a href="/posts/2/edit">Destroy</a> <!-- inline javascript omitted -->
+        </td>
       </tr>
       <tr class="post odd" id="post_3">
         <td class="titlestring">Something else</td>
         <td>Blah!</td>
         <td></td>
-        <td>
+        <td class="actions show_link">
+          <a href="/posts/3">Show</a>
+        </td>
+        <td class="actions edit_link">
           <a href="/posts/3/edit">Edit</a>
         </td>
+        <td class="actions destroy_link">
+          <a href="/posts/3/edit">Destroy</a> <!-- inline javascript omitted -->
+        </td>
       </tr>
     </tbody>
   </table>

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/tabletastic.rb

@@ -2,40 +2,85 @@ module Tabletastic
 
   # returns and outputs a table for the given active record collection
   def table_for(collection, *args)
+    klass = default_class_for(collection)
     options = args.extract_options!
     options[:html] ||= {}
-    options[:html][:id] ||= get_id_for(collection)
+    options[:html][:id] ||= get_id_for(klass)
     concat(tag(:table, options[:html], true))
-    yield TableBuilder.new(collection, self)
+    yield TableBuilder.new(collection, klass, self)
     concat("</table>")
   end
 
-  def get_id_for(collection)
-    !collection.empty? && collection.first.class.to_s.tableize
+  private
+  # Finds the class representing the objects within the collection
+  def default_class_for(collection)
+    if collection.respond_to?(:proxy_reflection)
+      collection.proxy_reflection.klass
+    elsif !collection.empty?
+      collection.first.class
+    end
+  end
+
+  def get_id_for(klass)
+    klass.to_s.tableize
   end
 
   class TableBuilder
     @@association_methods = %w[display_name full_name name title username login value to_s]
     attr_accessor :field_labels
+    attr_reader   :collection, :klass
 
-    def initialize(collection, template)
-      @collection, @template = collection, template
+    def initialize(collection, klass, template)
+      @collection, @klass, @template = collection, klass, template
     end
 
     # builds up the fields that the table will include,
     # returns table head and body with all data
-    def data(*args, &block)
+    #
+    # Can be used one of three ways:
+    #
+    # * Alone, which will try to detect all content columns on the resource
+    # * With an array of methods to call on each element in the collection
+    # * With a block, which assumes you will use +cell+ method to build up
+    #   the table
+    #
+    #
+    def data(*args, &block) # :yields: tablebody
+      options = args.extract_options!
       if block_given?
         yield self
+        action_cells(options[:actions])
         @template.concat(head)
         @template.concat(body)
       else
-        @fields = args unless args.empty?
+        @fields = args.empty? ? fields : args
         @field_labels = fields.map { |f| f.to_s.humanize }
+        action_cells(options[:actions])
         [head, body].join("")
       end
     end
 
+    # individually specify a column, which will build up the header,
+    # and method or block to call on each resource in the array
+    #
+    # Should always be called within the block of +data+
+    #
+    # For example:
+    #
+    #   t.cell :blah
+    #
+    # will simply call +blah+ on each resource
+    #
+    # You can also provide a block, which allows for other helpers
+    # or custom formatting. Since by default erb will just call +to_s+
+    # on an any element output, you can more greatly control the output:
+    #
+    #   t.cell(:price) {|resource| number_to_currency(resource)}
+    #
+    # would output something like:
+    #
+    #   <td>$1.50</td>
+    #
     def cell(*args, &block)
       options = args.extract_options!
       @field_labels ||= []
@@ -43,12 +88,16 @@ module Tabletastic
 
       method_or_attribute = args.first.to_sym
 
+      method_or_attribute_or_proc = if block_given?
+        block.to_proc
+      else
+        method_or_attribute
+      end
+
       if cell_html = options.delete(:cell_html)
-        @fields << [method_or_attribute, cell_html]
-      elsif block_given?
-        @fields << block.to_proc
+        @fields << [method_or_attribute_or_proc, cell_html]
       else
-        @fields << method_or_attribute
+        @fields << method_or_attribute_or_proc
       end
 
       if heading = options.delete(:heading)
@@ -56,8 +105,9 @@ module Tabletastic
       else
         @field_labels << method_or_attribute.to_s.humanize
       end
-
-      return "" # Since this will likely be called with <%= erb %>, this suppresses strange output
+      # Since this will likely be called with <%= %> (aka 'concat'), explicitly return an empty string
+      # This suppresses unwanted output
+      return ""
     end
 
     def head
@@ -85,12 +135,12 @@ module Tabletastic
       @collection.inject("") do |rows, record|
         rowclass = @template.cycle("odd","even")
         rows += @template.content_tag_for(:tr, record, :class => rowclass) do
-          tds_for_row(record)
+          cells_for_row(record)
         end
       end
     end
 
-    def tds_for_row(record)
+    def cells_for_row(record)
       fields.inject("") do |cells, field_or_array|
         field = field_or_array
         if field_or_array.is_a?(Array)
@@ -113,9 +163,34 @@ module Tabletastic
       result.send(to_string) if to_string
     end
 
+    # Used internally to build up cells for common CRUD actions
+    def action_cells(actions)
+      return if actions.blank?
+      actions = [actions] if !actions.respond_to?(:each)
+      actions = [:show, :edit, :destroy] if actions == [:all]
+      actions.each do |action|
+        action_link(action.to_sym)
+      end
+    end
+
+    # Dynamically builds links for the action
+    def action_link(action)
+      html_class = "actions #{action.to_s}_link"
+      self.cell(action, :heading => "", :cell_html => {:class => html_class}) do |resource|
+        case action
+        when :show
+          @template.link_to("Show", resource)
+        when :edit
+          @template.link_to("Edit", @template.polymorphic_path(resource, :action => :edit))
+        when :destroy
+          @template.link_to("Destroy", resource, :method => :delete)
+        end
+      end
+    end
+
     def fields
       return @fields if defined?(@fields)
-      @fields = @collection.empty? ? [] : active_record_fields_for_object(@collection.first)
+      @fields = @collection.empty? ? [] : active_record_fields
     end
 
     protected
@@ -125,13 +200,14 @@ module Tabletastic
     end
 
 
-    def active_record_fields_for_object(obj)
+    def active_record_fields
+      return [] if klass.blank?
       # normal content columns
-      fields = obj.class.content_columns.map(&:name)
+      fields = klass.content_columns.map(&:name)
 
       # active record associations
-      associations = obj.class.reflect_on_all_associations(:belongs_to) if obj.class.respond_to?(:reflect_on_all_associations)
-      if associations
+      if klass.respond_to?(:reflect_on_all_associations)
+        associations = klass.reflect_on_all_associations(:belongs_to)
         associations = associations.map(&:name)
         fields += associations
       end
@@ -141,16 +217,18 @@ module Tabletastic
       fields = fields.map(&:to_sym)
     end
 
+    def content_tag(name, content = nil, options = nil, escape = true, &block)
+      @template.content_tag(name, content, options, escape, &block)
+    end
+
+    private
+
     def send_or_call(object, duck)
-      if duck.is_a?(Proc)
+      if duck.respond_to?(:call)
         duck.call(object)
       else
         object.send(duck)
       end
     end
-
-    def content_tag(name, content = nil, options = nil, escape = true, &block)
-      @template.content_tag(name, content, options, escape, &block)
-    end
   end
 end

data/spec/tabletastic_spec.rb

@@ -129,6 +129,57 @@ describe "Tabletastic#table_for" do
         end
       end
 
+      context "with options[:actions]" do
+        it "includes path to post for :show" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => :show))
+          end
+          output_buffer.should have_table_with_tag("a[@href=/posts/#{@post.id}]")
+          output_buffer.should have_table_with_tag("th", "")
+        end
+
+        it "should have a cell with default class 'actions' and the action name" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => :show))
+          end
+          output_buffer.should have_tag("td.actions.show_link") do |td|
+            td.should have_tag("a")
+          end
+        end
+
+        it "includes path to post for :edit" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => :edit))
+          end
+          output_buffer.should have_tag("a[@href=/posts/#{@post.id}/edit]", "Edit")
+        end
+
+        it "includes path to post for :destroy" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => :destroy))
+          end
+          output_buffer.should have_table_with_tag("a[@href=/posts/#{@post.id}]", "Destroy")
+          output_buffer.should have_table_with_tag("th", "")
+        end
+
+        it "includes path to post for :show and :edit" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => [:show, :edit]))
+          end
+          output_buffer.should have_tag("td:nth-child(3) a[@href=/posts/#{@post.id}]", "Show")
+          output_buffer.should have_tag("td:nth-child(4) a[@href=/posts/#{@post.id}/edit]", "Edit")
+        end
+
+        it "includes path to post for :all" do
+          table_for(@posts) do |t|
+            concat(t.data(:actions => :all))
+          end
+          output_buffer.should have_tag("td:nth-child(3) a[@href=/posts/#{@post.id}]", "Show")
+          output_buffer.should have_tag("td:nth-child(4) a[@href=/posts/#{@post.id}/edit]", "Edit")
+          output_buffer.should have_tag("td:nth-child(5) a[@href=/posts/#{@post.id}]", "Destroy")
+        end
+      end
+
       context "with a list of attributes" do
         before do
           table_for(@posts) do |t|
@@ -142,6 +193,20 @@ describe "Tabletastic#table_for" do
           output_buffer.should_not have_table_with_tag("th", "Body")
         end
       end
+
+      context "with a list of attributes and options[:actions]" do
+        it "includes path to post for :show" do
+          table_for(@posts) do |t|
+            concat(t.data(:title, :created_at, :actions => :show))
+          end
+          output_buffer.should have_tag("th:nth-child(1)", "Title")
+          output_buffer.should have_tag("th:nth-child(2)", "Created at")
+          output_buffer.should have_tag("th:nth-child(3)", "")
+          output_buffer.should_not have_tag("th", "Body")
+
+          output_buffer.should have_tag("td:nth-child(3) a[@href=/posts/#{@post.id}]")
+        end
+      end
     end
 
     context "with a block" do
@@ -205,6 +270,18 @@ describe "Tabletastic#table_for" do
         end
       end
 
+      context "with options[:actions]" do
+        it "includes path to post for :show" do
+          table_for(@posts) do |t|
+            t.data(:actions => :show) do
+              concat(t.cell(:title))
+              concat(t.cell(:body))
+            end
+          end
+          output_buffer.should have_table_with_tag("td:nth-child(3) a[@href=/posts/#{@post.id}]")
+        end
+      end
+
       context "and normal/association columns" do
         before do
           ::Post.stub!(:reflect_on_all_associations).with(:belongs_to).and_return([@mock_reflection_belongs_to_author])
@@ -236,7 +313,7 @@ describe TableBuilder do
     mock_everything
     ::Post.stub!(:content_columns).and_return([mock('column', :name => 'title'), mock('column', :name => 'body'), mock('column', :name => 'created_at')])
     @posts = [@post, Post.new]
-    @builder = TableBuilder.new(@posts, nil)
+    @builder = TableBuilder.new(@posts, ::Post, nil)
   end
 
   it "should detect attributes" do

data/tabletastic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tabletastic}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Davey"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-22}
   s.description = %q{A table builder for active record collections   that produces semantically rich and accessible markup}
   s.email = %q{josh@joshuadavey.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tabletastic
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Davey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -06:00
+date: 2009-11-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency