sorting_table_for 0.1.2 → 0.2.0

data/CHANGELOG.mdown

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+### Version 0.2.0 _(November 14, 2010)_
+
+* Add footers and footer
+* Add caption
+* Add option colspan
+* Add option i18n
+* Change name on licence
+
 ### Version 0.1.2 _(November 02, 2010)_
 
 * Problem with date

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 arkownz (tom)
+Copyright (c) 2010 arkownz (Thomas Floch)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.mdown

@@ -6,9 +6,8 @@ SortingTableFor is a Rails TableBuilder made to easily create table or sort a ta
 
 ## Infos
 
-- It's Rails 2.3 and 3 compatible
+- It's Rails 2 and 3 compatible
 - I18n compatible
-- Almost fully configurable
 
 ## Installation
 
@@ -24,154 +23,183 @@ Alternatively, you can install it as a plugin.
 
     rails plugin install git://github.com/arkownz/sorting_table_for.git
 
-
 ## Usage
 
-To create a simple table
+To create a quick table
 
-    <%- sorting_table_for @users do |table| %>
+    <% sorting_table_for @users do |table| %>
       <%= table.headers %>
       <%= table.columns %>
-    <%- end %>
+    <% end %>
 
 will render
 
     <table>
       <thead>
         <tr>
-          <th><a href='/to_sort'>Username</a></th>
-          <th><a href='/to_sort'>Firstname</a></th>
+          <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>
       <tbody>
         <tr>
-          <td colspan='4'>Total rows : 1</td>
+          <td colspan='4' class='total-entries'>Total Entries: 2</td>
         </tr>
         <tr>
           <td>Test</td>
           <td>Myname</td>
-          <td><a href='/to_edit'>Edit</a></td>
-          <td><a href='/to_delete'>Delete</a></td>
+          <td><a href='/users/1/edit'>Edit</a></td>
+          <td><a href='/users/1'>Delete</a></td>
         <tr>
       </tbody>
     </table>
 
-You can specify columns and headers
+column and header can be called with a list
 
-    <%- sorting_table_for @users do |table| %>
+    <% sorting_table_for @users do |table| %>
       <%= table.headers :username, :firstname, :lastname %>
       <%= table.columns :username, :firstname, :lastname %>
-    <%- end %>
+    <% end %>
 
-On columns you can get the object of your collection.
-Your can pass to column or header what ever your want: symbol, string, image, ...
+On columns you can get the current object of your collection.
+You can give to column or header whatever you want: symbol, string, image, ...
 
-    <%- sorting_table_for @users do |table| %>
+    <% sorting_table_for @users do |table| %>
       <%= table.headers do %>
         <%= table.header :username %>
         <%= table.header :firstname %>
         <%= table.header image_tag('rails.png') %>
-      <%- end %>
+      <% end %>
       <%= table.columns do |user| %>
         <%= table.column :username %>
         <%= table.column user.firstname %>
         <%= table.column 'exemple' %>
-      <%- end %>
-    <%- end %>
+      <% end %>
+    <% end %>
     
-For more control on headers or columns
+column and header can be called with a block
 
-    <%- sorting_table_for @users do |table| %>
+    <% sorting_table_for @users do |table| %>
       <%= table.headers do %>
         <%= table.header do %>
           <%= image_tag('rails.png') %>
-        <%- end %>
-      <%- end %>
-      <%= table.columns do |val| %>
+        <% end %>
+      <% end %>
+      <%= table.columns do |user| %>
         <%= table.column do %>
-          <%= val.username.downcase %>
-        <%- end %>
-      <%- end %>
-    <%- end %>
+          <%= user.username.downcase %>
+        <% end %>
+      <% end %>
+    <% end %>
+
+### Footer
+
+You can set a footer to the table, it can be called with a list or a block
+
+    <% sorting_table_for @users do |table| %>
+      <%= table.footers :footer %>
+    <% end %>
 
-By default SortingTableFor will customize your table
+    -- equivalent --
 
-Header:
+    <% sorting_table_for @users do |table| %>
+      <%= table.footers do %>
+        <%= table.footer :footer %>
+      <% end %>
+    <% end %>
 
-- On symbol it make by default a sorting
-- On symbol it will add the translation (I18n.t)
-- On sorting it will add a class with an image to show the sort order
+### Caption
 
-Column:
+Create a tag caption to set a title to the table, it can be called
+with or without a block
 
-- On Symbol it will find the value in collection
-- On Object Date or DateTime it will add the localization (I18n.l)
-- On Column name (price, total_price, ...) it will the currency
-- On Boolean it will add the translation (I18n.t) true or false
+    <% sorting_table_for @users do |table| %>
+      <%= table.caption 'my title' %>
+    <% end %>
 
-You can customize the table
+### Options
 
-    <%- sorting_table_for @users do |table| %>
+- :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
+- :caption => Set caption on td
+- :actions => Set actions to render
+- :only => Columns to render (on list)
+- :except => Columns to not render (on list)
+- :sort => Add or not sorting (true of false)
+
+Options for sorting table for
+
+- :builder => Set a table builder
+- :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)
+- :i18n => To use or not i18n on values (true or false)
+
+Exemple
+
+    <% sorting_table_for @users do |table| %>
       <%= table.headers do %>
         <%= table.header :username %>
         <%= table.header :price, :sort => false %>
         <%= table.header :created_at %>
         <%= table.header 'today' %>
-      <%- end %>
+      <% end %>
       <%= table.columns do |user| %>
         <%= table.column user.username %>
         <%= table.column user.price, :as => :currency %>
         <%= table.column user.created, :as => :date %>
         <%= table.column DateTime.now, :as => :datetime, :format => :short %>
-      <%- end %>
-    <%- end %>
+      <% end %>
+    <% end %>
 
-You can customize the table with action
+Exemple with action
 
-    <%- sorting_table_for @users do |table| %>
+    <% sorting_table_for @users do |table| %>
       <%= table.headers do %>
         <%= table.header :username %>
         <%= table.header :action => :edit %>
-      <%- end %>
+      <% end %>
       <%= table.columns do |user| %>
         <%= table.column user.username, :action => :show %>
         <%= table.column :action => :edit %>
-      <%- end %>
-    <%- end %>
+      <% end %>
+    <% end %>
 
-You can customize the html and add title
+Exemple with html
 
-    <%- sorting_table_for @users, :html => { :class => 'my_table' } do |table| %>
+    <% sorting_table_for @users, :html => { :class => 'my_table' } do |table| %>
       <%= table.headers :html => { :class => 'my_headers', :title => 'column !' } do %>
         <%= table.header :username :html => { :class => 'header_username' } %>
         <%= table.header :firstname :html => { :title => 'hello price' } %>
-      <%- end %>
+      <% end %>
       <%= table.columns :html => { :class => 'my_columns' } do |user| %>
         <%= table.column :username :html => { :class => 'column_username' }%>
-        <%= table.column :firstname :html => { :title => "it's #{val.firstname}" } %>
-      <%- end %>
-    <%- end %>
+        <%= table.column :firstname :html => { :title => "it's #{user.firstname}" } %>
+      <% end %>
+    <% end %>
 
 ## Namespace
 
 SortingTableFor can use your namespace
 
-    <%- sorting_table_for [:admin, @users] do |table| %>
+    <% sorting_table_for [:admin, @users] do |table| %>
       <%= table.headers %>
       <%= table.columns %>
-    <%- end %>
+    <% end %>
 
 ## Sorting
 
-To add sorting in your query, you just have to add sorting_table in your query
+To add sort in your query, you just have to add sorting_table in your query
 
     def index
       @users = User.sorting_table(params).all
     end
 
-to add a default sorting 
+to add a default sorting
 
     def index
       @users = User.sorting_table(params, :username).all
