sorting_table_for 0.1.0 → 0.1.2

data/CHANGELOG.mdown

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+### Version 0.1.2 _(November 02, 2010)_
+
+* Problem with date
+
+### Version 0.1.1 _(November 02, 2010)_
+
+* Add documentation
+* Fix a bug with sort options
+
+### Version 0.1.0 _(October 29, 2010)_
+
+* Initial commit

data/README.mdown

@@ -12,11 +12,18 @@ SortingTableFor is a Rails TableBuilder made to easily create table or sort a ta
 
 ## Installation
 
-Install with git
+In Rails 3, add this to your Gemfile.
+
+    gem "sorting_table_for"
+
+In Rails 2, add this to your environment.rb file.
+
+    config.gem "sorting_table_for"
+
+Alternatively, you can install it as a plugin.
+
+    rails plugin install git://github.com/arkownz/sorting_table_for.git
 
-    cd your_rails_app
-    cd vendor/plugins
-    git clone git://github.com/arkownz/sorting_table_for.git
 
 ## Usage
 

data/TODO

@@ -0,0 +1,4 @@
+New Version :
+
+√ - Add comment in code
+- Add spec for routes

data/lib/model/sorting_table_model_scope.rb

@@ -2,29 +2,46 @@
 
 module SortingTableModelScope
   
+  # Include the methods in models
   def self.included(base)
     base.extend(SingletonMethods)
   end
   
   module SingletonMethods
-
+    
+    # Return a scope of the object with an order
+    #
+    # === Usage
+    # 
+    #  sorting_table(the params) - Sorting by the given parameters
+    #  sorting_table(the params, column name) - Sort by the column name with direction ascending, if no parameters
+    #  sorting_table(the params, column name, direction) - Sort by the column name with the given direction, if no parameters
+    #
+    # === Exemples
+    #
+    #  User.sorting_table(params)
+    #  User.sorting_table(params, :username)
+    #  User.sorting_table(params, :username, :desc)
+    #
     def sorting_table(*args)
       raise ArgumentError, 'sorting_table: Too many arguments (max : 3)' if args.size > 3 
       sort_table_param = get_sorting_table_params(args)
       return scoped({})  if !sort_table_param and args.size == 1
       sort, direction = get_sort_and_direction(sort_table_param, args)
       return scoped({}) if !sort or !valid_column?(sort) or !valid_direction?(direction)
-      return scoped({ :order => "#{sort} #{direction}" })
+      scoped({ :order => "#{sort} #{direction}" })
     end
 
     private
-
+    
+    # Return the params for sorting table
     def get_sorting_table_params(args)
-      return nil unless args.first.is_a? Hash      
+      return nil unless args.first.is_a? Hash
       return nil unless args.first.has_key? SortingTableFor::TableBuilder.params_sort_table.to_s
       args.first[SortingTableFor::TableBuilder.params_sort_table.to_s]
     end
-  
+    
+    # Parse the params and return the column name and the direction
     def get_sort_and_direction(sort_table_param, args)
       if sort_table_param
         key = sort_table_param.keys.first rescue nil
@@ -37,10 +54,12 @@ module SortingTableModelScope
       return args[1], args[2]
     end
     
+    # Return true if the column name exist
     def valid_column?(column)
       column_names.include? column.to_s.downcase
     end
     
+    # Return true if the direction exist
     def valid_direction?(direction)
       %[asc desc].include? direction.to_s.downcase
     end

data/lib/sorting_table_for.rb

@@ -6,6 +6,24 @@ require 'sorting_table_for/tools'
 
 module SortingTableFor
   
+  # Method sorting_table_for with builder => SortingTableFor::TableBuilder
+  #
+  #  # Exemples :
+  #  <% sorting_table_for @users do |table| %>
+  #  <% end %>
+  #
+  #  <% sorting_table_for @users do |table| %>
+  #    <%= table.headers %>
+  #    <%= table.columns %>
+  #  <% end %>
+  #
+  # === Options
+  #
+  # * :builder - Set a table builder (default: SortingTableFor::TableBuilder)
+  # * :html - Set html options (id, class, ...)
+  # * :remote_link - To set actions link with ajax (true or false)
+  # * :remote_sort - To set link for sorting with ajax (true of false)
+  #
   def sorting_table_for(object_or_array, *args)
     raise ArgumentError, 'Missing block' unless block_given?
     options = args.extract_options!

