acts_as_restful_list 0.3.0 → 0.4.0

data/History.rdoc

@@ -1,3 +1,13 @@
+=== Version 0.4.0 / 2010-11-15
+
+* enhancements
+  * Support Rails optimistic locking.  Thanks, Matt Smith (two-bit-fool)
+
+=== Version 0.3.0 / 2010-11-11
+
+* enhancements
+  * added ability to scope on a non-integer and non-id columns
+
 === Version 0.1.0 / 2010-02-17
 
 * enhancements

data/README.rdoc

@@ -5,6 +5,10 @@ non-standard method calls like insert_at, acts_as_restful_list makes managing li
 simple.  You update the position attribute just like you would update anything else
 and the rest is taken care of for you.
 
+== Features
+* Automatically update your list's order through standard REST methods
+* Support for Rails Optimistic Locking
+
 == Installation
   #environment.rb
   config.gem 'acts_as_restful_list'
@@ -60,4 +64,4 @@ Report issues at http://github.com/12spokes/acts_as_restful_list/issues
 
 == Copyright
 
-Copyright (c) 2010 'Trey Bean'. See LICENSE for details.
+Copyright (c) 2010 '12 Spokes'. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/acts_as_restful_list.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_restful_list}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["'Trey Bean'"]
-  s.date = %q{2010-11-11}
+  s.date = %q{2010-11-15}
   s.description = %q{Just like acts_as_list, but allows updating through standard restful methods.}
   s.email = %q{trey@12spokes.com}
   s.extra_rdoc_files = [

data/lib/acts_as_restful_list.rb

@@ -4,7 +4,7 @@ module ActsAsRestfulList
       base.extend ClassMethods
     end
   end
-  
+
   module ClassMethods
     # +acts_as_restful_list+ makes the class it is called on automatically behave like an
     # ordered list. There are a number of options you can set:
@@ -35,6 +35,10 @@ module ActsAsRestfulList
           scopes.join(' AND ')
         end
       end
+      
+      define_method 'optimistic_locking_update' do
+        self.class.column_names.include?("lock_version") ? ", lock_version = (lock_version + 1)" : ""
+      end
     end
   end
   
@@ -47,15 +51,15 @@ module ActsAsRestfulList
     def reset_order_after_update
       if self.send( "#{position_column}_changed?" )
         if self.send( "#{position_column}_was" ) > self.send( position_column )
-          self.class.update_all("#{position_column} = (#{position_column} + 1)", [scope_condition, "#{position_column} >= #{self.send( position_column )}", "id != #{id}", "#{position_column} < #{self.send( "#{position_column}_was" )}"].compact.join(' AND '))
+          self.class.update_all("#{position_column} = (#{position_column} + 1) #{optimistic_locking_update}", [scope_condition, "#{position_column} >= #{self.send( position_column )}", "id != #{id}", "#{position_column} < #{self.send( "#{position_column}_was" )}"].compact.join(' AND '))
         else
-          self.class.update_all("#{position_column} = (#{position_column} - 1)", [scope_condition, "#{position_column} <= #{self.send( position_column )}", "#{position_column} >= #{self.send( "#{position_column}_was" )}", "id != #{id}"].compact.join(' AND '))
+          self.class.update_all("#{position_column} = (#{position_column} - 1) #{optimistic_locking_update}", [scope_condition, "#{position_column} <= #{self.send( position_column )}", "#{position_column} >= #{self.send( "#{position_column}_was" )}", "id != #{id}"].compact.join(' AND '))
         end
       end
     end
     
     def reset_order_after_destroy
-      self.class.update_all("#{position_column} = (#{position_column} - 1)", [scope_condition, "#{position_column} > #{self.send( position_column )}"].compact.join(' AND '))
+      self.class.update_all("#{position_column} = (#{position_column} - 1) #{optimistic_locking_update}", [scope_condition, "#{position_column} > #{self.send( position_column )}"].compact.join(' AND '))
     end
   end
 end

data/spec/acts_as_restful_list_spec.rb

@@ -12,7 +12,7 @@ describe "ActsAsRestfulList" do
         create_table :mixins do |t|
           t.column :position, :integer
           t.column :parent_id, :integer
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end
@@ -24,7 +24,7 @@ describe "ActsAsRestfulList" do
     
     after(:all) do
       Object.send(:remove_const, :Mixin)
-      
+
       ActiveRecord::Base.connection.tables.each do |table|
         ActiveRecord::Base.connection.drop_table(table)
       end
@@ -85,7 +85,7 @@ describe "ActsAsRestfulList" do
         Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2,3,4]
       end
     end
-      
+    
     describe 'reordering on deletion' do
       it 'should reset the order after deleting a record' do
         mixin = Mixin.create
@@ -106,6 +106,78 @@ describe "ActsAsRestfulList" do
     end
   end
   
+  describe 'optimistic locking' do
+    before(:all) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :mixins do |t|
+          t.column :position, :integer
+          t.column :parent_id, :integer
+          t.column :lock_version, :integer, :default => 0
+          t.column :created_at, :datetime
+          t.column :updated_at, :datetime
+        end
+      end
+      
+      class Mixin < ActiveRecord::Base
+        acts_as_restful_list
+      end
+    end
+    
+    after(:all) do
+      Object.send(:remove_const, :Mixin)
+
+      ActiveRecord::Base.connection.tables.each do |table|
+        ActiveRecord::Base.connection.drop_table(table)
+      end
+    end
+    
+    before(:each) do
+      (1..4).each{ Mixin.create! }
+    end
+    
+    describe 'reordering on destroy' do
+      it 'should raise an error for stale objects' do
+        second_mixin = Mixin.first( :conditions => { :position => 2 } )
+        third_mixin  = Mixin.first( :conditions => { :position => 3 } )
+        second_mixin.destroy
+        lambda {
+          third_mixin.destroy
+        }.should raise_error(ActiveRecord::StaleObjectError)
+      end
+      
+      it 'should NOT raise an error if update did not affect existing position' do
+        second_mixin = Mixin.first( :conditions => { :position => 2 } )
+        third_mixin  = Mixin.first( :conditions => { :position => 3 } )
+        third_mixin.destroy
+        lambda {
+          second_mixin.destroy
+        }.should_not raise_error(ActiveRecord::StaleObjectError)
+        Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2]
+      end
+    end
+    
+    describe 'reordering on update' do
+      it 'should raise an error for stale objects' do
+        first_mixin  = Mixin.first( :conditions => { :position => 1 } )
+        fourth_mixin = Mixin.first( :conditions => { :position => 4 } )
+        fourth_mixin.update_attributes(:position => 1)
+        lambda {
+          first_mixin.update_attributes(:position => 2)
+        }.should raise_error(ActiveRecord::StaleObjectError)
+      end
+      
+      it 'should NOT raise an error if update did not affect existing position' do
+        first_mixin  = Mixin.first( :conditions => { :position => 1 } )
+        fourth_mixin = Mixin.first( :conditions => { :position => 4 } )
+        fourth_mixin.update_attributes(:position => 2)
+        lambda {
+          first_mixin.update_attributes(:position => 3)
+        }.should_not raise_error(ActiveRecord::StaleObjectError)
+        Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2,3,4]
+      end
+    end
+    
+  end
   
   describe 'declaring acts_as_restful_list and setting the column' do
     before(:all) do
@@ -113,7 +185,7 @@ describe "ActsAsRestfulList" do
         create_table :mixins do |t|
           t.column :pos, :integer
           t.column :parent_id, :integer
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end
@@ -125,7 +197,7 @@ describe "ActsAsRestfulList" do
     
     after(:all) do
       Object.send(:remove_const, :Mixin)
-      
+
       ActiveRecord::Base.connection.tables.each do |table|
         ActiveRecord::Base.connection.drop_table(table)
       end
@@ -178,7 +250,7 @@ describe "ActsAsRestfulList" do
         Mixin.all(:order => 'pos ASC').collect(&:pos).should == [1,2,3,4]
       end
     end
-      
+    
     describe 'reordering on deletion' do
       it 'should reset the order after deleting a record' do
         mixin = Mixin.create
@@ -201,7 +273,7 @@ describe "ActsAsRestfulList" do
         create_table :mixins do |t|
           t.column :position, :integer
           t.column :parent_id, :integer
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end
@@ -213,7 +285,7 @@ describe "ActsAsRestfulList" do
     
     after(:all) do
       Object.send(:remove_const, :Mixin)
-      
+
       ActiveRecord::Base.connection.tables.each do |table|
         ActiveRecord::Base.connection.drop_table(table)
       end
@@ -279,7 +351,7 @@ describe "ActsAsRestfulList" do
         create_table :mixins do |t|
           t.column :position, :integer
           t.column :parent_id, :integer
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end
@@ -291,7 +363,7 @@ describe "ActsAsRestfulList" do
     
     after(:all) do
       Object.send(:remove_const, :Mixin)
-      
+
       ActiveRecord::Base.connection.tables.each do |table|
         ActiveRecord::Base.connection.drop_table(table)
       end
@@ -313,7 +385,7 @@ describe "ActsAsRestfulList" do
         create_table :mixins do |t|
           t.column :position, :integer
           t.column :parent_name, :string
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end
@@ -348,7 +420,7 @@ describe "ActsAsRestfulList" do
           t.column :position, :integer
           t.column :user_id, :integer
           t.column :parent_id, :integer
-          t.column :created_at, :datetime      
+          t.column :created_at, :datetime
           t.column :updated_at, :datetime
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_restful_list
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "'Trey Bean'"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 -07:00
+date: 2010-11-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency