shuber-sortable 1.0.4 → 1.0.5

data/CHANGELOG

@@ -1,3 +1,13 @@
+2009-05-30 - Sean Huber (shuber@huberry.com)
+  * Always convert options[:conditions] into an array
+  * options[:conditions] can be a hash
+  * Add higher_items and lower_items instance methods
+  * Update README.rdoc
+  * Update gemspec
+
+2009-05-29 - Sean Huber (shuber@huberry.com)
+  * Call remove_from_lists after destroy instead of before in case any other before_destroy callbacks fail
+
 2009-05-28 - Sean Huber (shuber@huberry.com)
   * All active record versions >= 2.0.0 are now fully supported
 

data/README.rdoc

@@ -133,6 +133,9 @@ Any attributes specified as a :scope that are changed on an item cause the item
   # Returns a boolean after determining if the current item is the first item in the specified list
   first_item?(list_name = nil)
   
+  # Returns an array of items higher than the current item in the specified list
+  higher_items(list_name = nil)
+  
   # Returns a boolean after determining if the current item is in the specified list
   in_list?(list_name = nil)
   
@@ -165,6 +168,9 @@ Any attributes specified as a :scope that are changed on an item cause the item
   # Returns 0 if there are no items in the specified list
   last_position(list_name = nil)
   
+  # Returns an array of items lower than the current item in the specified list
+  lower_items(list_name = nil)
+  
   # Moves the current item down one position in the specified list and saves
   move_down!(list_name = nil)
   

data/lib/sortable.rb

@@ -12,7 +12,7 @@ module Huberry
     # Accepts four options:
     #
     #   :column     => The name of the column that will be used to store an item's position in the list. Defaults to :position
-    #   :conditions => Any extra constraints to use if you need to specify a tighter scope than just a foreign key. Defaults to '1 = 1'
+    #   :conditions => Any extra constraints to use if you need to specify a tighter scope than just a foreign key. Defaults to {}
     #   :list_name  => The name of the list (this is used when calling all sortable related instance methods). Defaults to nil
     #   :scope      => A foreign key or an array of foreign keys to use as list constraints. Defaults to []
     #
@@ -123,11 +123,22 @@ module Huberry
       
       define_attribute_methods
       
-      options = { :column => :position, :conditions => '1 = 1', :list_name => nil, :scope => [] }.merge(options)
-      options[:scope] = [options[:scope]] unless options[:scope].is_a?(Array)
+      options = { :column => :position, :conditions => {}, :list_name => nil, :scope => [] }.merge(options)
       
+      options[:conditions] = options[:conditions].inject(['1 = 1']) do |conditions, (key, value)| 
+        conditions.first << " AND #{key.is_a?(Symbol) ? "#{table_name}.#{key}" : key} "
+        if value.nil?
+          conditions.first << 'IS NULL'
+        else
+          conditions.first << '= ?'
+          conditions << value
+        end
+      end if options[:conditions].is_a?(Hash)
+      options[:conditions] = Array(options[:conditions])
+      
+      options[:scope] = Array(options[:scope])
       options[:scope].each do |scope|
