acts_as_sortable 0.0.0.pre1

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 jduarte
+
+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_sortable
+
+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 jduarte. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_sortable"
+    gem.summary = %Q{Easy way to make sortable models in ActiveRecord}
+    gem.description = %Q{Easy way to make sortable models in ActiveRecord}
+    gem.email = "jose.fduarte@gmail.com"
+    gem.homepage = "http://github.com/jduarte/acts_as_sortable"
+    gem.authors = ["jduarte"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_sortable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0.pre1

data/lib/acts_as_sortable.rb

@@ -0,0 +1,123 @@
+module ActsAsSortable
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    @@defaults = {:column => :sequence, :auto_increment => true}
+    
+    # == Configuration options
+    #
+    #
+    # * +column+ - Integer DB column that saves the item position. default (:sequence) 
+    # * +scope+  - Attribute that will be the scope in which to sort by
+    # * +auto_increment+ - If the column attribute auto_increments on a newly created model if it has no value defined
+    #
+    #
+    #
+    def acts_as_sortable(options={})
+      # don't allow multiple calls
+      raise "acts_as_sortable defined more than once for #{self.class}" if self.included_modules.include?(ActsAsSortable::InstanceMethods)
+      
+      opts = @@defaults.merge(options)
+      write_inheritable_attribute :aas_column, opts[:column]
+      write_inheritable_attribute :aas_scope_column, opts[:scope]
+      write_inheritable_attribute :aas_auto_increment, opts[:auto_increment]
+      
+      
+      class_inheritable_reader    :aas_column
+      class_inheritable_reader    :aas_scope_column
+      class_inheritable_reader    :aas_auto_increment
+    
+      before_create :auto_increment_value, :if => opts[:auto_increment]
+    
+      self.send(:include,ActsAsSortable::InstanceMethods)
+    end
+    
+  end # ClassMethods
+  
+  module InstanceMethods
+    def can_be_sorted_up?
+      column , scope_column = read_inheritable_attribute(:aas_column) , read_inheritable_attribute(:aas_scope_column)
+      sequence = self.send(column)
+      klass = self.class
+      conditions = {}
+      conditions.merge({ scope_column.to_sym => self.scope_column }) if scope_column.present?
+      min = klass.minimum(column, conditions)
+      sequence == min ? false : true
+    end
+    
+    def can_be_sorted_down?
+      column , scope_column = read_inheritable_attribute(:aas_column) , read_inheritable_attribute(:aas_scope_column)
+      sequence = self.send(column)
+      klass = self.class
+      conditions = {}
+      conditions.merge({ scope_column.to_sym => self.scope_column }) if scope_column.present?
+      max = klass.maximum(column, conditions)
+      sequence == max ? false : true
+    end
+    
+    def sort_up!
+      column = read_inheritable_attribute(:aas_column)
+      prev_elem = self.previous_element
+      
+      if self.can_be_sorted_up? and prev_elem
+        ActiveRecord::Base.transaction do
+          previous_sequence , self_sequence = prev_elem.send(column) , self.send(column)
+          prev_elem.send(column.to_s.concat("=").to_sym, -1) # Temp only
+          self.send(column.to_s.concat("=").to_sym) = previous_sequence # Ups self
+          prev_elem.send(column.to_s.concat("=").to_sym) = self_sequence # Downs the Previous Element
+          prev_elem.save!
+          self.save!
+        end
+        return self
+      else
+        raise "ActsAsSortable Error::Invalid Sort" 
+      end
+    end
+    
+    def sort_down!
+      column = read_inheritable_attribute(:aas_column)
+      next_elem = self.next_element
+      
+      if self.can_be_sorted_down? and next_elem
+        ActiveRecord::Base.transaction do
+          next_sequence , self_sequence = next_elem.send(column) , self.send(column)
+          next_elem.send(column.to_s.concat("=").to_sym, -1) # Temp only
+          self.send(column.to_s.concat("=").to_sym) = next_sequence # Downs self
+          next_elem.send(column.to_s.concat("=").to_sym) = self_sequence # Ups The Next Element
+          next_elem.save!
+          self.save!
+        end
+        return self
+      else
+        raise "ActsAsSortable Error::Invalid Sort" 
+      end
+    end
+    
+    def previous_element
+      column = read_inheritable_attribute(:aas_column)
+      self_sequence = self.send(column)
+      scope_column = read_inheritable_attribute(:aas_scope_column)
+      klass = self.class
+      
+      conditions = ["#{column} < #{self_sequence}"]
+      conditions.first << " AND (#{scope_column} = #{self.send(scope_column)})" if scope_column.present?
+      
+      klass.find(:first, :conditions => conditions, :order => "#{column} DESC")
+    end
+    
+    def next_element
+      column = read_inheritable_attribute(:aas_column)
+      self_sequence = self.send(column)
+      scope_column = read_inheritable_attribute(:aas_scope_column)
+      
+      klass = self.class
+      conditions = ["#{column} > #{self_sequence}"]
+      conditions.first << " AND (#{scope_column} = #{self.send(scope_column)})" if scope_column.present?
+      
+      klass.find(:first, :conditions => conditions, :order => column)
+    end
+  end # InstanceMethods
+  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'acts_as_sortable'
+
+class Test::Unit::TestCase
+end

data/test/test_acts_as_sortable.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestActsAsSortable < Test::Unit::TestCase
+  should "define instance method sort_up! in a model that includes acts_as_sortable"
+  should "define instance method sort_down! in a model that includes acts_as_sortable"
+  should "default column to sequence"
+  should "default scope to nil"
+  should "define instance method can_be_sorted_up?"
+  should "define instance method can_be_sorted_down?"
+  should "default can_be_sorted_up? to return true unless column sequence value equals the minimum for given scope"
+  should "default can_be_sorted_down? to return true unless column sequence value has the maximum value of given scope"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_sortable
+version: !ruby/object:Gem::Version 
+  version: 0.0.0.pre1
+platform: ruby
+authors: 
+- jduarte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easy way to make sortable models in ActiveRecord
+email: jose.fduarte@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/acts_as_sortable.rb
+- test/helper.rb
+- test/test_acts_as_sortable.rb
+has_rdoc: true
+homepage: http://github.com/jduarte/acts_as_sortable
+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: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easy way to make sortable models in ActiveRecord
+test_files: 
+- test/helper.rb
+- test/test_acts_as_sortable.rb