sortifiable 0.1.2 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+*0.2.0 (April 7th, 2011)
+
+* Use pessimistic locking to reduce concurrency problems
+
+* Use update_all instead of update_attribute so callbacks are not triggered
+
+
 *0.1.2 (February 7th, 2011)
 
 * Configure association scopes correctly

data/lib/sortifiable.rb

@@ -70,7 +70,7 @@ module Sortifiable
       options[:class] = self
 
       include InstanceMethods
-      before_create :add_to_list_bottom
+      before_create :add_to_list
       before_destroy :decrement_position_on_lower_items, :if => :in_list?
 
       self.acts_as_list_options = options
@@ -85,9 +85,18 @@ module Sortifiable
   module InstanceMethods
     # Add the item to the end of the list
     def add_to_list
-      list_class.transaction do
-        remove_from_list if in_list?
-        update_attribute(position_column, last_position + 1)
+      if in_list?
+        move_to_bottom
+      else
+        list_class.transaction do
+          ids = lock_list!
+          last_position = ids.size
+          if persisted?
+            update_position(last_position + 1)
+          else
+            send("#{position_column}=".to_sym, last_position + 1)
+          end
+        end
       end
     end
 
@@ -98,7 +107,7 @@ module Sortifiable
 
     # Decrease the position of this item without adjusting the rest of the list.
     def decrement_position
-      in_list? && update_attribute(position_column, current_position - 1)
+      in_list? && update_position(current_position - 1)
     end
 
     # Return +true+ if this object is the first in the list.
@@ -131,23 +140,44 @@ module Sortifiable
 
     # Increase the position of this item without adjusting the rest of the list.
     def increment_position
-      in_list? && update_attribute(position_column, current_position + 1)
+      in_list? && update_position(current_position + 1)
     end
 
     # Insert the item at the given position (defaults to the top position of 1).
     def insert_at(position = 1)
-      if position > 0
-        list_class.transaction do
-          remove_from_list
-          if position > last_position
-            add_to_list
-          else
-            increment_position_on_lower_items(position - 1)
-            update_attribute(position_column, position)
-          end
+      list_class.transaction do
+        ids = lock_list!
+        position = [[1, position].max, ids.size].min
+
+        if persisted?
+          current_position = ids.index(id) + 1
+
+          sql = <<-SQL
+            #{quoted_position_column} = CASE
+            WHEN #{quoted_position_column} = #{current_position} THEN #{position}
+            WHEN #{quoted_position_column} > #{current_position}
+            AND #{quoted_position_column} < #{position} THEN #{quoted_position_column} - 1
+            WHEN #{quoted_position_column} < #{current_position}
+            AND #{quoted_position_column} >= #{position} THEN #{quoted_position_column} + 1
+            ELSE #{quoted_position_column}
+            END
+          SQL
+
+          list_scope.update_all(sql)
+          update_position(position)
+        else
+          save!
+
+          sql = <<-SQL
+            #{quoted_position_column} = CASE
+            WHEN #{quoted_position_column} >= #{position} THEN #{quoted_position_column} + 1
+            ELSE #{quoted_position_column}
+            END
+          SQL
+
+          list_scope.update_all(sql)
+          update_position(position)
         end
-      else
-        false
       end
     end
 
@@ -188,34 +218,125 @@ module Sortifiable
 
     # Swap positions with the next higher item, if one exists.
     def move_higher
-      in_list? && (first? || insert_at(current_position - 1))
+      if in_list?
+        list_class.transaction do
+          ids = lock_list!
+          current_position, last_position = ids.index(id) + 1, ids.size
+
+          if current_position > 1
+            sql = <<-SQL
+              #{quoted_position_column} = CASE
+              WHEN #{quoted_position_column} = #{current_position} - 1 THEN #{current_position}
+              WHEN #{quoted_position_column} = #{current_position} THEN #{current_position} - 1
+              ELSE #{quoted_position_column}
+              END
+            SQL
+
+            send("#{position_column}=".to_sym, current_position - 1)
+            list_scope.update_all(sql) > 0
+          end
+        end
+      else
+        false
+      end
     end
     alias_method :move_up, :move_higher
 
     # Swap positions with the next lower item, if one exists.
     def move_lower
-      in_list? && (last? || insert_at(current_position + 1))
+      if in_list?
+        list_class.transaction do
+          ids = lock_list!
+          current_position, last_position = ids.index(id) + 1, ids.size
+
+          if current_position < last_position
+            sql = <<-SQL
+              #{quoted_position_column} = CASE
+              WHEN #{quoted_position_column} = #{current_position} + 1 THEN #{current_position}
+              WHEN #{quoted_position_column} = #{current_position} THEN #{current_position} + 1
+              ELSE #{quoted_position_column}
+              END
+            SQL
+
+            send("#{position_column}=".to_sym, current_position + 1)
+            list_scope.update_all(sql) > 0
+          end
+        end
+      else
+        false
+      end
     end
     alias_method :move_down, :move_lower
 
     # Move to the bottom of the list. If the item is already in the list,
     # the items below it have their position adjusted accordingly.
     def move_to_bottom
-      in_list? && (last? || add_to_list)
+      if in_list?
+        list_class.transaction do
+          ids = lock_list!
+          current_position, last_position = ids.index(id) + 1, ids.size
+
+          if current_position < last_position
+            sql = <<-SQL
+              #{quoted_position_column} = CASE
+              WHEN #{quoted_position_column} = #{current_position} THEN #{last_position}
+              WHEN #{quoted_position_column} > #{current_position} THEN #{quoted_position_column} - 1
+              ELSE #{quoted_position_column}
+              END
+            SQL
+
+            send("#{position_column}=".to_sym, last_position)
+            list_scope.update_all(sql) > 0
+          end
+        end
+      else
+        false
+      end
     end
 
     # Move to the top of the list. If the item is already in the list,
     # the items above it have their position adjusted accordingly.
     def move_to_top
-      in_list? && (first? || insert_at(1))
+      if in_list?
+        list_class.transaction do
+          ids = lock_list!
+          current_position, last_position = ids.index(id) + 1, ids.size
+
+          if current_position > 1
+            sql = <<-SQL
+              #{quoted_position_column} = CASE
+              WHEN #{quoted_position_column} = #{current_position} THEN 1
+              WHEN #{quoted_position_column} < #{current_position} THEN #{quoted_position_column} + 1
+              ELSE #{quoted_position_column}
+              END
+            SQL
+
+            send("#{position_column}=".to_sym, 1)
+            list_scope.update_all(sql) > 0
+          end
+        end
+      else
+        false
+      end
     end
 
     # Removes the item from the list.
     def remove_from_list
       if in_list?
         list_class.transaction do
-          decrement_position_on_lower_items
-          update_attribute(position_column, nil)
+          ids = lock_list!
+          current_position, last_position = ids.index(id) + 1, ids.size
+
+          sql = <<-SQL
+            #{quoted_position_column} = CASE
+            WHEN #{quoted_position_column} = #{current_position} THEN NULL
+            WHEN #{quoted_position_column} > #{current_position} THEN #{quoted_position_column} - 1
+            ELSE #{quoted_position_column}
+            END
+          SQL
+
+          send("#{position_column}=".to_sym, nil)
+          list_scope.update_all(sql) > 0
         end
       else
         false
@@ -223,20 +344,14 @@ module Sortifiable
     end
 
     private
-      def add_to_list_bottom #:nodoc:
-        send("#{position_column}=".to_sym, last_position + 1)
-      end
-
       def base_scope #:nodoc:
         list_class.unscoped.where(scope_condition)
       end
 
       def decrement_position_on_lower_items #:nodoc:
