sorting_table_for 0.1.2 → 0.2.0

data/lib/sorting_table_for/table_builder.rb

@@ -13,7 +13,8 @@ module SortingTableFor
                                :default_boolean, :show_total_entries,
                                :params_sort_table, :i18n_default_format_date,
                                :html_sorting_class, :default_actions,
-                               :i18n_default_scope, :i18n_add_header_action_scope
+                               :i18n_default_scope, :i18n_add_header_action_scope,
+                               :i18n_add_footer_action_scope
     
     self.reserved_columns             = [:id, :password, :salt]
     self.currency_columns             = [:price, :total_price, :currency, :money]
@@ -25,11 +26,12 @@ module SortingTableFor
     self.default_actions              = [:edit, :delete]
     self.i18n_default_scope           = [:namespace, :controller, :action]
     self.i18n_add_header_action_scope = :header
+    self.i18n_add_footer_action_scope = :footer
     
     def initialize(collection, object_or_array, template, options, params)
       @collection, @@object_or_array, @@template, @@options, @@params = collection, object_or_array, template, options, params
-      I18n.set_options(params, model_name(@collection.first), object_or_array.first)
       set_default_global_options
+      I18n.set_options(params, model_name(@collection.first), object_or_array.first, @@options[:i18n])
       @lines = []
     end
     
@@ -75,9 +77,10 @@ module SortingTableFor
     #
     # === Options
     #
-    # All options are passed down to the fieldser HTML attribtues (id, class, title, ...) expect
-    # for option sort.
-    #   
+    # * :sort - true of false to add or not sorting
+    # * :html - Hash options: class, id, ...
+    # * :caption - set caption on td
+    # 
     #  # Html option:
     #  <% sorting_table_for @users do |table| do %>
     #    <%= table.headers :username, :firstname, :html => { :class => 'my_class', :id => 'my_id' }
@@ -170,6 +173,7 @@ module SortingTableFor
     #
     # * :sort - true of false to add or not sorting
     # * :html - Hash options: class, id, ...
+    # * :caption - set caption on td
     #
     # === Values
     #
@@ -243,6 +247,7 @@ module SortingTableFor
     # * :actions - Set actions to render
     # * :only - Columns only to render
     # * :except - Columns to not render
+    # * :caption - set caption on td    
     #
     #  # Exemples:
     #  <% sorting_table_for @users do |table| %>
@@ -318,7 +323,7 @@ module SortingTableFor
     #
     # the values given to columns can be anything. Only the symbols are the values of the collection.
     # If you give other types (string, image, ...) there won't be interpreted.
-    #    
+    # 
     def columns(*args, &block)
       column_options, html_options = get_column_and_html_options( args.extract_options! )
       @collection.each do |object|
@@ -366,6 +371,7 @@ module SortingTableFor
     # * :as - Force to render a type (:date, :time, :currency)
     # * :format - Set the I18n localization format for :date or :time (:default, :short, ...)
     # * :action - Set an action
+    # * :caption - set caption on td
     #
     #  # Exemple:
     #  <% sorting_table_for @users do |table| %>
@@ -394,6 +400,170 @@ module SortingTableFor
       nil
     end
     
+    # Create a footer around tfoot and tr.
+    # It can be called with or without a block.
+    # These two exemples are equivalent:
+    #
+    #  # With a list:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.footers :username, :firstname %>
+    #  <% end %>
+    #  
+    #  # With a block:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.footers do %>
+    #      <%= table.footer :username %>
+    #      <%= table.footer :firstname %>
+    #    <% end %>
+    #  <% end %>
+    #    
+    #  # Output:
+    #  <table class='sorting_table_for'>
+    #    <tfoot>
+    #      <tr>
+    #        <td>...</td>
+    #        <td>...</td>
+    #      </tr>
+    #    </tfoot>
+    #  </table>
+    #
+    # === Options
+    #
+    # * :html - Hash options: class, id, ...
+    # * :caption - set caption on td
+    #
+    #  # Exemples:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns :username, :cation => 5 %>
+    #  <% end %>
+    #
+    # === I18n
+    #
+    # Add a value on scope for footer. Only with symbol.
+    #
+    #  # Exemple of i18n_add_header_action_scope:
+    #  SortingTableFor::TableBuilder.i18n_add_footer_action_scope = :footer
+    #
+    #  # Ouput:
+    #  I18n.t(:edit, :scope => [:current_controller, :current_action]) => en.current_controller.current_action.footer.edit
+    #
+    def footers(*args, &block)
+      column_options, html_options = get_column_and_html_options( args.extract_options! )
+      if block_given?
+        @footer_line = FormatLine.new(args, column_options, html_options, nil, :tfoot)
+        @@template.capture(&block)
+      else
+        @footer_line = FormatLine.new(args, column_options, html_options, @collection.first, :tfoot) if !args.empty?
+      end
+      render_tfoot
+    end
+    
+    # Create a cell of footer, to have more control.
+    # It can be called with or without a block.
+    # The three exemples are equivalent:
+    #  
+    #  # With a block:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.footers do %>
+    #      <%= table.footer :username %>
+    #      <%= table.footer :firstname %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With a block:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.footers do %>
+    #      <%= table.footer do %>
+    #        <%= :username %>
+    #      <% end %>
+    #      <%= table.footer do %>
+    #        <%= :firstname %>
+    #      <% end %>
+    #    <% end %>
+    #  <% end %>    
+    #
+    # === Options
+    #
+    # * :html - Hash options: class, id, ...
+    # * :caption - set caption on td
+    #
+    #  # Exemples:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns :username, :cation => 5 %>
+    #  <% end %>
+    #
+    # === I18n
+    #
+    # Add a value on scope for footer. Only with symbol.
+    #
+    #  # Exemple of i18n_add_header_action_scope:
+    #  SortingTableFor::TableBuilder.i18n_add_footer_action_scope = :footer
+    #
+    #  # Ouput:
+    #  I18n.t(:edit, :scope => [:current_controller, :current_action]) => en.current_controller.current_action.footer.edit
+    #
+    # With block the value won't be interpreted.
+    #
+    def footer(*args, &block)
+      if block_given?
+        block = @@template.capture(&block)
+        @footer_line.add_cell(@collection.first, args, nil, block)
+      else
+        @footer_line.add_cell(@collection.first, args)
+      end
+      nil
+    end
+    
+    # Create a tag caption to set a title to the table
+    # It can be called with or without a block.
+    # The two exemples are equivalent:
+    #
+    #  # Without block
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.caption 'hello' %>
+    #  <% end %>
+    #
+    #  # With block
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.caption do %>
+    #      'hello'
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # Output:
+    #  <table class='sorting_table_for'>    
+    #    <caption>hello</caption>
+    #  </table>
+    #
+    # === Quick
+    #
+    # When called without a block or a value, caption is set with I18n translation.
+    #
+    #  # Exemple of i18n_default_scope:
+    #  SortingTableFor::TableBuilder.i18n_default_scope = [:controller, :action]
+    #
+    #  # Ouput:
+    #  I18n.t(:table_caption, :scope => [:current_controller, :current_action]) => en.current_controller.current_action.table_caption
+    #
+    # === Options
+    #
+    # * :position - To set the position of the caption: :top, :bottom, :left, :right (default: :top)
+    # * :html - Hash options: class, id, ...
+    #
+    # === Values
+    #
+    # All the values won't be interpreted.
+    #
+    def caption(*args, &block)
+      @caption[:option], @caption[:html] = get_column_and_html_options( args.extract_options! )
+      if block_given?
+        @caption[:value] = @@template.capture(&block)
+      else
+        @caption[:value] = (args.empty?) ? I18n.t(:table_caption) : args.first;
+      end
+      render_caption
+    end
+    
     protected
     
     # Return the name of the model
@@ -403,6 +573,16 @@ module SortingTableFor
     
     private
     
+    def render_caption
+      if @caption
+        if @caption.has_key? :option and @caption[:option].has_key? :position
+          @caption[:html].merge!(:align => @caption[:option][:position])
+        end
+        return Tools::html_safe(content_tag(:caption, @caption[:value], @caption[:html]))
+      end
+      ''
+    end
+    
     # Return the balise thead and its content
     def render_thead
       if @header_line
@@ -419,10 +599,22 @@ module SortingTableFor
       ''
     end
     
+    # Return the balise tfoot and its content
+    def render_tfoot
+      if @footer_line
+        return Tools::html_safe(content_tag(:tfoot, @footer_line.render_line))
+      end
+      ''
+    end
+    
     # Set default global options
+    # init caption to a new hash
     # Set sort to true if the value isn't defined in options
+    # Set i18n to true if the value isn't defined in options
     def set_default_global_options
+      @caption = {}
       @@options[:sort] = true if !defined?(@@options[:sort]) or !@@options.has_key? :sort
+      @@options[:i18n] = true if !defined?(@@options[:i18n]) or !@@options.has_key? :i18n
     end
     
     # Calculate the total entries
@@ -430,7 +622,9 @@ module SortingTableFor
     def render_total_entries
       if self.show_total_entries
         total_entries = @collection.total_entries rescue @collection.size
-        return Tools::html_safe(content_tag(:tr, content_tag(:td, I18n.t(:total_entries, :scope => :sorting_table_for, :value => total_entries), {:colspan => @lines.first.total_cells}), { :class => 'total-entries' }))
+        header_total_cells = @header_line ? @header_line.total_cells : 0
+        max_cells = (@lines.first.total_cells > header_total_cells) ? @lines.first.total_cells : header_total_cells
+        return Tools::html_safe(content_tag(:tr, content_tag(:td, I18n.t(:total_entries, :scope => :sorting_table_for, :value => total_entries), {:colspan => max_cells}), { :class => 'total-entries' }))
       end
       ''
     end
@@ -459,18 +653,20 @@ module SortingTableFor
       @cells << FormatCell.new(object, args, type, block)
     end
     
-    # Return a tr line based on the type (:thead or :tbody)
+    # Return a tr line based on the type (:thead, :tbody or :tfoot) 
     def render_line
       if @type == :thead
-        header = content_tag(:tr, Tools::html_safe(@cells.collect { |cell| cell.render_cell_thead }.join), @html_options)
+        return content_tag(:tr, Tools::html_safe(@cells.collect { |cell| cell.render_cell_thead }.join), @html_options)
+      elsif @type == :tfoot
+        return content_tag(:tr, Tools::html_safe(@cells.collect { |cell| cell.render_cell_tfoot }.join), @html_options)
       else
         content_tag(:tr, Tools::html_safe(@cells.collect { |cell| cell.render_cell_tbody }.join), @html_options.merge(:class => "#{@html_options[:class]} #{@@template.cycle(:odd, :even)}".strip))
       end
     end
     
-    # Return a string with the total of cells
+    # Return the number of cells in line
     def total_cells
-      @cells.size.to_s
+      @cells.size
     end
     
     protected
@@ -492,14 +688,34 @@ module SortingTableFor
     def can_sort_column?(column)
       model_have_column?(column)
     end
-    
+
+    # Options only for cells
+    def only_cell_option?(key)
+      [:colspan].include? key
+    end
+
+    # Format ask to send options to cell
+    def format_options_to_cell(ask, options = @column_options)
+      options.each do |key, value|
+        if only_cell_option?(key)
+          if ask.is_a? Hash
+            ask.merge!(key => value)
+          else            
+            ask = [ask] unless ask.is_a? Array
+            (ask.last.is_a? Hash and ask.last.has_key? :html) ? ask.last[:html].merge!(key => value) : ask << { :html =>  { key => value }} 
+          end
+        end
+      end
+      ask
+    end
+
     private
     
     # Call after headers or columns with no attributes (table.headers)
     # Create all the cells based on each column in the model's database table
     # Create cell's actions based on option default_actions or on actions given (:actions => [:edit])
     def create_cells
-      @attributes.each { |ask| add_cell(@object, ask) }
+      @attributes.each { |ask| add_cell(@object, format_options_to_cell(ask)) }
       if @args.empty?
         TableBuilder.default_actions.each { |action| add_cell(@object, action, :action) }
       else
@@ -568,7 +784,7 @@ module SortingTableFor
     # Return a td with the formated value or action for headers
     def render_cell_thead
       if @ask
-        cell_value = (@ask.is_a?(Symbol)) ? I18n.t(@ask, {}, true) : @ask
+        cell_value = (@ask.is_a?(Symbol)) ? I18n.t(@ask, {}, :header) : @ask
       else
         cell_value = @block
       end
@@ -580,6 +796,16 @@ module SortingTableFor
       end
     end
     
+    def render_cell_tfoot
+      if @ask
+        cell_value = (@ask.is_a?(Symbol)) ? I18n.t(@ask, {}, :footer) : @ask
+      else
+        cell_value = @block
+      end
+      cell_value = action_link_to(@options[:action], cell_value) if @type != :action and @options.has_key?(:action)
+      content_tag(:td, cell_value, @html_options)
+    end
+    
     private
     
     # Return options and html options for a cell
@@ -594,6 +820,7 @@ module SortingTableFor
     def set_default_options
       @html_options = {} unless defined? @html_options
       @options = {} unless defined? @options
+      @html_options = format_options_to_cell(@html_options, @options)
       @options[:sort] = @@options[:sort] if !@options.has_key? :sort
     end
     
@@ -704,4 +931,4 @@ module SortingTableFor
     end
     
   end
-end
+end

data/spec/helpers/builder_spec.rb

@@ -42,6 +42,50 @@ describe SortingTableFor, :type => :helper do
       end
     end
     
+    it "should no use i18n by default" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.headers(:username)
+        html.should have_comp_tag("th:nth-child(1)", :text => 'Usernames')
+      end
+    end
+    
+    it "should not use i18n" do
+      helper.sorting_table_for(@users, :i18n => false) do |table|
+        html = table.headers(:username)
+        html.should have_comp_tag("th:nth-child(1)", :text => 'username')
+      end
+    end
+    
   end
+   
+  describe " #All" do
     
+    it "should works with by default" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption
+        html += table.headers
+        html += table.columns
+        html += table.footers :username
+        html.should have_comp_tag("caption", :count => 1)
+        html.should have_comp_tag("thead", :count => 1)
+        html.should have_comp_tag("tbody", :count => 1)
+        html.should have_comp_tag("tfoot", :count => 1)
+      end
+    end
+    
+    it "should works with by default" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption 'hello'
+        html += table.headers :username
+        html += table.columns :username
+        html += table.footers :username
+        html.should have_comp_tag("thead tr th", :count => 1)
+        html.should have_comp_tag("tbody tr td", :count => @users.count + 1)
+        html.should have_comp_tag("tbody tr[class=total-entries] td", :count => 1)
+        html.should have_comp_tag("tfoot tr td", :count => 1)
+      end
+    end    
+    
+  end 
+  
 end

data/spec/helpers/caption_spec.rb

@@ -0,0 +1,162 @@
+# 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 ' #Caption' do
+    
+    describe ' #Without block' do
+      
+      it "should set caption tag" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption
+          html.should have_comp_tag("caption", :count => 1)
+        end
+      end
+    
+      it "should set caption tag with arguments" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption 'hello'
+          html.should have_comp_tag("caption", :text => 'hello')
+        end
+      end
+    
+      it "should set caption tag with arguments and option position left" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption 'hello', :position => :left
+          html.should have_comp_tag("caption[align=left]")
+        end
+      end
+      
+      it "should set caption tag with arguments and option position bottom" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption 'hello', :position => :bottom
+          html.should have_comp_tag("caption[align=bottom]")
+        end
+      end
+      
+      it "should works with html options" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption 'hello', :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'}
+          html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title]")
+        end
+      end
+      
+      it "should works with html options and position option" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption 'hello', :position => :right, :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'}
+          html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title][align=right]")
+        end
+      end
+      
+    end
+    
+    describe ' #With block' do
+      
+      it "should set caption tag" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption {}
+          html.should have_comp_tag("caption", :count => 1)
+        end
+      end
+      
+      it "should set caption tag with arguments" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption do
+            'hello'
+          end
+          html.should have_comp_tag("caption", :text => 'hello')
+        end
+      end
+    
+      it "should set caption tag with arguments and option position left" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption :position => :left do
+            'hello'
+          end 
+          html.should have_comp_tag("caption[align=left]")
+        end
+      end
+ 
+      it "should set caption tag with arguments and option position bottom" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption :position => :bottom do
+            'hello'
+          end
+          html.should have_comp_tag("caption[align=bottom]")
+        end
+      end
+      
+      it "should works with html options" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'} do
+            'hello'
+          end
+          html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title]")
+        end
+      end
+      
+      it "should works with html options and position option" do
+        helper.sorting_table_for(@users) do |table|
+          html = table.caption :position => :right, :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'} do
+            'hello'
+          end
+          html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title][align=right]")
+        end
+      end
+      
+    end
+  end
+  
+  describe " #Quick" do
+  
+    it "should set caption tag with i18n translation" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption
+        html.should have_comp_tag("caption", :count => 1)
+        html.should have_comp_tag("caption", :text => 'Quick Caption')
+      end
+    end
+  
+    it "should set caption tag with arguments and option position left" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption :position => :left
+        html.should have_comp_tag("caption[align=left]")
+      end
+    end
+    
+    it "should set caption tag with arguments and option position bottom" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption :position => :bottom
+        html.should have_comp_tag("caption[align=bottom]")
+      end
+    end
+    
+    it "should works with html options" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'}
+        html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title]")
+      end
+    end
+    
+    it "should works with html options and position option" do
+      helper.sorting_table_for(@users) do |table|
+        html = table.caption :position => :right, :html => {:class => 'my_class', :id => 'my_id', :title => 'my_title'}
+        html.should have_comp_tag("caption[class=my_class][id=my_id][title=my_title][align=right]")
+      end
+    end
+    
+  end
+  
+end