data/lib/sorting_table_for/i18n.rb

@@ -4,10 +4,13 @@ module SortingTableFor
   module I18n    
     class << self
       
+      # Set options to create a default scope
       def set_options(params, model_name, namespace)
         @params, @model_name, @namespace = params, model_name, namespace
       end
       
+      # Translate
+      # Add a default scope if option scope isn't defined
       def translate(attribute, options = {}, action_header = false)
         if !options.has_key? :scope
           options[:scope] = create_scope 
@@ -18,7 +21,8 @@ module SortingTableFor
       alias :t :translate
       
       private
-
+      
+      # Return an array with the scope based on option: SortingTableFor::TableBuilder.i18n_default_scope
       def create_scope
         return TableBuilder.i18n_default_scope.collect do |scope_value|
           case scope_value.to_sym

data/lib/sorting_table_for/table_builder.rb

@@ -33,8 +33,101 @@ module SortingTableFor
       @lines = []
     end
     
-    ##  Headers
-    
+    # Create a header with the name of the columns (th) around thead and tr.
+    # It can be called with or without a block, or with a list of columns.
+    # By default it will add the default actions (edit, delete).
+    # Also by default it will add a link to sort to the column.
+    # These two exemples are equivalent:
+    # 
+    #  # With a block:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.headers do %>
+    #      <%= table.header :username %>
+    #      <%= table.header :firstname %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With a list:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.headers :username, :firstname %>
+    #  <% end %>
+    #
+    #  # Output:
+    #  <table class='sorting_table_for'>
+    #    <thead>
+    #      <tr>
+    #        <th class='cur-sort-not'><a href='/my_link?table_sort[username]=asc'>...</a></th>
+    #        <th class='cur-sort-not'><a href='/my_link?table_sort[firstname]=asc'>...</a></th>
+    #        <th>Edit</th>
+    #        <th>Delete</th>
+    #      </tr>
+    #    </thead>
+    #  </table>
+    #
+    # === Quick Headers
+    #
+    # When called without a block or a list, the headers are rendered for each column in 
+    # the model's database table and the default actions (edit, delete), and the links to sort.
+    #
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.headers %>
+    #  <% end %>
+    #
+    # === Options
+    #
+    # All options are passed down to the fieldser HTML attribtues (id, class, title, ...) expect
+    # for option sort.
+    #   
+    #  # Html option:
+    #  <% sorting_table_for @users do |table| do %>
+    #    <%= table.headers :username, :firstname, :html => { :class => 'my_class', :id => 'my_id' }
+    #  <% end %>
+    #
+    #  # Sort option:
+    #  <% sorting_table_for @users do |table| do %>
+    #    <%= table.headers :sort => false %>
+    #  <% end %>
+    #
+    # === I18n
+    #
+    # For each column contained in the model's database table, the name is set with the I18n translation.
+    # The translation are scoped by option 'i18n_default_scope' defined in your options.
+    #
+    #  # Exemple of I18n options for header:
+    #  SortingTableFor::TableBuilder.i18n_default_scope = [:controller, :action]
+    #
+    #  # Ouput:
+    #  I18n.t(:username, :scope => [:current_controller, :current_action]) => en.current_controller.current_action.username
+    #
+    # === Actions
+    #
+    # The option 'default_actions' contained the actions to add by default to the table. The header's actions
+    # are not sortable. The name of action is set with I18n translation.
+    # It's possible to add a value in the scope for header by option 'i18n_add_header_action_scope'
+    #
+    #  # Exemple of default_actions:
+    #  SortingTableFor::TableBuilder.default_actions = [:edit]
+    #  SortingTableFor::TableBuilder.i18n_add_header_action_scope = :header
+    #
+    #  # Ouput:
+    #  I18n.t(:edit, :scope => [:current_controller, :current_action, :header]) => en.current_controller.current_action.header.edit
+    #
+    # === Sorting
+    #
+    # The link for sorting is set if the column is contained in the model's database table. the link for sorting
+    # is set with the current url, the builder adds a param 'table_sort'.
+    # 
+    #  # Exemple for column username:
+    #  current url: /my_link
+    #  param sort: /my_link?table_sort[username]=asc
+    #
+    # the name of the param is set by option: TableSortingFor::TableBuilder.params_sort_table
+    #
+    # === Values
+    #
+    # the values given to headers could be anything. Only the symbols are set with I18n translation.
+    # If you give other types (string, image, ...) there won't have sorting and I18n translation.
+    #
     def headers(*args, &block)
       column_options, html_options = get_column_and_html_options( args.extract_options! )
       if block_given?
