acts_as_restful_list 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 'Trey Bean'
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= acts_as_restful_list
+
+Description goes here.
+
+== 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
+  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)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 'Trey Bean'. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_restful_list"
+    gem.summary = %Q{Restful acts_as_list}
+    gem.description = %Q{Just like acts_as_list, but allows updating through standard restful methods.}
+    gem.email = "trey@12spokes.com"
+    gem.homepage = "http://github.com/treybean/acts_as_restful_list"
+    gem.authors = ["'Trey Bean'"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_restful_list #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/acts_as_restful_list.rb

@@ -0,0 +1,51 @@
+module ActsAsRestfulList
+  class << self
+    def included base #:nodoc:
+      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:
+    # * +column+: The column to use as the position column.  It's set to position by default.
+    def acts_as_restful_list(options = {})
+      include InstanceMethods
+      
+      configuration = {:column => :position}.merge(options)
+      
+      before_create :set_position
+      after_update :reset_order_after_update
+      after_destroy :reset_order_after_destroy
+      
+      define_method 'position_column' do
+        configuration[:column].to_s
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def set_position
+      last_record = self.class.last( :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}")
+        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}")
+        end
+      end
+    end
+    
+    def reset_order_after_destroy
+      self.class.update_all("#{position_column} = (#{position_column} - 1)", "#{position_column} > #{self.send( position_column )}")
+    end
+  end
+end
+
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, ActsAsRestfulList)
+end

data/spec/acts_as_restful_list_spec.rb

@@ -0,0 +1,185 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActsAsRestfulList" do
+  after(:each) do
+    ActiveRecord::Base.connection.execute("DELETE FROM mixins")
+    ActiveRecord::Base.connection.execute("DELETE FROM sqlite_sequence where name='mixins'")
+  end
+  
+  describe 'standard declaration with no options' 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
+      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 return position as it's position column" do
+      Mixin.new.position_column.should == 'position'
+    end
+    
+    it 'should set the position before creating the record' do
+      mixin = Mixin.new
+      mixin.should_receive(:set_position).and_return(true)
+      mixin.save!
+    end
+    
+    it 'should save the first record with position 1' do
+      Mixin.create!.position.should == 1
+    end
+    
+    it 'should put each new record at the end of the list' do
+      (1..4).each do |n|
+        Mixin.create!.position.should == n
+      end
+    end
+    
+    describe 'reordering on update' do
+      before(:each) do
+        (1..4).each{ Mixin.create! }
+      end
+      
+      it 'should reset order after updating a record' do
+        mixin = Mixin.create
+        mixin.should_receive(:reset_order_after_update).and_return(true)
+        mixin.save!
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a lower position' do
+        fourth_mixin = Mixin.first( :conditions => { :position => 4 } )
+        fourth_mixin.position = 2
+        fourth_mixin.save!
+        fourth_mixin.reload.position.should == 2
+        Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2,3,4]
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a higher position' do
+        second_mixin = Mixin.first( :conditions => { :position => 2 } )
+        second_mixin.position = 4
+        second_mixin.save!
+        second_mixin.reload.position.should == 4
+        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
+        mixin.should_receive(:reset_order_after_destroy).and_return(true)
+        mixin.destroy
+      end
+      
+      it 'should automatically reorder the list if the record id deleted' do
+        (1..4).each{ Mixin.create! }
+        second_mixin = Mixin.first( :conditions => { :position => 2 } )
+        second_mixin.destroy
+        Mixin.all(:order => 'position ASC').collect(&:position).should == [1,2,3]
+      end
+    end
+  end
+  
+  
+  describe 'declaring acts_as_restful_list and setting the column' do
+    before(:all) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :mixins do |t|
+          t.column :pos, :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 :column => :pos
+      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 return pos as it's position column" do
+      Mixin.new.position_column.should == 'pos'
+    end
+    
+    it 'should set the position before creating the record' do
+      mixin = Mixin.new
+      mixin.should_receive(:set_position).and_return(true)
+      mixin.save!
+    end
+    
+    it 'should save the first record with position 1' do
+      Mixin.create!.pos.should == 1
+    end
+    
+    it 'should put each new record at the end of the list' do
+      (1..4).each do |n|
+        Mixin.create!.pos.should == n
+      end
+    end
+    
+    describe 'reordering on update' do
+      before(:each) do
+        (1..4).each{ Mixin.create! }
+      end
+      
+      it 'should reset order after updating a record' do
+        mixin = Mixin.create
+        mixin.should_receive(:reset_order_after_update).and_return(true)
+        mixin.save!
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a lower position' do
+        fourth_mixin = Mixin.first( :conditions => { :pos => 4 } )
+        fourth_mixin.pos = 2
+        fourth_mixin.save!
+        fourth_mixin.reload.pos.should == 2
+        Mixin.all(:order => 'pos ASC').collect(&:pos).should == [1,2,3,4]
+      end
+      
+      it 'should automatically reorder the list if a record is updated with a higher position' do
+        second_mixin = Mixin.first( :conditions => { :pos => 2 } )
+        second_mixin.pos = 4
+        second_mixin.save!
+        second_mixin.reload.pos.should == 4
+        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
+        mixin.should_receive(:reset_order_after_destroy).and_return(true)
+        mixin.destroy
+      end
+      
+      it 'should automatically reorder the list if the record id deleted' do
+        (1..4).each{ Mixin.create! }
+        second_mixin = Mixin.first( :conditions => { :pos => 2 } )
+        second_mixin.destroy
+        Mixin.all(:order => 'pos ASC').collect(&:pos).should == [1,2,3]
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+gem 'activerecord', '>= 1.15.4.7794'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_restful_list'
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_restful_list
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- "'Trey Bean'"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Just like acts_as_list, but allows updating through standard restful methods.
+email: trey@12spokes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/acts_as_restful_list.rb
+- spec/acts_as_restful_list_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/treybean/acts_as_restful_list
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Restful acts_as_list
+test_files: 
+- spec/acts_as_restful_list_spec.rb
+- spec/spec_helper.rb