table_cloth 0.1.2 → 0.2.0

data/README.md

@@ -37,7 +37,7 @@ class UserTable < TableCloth::Base
   # Columns can be provided a block
   #
   # column :name do |object|
-  #   object.downcase
+  #   object.name.downcase
   # end
   #
   # Columns can also have conditionals if you want.
@@ -55,7 +55,9 @@ class UserTable < TableCloth::Base
   # Pass a block with an arity of 2, (object, view context).
   # You can add as many actions as you want.
   #
-  # action {|object, view| view.link_to "Edit", edit_object_path(object) }
+  # actions do
+  #   action {|object| link_to "Edit", edit_object_path(object) }
+  # end
 end
 ```
 
@@ -104,8 +106,8 @@ A lot of tables have an actions column to give you the full CRUD effect. They ca
 ```
 class UserTable < TableCloth::Base
   column :name
-  action {|object, view| view.link_to 'View', object }
-  action(if: :admin?) {|object, view| view.link_to 'Delete', object, method: :delete }
+  action {|object| link_to 'View', object }
+  action(if: :admin?) {|object| link_to 'Delete', object, method: :delete }
 
   def admin?
     view.current_user.admin?
@@ -131,6 +133,22 @@ TableCloth::Configuration.configure do |config|
 end
 ```
 
+You can also configure specific tables separately.
+
+```ruby
+class UserTable < TableCloth::Base
+  column :name, :email
+  action(:edit) {|object| link_to "Edit", edit_object_path(object) }
+  
+  config.table.class = ''
+  config.thead.class = ''
+  config.th.class    = ''
+  config.tbody.class = ''
+  config.tr.class    = ''
+  config.td.class    = ''
+end
+```
+
 You can set any value on table element configurations. For example:
 
 ```ruby
@@ -138,6 +156,36 @@ config.table.cellpadding = 1
 config.td.valign = 'top'
 ```
 
+You also have the option to specify options on a specific column with the ```td_options``` key.
+
+```ruby
+class UserTable < TableCloth::Base
+  column :name, td_options: { class: "awesome-column" }
+end
+```
+
+Not good enough? Fine... you can do row / column specific config as well for a TD.
+
+```ruby
+class UserTable < TableCloth::Base
+  column :name do |user|
+    [user.name, {class: "#{user.type}-user"}]
+  end
+end
+
+```
+
+This would render something alow the lines of:
+
+```html
+<td class="admin-user">Robert Ross</td>
+```
+
+## Thanks
+
+- TableCloth was built during my open source time at [philosophie](http://gophilosophie.com)
+- simple_form for the idea of ```simple_table_for```
+
 ## Contributing
 
 1. Fork it
@@ -145,4 +193,4 @@ config.td.valign = 'top'
 3. CREATE A SPEC.
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+6. Create new Pull Request

data/lib/generators/templates/table.rb

@@ -23,5 +23,7 @@ class <%= class_name %>Table < TableCloth::Base
   # Pass a block with an arity of 2, (object, view context).
   # You can add as many actions as you want.
   #
-  # action {|object, view| view.link_to "Edit", edit_object_path(object) }
-end
+  # actions do
+  #   action {|object| link_to "Edit", edit_object_path(object) }
+  # end
+end

data/lib/table_cloth.rb

@@ -8,6 +8,7 @@ module TableCloth
   autoload :Builder, 'table_cloth/builder'
   autoload :Column, 'table_cloth/column'
   autoload :Action, 'table_cloth/action'
+  autoload :Actions, 'table_cloth/actions'
   autoload :Presenter, 'table_cloth/presenter'
   autoload :ActionViewExtension, 'table_cloth/action_view_extension'
 
@@ -19,10 +20,10 @@ module TableCloth
     autoload :Action, 'table_cloth/columns/action'
   end
 
-  extend self
-  def self.config_for(type)
+  def config_for(type)
     Configuration.config_for(type)
   end
+  module_function :config_for
 end
 
 TableCloth::Base.presenter ::TableCloth::Presenters::Default

data/lib/table_cloth/actions.rb

@@ -0,0 +1,23 @@
+module TableCloth
+  class Actions
+    attr_reader :column, :options
+
+    def initialize(options={}, &block)
+      @options = options
+      @column = Columns::Action.new(:actions, options)
+
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
+    end
+
+    def action(*args, &block)
+      options        = args.extract_options! || {}
+      options[:proc] = block if block_given?
+
+      column.actions << Action.new(options)
+    end
+
+    def all
+      column.actions
+    end
+  end
+end

data/lib/table_cloth/base.rb

@@ -1,5 +1,7 @@
 module TableCloth
   class Base
+    NoPresenterError = Class.new(Exception)
+
     attr_reader :collection, :view
 
     def initialize(collection, view)
@@ -29,11 +31,9 @@ module TableCloth
       end
 
       def presenter(klass=nil)
-        if klass
-          @presenter = klass
-        else
-          @presenter || (superclass.respond_to?(:presenter) ? superclass.presenter : raise("No Presenter"))
-        end
+        return @presenter = klass if klass
+
+        @presenter || (superclass.respond_to?(:presenter) ? superclass.presenter : NoPresenterError.new("No Presenter"))
       end
 
       def column(*args, &block)
@@ -61,20 +61,13 @@ module TableCloth
         @columns[name] = column
       end
 
-      def action(*args, &block)
-        options        = args.extract_options! || {}
-        options[:proc] = block if block_given?
-
-        add_action Action.new(options)
-      end
-
-      def add_action(action)
-        unless has_actions?
-          columns[:actions] = Columns::Action.new(:actions)
+      def actions(options={}, &block)
+        if block_given?
+          actions = Actions.new(options, &block)
+          columns[:actions] = actions.column
         end
 
-        columns[:actions].actions << action
-        action
+        columns[:actions].actions
       end
 
       def has_actions?

data/lib/table_cloth/column.rb

@@ -9,7 +9,7 @@ module TableCloth
 
     def value(object, view, table=nil)
       if options[:proc] && options[:proc].respond_to?(:call)
-        view.capture(object, view, &options[:proc])
+        view.instance_exec(object, view, &options[:proc])
       else
         object.send(name)
       end

data/lib/table_cloth/columns/action.rb

@@ -2,11 +2,10 @@ module TableCloth
   module Columns
     class Action < Column
       def value(object, view_context, table)
-        actions_html = actions.inject('') do |links, action|
+        actions_html = actions.each_with_object('') do |action, links|
           if action.available?(table)
-            links + "\n" + view_context.capture(object, view_context, &action.options[:proc])
-          else
-            links
+            links << "\n"
+            links << view_context.instance_exec(object, view_context, &action.options[:proc])
           end
         end
 

data/lib/table_cloth/presenters/default.rb

@@ -21,7 +21,16 @@ module TableCloth
 
       def render_td(column, object)
         td_options = column.options.delete(:td_options) || {}
-        wrapper_tag(:td, column.value(object, view_context, table), td_options)
+        value = column.value(object, view_context, table)
+
+        if value.is_a?(Array)
+          options = value.pop
+          value   = value.shift
+
+          td_options.update(options)
+        end
+
+        wrapper_tag(:td, value, td_options)
       end
 
       def render_header

data/lib/table_cloth/version.rb

@@ -1,3 +1,3 @@
 module TableCloth
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/lib/actions_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe TableCloth::Actions do
+  subject { TableCloth::Actions }
+
+  context "block syntax" do
+
+    it "accepts a block" do
+      actions = subject.new do
+        action { 'Edit' }
+      end
+
+      actions.column.should have(1).actions
+    end
+
+    it "accepts options with a block" do
+      expect do
+        subject.new(class: "actions") do
+          action { "Edit" }
+        end
+      end.not_to raise_error
+    end
+
+    it ".all returns all actions for the column" do
+      actions = subject.new { action { "Edit" } }
+      actions.should have(1).all
+    end
+  end
+end

data/spec/lib/base_spec.rb

@@ -48,12 +48,15 @@ describe TableCloth::Base do
     end
 
     it '.column_names includes actions when given' do
-      subject.action { '/' }
+      subject.actions { action { } }
       subject.new([], view_context).column_names.should include 'Actions'
     end
 
     it '.column_names does not include actions if all action conditions fail' do
-      subject.action(if: :admin?) { '/' }
+      subject.actions do
+        action(if: :admin?) { '/' }
+      end
+
       table = subject.new([], view_context)
       def table.admin?
         false
@@ -63,8 +66,11 @@ describe TableCloth::Base do
     end
 
     it '.column_names include actions when only partial are available' do
-      subject.action(if: :admin?) { '/' }
-      subject.action(if: :awesome?) { '/' }
+      subject.actions do
+        action(if: :admin?) { '/' }
+        action(if: :awesome?) { '/' }
+      end
+      
       table = subject.new([], view_context)
       def table.admin?
         false
@@ -134,29 +140,13 @@ describe TableCloth::Base do
   end
 
   context 'actions' do
-    it 'has an action method' do
-      subject.should respond_to :action
-    end
-
-    it 'it adds an acion' do
-      subject.action { '/' }
-      subject.columns[:actions].should have(1).actions
-    end
-
-    context 'conditionals' do
-      let!(:table_class) { Class.new(DummyTable) }
-      subject { table_class.new([dummy_model], view_context) }
-
-      it 'accepts if condition' do
-        action = table_class.action(if: :admin?) { '/conditioned' }
-        action.available?(subject).should be_true
+    it "takes a block" do
+      subject.actions do
+        action { 'Edit' }
+        action { 'Delete' }
       end
 
-
-      it 'accepts unless condition' do
-        action = table_class.action(unless: :admin?) { '/conditioned' }
-        action.available?(subject).should be_false
-      end
+      subject.columns[:actions].should have(2).actions
     end
   end
 end

data/spec/lib/builder_spec.rb

@@ -8,7 +8,9 @@ describe TableCloth::Builder do
     it 'can build a table on the fly with a block' do
       new_table = subject.build([], view_context) do |table|
         table.column :name
-        table.action(:edit) { '/model/1/edit' }
+        table.actions do
+          action { '/model/1/edit' }
+        end
       end
 
       new_table.table.columns.length.should == 2

data/spec/lib/columns/action_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+ require 'spec_helper'
 
 describe TableCloth::Columns::Action do
   let(:view_context) { ActionView::Base.new }
@@ -14,9 +14,10 @@ describe TableCloth::Columns::Action do
   subject { TableCloth::Columns::Action.new(object, view_context) }
 
   it '.value returns all actions in HTML' do
-    dummy_table.action {|object, view| view.link_to "Edit", "#{object.id}"}
+    dummy_table.actions do
+      action {|object, view| view.link_to "Edit", "#{object.id}"}
+    end
     presenter = TableCloth::Presenters::Default.new([dummy_model], dummy_table, view_context)
-
     doc = Nokogiri::HTML(presenter.render_table)
 
     actions_column = doc.at_xpath('//tbody')
@@ -30,9 +31,12 @@ describe TableCloth::Columns::Action do
   end
 
   it '.value only returns actions that pass' do
-    admin_action     = dummy_table.action(if: :admin?) { '/admin' }
-    moderator_action = dummy_table.action(if: :moderator?) { '/moderator' }
-    table            = dummy_table.new([], view_context)
+    dummy_table.actions do
+      action(if: :admin?) { '/admin' }
+      action(if: :moderator?) { '/moderator' }
+    end
+
+    table = dummy_table.new([], view_context)
 
     def table.admin?
       true
@@ -42,7 +46,28 @@ describe TableCloth::Columns::Action do
       false
     end
 
-    dummy_table.columns[:actions].value(dummy_model, view_context, table).should include '/admin'
-    dummy_table.columns[:actions].value(dummy_model, view_context, table).should_not include '/moderator'
+    actions_column = dummy_table.columns[:actions] 
+    actions_value = actions_column.value(dummy_model, view_context, table)
+
+    actions_value.should include '/admin'
+    actions_value.should_not include '/moderator'
+  end
+
+  it "does not need to use the view context of a block" do
+    dummy_table.actions do
+      action {|object| link_to "Edit", "#{object.id}" }
+    end
+    presenter = TableCloth::Presenters::Default.new([dummy_model], dummy_table, view_context)
+
+    doc = Nokogiri::HTML(presenter.render_table)
+
+    actions_column = doc.at_xpath('//tbody')
+      .at_xpath('.//tr')
+      .xpath('.//td')
+      .last
+
+    link = actions_column.at_xpath('.//a')
+    link.should be_present
+    link[:href].should == '1'
   end
 end

data/spec/lib/presenter_spec.rb

@@ -29,10 +29,13 @@ describe TableCloth::Presenter do
   end
 
   it 'returns an edit link in the actions column' do
-    dummy_table.action {|object, view| view.link_to 'Edit', '/model/1/edit' }
+    dummy_table.actions do
+      action {|object, view| link_to 'Edit', '/model/1/edit' }
+    end
     presenter = TableCloth::Presenter.new(objects, dummy_table, view_context)    
 
-    column = Nokogiri::HTML(presenter.row_values(dummy_model).last)
+    actions_value = presenter.row_values(dummy_model).last
+    column = Nokogiri::HTML(actions_value)
     column.at_xpath('//a')[:href].should == '/model/1/edit'
     column.at_xpath('//a').text.should == 'Edit'
   end

data/spec/lib/presenters/default_spec.rb

@@ -62,6 +62,28 @@ describe TableCloth::Presenters::Default do
     end
   end
 
+  context 'escaped values' do
+    let(:objects) do
+      model = DummyModel.new.tap do |d|
+        d.id = 1
+        d.email = 'robert@creativequeries.com'
+        d.name = '<script>alert("Im in your columns, snatching your main thread.")</script>'
+      end
+
+      [model]
+    end
+
+    it 'does not allow unescaped values in columns' do
+      rows = subject.render_rows
+      doc = Nokogiri::HTML(rows)
+
+      tbody = doc.xpath('//tbody')
+      tbody.xpath('//td').each do |td|
+        td.at_xpath('.//script').should_not be_present
+      end
+    end
+  end
+
   it 'creates an entire table' do
     doc = Nokogiri::HTML(subject.render_table)
     table = doc.xpath('//table')
@@ -117,7 +139,6 @@ describe TableCloth::Presenters::Default do
   end
 
   context 'specific configuration' do
-    let(:doc) { Nokogiri::HTML(subject.render_table) }
     let(:dummy_table) do
       Class.new(TableCloth::Base) do
         column :email, td_options: { class: 'email_column' }
@@ -125,8 +146,30 @@ describe TableCloth::Presenters::Default do
     end
 
     it 'td has a class set' do
+      doc = Nokogiri::HTML(subject.render_table)
       doc.at_xpath('//td')[:class].should include 'email_column'
     end
+
+    context 'actions column' do
+      let(:dummy_table) { Class.new(DummyTableWithActions) }
+
+      specify 'actions column has a class set' do
+        doc = Nokogiri::HTML(subject.render_table)
+        td = doc.at_css('td:last')
+        td[:class].should include "actions"
+      end
+    end
+
+    context 'by value of row column' do
+      let(:dummy_table) { Class.new(DummyTableWithValueOptions) }
+
+      specify 'column has options because of value' do
+        doc = Nokogiri::HTML(subject.render_table)
+        td = doc.at_xpath('//td')
+        expect(td.text).to include "robert@creativequeries.com"
+        expect(td[:class]).to eq("special-class")
+      end
+    end
   end
 
   context 'table configuration' do
@@ -144,28 +187,24 @@ describe TableCloth::Presenters::Default do
       end
     end
 
-    it 'tables have a class attached' do
-      doc.at_xpath('//table')[:class].should include 'table2'
-    end
+    include_examples "table configuration"
 
-    it 'thead has a class attached' do
-      doc.at_xpath('//thead')[:class].should include 'thead2'
-    end
+    context "is extendable" do
+      let(:dummy_table) do 
+        table = Class.new(TableCloth::Base) do
+          column :email
 
-    it 'th has a class attached' do
-      doc.at_xpath('//th')[:class].should include 'th2'
-    end
-
-    it 'tbody has a class attached' do
-      doc.at_xpath('//tbody')[:class].should include 'tbody2'
-    end
-
-    it 'tr has a class attached' do
-      doc.at_xpath('//tr')[:class].should include 'tr2'
-    end
-
-    it 'td has a class attached' do
-      doc.at_xpath('//td')[:class].should include 'td2'
+          config.table.class = 'table2'
+          config.thead.class = 'thead2'
+          config.th.class    = 'th2'
+          config.tbody.class = 'tbody2'
+          config.tr.class    = 'tr2'
+          config.td.class    = 'td2'
+        end
+        Class.new(table)
+      end
+      
+      include_examples "table configuration"
     end
   end
 end

data/spec/support/dummy_table_with_actions.rb

@@ -0,0 +1,7 @@
+class DummyTableWithActions < TableCloth::Base
+  column :name
+
+  actions(td_options: {class: 'actions'}) do
+    action {|object| link_to "Edit", "/#{object.id}/edit" }
+  end
+end

data/spec/support/dummy_table_with_value_options.rb

@@ -0,0 +1,5 @@
+class DummyTableWithValueOptions < TableCloth::Base
+  column :email do
+    ["robert@creativequeries.com", {class: "special-class"}]
+  end
+end

data/spec/support/shared_config_examples.rb

@@ -0,0 +1,25 @@
+shared_examples "table configuration" do
+  it 'tables have a class attached' do
+    doc.at_xpath('//table')[:class].should include 'table2'
+  end
+
+  it 'thead has a class attached' do
+    doc.at_xpath('//thead')[:class].should include 'thead2'
+  end
+
+  it 'th has a class attached' do
+    doc.at_xpath('//th')[:class].should include 'th2'
+  end
+
+  it 'tbody has a class attached' do
+    doc.at_xpath('//tbody')[:class].should include 'tbody2'
+  end
+
+  it 'tr has a class attached' do
+    doc.at_xpath('//tr')[:class].should include 'tr2'
+  end
+
+  it 'td has a class attached' do
+    doc.at_xpath('//td')[:class].should include 'td2'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_cloth
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -143,6 +143,7 @@ files:
 - lib/table_cloth.rb
 - lib/table_cloth/action.rb
 - lib/table_cloth/action_view_extension.rb
+- lib/table_cloth/actions.rb
 - lib/table_cloth/base.rb
 - lib/table_cloth/builder.rb
 - lib/table_cloth/column.rb
@@ -153,6 +154,7 @@ files:
 - lib/table_cloth/presenters/default.rb
 - lib/table_cloth/version.rb
 - spec/lib/action_view_extension_spec.rb
+- spec/lib/actions_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/builder_spec.rb
 - spec/lib/column_spec.rb
@@ -163,6 +165,9 @@ files:
 - spec/spec_helper.rb
 - spec/support/dummy_model.rb
 - spec/support/dummy_table.rb
+- spec/support/dummy_table_with_actions.rb
+- spec/support/dummy_table_with_value_options.rb
+- spec/support/shared_config_examples.rb
 - spec/support/view_mocks.rb
 - table_cloth.gemspec
 homepage: http://www.github.com/bobbytables/table_cloth
@@ -192,6 +197,7 @@ summary: Table Cloth provides an easy and intuitive DSL for creating tables in r
   views.
 test_files:
 - spec/lib/action_view_extension_spec.rb
+- spec/lib/actions_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/builder_spec.rb
 - spec/lib/column_spec.rb
@@ -202,4 +208,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/dummy_model.rb
 - spec/support/dummy_table.rb
+- spec/support/dummy_table_with_actions.rb
+- spec/support/dummy_table_with_value_options.rb
+- spec/support/shared_config_examples.rb
 - spec/support/view_mocks.rb