table_cloth 0.2.3 → 0.3.0.beta1

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 .bundle
+coverage
 .config
 .yardoc
 Gemfile.lock

data/lib/generators/templates/table.rb

@@ -1,4 +1,7 @@
 class <%= class_name %>Table < TableCloth::Base
+  # To include actions on this table, uncomment this line
+  # include TableCloth::Extensions::Actions
+
   # Define columns with the #column method
   # column :name, :email
 
@@ -22,8 +25,12 @@ class <%= class_name %>Table < TableCloth::Base
   # Actions give you the ability to create a column for any actions you'd like to provide.
   # Pass a block with an arity of 2, (object, view context).
   # You can add as many actions as you want.
+  # Make sure you include the actions extension.
   #
   # actions do
   #   action {|object| link_to "Edit", edit_object_path(object) }
+  #   action(if: :valid?) {|object| link_to "Invalidate", invalidate_object_path(object) }
   # end
+  # 
+  # If action provides an "if:" option, it will call that method on the object. It can also take a block with an arity of 1.
 end

data/lib/table_cloth.rb

@@ -1,24 +1,23 @@
-require 'action_view'
-require 'active_support/core_ext/class'
-require 'table_cloth/version'
-require 'table_cloth/configurable_elements'
-require 'table_cloth/base'
+require "action_view"
+require "active_support/core_ext/class"
+require "table_cloth/version"
+require "table_cloth/configurable_elements"
+require "table_cloth/base"
 
 module TableCloth
-  autoload :Configuration, 'table_cloth/configuration'
-  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'
+  autoload :Configuration, "table_cloth/configuration"
+  autoload :Builder, "table_cloth/builder"
+  autoload :Column, "table_cloth/column"
+  autoload :ColumnJury, "table_cloth/column_jury"
+  autoload :Presenter, "table_cloth/presenter"
+  autoload :ActionViewExtension, "table_cloth/action_view_extension"
 
   module Presenters
-    autoload :Default, 'table_cloth/presenters/default'
+    autoload :Default, "table_cloth/presenters/default"
   end
 
-  module Columns
-    autoload :Action, 'table_cloth/columns/action'
+  module Extensions
+    autoload :Actions, "table_cloth/extensions/actions"
   end
 
   def config_for(type)

data/lib/table_cloth/base.rb

@@ -11,16 +11,6 @@ module TableCloth
       @view       = view
     end
 
-    def columns
-      @columns ||= self.class.columns.each_with_object({}) do |(column_name, column), columns|
-        columns[column_name] = column if column.available?(self)
-      end
-    end
-
-    def has_actions?
-      self.class.has_actions?
-    end
-
     class << self
       def presenter(klass=nil)
         return @presenter = klass if klass
@@ -40,7 +30,7 @@ module TableCloth
         column_class = options.delete(:using) || Column
 
         args.each do |name|
-          add_column name, column_class.new(name, options)
+          add_column(class: column_class, options: options, name: name)
         end
       end
 
@@ -53,22 +43,9 @@ module TableCloth
         @columns
       end
 
-      def add_column(name, column)
+      def add_column(options)
         @columns ||= {}
-        @columns[name] = column
-      end
-
-      def actions(options={}, &block)
-        if block_given?
-          actions = Actions.new(options, &block)
-          columns[:actions] = actions.column
-        end
-
-        columns[:actions].actions
-      end
-
-      def has_actions?
-        columns[:actions].present?
+        @columns[options[:name]] = options
       end
     end
   end

data/lib/table_cloth/column.rb

@@ -18,17 +18,5 @@ module TableCloth
     def human_name
       options[:label] || name.to_s.humanize
     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/{action.rb → column_jury.rb}

@@ -1,12 +1,12 @@
 module TableCloth
-  class Action
-    attr_reader :action, :options
-    
-    def initialize(options)
-      @options = options
+  class ColumnJury
+    attr_reader :column, :table
+
+    def initialize(column, table)
+      @column, @table = column, table
     end
 
-    def available?(table)
+    def available?
       if options[:if] && options[:if].is_a?(Symbol)
         return !!table.send(options[:if])
       end
@@ -17,5 +17,9 @@ module TableCloth
 
       true
     end
+
+    def options
+      column.options
+    end
   end
 end

data/lib/table_cloth/configurable_elements.rb

@@ -1,21 +1,14 @@
 module TableCloth
   module ConfigurableElements
+    OPTIONS = %w(table thead th tbody tr td).map(&:to_sym)
+
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :table
-      cattr_accessor :thead
-      cattr_accessor :th
-      cattr_accessor :tbody
-      cattr_accessor :tr
-      cattr_accessor :td
-
-      self.table = ActiveSupport::OrderedOptions.new
-      self.thead = ActiveSupport::OrderedOptions.new
-      self.th    = ActiveSupport::OrderedOptions.new
-      self.tbody = ActiveSupport::OrderedOptions.new
-      self.tr    = ActiveSupport::OrderedOptions.new
-      self.td    = ActiveSupport::OrderedOptions.new
+      OPTIONS.each do |option|
+        cattr_accessor option
+        self.send "#{option}=", ActiveSupport::OrderedOptions.new
+      end
     end
   end
 end

data/lib/table_cloth/extensions/actions.rb

@@ -0,0 +1,25 @@
+module TableCloth
+  module Extensions
+    module Actions
+      autoload :Action, "table_cloth/extensions/actions/action"
+      autoload :Column, "table_cloth/extensions/actions/column"
+      autoload :ActionCollection, "table_cloth/extensions/actions/action_collection"
+      autoload :Jury, "table_cloth/extensions/actions/jury"
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def actions(options={}, &block)
+          action_collection.instance_eval(&block)
+
+          column :actions, options.update(collection: action_collection, using: Column)
+        end
+
+        private
+
+        def action_collection
+          @action_collection ||= ActionCollection.new
+        end
+      end
+    end
+  end
+end

data/lib/table_cloth/extensions/actions/action.rb

@@ -0,0 +1,21 @@
+module TableCloth::Extensions::Actions
+  class Action
+    attr_reader :options
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def jury
+      @jury ||= Jury.new(self)
+    end
+
+    def value(object, view)
+      if jury.available?(object)
+        view.instance_exec(object, &options[:proc])
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/table_cloth/extensions/actions/action_collection.rb

@@ -0,0 +1,11 @@
+module TableCloth::Extensions::Actions
+  class ActionCollection
+    def actions
+      @actions ||= []
+    end
+
+    def action(options={}, &block)
+      actions << Action.new({proc: block}.merge(options))
+    end
+  end
+end

data/lib/table_cloth/extensions/actions/column.rb

@@ -0,0 +1,21 @@
+module TableCloth::Extensions::Actions
+  class Column < ::TableCloth::Column
+    def value(object, view, table=nil)
+      actions = action_collection.actions.map do |action|
+        action.value(object, view)
+      end
+
+      view.raw(actions.join(separator))
+    end
+
+    private
+
+    def separator
+      options[:separator] || " "
+    end
+
+    def action_collection
+      @action_collection ||= options[:collection]
+    end
+  end
+end

data/lib/table_cloth/extensions/actions/jury.rb

@@ -0,0 +1,37 @@
+module TableCloth::Extensions::Actions
+  class Jury
+    attr_reader :action
+
+    def initialize(action)
+      @action = action
+    end
+
+    def available?(object)
+      case action_if
+      when Proc
+        return !!action_if.call(object)
+      when Symbol
+        return !!object.send(action_if)
+      end
+
+      case action_unless
+      when Proc
+        return !action_unless.call(object)
+      when Symbol
+        return !object.send(action_unless)
+      end
+
+      return true
+    end
+
+    private
+
+    def action_if
+      action.options[:if]
+    end
+
+    def action_unless
+      action.options[:unless]
+    end
+  end
+end

data/lib/table_cloth/presenter.rb

@@ -4,13 +4,12 @@ module TableCloth
       :table
 
     def initialize(objects, table, view)
-      @view_context = view
-      @table_definition = table
       @objects = objects
+      @table_definition = table
+      @view_context = view
       @table = table_definition.new(objects, view)
     end
 
