sortablecolumns 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.1.5 / 2009-02-19
+* Fixed bug 23868 - now works with Rails 2.2 - http://rubyforge.org/tracker/?atid=23868&group_id=6158&func=browse
+* Added default_sorter as an option instead of creating a yaml file.  Also able to generate default yaml output using 
+  ModelName.default_col_defs
+
 === 0.1.4 / 2008-06-04
 * Table heading (TH) urls now remove any parameter named "page". This is to support paginated tables
   since, if a user is on a page other than 1, clicking on a column heading should sort all data and 

data/README.txt

@@ -6,8 +6,7 @@
 
 SortableColumns is a Rails plugin that allows easy creation of sortable HTML tables as plain HTML or as a YUI DataTable (requires YUI4Rails plugin - http://rubyforge.org/projects/yui4rails/).  Table column characteristics (e.g., default sort direction, data type, CSS attributes, and methods to wrap the output in) are defined in YAML files (more options to be added later, such auto-detecting the column types, using a hash, etc.). Multiple table column definitions can be created for a single model.
 
-An example live application can be found here: http://sortablecolumns.heroku.com/
-Download the example app here: http://www.bryandonovan.com/sortable_columns_example.tar.gz
+Download an example app here: http://www.bryandonovan.com/sortable_columns_example.tar.gz
 
 Also see: ActiveRecord::Acts::SortableColumns::ClassMethods#sortable_columns
 
@@ -26,12 +25,10 @@ Also see: ActiveRecord::Acts::SortableColumns::ClassMethods#sortable_columns
   created in the SQL query.
 * Test coverage for all current features.
 
-=== Problems
-* Doesn't yet support date formats (should be easy to implement though and will hopefully happen soon)
-
 == SYNOPSIS:
 * First, create a directory to store your column definitions YAML files.  The default location SortableColumns will look is app/models/col_defs. 
 * Create a YAML file for the configuration of your table columns.
+* NEW: You can now set a :sorter_name of :default_sorter which will guess the configuration of the model's table. You can also use ModelName.default_col_defs(:yaml) to generate YAML output with these same defaults.
 * Call sortable_tables in your model
 * Run query (get an ActiveRecord result set)
 * Render table in your view
@@ -51,6 +48,8 @@ We're going to call this sorter "mysorter".  This will be the name of the YAML f
 
   class Person < ActiveRecord::Base
     sortable_columns :mysorter
+    # or if you want to use the defaults:
+    # sortable_columns :default_sorter
 
     # method to run query with sort options
     def self.find_for_mysorter(options = {})

data/lib/sortablecolumns.rb

@@ -1,5 +1,5 @@
 module Sortablecolumns #:nodoc:
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end
 Dir[File.join(File.dirname(__FILE__), "sortablecolumns/**/*.rb")].sort.each { |lib| require lib }
 ActiveRecord::Base.send(:include, ActiveRecord::Acts::Sortablecolumns)

data/lib/sortablecolumns/sortablecolumns.rb

@@ -37,233 +37,273 @@ module ActiveRecord #:nodoc:
           class_inheritable_reader :sorter_options
 
           self.class_eval <<-END
-            def self.#{sorter_name}_cols=(val)
-              @@#{sorter_name}_cols = val
-            end
-
-            def self.#{sorter_name}_cols
-              @@#{sorter_name}_cols
-            end
-            cattr_accessor :#{sorter_name}_cols
-
-            def self.#{sorter_name}_col_defs
-              @@#{sorter_name}_cols ||= #{sorter_name}_initialize_col_defs
-            end
-
-            def self.#{sorter_name}_col_text(obj, col)
-               if self.#{sorter_name}_in_resultset?(col)
-                 ret = obj.send(col)
-                 if ret == '' or ret.nil?
-                   ret = "&nbsp;" #so empty TD cells still get displayed
-                 end
-                 return ret
-               end
-               return self.#{sorter_name}_print_text(col)
-            end
-
-            def self.#{sorter_name}_yaml_path
-              raise "RAILS_ROOT is not defined" unless defined?(RAILS_ROOT)
-              klass_name = Inflector.underscore(self.class_name)
-              file_name = "#{sorter_name}.yml"
-              if sorter_options[:subclass_name]
-                sub_path = File.join(klass_name, Inflector.underscore(sorter_options[:subclass_name]), file_name)
-              else
-                sub_path = File.join(klass_name, file_name)
-              end
-              if sorter_options[:path_prefix]
-                return File.join(RAILS_ROOT, sorter_options[:path_prefix], sub_path)
-              else
-                #defaults to col_defs subdirectory in app/models
-                return File.join(RAILS_ROOT, "app/models/col_defs", sub_path)
+          def self.#{sorter_name}_cols=(val)
+            @@#{sorter_name}_cols = val
+          end
+
+          def self.#{sorter_name}_cols
+            @@#{sorter_name}_cols
+          end
+          cattr_accessor :#{sorter_name}_cols
+
+          def self.#{sorter_name}_col_defs
+            @@#{sorter_name}_cols ||= #{sorter_name}_initialize_col_defs
+          end
+
+          def self.#{sorter_name}_col_text(obj, col)
+            if self.#{sorter_name}_in_resultset?(col)
+              ret = obj.send(col)
+              if ret == '' or ret.nil?
+                ret = "&nbsp;" #so empty TD cells still get displayed
               end
-            end
-
-            def self.#{sorter_name}_initialize_col_defs
+              return ret
+            end
+            return self.#{sorter_name}_print_text(col)
+          end
+
+          def self.#{sorter_name}_yaml_path
+            raise "RAILS_ROOT is not defined" unless defined?(RAILS_ROOT)
+            klass_name = ActiveSupport::Inflector.underscore(self.class_name)
+            file_name = "#{sorter_name}.yml"
+            if sorter_options[:subclass_name]
+              sub_path = File.join(klass_name, ActiveSupport::Inflector.underscore(sorter_options[:subclass_name]), file_name)
+            else
+              sub_path = File.join(klass_name, file_name)
+            end
+            if sorter_options[:path_prefix]
+              return File.join(RAILS_ROOT, sorter_options[:path_prefix], sub_path)
+            else
+              #defaults to col_defs subdirectory in app/models
+              return File.join(RAILS_ROOT, "app/models/col_defs", sub_path)
+            end
+          end
+
+          def self.#{sorter_name}_initialize_col_defs
+            if "#{sorter_name}" == 'default_sorter'
+              self.default_col_defs
+            else
               YAML.load_file(#{sorter_name}_yaml_path)
             end
+          end
 
-            def self.#{sorter_name}_col_def_hash
-              @@#{sorter_name}_col_def_hash ||= #{sorter_name}_initialize_col_def_hash
-            end
+          def self.#{sorter_name}_col_def_hash
+            @@#{sorter_name}_col_def_hash ||= #{sorter_name}_initialize_col_def_hash
+          end
 
-            def self.#{sorter_name}_initialize_col_def_hash
-              col_def_hash = {}
-              #{sorter_name}_col_defs.each do |c|
-                c.keys.each do |key|
-                  col_def_hash[key] = c[key]
-                end
+          def self.#{sorter_name}_initialize_col_def_hash
+            col_def_hash = {}
+            #{sorter_name}_col_defs.each do |c|
+              c.keys.each do |key|
+                col_def_hash[key] = c[key]
               end
-              col_def_hash
             end
+            col_def_hash
+          end
 
-            def self.#{sorter_name}_col_keys_in_order
-              @@#{sorter_name}_col_keys_in_order ||= #{sorter_name}_initialize_col_keys_in_order
-            end
+          def self.#{sorter_name}_col_keys_in_order
+            @@#{sorter_name}_col_keys_in_order ||= #{sorter_name}_initialize_col_keys_in_order
+          end
 
-            def self.#{sorter_name}_initialize_col_keys_in_order
-              cols = []
-              #{sorter_name}_col_defs.each do |hsh|
-                hsh.each do |key, sub_hash|
-                  cols << key
-                end
+          def self.#{sorter_name}_initialize_col_keys_in_order
+            cols = []
+            #{sorter_name}_col_defs.each do |hsh|
+              hsh.each do |key, sub_hash|
+                cols << key
               end
-              cols
             end
+            cols
+          end
 
-            def self.#{sorter_name}_heading(col)
-              return false if #{sorter_name}_col_def_hash[col]['heading'] == false
-              #{sorter_name}_col_def_hash[col]['heading'] || col.humanize
-            end
+          def self.#{sorter_name}_heading(col)
+            return false if #{sorter_name}_col_def_hash[col]['heading'] == false
+            #{sorter_name}_col_def_hash[col]['heading'] || col.humanize
+          end
 
-            def self.#{sorter_name}_headings_in_order
-              @@#{sorter_name}_headings_in_order ||= #{sorter_name}_initialize_headings_in_order
-            end
+          def self.#{sorter_name}_headings_in_order
+            @@#{sorter_name}_headings_in_order ||= #{sorter_name}_initialize_headings_in_order
+          end
 
-            def self.#{sorter_name}_initialize_headings_in_order
-              headings = []
-              #{sorter_name}_col_keys_in_order.each do |key|
-                headings << #{sorter_name}_heading(key) if #{sorter_name}_heading(key)
-              end
-              headings
+          def self.#{sorter_name}_initialize_headings_in_order
+            headings = []
+            #{sorter_name}_col_keys_in_order.each do |key|
+              headings << #{sorter_name}_heading(key) if #{sorter_name}_heading(key)
             end
+            headings
+          end
 
-            def self.#{sorter_name}_col_def(col)
-              #{sorter_name}_col_def_hash[col]
-            end
+          def self.#{sorter_name}_col_def(col)
+            #{sorter_name}_col_def_hash[col]
+          end
 
-            def self.#{sorter_name}_datatype(col)
-              #{sorter_name}_col_def_hash[col]['datatype']
-            end
+          def self.#{sorter_name}_datatype(col)
+            #{sorter_name}_col_def_hash[col]['datatype']
+          end
 
-            def self.#{sorter_name}_sort_options(col)
-              #{sorter_name}_col_def_hash[col]['sort_options']
-            end
+          def self.#{sorter_name}_sort_options(col)
+            #{sorter_name}_col_def_hash[col]['sort_options']
+          end
 
-            def self.#{sorter_name}_default_sort_dir(col)
-              if sort_ops = #{sorter_name}_col_def_hash[col]['sort_options']
-                sort_ops['default_dir'] ? sort_ops['default_dir'] : 'asc'
-              else 
-                'asc'
-              end
-            end
-            
-            def self.#{sorter_name}_print_options(col)
-              if #{sorter_name}_col_def_hash[col]
-                #{sorter_name}_col_def_hash[col]['print_options']
-              end
-            end
-            
-            def self.#{sorter_name}_td_class(col)
-              #{sorter_name}_col_def_hash[col]['td_class']
+          def self.#{sorter_name}_default_sort_dir(col)
+            if sort_ops = #{sorter_name}_col_def_hash[col]['sort_options']
+              sort_ops['default_dir'] ? sort_ops['default_dir'] : 'asc'
+            else 
+              'asc'
             end
+          end
 
-            def self.#{sorter_name}_th_class(col)
-              #{sorter_name}_col_def_hash[col]['th_class']
+          def self.#{sorter_name}_print_options(col)
+            if #{sorter_name}_col_def_hash[col]
+              #{sorter_name}_col_def_hash[col]['print_options']
             end
+          end
 
-            def self.#{sorter_name}_precision(col)
-              #{sorter_name}_col_def_hash[col]['precision']
-            end
-
-            def self.#{sorter_name}_delimiter(col)
-              #{sorter_name}_col_def_hash[col]['delimiter'] || ","
-            end
-
-            def self.#{sorter_name}_separator(col)
-              #{sorter_name}_col_def_hash[col]['separator'] || "."
-            end
-
-            def self.#{sorter_name}_unit(col)
-              #{sorter_name}_col_def_hash[col]['unit'] || "$"
-            end
-
-            def self.#{sorter_name}_date_format(col)
-              format = #{sorter_name}_col_def_hash[col]['date_format']
-               unless format
-                 datatype = #{sorter_name}_datatype(col)
-                 if datatype.downcase == 'datetime'
-                   format = "%Y-%m-%d %I:%M:%S"
-                 else
-                   format = "%Y-%m-%d"
-                 end
-               end
-               format
-            end
+          def self.#{sorter_name}_td_class(col)
+            #{sorter_name}_col_def_hash[col]['td_class']
+          end
 
-            def self.#{sorter_name}_print_text(col)
-              #{sorter_name}_col_def_hash[col]['print_text'] || '' 
-            end
+          def self.#{sorter_name}_th_class(col)
+            #{sorter_name}_col_def_hash[col]['th_class']
+          end
 
-            def self.#{sorter_name}_sortable?(col)
-              hsh = #{sorter_name}_col_def_hash[col]
-              return false if hsh.has_key?('sortable') && hsh['sortable'] == false
-              return false if hsh.has_key?('heading') && hsh['heading'] == false
-              return true
-            end
+          def self.#{sorter_name}_precision(col)
+            #{sorter_name}_col_def_hash[col]['precision']
+          end
 
-            def self.#{sorter_name}_link_options(col)
-              link_ops = #{sorter_name}_col_def_hash[col]['link_options']
-              return link_ops.symbolize_keys! if link_ops 
-            end
+          def self.#{sorter_name}_delimiter(col)
+            #{sorter_name}_col_def_hash[col]['delimiter'] || ","
+          end
 
-            def self.#{sorter_name}_link?(col)
-              return true if #{sorter_name}_link_options(col)
-              return false
-            end
+          def self.#{sorter_name}_separator(col)
+            #{sorter_name}_col_def_hash[col]['separator'] || "."
+          end
 
-            def self.#{sorter_name}_in_resultset?(col)
-              hsh = #{sorter_name}_col_def_hash[col]
-              return false if hsh.has_key?('in_resultset') && hsh['in_resultset'] == false
-              return true
-            end
+          def self.#{sorter_name}_unit(col)
+            #{sorter_name}_col_def_hash[col]['unit'] || "$"
+          end
 
-            def self.#{sorter_name}_col_def_for_yui(col)
-              label = #{sorter_name}_heading(col) ? #{sorter_name}_heading(col) : ''
-              sortable = #{sorter_name}_sortable?(col)
+          def self.#{sorter_name}_date_format(col)
+            format = #{sorter_name}_col_def_hash[col]['date_format']
+            unless format
               datatype = #{sorter_name}_datatype(col)
-              if datatype == 'number' or datatype == 'currency'
-                formatter = datatype
-              end
-              sort_dir = #{sorter_name}_default_sort_dir(col)
-              if sort_dir == 'desc'
-                sort_ops =  {:defaultDir => "YAHOO.widget.DataTable.CLASS_DESC"}
+              if datatype.downcase == 'datetime'
+                format = "%Y-%m-%d %I:%M:%S"
+              else
+                format = "%Y-%m-%d"
               end
-              yui = {:key => col, :label => label, :sortable => sortable}
-              yui[:sortOptions] = sort_ops  if sort_ops
-              yui[:formatter]   = formatter if formatter
-              yui
             end
-
-            def self.#{sorter_name}_col_defs_for_yui
-              yui_col_defs = [] 
-              #{sorter_name}_col_keys_in_order.each do |col|
-                yui_col_defs << #{sorter_name}_col_def_for_yui(col)
+            format
+          end
+
+          def self.#{sorter_name}_print_text(col)
+            #{sorter_name}_col_def_hash[col]['print_text'] || '' 
+          end
+
+          def self.#{sorter_name}_sortable?(col)
+            hsh = #{sorter_name}_col_def_hash[col]
+            return false if hsh.has_key?('sortable') && hsh['sortable'] == false
+            return false if hsh.has_key?('heading') && hsh['heading'] == false
+            return true
+          end
+
+          def self.#{sorter_name}_link_options(col)
+            link_ops = #{sorter_name}_col_def_hash[col]['link_options']
+            return link_ops.symbolize_keys! if link_ops 
+          end
+
+          def self.#{sorter_name}_link?(col)
+            return true if #{sorter_name}_link_options(col)
+            return false
+          end
+
+          def self.#{sorter_name}_in_resultset?(col)
+            hsh = #{sorter_name}_col_def_hash[col]
+            return false if hsh.has_key?('in_resultset') && hsh['in_resultset'] == false
+            return true
+          end
+
+          def self.#{sorter_name}_col_def_for_yui(col)
+            label = #{sorter_name}_heading(col) ? #{sorter_name}_heading(col) : ''
+            sortable = #{sorter_name}_sortable?(col)
+            datatype = #{sorter_name}_datatype(col)
+            if datatype == 'number' or datatype == 'currency'
+              formatter = datatype
+            end
+            sort_dir = #{sorter_name}_default_sort_dir(col)
+            if sort_dir == 'desc'
+              sort_ops =  {:defaultDir => "YAHOO.widget.DataTable.CLASS_DESC"}
+            end
+            yui = {:key => col, :label => label, :sortable => sortable}
+            yui[:sortOptions] = sort_ops  if sort_ops
+            yui[:formatter]   = formatter if formatter
+            yui
+          end
+
+          def self.#{sorter_name}_col_defs_for_yui
+            yui_col_defs = [] 
+            #{sorter_name}_col_keys_in_order.each do |col|
+              yui_col_defs << #{sorter_name}_col_def_for_yui(col)
+            end
+            yui_col_defs
+          end
+
+          def self.#{sorter_name}_field_def_for_yui(col)
+            datatype = #{sorter_name}_datatype(col)
+            yui_field_def = {:key => col}
+            if datatype == 'number'
+              yui_field_def[:parser] = "YAHOO.util.DataSource.parseNumber"
+            end
+            if  datatype == 'currency'
+              yui_field_def[:parser] = "this.parseNumberFromCurrency"
+            end
+            yui_field_def
+          end
+
+          def self.#{sorter_name}_fields_for_yui
+            yui_fields = []
+            #{sorter_name}_col_keys_in_order.each do |col|
+              yui_fields << #{sorter_name}_field_def_for_yui(col)
+            end
+            yui_fields
+          end
+
+
+          def self.default_col_defs(output=:hsh)
+            col_arr = []
+            col_hsh = self.columns_hash
+            self.column_names.each do |col_name|
+              hsh = {}
+              col = col_hsh[col_name]
+              hsh[col.name] = {}
+              h = hsh[col.name]
+              h['heading'] = col.name.titleize
+              if col.limit && col.limit > 50
+                h['sortable'] = 'false'
               end
-              yui_col_defs
-            end
-
-            def self.#{sorter_name}_field_def_for_yui(col)
-              datatype = #{sorter_name}_datatype(col)
-              yui_field_def = {:key => col}
-              if datatype == 'number'
-                yui_field_def[:parser] = "YAHOO.util.DataSource.parseNumber"
+              if col.type == :date
+                h['datatype'] = 'date'
               end
-              if  datatype == 'currency'
-                yui_field_def[:parser] = "this.parseNumberFromCurrency"
+              if col.type == :datetime
+                h['datatype'] = 'datetime'
               end
-              yui_field_def
-            end
-
-            def self.#{sorter_name}_fields_for_yui
-              yui_fields = []
-              #{sorter_name}_col_keys_in_order.each do |col|
-                yui_fields << #{sorter_name}_field_def_for_yui(col)
+              if col.type == :integer
+                h['datatype'] = 'number'
+                h['sort_options'] = {'default_dir' => 'asc'}
+              end
+              if col.name.match(/amt|cost|price|balance/)
+                h['datatype'] = 'currency'
+                h['sort_options'] = {'default_dir' => 'desc'}
+              elsif col.type == :decimal
+                h['datatype'] = 'number'
+                h['precision'] = 2
+                h['sort_options'] = {'default_dir' => 'asc'}
               end
-              yui_fields
+              col_arr << hsh
             end
+            return col_arr if output == :hsh
+            return col_arr.to_yaml
+          end
 
-
-            END
+          END
 
         end #sortable_columns
       end #ClassMethods

data/test/sortablecolumns_test.rb

@@ -45,6 +45,8 @@ class Person < ActiveRecord::Base
     :path_prefix => "/test/col_def_test_yaml_files"
   sortable_columns :tacosorter,
     :path_prefix => "/test/col_def_test_yaml_files"
+  sortable_columns :default_sorter,
+    :path_prefix => "/test/col_def_test_yaml_files"
 
   #Some mock methods. Normally we would have an AR object which could have been
   #created by a find_by_sql query, which could include methods such as these.
@@ -300,6 +302,48 @@ class SortableColumnsTest< Test::Unit::TestCase
     assert_equal expected, Person.mysorter_fields_for_yui
   end
 
+  def test_default_yaml_col_defs_for_person
+    expected='---
+- id:
+    sort_options:
+      default_dir: asc
+    datatype: number
+    heading: Id
+- firstname:
+    heading: Firstname
+    sortable: "false"
+- lastname:
+    heading: Lastname
+    sortable: "false"
+- age:
+    sort_options:
+      default_dir: asc
+    datatype: number
+    heading: Age
+- description:
+    heading: Description
+    sortable: "false"
+- balance:
+    sort_options:
+      default_dir: desc
+    datatype: currency
+    heading: Balance
+- created_at:
+    datatype: datetime
+    heading: Created At
+- registered_at:
+    datatype: datetime
+    heading: Registered At'
+    
+    default_col_defs = Person.default_col_defs(:yaml)
+    assert_equal YAML.load(expected), YAML.load(default_col_defs)
+  end
+
+  def test_default_sorter_for_person
+    assert_equal 'number', Person.default_sorter_datatype('age')
+    assert_equal 'Balance', Person.default_sorter_heading('balance')
+  end
+
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sortablecolumns
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Bryan Donovan - http://www.bryandonovan.com
@@ -9,17 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-04 00:00:00 -07:00
+date: 2009-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.3
+        version: 1.8.3
     version: 
 description: Sortable HTML tables for Rails
 email: b.dondo+rubyforge@gmail.com
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sortablecolumns
-rubygems_version: 1.1.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Sortable HTML tables for Rails