sortablecolumns 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.1.2 / 2008-05-01
+
+* Added date and datetime formats for columns
+* Added ability to supply attributes as extra url parameters
+
 === 0.1.1 / 2008-04-29
 
 * Minor fixes to test code

data/Manifest.txt

@@ -2,7 +2,6 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/sortable_columns
 lib/sortablecolumns.rb
 lib/sortablecolumns/helpers.rb
 lib/sortablecolumns/sortablecolumns.rb

data/README.txt

@@ -64,6 +64,10 @@ In model:
   end
 
 YAML file:
+
+  The YAML file needs to be in an ordered format (i.e., it gets loaded into Ruby as an Array).  The order
+  of the columns in the YAML file determines their display order when rendered as HTML.
+
 -
   firstname:
     heading: First
@@ -104,6 +108,11 @@ YAML file:
     delimiter: " "
     unit: £
     td_class: right
+-
+  created_at:
+    heading: Create Date
+    datatype: datetime
+    date_format: "%m/%d/%Y at %I:%M%p"
 -
   edit:
     in_resultset: false
@@ -129,6 +138,17 @@ YAML file:
         confirm: Are you sure?
 
 In the link_options, use obj_id to specify that the current object's id field should be used.
+You can also have extra parameters in the url that are attributes in the resultset.
+ e.g.
+  -
+    print_view:
+      heading: Print   
+      link_options:     
+      controller: dudes    
+      action: print_view   
+      person_id: person_id   
+
+...where person_id is a field (method) in the result set that will be invoked.
 
 In the controller:
 

data/lib/sortablecolumns.rb

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

data/lib/sortablecolumns/helpers.rb

@@ -32,6 +32,13 @@ module Sortablecolumns
         :unit => unit, :separator => separator, :delimiter => delimiter)
       end
 
+      if datatype == 'datetime' or datatype == 'date'
+        if txt.respond_to?(:strftime)
+          format = klass.send("#{sorter}_date_format",col)
+          txt = txt.strftime(format)
+        end
+      end
+
       do_link = klass.send("#{sorter}_link?",col)
 
       if do_link
@@ -47,6 +54,15 @@ module Sortablecolumns
             extras = link_ops.delete(:extras)
             txt = link_to(txt, link_ops, extras)
           else
+            if link_ops.size > 2
+              # cycle through link_ops, other than controller, action, and id, 
+              # and check if the option value is a method for this object.  If not, 
+              # assign the value directly in the url.
+              ops = link_ops.reject{|key,val| key == :controller or key == :action or key == :id}
+              ops.each do |key, val|
+                link_ops[key] = obj.send(val) if obj.respond_to?(val)
+              end
+            end
             txt = link_to(txt, link_ops)
           end
         elsif link_ops[:url]

data/lib/sortablecolumns/sortablecolumns.rb

@@ -57,7 +57,6 @@ module ActiveRecord #:nodoc:
 
             def self.#{sorter_name}_yaml_path
               raise "RAILS_ROOT is not defined" unless defined?(RAILS_ROOT)
-              #klass_name = self.class_name.downcase
               klass_name = Inflector.underscore(self.class_name)
               file_name = "#{sorter_name}.yml"
               if sorter_options[:subclass_name]
@@ -172,6 +171,19 @@ module ActiveRecord #:nodoc:
               #{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}_print_text(col)
               #{sorter_name}_col_def_hash[col]['print_text'] || '' 
             end

data/test/col_def_test_yaml_files/person/dude/dude_report.yml

@@ -22,3 +22,21 @@
       wrappers: 
         - truncate: 5 
         - simple_format
+-
+  print_view:
+    in_resultset: false
+    heading: false
+    print_text: Print
+    link_options: 
+      controller: dudes
+      action: print_view
+      person_id: person_id
+-
+  created_at:
+    heading: Create Date
+    datatype: datetime
+    date_format: "%m/%d/%Y at %I:%M%p"
+-
+  registered_at:
+    heading: Registration Date 
+    datatype: datetime

data/test/col_def_test_yaml_files/person/tacosorter.yml

