sorting_table_for 0.1.0

data/lib/sorting_table_for/tools.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module SortingTableFor
+  module Tools
+    extend self
+    
+    ##
+    ## This module is a copy from Formtastic : http://github.com/justinfrench/formtastic
+    ##
+    
+    ## Rails XSS Safety
+
+    # Returns the given text, marked as being HTML-safe.
+    # With older versions of the Rails XSS-safety mechanism,
+    # this destructively modifies the HTML-safety of `text`.
+    #
+    # @param text [String]
+    # @return [String] `text`, marked as HTML-safe
+    def html_safe(text)
+      return text if !text
+      return text.html_safe if defined?(ActiveSupport::SafeBuffer)
+      return text.html_safe! if text.respond_to?(:html_safe!)
+      text
+    end
+
+    def rails_safe_buffer_class
+      # It's important that we check ActiveSupport first,
+      # because in Rails 2.3.6 ActionView::SafeBuffer exists
+      # but is a deprecated proxy object.
+      return ActiveSupport::SafeBuffer if defined?(ActiveSupport::SafeBuffer)
+      return ActionView::SafeBuffer
+    end
+
+    def rails3?
+      version=
+        if defined?(ActionPack::VERSION::MAJOR)
+          ActionPack::VERSION::MAJOR
+        end
+      !version.blank? && version >= 3
+    end
+    
+  end
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  database: ":memory:"
+  adapter: sqlite3

data/spec/db/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :users, :force => true do |t|
+    
+    t.string    :username
+    t.string    :firstname
+    t.string    :lastname
+    
+    t.integer   :position
+    t.integer   :salary
+    t.integer   :price
+    
+    t.boolean   :active
+    
+    t.datetime  :created_at
+    t.datetime  :updated_at
+    
+  end
+  
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,24 @@
+class User < ActiveRecord::Base
+  if ::SortingTableFor::Tools::rails3?
+    scope :good_position, :conditions => 'position > 3'
+    scope :set_limit, lambda { |limit| { :limit => limit } }
+  else
+    named_scope :good_position, :conditions => 'position > 3'
+    named_scope :set_limit, lambda { |limit| { :limit => limit } }
+  end
+  
+end
+
+20.times do |n|
+  User.create( 
+      :username => "my_usename_#{n}",
+      :firstname => "my_firstname_#{n}",
+      :lastname => "my_lastname_#{n}",
+      :position => n + 2,
+      :salary => n * 424,
+      :price => n * 3,
+      :active => ((n % 2) == 0) ? true : false,
+      :created_at => DateTime.now - 5.days,
+      :updated_at => DateTime.now - 2.hours
+  )
+end

data/spec/helpers/builder_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../fixtures/user')
+
+include SortingTableForSpecHelper
+
+describe SortingTableFor, :type => :helper do
+  
+  before :each do
+    @users = User.all
+    helper.stub!(:url_for).and_return('fake_link')
+    helper.stub!(:params).and_return({ :controller => 'fakes', :action => 'index' })
+    helper.output_buffer = ''
+  end
+  
+  describe ' #construct table' do
+  
+    it "should raise and error" do
+      expect {
+        helper.sorting_table_for(@users)
+      }.to raise_error { ArgumentError }
+    end
+    
+    it "should have balise table with class" do
+      table_html = helper.sorting_table_for(@users) {}
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class=sorting_table_for]")
+    end
+    
+    it "should be custom by html" do
+      table_html = helper.sorting_table_for(@users, :html => { :class => 'hello', :id => 'my_test' }) {}
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class='hello sorting_table_for'][id='my_test']")
+    end
+    
+    it "should take another builder" do
+      class MyNewBuilder < SortingTableFor::TableBuilder
+      end
+      helper.sorting_table_for(@users, :builder => MyNewBuilder) do |builder|
+        builder.class.should == MyNewBuilder
+      end
+    end
+    
+  end
+    
+end

data/spec/helpers/cell_value_spec.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../fixtures/user')
+
+include SortingTableForSpecHelper
+
+describe SortingTableFor, :type => :helper do
+
+  before :each do
+    @users = User.all
+    helper.stub!(:url_for).and_return('fake_link')
+    helper.stub!(:params).and_return({ :controller => 'fakes', :action => 'index' })
+    helper.output_buffer = ''
+    SortingTableFor::TableBuilder.default_boolean = [I18n.t(:bool_true, :scope => [:sorting_table_for, :columns]), I18n.t(:bool_false, :scope => [:sorting_table_for, :columns])]      
+    SortingTableFor::TableBuilder.i18n_default_format_date = :default
+  end
+  
+  it "should format by default values" do
+    helper.sorting_table_for(@users) do |table|
+      html = table.columns
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => @users.first.username)
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => @users.first.firstname)
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(3)", :text => @users.first.lastname)
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(4)", :text => @users.first.position.to_s)
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(5)", :text => @users.first.salary.to_s)
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(6)", :text => number_to_currency(@users.first.price))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(7)", :text => "True")
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(8)", :text => I18n.l(@users.first.created_at, :format => :default))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(9)", :text => I18n.l(@users.first.updated_at, :format => :default))
+    end
+  end
+  
+  it "should works with as" do
+    current_datetime = DateTime.now
+    helper.sorting_table_for(@users) do |table|
+      html = table.columns do |value|
+        table.column :price
+        table.column value.price, :as => :currency
+        table.column current_datetime, :as => :time
+        table.column current_datetime, :as => :date
+        table.column current_datetime, :as => :time, :format => :short
+        table.column current_datetime, :as => :date, :format => :short
+        table.column true
+        table.column :active
+      end
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => number_to_currency(@users.first.price))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => number_to_currency(@users.first.price))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(3)", :text => I18n.l(current_datetime, :format => :default))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(4)", :text => I18n.l(current_datetime.to_date, :format => :default)) 
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(5)", :text => I18n.l(current_datetime, :format => :short))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(6)", :text => I18n.l(current_datetime.to_date, :format => :short))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(7)", :text => "True")
+      html.should have_comp_tag("tr:nth-child(3) td:nth-child(8)", :text => "False")
+    end
+  end
+  
+  it "should works with boolean option" do
+    SortingTableFor::TableBuilder.default_boolean = ['BoolTrue', 'BoolFalse']
+    helper.sorting_table_for(@users) do |table|
+      html = table.columns do
+        table.column true
+        table.column :active
+      end
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => "BoolTrue")
+      html.should have_comp_tag("tr:nth-child(3) td:nth-child(2)", :text => "BoolFalse")
+    end    
+  end
+  
+  it "should works with format date option" do
+    SortingTableFor::TableBuilder.i18n_default_format_date = :short
+    current_datetime = DateTime.now
+    helper.sorting_table_for(@users) do |table|
+      html = table.columns do |value|
+        table.column :created_at
+        table.column current_datetime, :as => :time
+        table.column current_datetime, :as => :time, :format => :default
+      end
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => I18n.l(@users.first.created_at, :format => :short))
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => I18n.l(current_datetime, :format => :short)) 
+      html.should have_comp_tag("tr:nth-child(2) td:nth-child(3)", :text => I18n.l(current_datetime, :format => :default))
+    end    
+  end
+  
+end

data/spec/helpers/column_spec.rb

@@ -0,0 +1,359 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../fixtures/user')
+
+include SortingTableForSpecHelper
+
+describe SortingTableFor, :type => :helper do
+
+  before :each do
+    @users = User.all
+    helper.stub!(:url_for).and_return('fake_link')
+    helper.stub!(:params).and_return({ :controller => 'fakes', :action => 'index' })
+    helper.output_buffer = ''
+  end
+  
+  describe ' #default usage' do
+  
+    it "should works" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => (@users.size * (User.content_columns.size + 2)) + 1)
+      end
+    end
+    
+    it "should add total entries" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should match(@users.size.to_s)
+      end
+    end
+    
+    it "should add colspan for total entries" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should match("<td colspan=\"" + (User.content_columns.size + 2).to_s  + "\">")
+      end
+    end
+  
+    it "should add i18n to total entries" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should match("Total Entries " + @users.size.to_s)
+      end
+    end
+    
+    it "should add colspan for total entries" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should match("<td colspan=\"" + (User.content_columns.size + 2).to_s  + "\">")
+      end
+    end
+    
+    it "should add link columns" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should have_comp_tag('a', :count => (@users.size * 2))
+      end
+    end
+    
+    it "should add i18n to link columns" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should have_comp_tag('a', :text => 'Edit', :count => @users.size)
+        html.should have_comp_tag('a', :text => 'Delete', :count => @users.size)
+      end
+    end
+    
+    it "should add class odd/even" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should have_comp_tag("tr[class=odd]", :count => (@users.size / 2))
+        html.should have_comp_tag("tr[class=even]", :count => (@users.size / 2))
+      end
+    end
+  
+    it "should customize html" do
+      table_html = helper.sorting_table_for(@users, :html => { :class => 'table_class', :id => 'table_id' }) do |table|
+        html = table.columns :html => { :class => 'hello_class', :id => 'hello_id', :title => 'hello_title' }
+        html.should have_comp_tag("tr:nth-child(2)[class='hello_class odd']")
+        html.should have_comp_tag("tr:nth-child(2)[id=hello_id]")
+        html.should have_comp_tag("tr:nth-child(2)[title=hello_title]")
+      end
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class='table_class sorting_table_for'][id=table_id]")
+    end
+    
+  end
+  
+  describe " #table columns" do
+    
+    it "should works with one column" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns :username
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => (@users.size + 1))        
+      end
+    end
+    
+    it "should have multi columns" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns :username, :price
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => ((@users.size * 2) + 1))
+      end
+    end
+    
+    it "should have multi columns and action" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns(:username, :price, :actions => :edit).should have_comp_tag("td", :count => ((@users.size * 3) + 1))
+      end      
+    end
+  
+    it "should have multi columns and multi action" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns(:username, :price, :actions => [:edit, :delete]).should have_comp_tag("td", :count => ((@users.size * 4) + 1))
+      end      
+    end
+    
+    it "should do nothing if the key isn't correct" do
+      helper.sorting_table_for(@users) do |table|
+        table.columns(:username, :price, :blabla => :edit).should have_comp_tag("td", :count => ((@users.size * 2) + 1))
+      end
+    end
+    
+    it "should works symbol and non symbol" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns(:username, 'hello', image_tag('rails.png'), :actions => :edit)
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => @users.first.username)
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => 'hello')
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(3) img")
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(4) a")
+      end
+    end
+    
+    it "should works with non key symbol" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns(:username, :test)
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => @users.first.username)
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => '')
+      end
+    end    
+    
+    it "should add remote on link" do
+      helper.sorting_table_for(@users, :link_remote => true) do |table|
+        html = table.columns :username, :actions => :edit
+        if SortingTableFor::Tools::rails3?
+          html.should have_comp_tag("tr:nth-child(2) td:nth-child(2) a[data-remote]")
+        else
+          html.should have_comp_tag("tr:nth-child(2) td:nth-child(2) a[onclick]")
+        end
+      end            
+    end
+    
+    it "should customize html" do
+      table_html = helper.sorting_table_for(@users, :html => { :class => 'table_class', :id => 'table_id' }) do |table|
+        html = table.columns :username, :price, :html => { :class => 'hello_class', :id => 'hello_id', :title => 'hello_title' }
+        html.should have_comp_tag("tr:nth-child(2)[class='hello_class odd'][id=hello_id][title=hello_title]")
+      end
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class='table_class sorting_table_for'][id=table_id]")
+    end
+  
+  end
+  
+  describe " #table column" do
+    
+    it "should works with one column" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do
+          table.column :username
+        end
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => (@users.size + 1))
+      end
+    end
+  
+    it "should have multi columns" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do
+          table.column :username
+          table.column :price
+        end
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => ((@users.size * 2) + 1))
+      end
+    end
+    
+    it "should works with multi types" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do
+          table.column :username
+          table.column :test
+          table.column 'hello'
+          table.column image_tag('rails.png')
+          table.column :action => :edit
+        end
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => @users.first.username)
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => '')
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(3)", :text => 'hello')
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(4) img")
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(5) a")
+      end
+    end
+    
+    it "should customize html" do
+      table_html = helper.sorting_table_for(@users, :html => { :class => 'table_class', :id => 'table_id' }) do |table|
+        html = table.columns :html => { :class => 'hello_class', :id => 'hello_id', :title => 'hello_title' } do
+          table.column :username, :html => { :class => 'hi_class', :id => 'hi_id', :title => 'hi_title' }
+        end
+        html.should have_comp_tag("tr:nth-child(2)[class='hello_class odd'][id=hello_id][title=hello_title]")
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)[class='hi_class'][id=hi_id][title=hi_title]")
+      end
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class='table_class sorting_table_for'][id=table_id]")
+    end
+    
+  end
+  
+  describe " #table column with value" do
+    
+    it "should have the row collection" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do |value|
+          table.column value.username
+        end
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => (@users.size + 1))
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => @users.first.username)
+      end
+    end
+    
+    it "should have symbol and value" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do |value|
+          table.column :price
+          table.column (value.price - 1)
+        end
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)", :text => number_to_currency(@users.first.price))
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(2)", :text => (@users.first.price - 1).to_s)
+      end
+    end
+    
+  end
+  
+  describe " #table sub column" do
+  
+    it "should not change symbol" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do
+          table.column do
+            :username
+          end
+          table.column do
+            'hello'
+          end
+        end
+        if SortingTableFor::Tools::rails3?
+          html.should have_comp_tag('tr:nth-child(2) td:nth-child(1)', :text => '')
+        else
+          html.should have_comp_tag('tr:nth-child(2) td:nth-child(1)', :text => 'username')
+        end
+        html.should have_comp_tag('tr:nth-child(2) td:nth-child(2)', :text => 'hello')
+      end
+    end
+  
+    it "should works with value" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do |value|
+          table.column do
+            value.username
+          end
+        end
+        html.should have_comp_tag('tr:nth-child(2) td:nth-child(1)', :text => @users.first.username)
+      end
+    end
+  
+    it "should customize html" do
+      table_html = helper.sorting_table_for(@users, :html => { :class => 'table_class', :id => 'table_id' }) do |table|
+        html = table.columns :html => { :class => 'hello_class', :id => 'hello_id', :title => 'hello_title' } do
+          table.column :html => { :class => 'hi_class', :id => 'hi_id', :title => 'hi_title' } do
+            'hello'
+          end
+        end
+        html.should have_comp_tag("tr:nth-child(2)[class='hello_class odd'][id=hello_id][title=hello_title]")
+        html.should have_comp_tag("tr:nth-child(2) td:nth-child(1)[class='hi_class'][id=hi_id][title=hi_title]")
+      end
+      helper.output_buffer.concat(table_html)
+      helper.output_buffer.should have_comp_tag("table[class='table_class sorting_table_for'][id=table_id]")
+    end
+    
+  end
+  
+  describe ' #With editable options' do
+    
+    before :each do
+      ## Restaure default values
+      SortingTableFor::TableBuilder.show_total_entries = true
+      SortingTableFor::TableBuilder.reserved_columns = [:id, :password, :salt]
+      SortingTableFor::TableBuilder.default_actions = [:edit, :delete]
+    end
+    
+    it "should not add total entries" do
+      SortingTableFor::TableBuilder.show_total_entries = false
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should_not match("Total Entries " + @users.size.to_s)
+        html.should_not match("<td colspan=\"" + (User.content_columns.size + 2).to_s  + "\">")        
+      end
+    end
+    
+    it "should add total entries" do
+      SortingTableFor::TableBuilder.show_total_entries = true
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should match("Total Entries " + @users.size.to_s)
+        html.should match("<td colspan=\"" + (User.content_columns.size + 2).to_s  + "\">")        
+      end
+    end    
+    
+    it "should change reserved columns" do
+      SortingTableFor::TableBuilder.reserved_columns = [:id, :firstname, :lastname, :position, :salary, :price, :active, :created_at, :updated_at]
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns
+        html.should have_comp_tag("tr", :count => (@users.size + 1))
+        html.should have_comp_tag("td", :count => ((@users.size * 3) + 1))
+      end
+    end
+    
+    it "Reserved columns should not impact on column" do
+      SortingTableFor::TableBuilder.reserved_columns = [:id, :firstname, :lastname, :position, :salary, :price, :active, :created_at, :updated_at]
+      helper.sorting_table_for(@users) do |table|
+        html = table.columns do
+          table.column :username
+          table.column :price
+        end
+        html.should have_comp_tag("td", :count => ((@users.size * 2) + 1))
+      end
+    end
+    
+    it "should edit default actions" do
+      SortingTableFor::TableBuilder.default_actions = [:show, :edit_password, :edit, :delete]
+      helper.sorting_table_for(@users) do |table|
+        table.columns.should have_comp_tag("td", :count => (@users.size * (User.content_columns.size + 4)) + 1)
+      end
+    end
+    
+    it "should edit default actions" do
+      pending('should check if the links are valids')
+      SortingTableFor::TableBuilder.default_actions = [:show, :edit_password, :edit, :delete]
+      helper.sorting_table_for(@users) do |table|
+      end
+    end    
+    
+  end
+  ## Add spec for links
+end