acts_as_restful_list 0.0.3 → 0.1.0

data/History.rdoc

@@ -0,0 +1,9 @@
+=== Version 0.1.0 / 2010-02-17
+
+* enhancements
+  * added ability to scope the list.
+    
+=== Version 0.0.3 / 2010-02-14
+
+* enhancements
+  * can set the position column

data/README.rdoc

@@ -1,12 +1,47 @@
 = acts_as_restful_list
 
-Description goes here.
+It's just like acts_as_list, but instead of having to clutter your code with 
+non-standard method calls like insert_at, acts_as_restful_list makes managing lists
+simple.  You update the position attribute just like you would update anything else
+and the rest is taken care of for you.
+
+For example:
+
+  class Item < ActiveRecord::Base
+    belongs_to :parent
+    acts_as_restful_list :scope => :parent
+  end
+
+Now, simply CRUD away:
+
+  item = Item.create
+  item.position # 1
+  
+  item2 = Item.create
+  item.position # 2
+  
+  item3 = Item.create
+  item.position # 3
+  
+  item.destroy
+  item2.position # 1
+  item3.position # 2
+  
+  item3.position = 1
+  item3.save
+  item3.position # 1
+  item2.position # 2
+  
+  different_parent = Item.create(:parent_id => 1)
+  different_parent.position # 1
+  
+And that's that.
 
 == Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
+* Add specs for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

data/Todo.rdoc

@@ -0,0 +1,6 @@
+* enhancements
+  * Add ability to provide custom scope
+  * Add ability to scope on multiple columns
+  
+* Cleanup
+  * Reduce some of the duplication of examples in specs

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/lib/acts_as_restful_list.rb

@@ -9,6 +9,7 @@ module ActsAsRestfulList
     # +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:
     # * +column+: The column to use as the position column.  It's set to position by default.
+    # * +scope+: The column to scope the list to.  It takes a symbol with our without the _id.
     def acts_as_restful_list(options = {})
       include InstanceMethods
       
@@ -21,27 +22,37 @@ module ActsAsRestfulList
       define_method 'position_column' do
         configuration[:column].to_s
       end
+      
+      define_method 'scope_condition' do
+        if configuration[:scope].nil?
+          nil
+        else
+          column = configuration[:scope].to_s.match(/_id$/) ? configuration[:scope].to_s : "#{configuration[:scope]}_id"
+          value = self.send(column)
+          value.nil? ? "#{column} IS NULL" : "#{column} = #{value}"
+        end
+      end
     end
   end
   
   module InstanceMethods
     def set_position
-      last_record = self.class.last( :order => "#{position_column} ASC" )
+      last_record = self.class.last( :conditions => scope_condition, :order => "#{position_column} ASC" )
       self.send( "#{position_column}=", ( last_record.nil? ? 1 : last_record.send(position_column) + 1 ) )
     end
     
     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)", "#{position_column} >= #{self.send( position_column )} AND id != #{id}")
+          self.class.update_all("#{position_column} = (#{position_column} + 1)", [scope_condition, "#{position_column} >= #{self.send( position_column )}", "id != #{id}"].compact.join(' AND '))
         else
-          self.class.update_all("#{position_column} = (#{position_column} - 1)", "#{position_column} <= #{self.send( position_column )} AND #{position_column} >= #{self.send( "#{position_column}_was" )} AND id != #{id}")
+          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 '))
         end
       end
     end
     
     def reset_order_after_destroy
-      self.class.update_all("#{position_column} = (#{position_column} - 1)", "#{position_column} > #{self.send( position_column )}")
+      self.class.update_all("#{position_column} = (#{position_column} - 1)", [scope_condition, "#{position_column} > #{self.send( position_column )}"].compact.join(' AND '))
     end
   end
 end

data/spec/acts_as_restful_list_spec.rb

@@ -92,6 +92,10 @@ describe "ActsAsRestfulList" do
         Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2,3]
       end
     end
+    
+    it 'should return nil for scope_condition since it was not set' do
+      Mixin.new.scope_condition.should be_nil
+    end
   end
   
   