@@ -21,3 +21,8 @@
       controller: foods
       action: calories
       foo: bar
+-
+  packaged_on:
+    heading: Packaged On
+    datatype: date
+    date_format: '%m/%d/%Y'

data/test/sortablecolumns_test.rb

@@ -25,6 +25,8 @@ def setup_db
       t.column :age, :integer
       t.column :description, :string
       t.column :balance, :decimal
+      t.column :created_at, :datetime
+      t.column :registered_at, :datetime
     end
   end
 end
@@ -57,6 +59,10 @@ class Person < ActiveRecord::Base
   def calories
     1200
   end
+
+  def packaged_on
+    Date.new(2008,01,03)
+  end
 end
 
 class Dude < Person
@@ -66,6 +72,10 @@ class Dude < Person
   def dudename
     firstname
   end
+
+  def person_id
+    id
+  end
 end
 
 class SubPerson < Person
@@ -154,23 +164,34 @@ class SortableColumnsTest< Test::Unit::TestCase
   end
 
   def test_dude_col_def_hash
-    expected = {"lastname"=>{"heading"=>"Last", "datatype"=>"string"},
+    expected = {"registered_at"=>{"heading"=>"Registration Date", "datatype"=>"datetime"},
+    "print_view"=>
+    {"link_options"=>
+    {"action"=>"print_view", "controller"=>"dudes", "person_id"=>"person_id"},
+    "in_resultset"=>false,
+    "heading"=>false,
+    "print_text"=>"Print"},
+    "lastname"=>{"heading"=>"Last", "datatype"=>"string"},
     "description"=>
     {"print_options"=>{"wrappers"=>[{"truncate"=>5}, "simple_format"]},
     "sortable"=>false,
     "heading"=>"Description",
     "datatype"=>"string"},
     "dudename"=>
-    {"link_options"=>{'object_url'=>true},
+    {"link_options"=>{"object_url"=>true},
     "heading"=>"Dudename",
     "datatype"=>"string"},
-    "age"=>{"heading"=>"Age", "datatype"=>"number"}}
+    "age"=>{"heading"=>"Age", "datatype"=>"number"},
+    "created_at"=>
+    {"date_format"=>"%m/%d/%Y at %I:%M%p",
+    "heading"=>"Create Date",
+    "datatype"=>"datetime"}}
     assert_equal expected, Dude.dude_report_col_def_hash
   end
 
   def test_col_keys_in_order
     assert_equal ['firstname','lastname','age','description','balance','edit','delete'], Person.mysorter_col_keys_in_order
-    assert_equal ['type','meat','calories'], Person.tacosorter_col_keys_in_order
+    assert_equal ['type','meat','calories','packaged_on'], Person.tacosorter_col_keys_in_order
   end
 
   def test_heading
@@ -182,10 +203,11 @@ class SortableColumnsTest< Test::Unit::TestCase
   end
 
   def test_headings_in_order
-    assert_equal Dude.dude_report_headings_in_order,  ['Dudename','Last','Age','Description']
-    assert_equal Person.tacosorter_headings_in_order, ['Taco Type','Meat','Calories']
+    assert_equal  ['Taco Type','Meat','Calories','Packaged On'], Person.tacosorter_headings_in_order
+    #should not include the print field in headings:
+    assert_equal ['Dudename','Last','Age','Description', 'Create Date', 'Registration Date'], Dude.dude_report_headings_in_order  
     #should not include the edit field in headings:
-    assert_equal Person.mysorter_headings_in_order,   ['First','Last','Age','Description','Balance']
+    assert_equal ['First','Last','Age','Description','Balance'], Person.mysorter_headings_in_order
   end
   
   def test_datatype
@@ -237,6 +259,13 @@ class SortableColumnsTest< Test::Unit::TestCase
     assert_equal ".", Person.mysorter_separator('age')
   end
 
+  def test_date_format
+    assert_equal "%m/%d/%Y at %I:%M%p" , Dude.dude_report_date_format('created_at')
+    #default:
+    assert_equal "%Y-%m-%d %I:%M:%S", Dude.dude_report_date_format('registered_at')
+    assert_equal "%m/%d/%Y", Person.tacosorter_date_format('packaged_on')
+  end
+
   def test_default_sort_dir
     assert_equal "desc", Person.mysorter_default_sort_dir('age')
     assert_equal 'asc', Person.mysorter_default_sort_dir('firstname')
@@ -319,8 +348,10 @@ class SortablecolumnsHelperTest < Test::Unit::TestCase
     @person2 = Person.create(:firstname => "Joe", :lastname => "Shmoe", :age => 54, 
       :balance => '12.00', :description => "Joe rocks")
 
+    created_at = DateTime.new(2008,4,28,9,26)
+    registered_at = DateTime.new(2008,5,1,7,30)
     @dude = Dude.create(:firstname => "The Dude", :lastname => "Lebowski", :age => 45, 
-    :description => "The Dude Speaks")
+    :description => "The Dude Speaks", :created_at => created_at, :registered_at => registered_at)
     
     @expected_person_row = "<tr><td class=\"left\"><a href=\"http://test.host/people/show/1\">Billy</a></td><td>Jones</td><td class=\"center\">24</td><td class=\"left\"><p>Billy is an awesome guy.\n<br />However, he is also a punk. <a href=\"http://www.google.com\">www.google.com</a></p></td><td class=\"right\">£1 234,57</td><td><a href=\"http://test.host/people/edit/1\">Edit</a></td><td><a href=\"http://test.host/people/destroy/1\" onclick=\"if (confirm('Are you sure?')) { var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method'); m.setAttribute('value', 'delete'); f.appendChild(m);f.submit(); };return false;\">Delete</a></td></tr>"
     @expected_person_row_alternate = @expected_person_row.gsub(/<tr>/, "<tr class=\"even\">")
