table_cloth 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,2 @@
+before_install:
+  - gem install nokogiri -- --with-cflags='--std=gnu99'

data/README.md

@@ -2,6 +2,8 @@
 
 Table Cloth gives you an easy to use DSL for creating and rendering tables in rails.
 
+[![Build Status](https://travis-ci.org/bobbytables/table_cloth.png)](https://travis-ci.org/bobbytables/table_cloth)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -72,6 +74,67 @@ The second approach to making tables with Table Cloth is in the view.
 <% end %>
 ```
 
+## Columns
+
+You can create your own column by making a class that responds to ```.value(object, view)```
+
+```ruby
+class ImageColumn < TableCloth::Column
+  def value(object, view)
+    view.raw(view.image_tag(object.image_url))
+  end
+end
+```
+
+In your table
+```
+<%= simple_table_for @users do |table| %>
+  <% table.column :name %>
+  <% table.column :image, using: ImageColumn %>
+<% end %>
+```
+
+## Actions
+
+A lot of tables have an actions column to give you the full CRUD effect. They can be painful but Table Cloth incorporates a way to easily add them to your definition.
+
+```
+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 }
+
+  def admin?
+    view.current_user.admin?
+  end
+end
+```
+
+
+## Configuration
+
+Create an initializer called ```table_cloth.rb```
+
+Configuration looks like this:
+
+```ruby
+TableCloth::Configuration.configure do |config|
+  config.table.class = 'table table-bordered'
+  config.thead.class = ''
+  config.tbody.class = ''
+  config.tr.class =''
+  config.th.class =''
+  config.td.class =''
+end
+```
+
+You can set any value on table element configurations. For example:
+
+```ruby
+config.table.cellpadding = 1
+config.td.valign = 'top'
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,4 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/table_cloth/action.rb

@@ -5,5 +5,17 @@ module TableCloth
     def initialize(options)
       @options = options
     end
+
+    def available?(table)
+      if options[:if] && options[:if].is_a?(Symbol)
+        return !!table.send(options[:if])
+      end
+
+      if options[:unless] && options[:unless].is_a?(Symbol)
+        return !table.send(options[:unless])
+      end
+
+      true
+    end
   end
 end

data/lib/table_cloth/base.rb

@@ -39,8 +39,10 @@ module TableCloth
         options = args.extract_options! || {}
         options[:proc] = block if block_given?
 
+        column_class = options.delete(:using) || Column
+
         args.each do |name|
-          add_column name, Column.new(name, options)
+          add_column name, column_class.new(name, options)
         end
       end
 
@@ -71,6 +73,7 @@ module TableCloth
         end
 
         columns[:actions].actions << action
+        action
       end
 
       def has_actions?

data/lib/table_cloth/column.rb

@@ -7,7 +7,7 @@ module TableCloth
       @options = options
     end
 
-    def value(object, view)
+    def value(object, view, table=nil)
       if options[:proc] && options[:proc].respond_to?(:call)
         view.capture(object, options, view, &options[:proc])
       else
@@ -16,7 +16,7 @@ module TableCloth
     end
 
     def human_name
-      name.to_s.humanize
+      options[:label] || name.to_s.humanize
     end
 
     def available?(table)

data/lib/table_cloth/columns/action.rb

@@ -1,9 +1,13 @@
 module TableCloth
   module Columns
     class Action < Column
-      def value(object, view_context)
+      def value(object, view_context, table)
         actions_html = actions.inject('') do |links, action|
-          links + "\n" + view_context.capture(object, view_context, &action.options[:proc])
+          if action.available?(table)
+            links + "\n" + view_context.capture(object, view_context, &action.options[:proc])
+          else
+            links
+          end
         end
 
         view_context.raw(actions_html)
@@ -12,6 +16,10 @@ module TableCloth
       def actions
         @actions ||= []
       end
+
+      def available?(table)
+        actions.any? {|a| a.available?(table) }
+      end
     end
   end
 end

data/lib/table_cloth/presenter.rb

@@ -33,7 +33,7 @@ module TableCloth
 
     def row_values(object)
       column_values = table.columns.inject([]) do |values, (key, column)|
-        values << column.value(object, view_context); values
+        values << column.value(object, view_context, table); values
       end
     end
 

data/lib/table_cloth/version.rb

@@ -1,3 +1,3 @@
 module TableCloth
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/lib/base_spec.rb

@@ -3,6 +3,13 @@ require 'spec_helper'
 describe TableCloth::Base do
   subject { Class.new(TableCloth::Base) }
   let(:view_context) { ActionView::Base.new }
+  let(:dummy_model) do
+    DummyModel.new.tap do |d|
+      d.id    = 1
+      d.email = 'robert@example.com'
+      d.name  = 'robert'
+    end
+  end
 
   context 'columns' do
     it 'has a column method' do
@@ -19,12 +26,12 @@ describe TableCloth::Base do
 
     it '.columns returns all columns' do
       subject.column :name
-      subject.columns.size.should == 1
+      subject.should have(1).columns
     end
 
     it 'excepts multiple column names' do
       subject.column :name, :email
-      subject.columns.size.should == 2
+      subject.should have(2).columns
     end
 
     it 'stores a proc if given in options' do
@@ -44,17 +51,52 @@ describe TableCloth::Base do
       subject.action { '/' }
       subject.new([], view_context).column_names.should include 'Actions'
     end
-  end
 
-  context 'conditions' do
-    let(:dummy_model) do
-      DummyModel.new.tap do |d|
-        d.id    = 1
-        d.email = 'robert@example.com'
-        d.name  = 'robert'
+    it '.column_names does not include actions if all action conditions fail' do
+      subject.action(if: :admin?) { '/' }
+      table = subject.new([], view_context)
+      def table.admin?
+        false
+      end
+
+      table.column_names.should_not include 'Actions'
+    end
+
+    it '.column_names include actions when only partial are available' do
+      subject.action(if: :admin?) { '/' }
+      subject.action(if: :awesome?) { '/' }
+      table = subject.new([], view_context)
+      def table.admin?
+        false
+      end
+
+      def table.awesome?
+        true
+      end
+
+      table.column_names.should include 'Actions'  
+    end
+
+    it '.column_names uses a name given to it' do
+      subject.column :email, label: 'Email Address'
+      subject.new([], view_context).column_names.should include 'Email Address'
+    end
+
+    it '.column can take a custom column' do
+      email_column = Class.new(TableCloth::Column) do
+        def value(object, view)
+          "AN EMAIL!"
+        end
       end
+
+      subject.column :email, using: email_column
+      subject.new([dummy_model], view_context)
+
+      subject.columns[:email].value(dummy_model, view_context).should == "AN EMAIL!"
     end
+  end
 
+  context 'conditions' do
     context 'if' do
       subject { DummyTable.new([dummy_model], view_context) }
 
@@ -98,7 +140,23 @@ describe TableCloth::Base do
 
     it 'it adds an acion' do
       subject.action { '/' }
-      subject.columns[:actions].actions.size.should == 1
+      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
+      end
+
+
+      it 'accepts unless condition' do
+        action = table_class.action(unless: :admin?) { '/conditioned' }
+        action.available?(subject).should be_false
+      end
     end
   end
 end

data/spec/lib/columns/action_spec.rb

@@ -28,4 +28,21 @@ describe TableCloth::Columns::Action do
     link.should be_present
     link[:href].should == '1'
   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)
+
+    def table.admin?
+      true
+    end
+
+    def table.moderator?
+      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'
+  end
 end

data/table_cloth.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('nokogiri')
   gem.add_development_dependency('pry')
   gem.add_development_dependency('guard-rspec')
+  gem.add_development_dependency('rake')
 
   gem.add_dependency('actionpack', '~> 3.2')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_cloth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt