table_for_collection 1.0.2 → 1.0.3

data/Changelog

@@ -1,7 +1,13 @@
-== v.0.2
+== v.1.0.3
+
+Callback column for given attribute
+Compatibility with rails 3.0.2
+Change dependency from rails to actionpack
+
+== v.1.0.2
 
 Packaged as a gem.
 
-== v.0.1
+== v.1.0.1
 
 Initial version: table_for method added.

data/Gemfile

@@ -1,6 +1,6 @@
 source :gemcutter
 
-gem "rails"
+gem "actionpack"
 
 group :development, :test do
   gem "rspec", ">=2.0.0"

data/README.rdoc

@@ -68,10 +68,13 @@ will be used as column's title. It will produce HTML similar to:
 
   <%= table_for @users do -%>
     <% column :login, :title => "User name" %>
-    <% column :email %>
+    <% column :email do |email| %>
+      <% mail_to email %>
+    <% end %>
     <% column :title => "Full name" do |user| %>
       <% [user.first_name, user.last_name].join(" ") %>
     <% end %>
+    <% column :company %>
     <% column :title => "Actions" do |user| %>
       <% [link_to("Show", user), link_to("Delete", user, :method => :delete)].join(" | ") %>
     <% end %>

data/Rakefile

@@ -1,5 +1,5 @@
 require "rspec/core/rake_task"
 
-desc "Test the table_for plugin."
+desc "Test table_for_collection plugin."
 RSpec::Core::RakeTask.new('spec')
 

data/lib/table_for/callback_column.rb

@@ -2,10 +2,11 @@ module TableHelper
   class CallbackColumn < Column # :nodoc:
     def initialize(template, obj, ops)
       super
-      @title = @options.delete(:title) || "&nbsp;"
+      @callback = @options.delete(:callback)
     end
+
     def content_for(record)
-      @attr.call(record)
+      @attr ? @callback.call(record.send(@attr).to_s) : @callback.call(record)
     end
   end
 end

data/lib/table_for/column.rb

@@ -1,13 +1,22 @@
 module TableHelper
   class Column # :nodoc:
-    attr_reader :title, :html, :html
+    attr_reader :title, :html
+    delegate :content_tag, :to => :@template
+
     def initialize(template, obj, ops)
-      @template, @options, @attr, @title = template, ops, obj, ""
-      @html = @options.delete(:html) || {}
+      @template, @attr, @options = template, obj, ops
+      @title = @options.delete(:title) || @attr.to_s.humanize.presence || " "
+      @html  = @options.delete(:html)  || {}
     end
-  
+
     def content_for
       raise NoMethodError, "Use SimpleColumn or CallbackColumn"
     end
+
+    def draw_title
+      content_tag :th, @html[:th] do
+        @title
+      end
+    end
   end
 end

data/lib/table_for/helper.rb

@@ -37,6 +37,6 @@ module TableHelper
   end
 end
 
-ActionView::Base.class_eval {
+ActionView::Base.class_eval do
   include TableHelper
-}
+end

data/lib/table_for/simple_column.rb

@@ -1,11 +1,7 @@
 module TableHelper
   class SimpleColumn < Column # :nodoc:
-    def initialize(template, obj, ops)
-      super
-      @title = @options.delete(:title) || @attr.to_s.humanize || "&nbsp;"
-    end
     def content_for(record)
-      record.send(@attr)
+      record.send(@attr).to_s
     end
   end
 end

data/lib/table_for/table.rb

@@ -3,7 +3,7 @@ require "core_ex/array"
 module TableHelper
   class Table # :nodoc:
     delegate :content_tag, :to => :@template
-
+    
     def initialize(template, records, options = {})
       @template, @records, @columns = template, records, []
       # table's html options
@@ -16,27 +16,32 @@ module TableHelper
     end
 
     def columns(*args)
+      res = []
       unless args.blank?
         args.each do |arg|
-          self.column(arg)
+          res << self.column(arg)
         end
       else
         raise ArgumentError, "At least one attribute name should be given"
       end
+      res
     end
 
     def column(*args, &block)
       col_options = args.extract_options!
-      unless args.blank?
-        attr = args.shift
-        @columns << SimpleColumn.new(@template, attr, col_options)
+      res = nil
+
+      attr = args.shift or nil
+
+      if block_given?
+        col_options[:callback] = block
+        @columns << (res = CallbackColumn.new(@template, attr, col_options))
+      elsif attr
+        @columns << (res = SimpleColumn.new(@template, attr, col_options))
       else
-        if block_given?
-          @columns << CallbackColumn.new(@template, block, col_options)
-        else
-          raise ArgumentError, "Attribute name or block should be given"
-        end
+        raise ArgumentError, "Attribute name or block should be given"
       end
+      res
     end
 
     def draw
@@ -56,11 +61,7 @@ module TableHelper
     def head
       content_tag :thead do
         content_tag :tr do
-          @columns.map do |col|
-            content_tag :th, col.html[:th] do
-              col.title
-            end
-          end.join
+          @columns.map { |col| col.draw_title }.join.html_safe
         end
       end
     end
@@ -73,9 +74,9 @@ module TableHelper
               content_tag :td, col.html[:td] do
                 col.content_for(rec).to_s
               end
-            end.join
+            end.join.html_safe
           end
-        end.join
+        end.join.html_safe
       end
     end
     

data/lib/table_for/version.rb

@@ -1,4 +1,4 @@
 module TableHelper
   GEM_NAME = "table_for_collection"
-  VERSION  = "1.0.2"
+  VERSION  = "1.0.3"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,46 @@
 require "table_for_collection"
 require "webrat"
 
+def build_column(klass, arg, options = {})
+  klass.new(template, arg, options)
+end
+
+# Column instance methods
+shared_examples_for "Column class instance" do
+  # Check are methods present
+  describe "should have method", :shared => true do
+    [:title, :html, :content_for, :content_tag].each do |method|
+      it ":#{method}" do
+        build_column(klass, :id).should respond_to(method)
+      end
+    end
+  end
+  # :html
+  describe ":html method" do
+    it "should success if :html option is empty" do
+      build_column(klass, :id).html.should eq({})
+    end
+    it "should success if :html option is given" do
+      build_column(klass, :id, :html => { :class => "some-class" }).html.should eq(:class => "some-class")
+    end
+  end
+  # :draw_title
+  describe ":draw_title method should render" do
+    it "valid th" do
+      col = build_column(klass, :id, :title => "Test", :html => {
+        :th => {
+          :class => "some-class",
+          :width => "50%",
+        }
+      })
+      html = col.draw_title
+      html.should have_selector("th.some-class[@width='50%']") do |th|
+        th.should contain(col.title)
+      end
+    end
+  end
+end
+
 RSpec.configure do |config|
   config.include(Webrat::Matchers)
 end

data/spec/table_for/callback_column_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe TableHelper::CallbackColumn do
+  # ActionView::Base instance
+  let(:template) { ActionView::Base.new }
+  # TableHelper::SimpleColumn
+  let(:klass) { TableHelper::CallbackColumn }
+  # user (stubbed data)
+  let(:user) { mock(:id => 12) }
+  # call-proc
+  let(:given_proc_without_attr) { lambda { |r| "aaa-#{r.id}" }}
+  let(:given_proc_with_attr) { lambda { |r| "aaa-#{r}" }}
+  # Instance methods
+  describe "an instance" do
+    it_should_behave_like "Column class instance"
+    # :title
+    describe ":title method should success" do
+      it "if :title option is empty" do
+        col = build_column(klass, nil, :callback => given_proc_without_attr)
+        col.title.should eq(" ")
+      end
+      it "if :title options is set" do
+        col = build_column(klass, nil, :callback => given_proc_without_attr, :title => "Some title")
+        col.title.should eq("Some title")
+      end
+      it "if :title options is empty, but attribute is set" do
+        col = build_column(klass, :id, :callback => given_proc_with_attr)
+        col.title.should eq("Id")
+      end
+    end
+
+    # :content_for
+    it ":content_for method should success without given attribute" do
+      col = build_column(klass, nil, :callback => given_proc_without_attr)
+      col.content_for(user).should == given_proc_without_attr.call(user)
+    end
+    it ":content_for method should success with given attribute" do
+      col = build_column(klass, :id, :callback => given_proc_with_attr)
+      col.content_for(user).should == given_proc_with_attr.call(user.id)
+    end
+  end
+end

data/spec/table_for/column_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe TableHelper::Column do
+  # ActionView::Base instance
+  let(:template) { ActionView::Base.new }
+  # TableHelper::Column
+  let(:klass) { TableHelper::Column }
+  # Instance methods
+  describe "an instance" do
+    it_should_behave_like "Column class instance"
+    # :title
+    it ":title method should success" do
+      build_column(klass, :id, :title => "Test").title.should eq("Test")
+    end
+    # :content_for
+    it ":content_for method should raise error" do
+      lambda do
+        build_column(klass, :id, :title => "Test").content_for
+      end.should raise_error(NoMethodError, "Use SimpleColumn or CallbackColumn")
+    end
+  end
+end

data/spec/table_for/simple_column_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe TableHelper::SimpleColumn do
+  # ActionView::Base instance
+  let(:template) { ActionView::Base.new }
+  # TableHelper::SimpleColumn
+  let(:klass) { TableHelper::SimpleColumn }
+  # user (stubbed data)
+  let(:user) { mock(:id => 12) }
+  # Instance methods
+  describe "an instance" do
+    it_should_behave_like "Column class instance"
+    # :title
+    describe ":title method should success" do
+      it "if :title option is empty" do
+        col = build_column(klass, attr = :id)
+        col.title.should eq(attr.to_s.humanize)
+      end
+      it "if :title options is set" do
+        col = build_column(klass, :id, :title => "Some title")
+        col.title.should eq("Some title")
+      end
+    end
+    # :content_for
+    it ":content_for method should success" do
+      col = build_column(klass, :id)
+      col.content_for(user).should == user.id.to_s
+    end
+  end
+end

data/spec/table_for/table_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe TableHelper::Table do
+  # ActionView::Base instance
+  let(:template) do
+    ActionView::Base.new
+  end
+  # users list (stubbed data)
+  let(:users) do
+    [
+      mock(:id => 1,
+           :name => "John Jackson",
+           :email => "john.jackson@example.com",
+           :address => "100, Spear Street, LA, USA"),
+      mock(:id => 2,
+           :name => "Jack Johnson",
+           :email => "jack.johnson@example.com",
+           :address => "12, Brooklin, NY, USA"),
+    ]
+  end
+  # table instance
+  let(:table) do
+    TableHelper::Table.new(template, users)
+  end
+  # Instance methods
+  describe "An instance" do
+    # check are methods available
+    describe "should have method" do
+      [:columns, :column, :draw, :content_tag].each do |method|
+        it "#{method}" do
+          table.should respond_to(method)
+        end
+      end
+    end
+    # :column method
+    describe ":column method" do
+      describe "with argument only" do
+        it "should build simple column" do
+          col = table.column(:id)
+          last = table.instance_variable_get(:@columns).last
+          last.should be_instance_of(TableHelper::SimpleColumn)
+          last.should eq(col)
+        end
+        it "should build column" do
+          lambda do
+            table.column(:id)
+          end.should change(table.instance_variable_get(:@columns), :size).by(1)
+        end
+      end
+      describe "with argument and options" do
+        it "should build simple column" do
+          col = table.column(:id, :title => "ID")
+          last = table.instance_variable_get(:@columns).last
+          last.should be_instance_of(TableHelper::SimpleColumn)
+          last.should eq(col)
+        end
+        it "should build column" do
+          lambda do
+            table.column(:id, :title => "ID")
+          end.should change(table.instance_variable_get(:@columns), :size).by(1)
+        end
+      end
+      describe "with block only" do
+        it "should build callback column" do
+          col = table.column { |r| "aaa-#{r}" }
+          last = table.instance_variable_get(:@columns).last
+          last.should be_instance_of(TableHelper::CallbackColumn)
+          last.should eq(col)
+        end
+        it "should build column" do
+          lambda do
+            table.column { |r| "aaa-#{r}" }
+          end.should change(table.instance_variable_get(:@columns), :size).by(1)
+        end
+      end
+      describe "with block and options" do
+        it "should build callback column" do
+          col = table.column(:title => "AAA") { |r| "aaa-#{r}" }
+          last = table.instance_variable_get(:@columns).last
+          last.should be_instance_of(TableHelper::CallbackColumn)
+          last.should eq(col)
+        end
+        it "should build column" do
+          lambda do
+            table.column(:title => "AAA") { |r| "aaa-#{r}" }
+          end.should change(table.instance_variable_get(:@columns), :size).by(1)
+        end
+      end
+      describe "without block and argument" do
+        it "should raise error" do
+          lambda do
+            table.column
+          end.should raise_error(ArgumentError, "Attribute name or block should be given")
+        end
+      end
+      describe "with options only" do
+        it "should raise error" do
+          lambda do
+            table.column(:title => "Title")
+          end.should raise_error(ArgumentError, "Attribute name or block should be given")
+        end
+      end
+    end
+    # :columns method
+    describe ":columns method" do
+      it "should create columns by attributes" do
+        attrs = [:id, :name, :email]
+        res = nil
+        lambda do
+          res = table.columns *attrs
+        end.should change(table.instance_variable_get(:@columns), :size).by(attrs.size)
+        res.should be_instance_of(Array)
+        res.size.should eq(attrs.size)
+      end
+      it "should raise if no arguments given" do
+        lambda do
+          table.columns
+        end.should raise_error(ArgumentError, "At least one attribute name should be given")
+      end
+    end
+    # :draw method
+    describe ":draw method" do
+      describe "for simple table" do
+        before(:each) do
+          @attr = :id
+          table = build_table
+          @col = table.column(@attr)
+          @html = table.draw
+        end
+        describe "should render table" do
+          it { @html.should have_selector("table") }
+          describe "thead" do
+            it { @html.should have_selector("table/thead") }
+            describe "tr" do
+              it { @html.should have_selector("table/thead/tr") }
+              describe "th" do
+                it "should contain valid title" do
+                  @html.should have_selector("table/thead/tr/th") do |th|
+                    th.should contain(@col.title)
+                  end
+                end
+              end
+            end
+          end
+          describe "tbody" do
+            it { @html.should have_selector("table/tbody") }
+          end
+        end
+      end
+    end
+  end
+protected
+  def build_table(options = {})
+    TableHelper::Table.new(template, users, options)
+  end
+end

data/spec/table_for_collection_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe ActionView::Base do
   # ActionView::Base instance
@@ -189,6 +189,31 @@ describe ActionView::Base do
       end
     end
 
+    describe "with named callback column" do
+      before(:each) do
+        @html = template.table_for(users) do
+          column :email do |email|
+            mail_to email
+          end
+        end
+      end
+
+      it "should render valid HTML" do
+        @html.should have_selector("table") do |table|
+          table.should have_selector("thead/tr/th") do |th|
+            th.should contain("Email")
+          end
+          table.should have_selector("tbody/tr") do |tr|
+            users.each do |user|
+              tr.should have_selector("td") do |td|
+                td.should have_selector("a[@href='mailto:#{user.email}']")
+              end
+            end
+          end
+        end
+      end
+    end
+
     # <%= table_for @users, :stripes => ["odd", "even"] do %>
     #   <% column :name %>
     # <% end %>

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: table_for_collection
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Dima Lunich
@@ -17,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +03:00
+date: 2010-11-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,21 +27,21 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: actionpack
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -70,7 +69,10 @@ files:
 - lib/table_for_collection.rb
 - spec/core_ex/array_spec.rb
 - spec/spec_helper.rb
-- spec/table_for_collection/table_spec.rb
+- spec/table_for/callback_column_spec.rb
+- spec/table_for/column_spec.rb
+- spec/table_for/simple_column_spec.rb
+- spec/table_for/table_spec.rb
 - spec/table_for_collection_spec.rb
 - README.rdoc
 - Rakefile
@@ -92,7 +94,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -101,7 +102,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -111,9 +111,12 @@ rubyforge_project: ""
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: table_for_collection-1.0.2
+summary: table_for_collection-1.0.3
 test_files: 
 - spec/core_ex/array_spec.rb
 - spec/spec_helper.rb
-- spec/table_for_collection/table_spec.rb
+- spec/table_for/callback_column_spec.rb
+- spec/table_for/column_spec.rb
+- spec/table_for/simple_column_spec.rb
+- spec/table_for/table_spec.rb
 - spec/table_for_collection_spec.rb

data/spec/table_for_collection/table_spec.rb

@@ -1,30 +0,0 @@
-require "spec_helper"
-
-describe TableHelper::Table do
-  # ActionView::Base instance
-  let(:template) do
-    ActionView::Base.new
-  end
-  # users list (stubbed data)
-  let(:users) do
-    [
-      mock({
-        :name => "John Smith",
-        :email => "tester@example.com",
-        :address => "100, Spear Street, NY, USA",
-      })
-    ]
-  end
-  # table instance
-  let(:table) do
-    TableHelper::Table.new(template, users)
-  end
-  # check are methods available
-  describe "should respond_to" do
-    [:columns, :column, :draw, :content_tag].each do |method|
-      it "#{method}" do
-        table.should respond_to(method)
-      end
-    end
-  end
-end