@@ -187,34 +215,33 @@ to add a default sorting
 
 You can add ajax on sorting
 
-        <%- sorting_table_for @users, :sort_remote => true do |table| %>
+        <% sorting_table_for @users, :sort_remote => true do |table| %>
           <%= table.headers %>
           <%= table.columns %>
-        <%- end %>
+        <% end %>
 
 You can add ajax on links
 
-        <%- sorting_table_for @users, :link_remote => true do |table| %>
-            <%= table.headers %>
-            <%= table.columns %>
-        <%- end %>
-
-## Stylesheet
+        <% sorting_table_for @users, :link_remote => true do |table| %>
+          <%= table.headers %>
+          <%= table.columns %>
+        <% end %>
 
-there are a default stylesheet in _stylesheet_
+## Configurations
 
-- A class 'odd' or 'even' on rows
-- A class 'cur-sort-not', 'cur-sort-asc' or 'cur-sort-desc' on headers that you want to sort
+There are some options that you can modify in your initiatilizer
 
-[_Here an exemple of css file_][]
+[_see the initializer file exemple for more explanation_][]
 
-## Configurations
+## Stylesheet
 
-There are some options that you can customize in your initiatilizer
+- Class 'odd' or 'even' on rows
+- Class 'cur-sort-not', 'cur-sort-asc' or 'cur-sort-desc' on sorting headers
+- Class 'total-entries' on total entries
 
-[_see the initializer file exemple for more explanation_][]
+[_Here an exemple of css file_][]
 
-Copyright (c) 2010 arkownz (tom), released under the MIT license
+Copyright (c) 2010 arkownz (Thomas Floch), released under the MIT license
 
 [_see the initializer file exemple for more explanation_]: http://github.com/arkownz/sorting_table_for/blob/master/assets/config/initializers/sorting_table_for.rb
 [_Here an exemple of css file_]: http://github.com/arkownz/sorting_table_for/blob/master/assets/public/stylesheets/sorting_table_for.css

data/assets/config/initializers/sorting_table_for.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+## All the values here are the defauls
+
+## This is the column you don't want to show by default
+## Array with columns name
+## SortingTableFor::TableBuilder.reserved_columns = [:id, :password, :salt]
+
+## Set the currency default columns
+## Array with columns name
+## SortingTableFor::TableBuilder.currency_columns = [:price, :total_price, :currency, :money]
+
+## Set default for the boolean values
+## Array with two states
+## SortingTableFor::TableBuilder.default_boolean = [I18n.t(:bool_true, :scope => [:sorting_table_for, :columns]), I18n.t(:bool_false, :scope => [:sorting_table_for, :columns])]
+
+## Show the total entries in table
+## true or false
+## SortingTableFor::TableBuilder.show_total_entries = true
+
+## The name of the url params for sorting
+## SortingTableFor::TableBuilder.params_sort_table = :table_sort
+
+## The html classes for sorting
+## Array with the tree states
+## SortingTableFor::TableBuilder.html_sorting_class = ['cur-sort-not', 'cur_sort_asc', 'cur-sort-desc']
+
+## Set default for actions
+## Array with actions
+## SortingTableFor::TableBuilder.default_actions = [:edit, :delete]
+
+## The default format for I18n localization
+## I18n.l
+## SortingTableFor::TableBuilder.i18n_default_format_date = :default
+
+## The default scope for localisation
+## I18n.t
+## Keywords are: namespace, controller, action, model
+## SortingTableFor::TableBuilder.i18n_default_scope = [:namespace, :controller, :action]
+
+## This value is add a value by default header's scope
+## SortingTableFor::TableBuilder.i18n_add_header_action_scope = :header
+
+## This value is add a value by default footer's scope
+## SortingTableFor::TableBuilder.i18n_add_footer_action_scope = :footer

data/assets/public/images/sorting_table_for/readme.txt

@@ -0,0 +1,22 @@
+Silk icon set 1.3
+
+_________________________________________
+Mark James
+http://www.famfamfam.com/lab/icons/silk/
+_________________________________________
+
+This work is licensed under a
+Creative Commons Attribution 2.5 License.
+[ http://creativecommons.org/licenses/by/2.5/ ]
+
+This means you may use it for any purpose,
+and make any changes you like.
+All I ask is that you include a link back
+to this page in your credits.
+
+Are you using this icon set? Send me an email
+(including a link or picture if available) to
+mjames@gmail.com
+
+Any other questions about this icon set please
+contact mjames@gmail.com

data/assets/public/stylesheets/sorting_table_for.css

@@ -0,0 +1,13 @@
+table.sorting_table_for { background-color: #BCBAB6; width: 100%; font-size: 12px; }
+table.sorting_table_for thead tr th { background-color: #F0CFAD; text-align: left; color: black; padding: 4px; }
+table.sorting_table_for thead tr th a { color: black; cursor: pointer; display: block; width: 100%; height: 100%; }
+table.sorting_table_for thead tr th a:hover { text-decoration: underline; }
+table.sorting_table_for thead tr th.cur-sort-not { background: #F0CFAD url('/images/sorting_table_for/bullet_black.png') no-repeat right; }
+table.sorting_table_for thead tr th.cur-sort-asc { background: #F0CFAD url('/images/sorting_table_for/bullet_arrow_down.png') no-repeat right; }
+table.sorting_table_for thead tr th.cur-sort-desc { background: #F0CFAD url('/images/sorting_table_for/bullet_arrow_up.png') no-repeat right; }
+table.sorting_table_for tbody tr.odd { background-color: #8FF1F4; }
+table.sorting_table_for tbody tr.even { background-color: white; }
+table.sorting_table_for tbody tr.total-entries { background-color: white; }
+table.sorting_table_for tbody tr td { padding: 4px; text-align: center; }
+table.sorting_table_for tbody tr td a { color: black; cursor: pointer; display: block; width: 100%; height: 100%; }
+table.sorting_table_for tfoot tr { background-color: white; text-align: center; }

data/lib/sorting_table_for.rb

@@ -13,16 +13,19 @@ module SortingTableFor
   #  <% end %>
   #
   #  <% sorting_table_for @users do |table| %>
+  #    <%= table.caption %>
   #    <%= table.headers %>
   #    <%= table.columns %>
+  #    <%= table.footers %>
   #  <% 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)
+  # * :builder - Set a table builder, default: SortingTableFor::TableBuilder
+  # * :html - Set html options (id, class, ...), default: empty
+  # * :remote_link - To set actions link with ajax (true or false), default: false
+  # * :remote_sort - To set link for sorting with ajax (true of false), default: false
+  # * :i18n - To use or not i18n on values (true or false), default: true
   #
   def sorting_table_for(object_or_array, *args)
     raise ArgumentError, 'Missing block' unless block_given?

data/lib/sorting_table_for/i18n.rb

@@ -5,16 +5,21 @@ module SortingTableFor
     class << self
       
       # Set options to create a default scope
-      def set_options(params, model_name, namespace)
-        @params, @model_name, @namespace = params, model_name, namespace
+      def set_options(params, model_name, namespace, i18n_active = true)
+        @params, @model_name, @namespace, @i18n_active = params, model_name, namespace, i18n_active
       end
       
       # Translate
       # Add a default scope if option scope isn't defined
-      def translate(attribute, options = {}, action_header = false)
+      def translate(attribute, options = {}, type = nil)
+        if !@i18n_active
+          return options[:value] if options.has_key? :value
+          return attribute
+        end
         if !options.has_key? :scope
           options[:scope] = create_scope 
-          options[:scope] << TableBuilder.i18n_add_header_action_scope if action_header
+          options[:scope] << TableBuilder.i18n_add_header_action_scope if type and type == :header
+          options[:scope] << TableBuilder.i18n_add_footer_action_scope if type and type == :footer
         end
         ::I18n.t(attribute, options)
       end