-    # Short hand so your fingers don't hurt
     def v
       view_context
     end
@@ -27,14 +26,26 @@ module TableCloth
       raise NoMethodError, "You must override the .rows method"
     end
 
+    def columns
+      @columns ||= table.class.columns.map do |name, options|
+        column = options[:class].new(name, options[:options])
+
+        if ColumnJury.new(column, table).available?
+          column
+        else
+          nil
+        end
+      end.compact
+    end
+
     def column_names
-      @column_names ||= table.columns.each_with_object([]) do |(column_name, column), names|
+      @column_names ||= columns.each_with_object([]) do |column, names|
         names << column.human_name
       end
     end
 
     def row_values(object)
-      table.columns.each_with_object([]) do |(key, column), values|
+      columns.each_with_object([]) do |column, values|
         values << column.value(object, view_context, table)
       end
     end

data/lib/table_cloth/presenters/default.rb

@@ -15,7 +15,7 @@ module TableCloth
 
       def render_row(object)
         wrapper_tag :tr do
-          v.raw table.columns.inject('') {|tds, (key, column)| tds + render_td(column, object) }
+          v.raw columns.inject('') {|tds, column| tds + render_td(column, object) }
         end
       end
 

data/lib/table_cloth/version.rb

@@ -1,3 +1,3 @@
 module TableCloth
-  VERSION = "0.2.3"
+  VERSION = "0.3.0.beta1"
 end

data/spec/factories/actions.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :action, class: "TableCloth::Extensions::Actions::Action" do
+    options({})
+    initialize_with { new(options) }
+  end
+end

data/spec/factories/columns.rb

@@ -0,0 +1,18 @@
+FactoryGirl.define do
+  factory :column, class: "TableCloth::Column" do
+    name :name
+    options({})
+
+    factory :if_column do
+      name :name
+      options({ if: :admin? })
+    end
+
+    factory :unless_column do
+      name :name
+      options({ unless: :moderator? })
+    end
+
+    initialize_with { new(name, options) }
+  end
+end

data/spec/factories/dummy_tables.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :dummy_table, class: "TableCloth::Base" do
+    initialize_with do
+      Class.new(TableCloth::Base).tap do |klass|
+        attributes.each do |key,attribute|
+          klass.column *[key, attribute]
+        end
+      end
+    end
+  end
+end

data/spec/lib/base_spec.rb

@@ -16,7 +16,8 @@ describe TableCloth::Base do
     end
 
     it 'column accepts options' do
-      expect { subject.column :n, {option: 'value'} }.not_to raise_error
+      subject.column :name, option: "value"
+      expect(subject.columns[:name][:options][:option]).to eq("value")
     end
 
     it '.columns returns all columns' do
@@ -33,22 +34,16 @@ describe TableCloth::Base do
       subject.column(:name) { 'Wee' }
 
       column = subject.columns[:name]
-      expect(column.options[:proc]).to be_present
-      expect(column.options[:proc]).to be_kind_of(Proc)
+      expect(column[:options][:proc]).to be_present
+      expect(column[:options][:proc]).to be_kind_of(Proc)
     end
 
     context "custom" do
-      let(:custom_column) do
-        Class.new(TableCloth::Column) do
-          def value(object, view)
-            "AN EMAIL!"
-          end
-        end
-      end
+      let(:custom_column) { stub(:custom, value: "AN EMAIL") }
 
       it '.column can take a custom column' do
         subject.column :email, using: custom_column
-        subject.columns[:email].value(dummy_model, view_context).should == "AN EMAIL!"
+        expect(subject.columns[:email][:class]).to eq(custom_column)
       end
     end
   end
@@ -59,17 +54,6 @@ describe TableCloth::Base do
     end
   end
 
-  context 'actions' do
-    it "takes a block" do
-      subject.actions do
-        action { 'Edit' }
-        action { 'Delete' }
-      end
-
-      expect(subject.columns[:actions]).to be_kind_of TableCloth::Columns::Action
-    end
-  end
-
   context "configuration" do
     subject { Class.new(TableCloth::Base) }
     let(:sibling1_class) { Class.new(subject) }