@@ -182,4 +186,115 @@ describe "ActsAsRestfulList" do
       end
     end
   end
+  
+  describe 'declaring acts_as_restful_list and setting the scope' 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 :created_at, :datetime      
+          t.column :updated_at, :datetime
+        end
+      end
+      
+      class Mixin < ActiveRecord::Base
+        acts_as_restful_list :scope => :parent_id
+      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
+    
+    it 'should define scope_condition as an instance method' do
+      Mixin.new.should respond_to(:scope_condition)
+    end
+    
+    it 'should return a scope condition that limits based on the parent_id' do
+      Mixin.new(:parent_id => 3).scope_condition.should == "parent_id = 3"
+    end
+    
+    it 'should return a scope limiting based parent_id being NULL if parent_id is nil' do
+      Mixin.new.scope_condition.should == "parent_id IS NULL"
+    end
+    
+    it 'should set the position based on the scope list when adding a new item' do
+      Mixin.create!.position.should == 1
+      Mixin.create!(:parent_id => 1).position.should == 1
+      Mixin.create!(:parent_id => 1).position.should == 2
+      Mixin.create!(:parent_id => 2).position.should == 1
+    end
+    
+    describe 'reordering on update' do
+      before(:each) do
+        (1..4).each{ Mixin.create!(:parent_id => 1) }
+        (1..6).each{ Mixin.create!(:parent_id => 2) }
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a lower position' do
+        fourth_mixin = Mixin.first( :conditions => { :position => 4, :parent_id => 1 } )
+        fourth_mixin.position = 2
+        fourth_mixin.save!
+        fourth_mixin.reload.position.should == 2
+        Mixin.all(:conditions => { :parent_id => 1 }, :order => 'position ASC').collect(&:position).should == [1,2,3,4]
+        Mixin.all(:conditions => { :parent_id => 2 }, :order => 'position ASC').collect(&:position).should == [1,2,3,4,5,6]
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a higher position' do
+        second_mixin = Mixin.first( :conditions => { :position => 2, :parent_id => 1  } )
+        second_mixin.position = 4
+        second_mixin.save!
+        second_mixin.reload.position.should == 4
+        Mixin.all(:conditions => { :parent_id => 1 }, :order => 'position ASC').collect(&:position).should == [1,2,3,4]
+        Mixin.all(:conditions => { :parent_id => 2 }, :order => 'position ASC').collect(&:position).should == [1,2,3,4,5,6]
+      end
+    end
+    
+    it 'should automatically reorder the list scoped by parent if the record id deleted' do
+      (1..4).each{ Mixin.create!(:parent_id => 1) }
+      (1..6).each{ Mixin.create!(:parent_id => 2) }
+      second_mixin = Mixin.first( :conditions => { :position => 2, :parent_id => 1 } )
+      second_mixin.destroy
+      Mixin.all(:conditions => { :parent_id => 1 }, :order => 'position ASC').collect(&:position).should == [1,2,3]
+      Mixin.all(:conditions => { :parent_id => 2 }, :order => 'position ASC').collect(&:position).should == [1,2,3,4,5,6]
+    end
+  end
+  
+  describe 'declaring acts_as_restful_list and setting the scope without the _id' 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 :created_at, :datetime      
+          t.column :updated_at, :datetime
+        end
+      end
+      
+      class Mixin < ActiveRecord::Base
+        acts_as_restful_list :scope => :parent
+      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
+    
+    it 'should define scope_condition as an instance method' do
+      Mixin.new.should respond_to(:scope_condition)
+    end
+    
+    it 'should return a scope condition that limits based on the parent_id' do
+      Mixin.new(:parent_id => 3).scope_condition.should == "parent_id = 3"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_restful_list
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - "'Trey Bean'"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-14 00:00:00 -07:00
+date: 2010-02-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,9 +34,11 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- History.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
+- Todo.rdoc
 - VERSION
 - lib/acts_as_restful_list.rb
 - spec/acts_as_restful_list_spec.rb