-        (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND (#{table_name}.#{scope} = ?) "
+        options[:conditions].first << " AND (#{table_name}.#{scope} = ?)"
         
         unless instance_methods.include?("#{scope}_with_sortable=")
           define_method "#{scope}_with_sortable=" do |value|
@@ -145,8 +156,8 @@ module Huberry
       def self.included(base)
         base.class_eval do
           before_create :add_to_lists
-          before_destroy :remove_from_lists
           before_update :update_lists
+          after_destroy :remove_from_lists
           alias_method_chain :reload, :sortable
         end
       end
@@ -171,6 +182,14 @@ module Huberry
         self == first_item(list_name)
       end
       
+      # Returns an array of items higher than the current item in the specified list
+      def higher_items(list_name = nil)
+        options = evaluate_sortable_options(list_name)
+        options[:conditions].first << " AND #{self.class.table_name}.#{options[:column]} < ?"
+        options[:conditions] << send(options[:column])
+        self.class.base_class.find(:all, :conditions => options[:conditions], :order => options[:column])
+      end
+      
       # Returns a boolean after determining if the current item is in the specified list
       def in_list?(list_name = nil)
         !new_record? && !send(evaluate_sortable_options(list_name)[:column]).nil?
@@ -213,9 +232,9 @@ module Huberry
       # Returns the last item in a list associated with the current item
       def last_item(list_name = nil)
         options = evaluate_sortable_options(list_name)
-        (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND #{self.class.table_name}.#{options[:column]} IS NOT NULL "
+        options[:conditions].first << " AND #{self.class.table_name}.#{options[:column]} IS NOT NULL"
         klass, conditions = [self.class.base_class, { :conditions => options[:conditions] }]
-        klass.send("find_by_#{options[:column]}".to_sym, klass.maximum(options[:column].to_s, conditions), conditions)
+        klass.send("find_by_#{options[:column]}".to_sym, klass.maximum(options[:column], conditions), conditions)
       end
       
       # Returns a boolean after determining if the current item is the last item in the specified list
@@ -231,6 +250,14 @@ module Huberry
         item.nil? ? 0 : item.send(evaluate_sortable_options(list_name)[:column])
       end
       
+      # Returns an array of items lower than the current item in the specified list
+      def lower_items(list_name = nil)
+        options = evaluate_sortable_options(list_name)
+        options[:conditions].first << " AND #{self.class.table_name}.#{options[:column]} > ?"
+        options[:conditions] << send(options[:column])
+        self.class.base_class.find(:all, :conditions => options[:conditions], :order => "#{self.class.table_name}.#{options[:column]}")
+      end
+      
       # Moves the current item down one position in the specified list and saves
       def move_down!(list_name = nil)        
         in_list?(list_name) && (last_item?(list_name) || insert_at!(send(evaluate_sortable_options(list_name)[:column]) + 1, list_name))
@@ -306,13 +333,12 @@ module Huberry
         # Returns the evaluated options
         def evaluate_sortable_options(list_name = nil)
           self.class.assert_sortable_list_exists!(list_name)
-          options = self.class.sortable_lists[list_name.to_s].inject({}) { |hash, pair| hash.merge! pair.first => (pair.last.dup rescue pair.last) }
+          options = self.class.sortable_lists[list_name.to_s].inject({}) { |hash, (key, value)| hash.merge! key => Marshal::load(Marshal.dump(value)) } # deep dup
           options[:scope].each do |scope|
             value = send(scope)
             if value.nil?
-              (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]).gsub!(/#{scope} \= \?/, "#{scope} IS NULL")
+              options[:conditions].first.gsub!(/#{scope} \= \?/, "#{scope} IS NULL")
             else
-              options[:conditions] = [options[:conditions]] unless options[:conditions].is_a?(Array)
               options[:conditions] << value
             end
           end
@@ -323,7 +349,8 @@ module Huberry
         # <tt>direction</tt> (:up or :down) for the specified list
         def move_lower_items(direction, position, list_name = nil)
           options = evaluate_sortable_options(list_name)
-          (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND #{self.class.table_name}.#{options[:column]} > '#{position}' AND #{self.class.table_name}.#{options[:column]} IS NOT NULL "
+          options[:conditions].first << " AND #{self.class.table_name}.#{options[:column]} > ? AND #{self.class.table_name}.#{options[:column]} IS NOT NULL"
+          options[:conditions] << position
           self.class.base_class.update_all "#{options[:column]} = #{options[:column]} #{direction == :up ? '-' : '+'} 1", options[:conditions]
         end
         
@@ -331,7 +358,7 @@ module Huberry
         def remove_from_list(list_name = nil)
           options = evaluate_sortable_options(list_name)
           move_lower_items(:up, send(options[:column]), list_name)
-          send("#{options[:column]}=".to_sym, nil)
+          send("#{options[:column]}=".to_sym, nil) unless self.frozen?
         end
         
         # Removes the current item from all sortable lists

data/test/sortable_test.rb

@@ -24,7 +24,9 @@ def create_tables
       
       create_table :users do |t|
         t.string   :type
+        t.string   :name
         t.integer  :position
+        t.integer  :steves_position
       end
     end
   end
@@ -44,6 +46,7 @@ end
 
 class User < ActiveRecord::Base
   sortable :scope => :type
+  sortable :conditions => { :name => 'steve' }, :column => :steves_position, :list_name => :steves
 end
 
 class Admin < User
@@ -297,4 +300,27 @@ class SortableTest < Test::Unit::TestCase
     assert_equal 2, @admin_2.position
   end
   
+  def test_should_accept_hash_conditions
+    @user = User.create :name => 'steve'
+    @user_2 = User.create :name => 'bob'
+    @user_3 = User.create :name => 'steve'
+    assert_equal 1, @user.steves_position
+    assert_equal 2, @user_2.steves_position
+    assert_equal 2, @user_3.steves_position
+  end
+  
+  def test_should_return_higher_items
+    @user = User.create
+    @user_2 = User.create
+    @user_3 = User.create
+    assert_equal [@user, @user_2], @user_3.higher_items
+  end
+  
+  def test_should_return_lower_items
+    @user = User.create
+    @user_2 = User.create
+    @user_3 = User.create
+    assert_equal [@user_2, @user_3], @user.lower_items
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-sortable
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 00:00:00 -07:00
+date: 2009-05-30 00:00:00 -07:00
 default_executable: 
 dependencies: []