@@ -46,6 +139,45 @@ module SortingTableFor
       render_thead
     end
     
+    # Create a cell of header, to have more control.
+    # It can be called with or without a block.
+    # The three exemples are equivalent:
+    #
+    #  # Without block (I18n and sorting)
+    #  <% sorting_table_for @users do |table| %> 
+    #    <%= table.headers do %>
+    #      <%= table.header :username %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With string (no I18n and no sorting)
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.headers do %>
+    #      <%= table.header 'hello_my_header' %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With a block and image (no I18n and no sorting)
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.headers do %>
+    #      <%= table.header do %>
+    #        <%= image_tag('rails.png') %>
+    #      <% end %>
+    #    <% end %>
+    #  <% end %>
+    #
+    # === Options
+    #
+    # * :sort - true of false to add or not sorting
+    # * :html - Hash options: class, id, ...
+    #
+    # === Values
+    #
+    # the values given to header can be anything. Only the symbols are set with I18n translation.
+    # If you give other types (string, image, ...) there won't have sorting and I18n translation.
+    #
+    # With block there won't have sorting and translation.
+    #
     def header(*args, &block)
       if block_given?
         block = @@template.capture(&block)
@@ -56,8 +188,137 @@ module SortingTableFor
       nil
     end
     
-    ##  Columns
-    
+    # Create the content of table with the values of collection (td) around tbody and tr.
+    # It can be called with or without a block, or with a list of columns.
+    # By default it will add the default actions (edit, delete).
+    # The method columns return the current object of the collection.
+    # These three exemples are equivalent:
+    #
+    #  # With a list:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns :username, :firstname %>
+    #  <% end %>
+    #  
+    #  # With a block:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns do %>
+    #      <%= table.column :username %>
+    #      <%= table.column :firstname %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With a block and current object:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns do |user| %>
+    #      <%= table.column user.username %>
+    #      <%= table.column user.firstname %>
+    #    <% end %>
+    #  <% end %>
+    #    
+    #  # Output:
+    #  <table class='sorting_table_for'>
+    #    <tbody>
+    #      <tr>
+    #        <td>...</td>
+    #        <td>...</td>
+    #        <td><a href='/users/1/edit'>Edit<a></td>
+    #        <td><a href='/users/1'>Delete</a></td>
+    #      </tr>
+    #      ...
+    #    </tbody>
+    #  </table>
+    #
+    # === Quick Columns
+    #
+    # When called without a block or a list, the columns are rendered for each column in 
+    # the model's database table and the default actions (edit, delete).
+    #
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns %>
+    #  <% end %>
+    #
+    # === Options
+    #
+    # * :html - Hash options: class, id, ...
+    # * :actions - Set actions to render
+    # * :only - Columns only to render
+    # * :except - Columns to not render
+    #
+    #  # Exemples:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns :username, :actions => [:edit, :delete] %>
+    #  <% end %>
+    #
+    #  <% sorting_table for @users do |table| %>
+    #    <%= table.columns :except => [:created_at, :updated_at] %>
+    #  <% end %>
+    #
+    # === I18n
+    #
+    # For each action, the name is set with the I18n translation.
+    #
+    #  # Exemple of i18n_default_scope:
+    #  SortingTableFor::TableBuilder.i18n_default_scope = [:controller, :action]
+    #
+    #  # Ouput:
+    #  I18n.t(:edit, :scope => [:current_controller, :current_action]) => en.current_controller.current_action.edit
+    # 
+    # === Actions
+    #
+    # The option 'default_actions' contains the actions to add by default to the table. The link to actions
+    # is set by the collection sent to the method sorting_table_for.
+    # The name of action is set with I18n translation.
+    #
+    #  # Exemple of default_actions:
+    #  SortingTableFor::TableBuilder.default_actions = [:edit]
+    #
+    #  # Ouput:
+    #  link_to( I18n.t(:edit, :scope => [:current_controller, :current_action]), [:edit, user]) => /users/1/edit
+    #
+    # For action :delete the builder set a confirm message with I18n translation.
+    #
+    #  # the I18n confirm message:
+    #  I18n.t(:confirm_delete, :scope => [:current_controller, :current_action])
+    #
+    # === Total entries
+    #
+    # The first tr of the columns are the number of results in the collection. The line appears if
+    # option 'show_total_entries' is set to true.
+    #
+    #  # Exemple of option:
+    #  SortingTableFor::TableBuilder.show_total_entries = true
+    #
+    #  # Exemple:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns :username, :firstname %>
+    #  <% end %>
+    #
+    #  # Ouput:
+    #  <table class='sorting_table_for'>
+    #    <tbody>
+    #      <tr>
+    #        <td colspan='2' class='total-entries'>Total Entries: 42</td>
+    #      </tr>
+    #      <tr>
+    #        <td>...</td>
+    #        <td>...</td>
+    #      </tr>
+    #      ...
+    #    </tbody>
+    #  </table>
+    #
+    # A colspan is added by default with the number of columns.
+    # Total entries are compatible with the plugin 'will_paginate'.
+    # The total entries text if defined by I18n translation.
+    #
+    #  # I18n translation: 
+    #  I18n.t(:total_entries, :scope => :sorting_table_for, :value => total_entries)
+    #
+    # === Values
+    #
+    # 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|
@@ -71,7 +332,58 @@ module SortingTableFor
       end
       render_tbody
     end
-    
+
+    # Create a cell of column, to have more control.
+    # It can be called with or without a block.
+    # The three exemples are equivalent:
+    #
+    #  # Without block
+    #  <% sorting_table_for @users do |table| %> 
+    #    <%= table.columns do %>
+    #      <%= table.column :username %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With current object
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns do |user| %>
+    #      <%= table.column user.username %>
+    #    <% end %>
+    #  <% end %>
+    #
+    #  # With a block and current object
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.columns do |user| %>
+    #      <%= table.column do %>
+    #        <%= user.username %>
+    #      <% end %>
+    #    <% end %>
+    #  <% end %>
+    #
+    # === Options
+    #
+    # * :html - Hash options: class, id, ...
+    # * :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
+    #
+    #  # Exemple:
+    #  <% sorting_table_for @users do |table| %>
+    #    <%= table.colums do |user| %>
+    #      <%= table.column :username, :html => { :class => 'my_class', :id => 'my_id' }
+    #      <%= table.column user.username, :action => :show %>
+    #      <%= table.column user.created_at, :as => :date, :format => :short %>
+    #      <%= table.column :action => :edit %>
+    #    <% end %>
+    #  <% end %>
+    #
+    # === Values
+    #
+    # the values given to column can be anything. Only the symbols are set with I18n translation.
+    # If you give other types (string, image, ...) there won't be interpreted.
+    #
+    # With block the value won't be interpreted.
+    #    
     def column(*args, &block)
       if block_given?
         block = @@template.capture(&block)
@@ -84,20 +396,22 @@ module SortingTableFor
     
     protected
     
-    # This function is a copy from Formtastic: http://github.com/justinfrench/formtastic
+    # Return the name of the model
     def model_name(object)
       object.present? ? object.class.name : object.to_s.classify
     end
     
     private
-
+    
+    # Return the balise thead and its content
     def render_thead
       if @header_line
         return Tools::html_safe(content_tag(:thead, @header_line.render_line))
       end
       ''
     end
-
+    
+    # Return the balise tbody and its content
     def render_tbody
       if @lines and @lines.size > 0
         return Tools::html_safe(content_tag(:tbody, render_total_entries + Tools::html_safe(@lines.collect { |line| line.render_line }.join)))
@@ -105,10 +419,14 @@ module SortingTableFor
       ''
     end
     
+    # Set default global options
+    # Set sort to true if the value isn't defined in options
     def set_default_global_options