@@ -379,6 +410,38 @@ class SortablecolumnsHelperTest < Test::Unit::TestCase
     assert_equal "<td><a href=\"http://test.host/foods/calories?foo=bar\">1200.00</a></td>", @view.print_col(@person, :tacosorter, :calories)
   end
 
+  def test_print_col_dude_print_view
+    #testing if we can have extra parameters in the url, and those params are attributes in the resultset
+    # e.g.
+    #-
+    #print_view:
+    #  heading: Print
+    #  link_options: 
+    #    controller: dudes
+    #    action: print_view
+    #    person_id: person_id
+    #
+    # Where person_id is a field in the result set (in this test, there's a mock method instead)
+
+    expected = "<td><a href=\"http://test.host/dudes/print_view?person_id=#{@dude.id}\">Print</a></td>"
+    assert_equal expected, @view.print_col(@dude, :dude_report, :print_view)
+  end
+
+  def test_print_col_dude_created_at
+    expected = "<td>04/28/2008 at 09:26AM</td>"
+    assert_equal expected, @view.print_col(@dude, :dude_report, :created_at)
+  end
+
+  def test_print_col_dude_registered_at
+    expected = "<td>2008-05-01 07:30:00</td>"
+    assert_equal expected, @view.print_col(@dude, :dude_report, :registered_at)
+  end
+
+  def test_print_col_person_packaged_on
+    expected = "<td>01/03/2008</td>"
+    assert_equal expected, @view.print_col(@person, :tacosorter, :packaged_on)
+  end
+
   def test_print_col_edit
     expected = "<td><a href=\"http://test.host/people/edit/#{@person.id}\">Edit</a></td>" 
     assert_equal expected, @view.print_col(@person, :mysorter, :edit)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sortablecolumns
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bryan Donovan - http://www.bryandonovan.com
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-29 00:00:00 +00:00
+date: 2008-05-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,8 +23,8 @@ dependencies:
     version: 
 description: Sortable HTML tables for Rails
 email: b.dondo+rubyforge@gmail.com
-executables: 
-- sortable_columns
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -36,7 +36,6 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/sortable_columns
 - lib/sortablecolumns.rb
 - lib/sortablecolumns/helpers.rb
 - lib/sortablecolumns/sortablecolumns.rb