-        lower_scope(current_position).update_all(position_update('- 1'))
-      end
-
-      def increment_position_on_lower_items(position) #:nodoc:
-        lower_scope(position).update_all(position_update('+ 1'))
+        update = "#{quoted_position_column} = #{quoted_position_column} - 1"
+        conditions = "#{quoted_position_column} > #{current_position}"
+        list_scope.update_all(update, conditions) > 0
       end
 
       def list_class #:nodoc:
@@ -247,6 +362,10 @@ module Sortifiable
         base_scope.order(position_column).where("#{quoted_position_column} IS NOT NULL")
       end
 
+      def lock_list! #:nodoc:
+        connection.select_values(list_scope.select(list_class.primary_key).lock(true).to_sql)
+      end
+
       def lower_scope(position) #:nodoc:
         base_scope.where(["#{quoted_position_column} > ?", position])
       end
@@ -259,10 +378,6 @@ module Sortifiable
         acts_as_list_options[:column]
       end
 
-      def position_update(direction) #:nodoc:
-        "#{quoted_position_column} = (#{quoted_position_column} #{direction})"
-      end
-
       def quoted_position_column #:nodoc:
         connection.quote_column_name(position_column)
       end
@@ -274,6 +389,11 @@ module Sortifiable
           Array.wrap(acts_as_list_options[:scope]).inject({}){ |m,k| m[k] = send(k); m }
         end
       end
+
+      def update_position(new_position)
+        list_class.update_all(["#{quoted_position_column} = ?", new_position], list_class.primary_key => id)
+        send("#{position_column}=".to_sym, new_position)
+      end
   end
 end
 

data/lib/sortifiable/version.rb

@@ -1,3 +1,3 @@
 module Sortifiable
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/sortifiable_test.rb

@@ -129,6 +129,16 @@ class ListTest < Test::Unit::TestCase
     assert_equal [4, 1, 3, 2], ListMixin.where('parent_id = 5').map(&:id)
   end
 
+  def test_bounds_checking
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5').map(&:pos)
+
+    ListMixin.find(1).move_higher
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5').map(&:pos)
+
+    ListMixin.find(4).move_lower
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5').map(&:pos)
+  end
+
   def test_move_to_bottom_with_next_to_last_item
     assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5').map(&:id)
     ListMixin.find(3).move_to_bottom
@@ -345,6 +355,16 @@ class ListSubTest < Test::Unit::TestCase
     assert_equal [4, 1, 3, 2], ListMixin.where('parent_id = 5000').map(&:id)
   end
 
+  def test_bounds_checking
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5000').map(&:pos)
+
+    ListMixin.find(1).move_higher
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5000').map(&:pos)
+
+    ListMixin.find(4).move_lower
+    assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5000').map(&:pos)
+  end
+
   def test_move_to_bottom_with_next_to_last_item
     assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5000').map(&:id)
     ListMixin.find(3).move_to_bottom
@@ -479,6 +499,16 @@ class ArrayScopeListTest < Test::Unit::TestCase
     assert_equal [4, 1, 3, 2], ArrayScopeListMixin.where(conditions).map(&:id)
   end
 
+  def test_bounds_checking
+    assert_equal [1, 2, 3, 4], ArrayScopeListMixin.where(conditions).map(&:pos)
+
+    ArrayScopeListMixin.find(1).move_higher
+    assert_equal [1, 2, 3, 4], ArrayScopeListMixin.where(conditions).map(&:pos)
+
+    ArrayScopeListMixin.find(4).move_lower
+    assert_equal [1, 2, 3, 4], ArrayScopeListMixin.where(conditions).map(&:pos)
+  end
+
   def test_move_to_bottom_with_next_to_last_item
     assert_equal [1, 2, 3, 4], ArrayScopeListMixin.where(conditions).map(&:id)
     ArrayScopeListMixin.find(3).move_to_bottom

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sortifiable
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Andrew White
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +00:00
+date: 2011-04-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Sort your models