-      @@options[:sort] = true unless @@options.has_key? :sort
+      @@options[:sort] = true if !defined?(@@options[:sort]) or !@@options.has_key? :sort
     end
     
+    # Calculate the total entries
+    # Return a tr and td with a colspan of total entries
     def render_total_entries
       if self.show_total_entries
         total_entries = @collection.total_entries rescue @collection.size
@@ -117,18 +435,13 @@ module SortingTableFor
       ''
     end
     
+    # Return options and html options
     def get_column_and_html_options(options)
       return options, options.delete(:html) || {}
     end
     
   end
   
-  ##
-  ##  Format Lines
-  ##
-  ##
-  ##
-  
   class FormatLine < TableBuilder
     
     def initialize(args, column_options = {}, html_options = {}, object = nil, type = nil)
@@ -140,10 +453,13 @@ module SortingTableFor
       end
     end
     
-    def add_cell(object, args, type =nil, block = nil)
+    # Create a new cell with the class FormatCell
+    # Add the object in @cells
+    def add_cell(object, args, type = nil, block = nil)
       @cells << FormatCell.new(object, args, type, block)
     end
     
+    # Return a tr line based on the type (:thead or :tbody)
     def render_line
       if @type == :thead
         header = content_tag(:tr, Tools::html_safe(@cells.collect { |cell| cell.render_cell_thead }.join), @html_options)
@@ -152,17 +468,19 @@ module SortingTableFor
       end
     end
     
+    # Return a string with the total of cells
     def total_cells
       @cells.size.to_s
     end
     
     protected
     
-    # This function is a copy from Formtastic: http://github.com/justinfrench/formtastic
+    # Return each column in the model's database table
     def content_columns
       model_name(@object).constantize.content_columns.collect { |c| c.name.to_sym }.compact rescue []
     end
     
+    # Return true if the column is in the model's database table
     def model_have_column?(column)
       model_name(@object).constantize.content_columns.each do |model_column|
         return true if model_column.name == column.to_s
@@ -170,12 +488,16 @@ module SortingTableFor
       false
     end
     
+    # Return true if the column is in the model's database table
     def can_sort_column?(column)
       model_have_column?(column)
     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) }
       if @args.empty?
@@ -185,6 +507,7 @@ module SortingTableFor
       end
     end
     
+    # Return an Array of all actions given to headers or columns (:actions => [:edit, :delete])
     def get_column_actions
       if @column_options.has_key? :actions
         if @column_options[:actions].is_a?(Array)
@@ -196,6 +519,7 @@ module SortingTableFor
       []
     end
     
+    # Return an Array of the columns based on options :only or :except
     def get_columns
       if @column_options.has_key? :only
         return @column_options[:only] if @column_options[:only].is_a?(Array)
@@ -210,12 +534,6 @@ module SortingTableFor
 
   end
 
-  ##
-  ## Format Cells
-  ##
-  ##
-  ##
-
   class FormatCell < FormatLine
     
     def initialize(object, args, type = nil, block = nil)
@@ -234,6 +552,7 @@ module SortingTableFor
       @can_sort = true if @options and @options[:sort] and can_sort_column?(@ask)
     end
     
+    # Return a td with the formated value or action for columns
     def render_cell_tbody
       if @type == :action
         cell_value = action_link_to(@ask)
@@ -246,6 +565,7 @@ module SortingTableFor
       content_tag(:td, cell_value, @html_options)
     end
     
+    # 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
@@ -262,16 +582,23 @@ module SortingTableFor
     
     private
     
+    # Return options and html options for a cell
     def get_cell_and_html_options(options)
       return options, options.delete(:html) || {}
     end
     
+    # Set default options for cell
+    # Set an empty hash if no html options
+    # Set an empty hash if no options
+    # Set sort to true if no options sort
     def set_default_options
       @html_options = {} unless defined? @html_options
       @options = {} unless defined? @options
-      @options[:sort] = @@options[:sort] or true if !@options.has_key? :sort
+      @options[:sort] = @@options[:sort] if !@options.has_key? :sort
     end
     
+    # Create the link for actions
+    # Set the I18n translation or the given block for the link's name
     def action_link_to(action, block = nil)
       object_or_array = @@object_or_array.clone
       object_or_array.push @object
@@ -286,10 +613,14 @@ module SortingTableFor
       end
     end
     
+    # Create sorting link
     def sort_link_to(name)
       create_link_to(name, sort_url, @@options[:sort_remote])
     end
     
+    # Create the link based on object
+    # Set an ajax link if option link_remote is set to true
+    # Compatible with rails 2 and 3.
     def create_link_to(block, url, remote, method = nil, confirm = nil)
       if remote and Tools::rails3?
         return @@template.link_to(block, url, :method => method, :confirm => confirm, :remote => true)
@@ -300,12 +631,17 @@ module SortingTableFor
       @@template.link_to(block, url, :method => method, :confirm => confirm)
     end
     
+    # Return a string with html class of sorting for headers
+    # The html class is based on option: SortingTableFor::TableBuilder.html_sorting_class
     def sorting_html_class
       return TableBuilder.html_sorting_class.first if current_sorting.nil?
       return TableBuilder.html_sorting_class.second if current_sorting == :asc
       TableBuilder.html_sorting_class.third
     end
     
+    # Return an url for sorting
+    # Add the param sorting_table[name]=direction to the url
+    # Add the default direction: :asc
     def sort_url
       url_params = @@params.clone
       if url_params.has_key? TableBuilder.params_sort_table
@@ -319,6 +655,7 @@ module SortingTableFor
       @@template.url_for(url_params)
     end
     
+    # Return a symbol of the current sorting (:asc, :desc, nil)
     def current_sorting
       if @@params.has_key? TableBuilder.params_sort_table and @@params[TableBuilder.params_sort_table].has_key? @ask
         return @@params[TableBuilder.params_sort_table][@ask].to_sym
@@ -326,12 +663,14 @@ module SortingTableFor
       nil
     end
     
+    # Return a symbol, the inverse of the current sorting
     def inverse_sorting
       return :asc if current_sorting.nil?
       return :desc if current_sorting == :asc
       :asc
     end
     
+    # Return the formated cell's value
     def format_cell_value(value, attribute = nil)
       unless (ret_value = format_cell_value_as_ask(value)).nil?
         return ret_value
@@ -339,6 +678,7 @@ module SortingTableFor
       format_cell_value_as_type(value, attribute)
     end
     
+    # Format the value if option :as is set
     def format_cell_value_as_ask(value)
       return nil if !@options or @options.empty? or !@options.has_key?(:as)
       return case @options[:as]
@@ -349,6 +689,7 @@ module SortingTableFor
       end
     end
     
+    # Format the value based on value's type
     def format_cell_value_as_type(value, attribute)
       if value.is_a?(Time) or value.is_a?(Date)
         return ::I18n.l(value, :format => @options[:format] || TableBuilder.i18n_default_format_date)

data/spec/helpers/header_spec.rb

@@ -26,7 +26,7 @@ describe SortingTableFor, :type => :helper do
           html.should have_comp_tag("th", :count => 11)
         end
       end
-    
+
       it "should add sorting class on th" do
         helper.sorting_table_for(@users) do |table|
           table.headers.should have_comp_tag("th[class='cur-sort-not']", :count => 9)
@@ -181,7 +181,7 @@ describe SortingTableFor, :type => :helper do
             table.header :price
           end
           html.should_not have_comp_tag("th[class=cur-sort-not]")
-        end        
+        end
       end
     
       it "should not sort on select columns" do

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sorting_table_for
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Thomas Floch
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 +02:00
+date: 2010-11-02 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -25,8 +24,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.mdown
 files: 
 - lib/model/sorting_table_model_scope.rb
 - lib/sorting_table_for/i18n.rb
@@ -45,17 +44,19 @@ files:
 - spec/locales/test_rails3.yml
 - spec/model/sorting_table_model_scope_spec.rb
 - spec/spec_helper.rb
+- CHANGELOG.mdown
 - MIT-LICENSE
 - Rakefile
 - README.mdown
+- TODO
 - init.rb
 has_rdoc: true
 homepage: http://github.com/arkownz/sorting_table_for
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -63,7 +64,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -72,7 +72,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 19
       segments: 
       - 1
       - 3