shuber-sortable 1.0.0

data/CHANGELOG

@@ -0,0 +1,16 @@
+2009-01-17 - Sean Huber (shuber@huberry.com)
+  * Update code documentation
+  * Make the sortable_scope_changes instance method public
+  * Add more tests
+  * Update README
+  * Add gemspec
+
+2009-01-16 - Sean Huber (shuber@huberry.com)
+  * Update logic and add some tests
+  * Add more tests
+  * Rename README.markdown to README.rdoc
+  * Symbolize arguments for calls to the "send" method
+
+2009-01-15 - Sean Huber (shuber@huberry.com)
+  * Initial commit
+  * Add logic

data/README.rdoc

@@ -0,0 +1,198 @@
+= sortable
+
+Allows you to sort ActiveRecord items similar to http://github.com/rails/acts_as_list but with support for multiple scopes and lists
+
+
+== Installation
+
+  gem install shuber-sortable --source http://gems.github.com
+  OR
+  script/plugin install git://github.com/shuber/sortable.git
+
+
+== Examples
+
+=== Simple
+
+Works just like http://github.com/rails/acts_as_list
+
+  class Todo < ActiveRecord::Base
+    # schema
+    #   id           :integer
+    #   project_id   :integer
+    #   description  :string
+    #   position     :integer
+    sortable :scope => :project_id
+  end
+  
+  @todo = Todo.create(:description => 'do something', :project_id => 1)
+  @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+  @todo_3 = Todo.create(:description => 'some other task', :project_id => 2)
+  
+  @todo.position # 1
+  @todo_2.position # 2
+  @todo_3.position # 1
+  
+  @todo.move_down!
+  @todo_2.reload
+  
+  @todo.position # 2
+  @todo_2.position # 1
+  @todo_3.position # 1
+
+
+=== Multiple scopes
+
+Stories may or may not be in a sprint, but if we scoped just by :sprint_id, all stories with a nil :sprint_id 
+would be sorted in one giant list instead of being sorted in each of their respective projects. Specifying an 
+array of scopes fixes this problem.
+
+  class Story < ActiveRecord::Base
+    # schema
+    #   id           :integer
+    #   project_id   :integer
+    #   sprint_id    :integer
+    #   description  :string
+    #   position     :integer
+    sortable :scope => [:project_id, :sprint_id]
+  end
+
+
+=== Multiple lists
+
+Your project management software needs to allow both clients and developers to prioritize todo items separately 
+so that they can be discussed and reviewed during their next meeting. Multiple lists solves this problem.
+
+  class Todo < ActiveRecord::Base
+    # schema
+    #   id                  :integer
+    #   project_id          :integer
+    #   description         :string
+    #   client_priority     :integer
+    #   developer_priority  :integer
+    sortable :scope => :project_id, :column => :client_priority, :list_name => :client
+    sortable :scope => :project_id, :column => :developer_priority, :list_name => :developer
+  end
+  
+  @todo = Todo.create(:description => 'do something', :project_id => 1)
+  @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+  
+  @todo.client_priority # 1
+  @todo.developer_priority # 1
+  @todo_2.client_priority # 2
+  @todo_2.developer_priority # 2
+  
+  @todo.move_down!(:client)
+  @todo_2.reload
+  
+  @todo.client_priority # 2
+  @todo.developer_priority # 1
+  @todo_2.client_priority # 1
+  @todo_2.developer_priority # 2
+
+
+=== Switching scope
+
+Any attributes specified as a :scope that are changed on an item cause the item to automatically switch lists when it is saved
+
+  class Todo < ActiveRecord::Base
+    # schema
+    #   id           :integer
+    #   project_id   :integer
+    #   description  :string
+    #   position     :integer
+    sortable :scope => :project_id
+  end
+  
+  @todo = Todo.create(:description => 'do something', :project_id => 1)
+  @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+  
+  @todo.position # 1
+  @todo_2.position # 2
+  
+  @todo.project_id = 2
+  @todo.save
+  @todo_2.reload
+  
+  @todo.position # 1
+  @todo_2.position # 1
+
+
+== Instance methods
+
+  # Adds the current item to the end of the specified list and saves
+  #
+  # If the current item is already in the list, it will remove it before adding it
+  add_to_list!(list_name = nil)
+  
+  # Returns the first item in a list associated with the current item
+  first_item(list_name = nil)
+  
+  # Returns a boolean after determining if the current item is the first item in the specified list
+  first_item?(list_name = nil)
+  
+  # Returns a boolean after determining if the current item is in the specified list
+  in_list?(list_name = nil)
+  
+  # Inserts the current item at a certain position in the specified list and saves
+  #
+  # If the current item is already in the list, it will remove it before adding it
+  #
+  # Aliased as insert_at_position!
+  insert_at!(position = 1, list_name = nil)
+  
+  # Returns the item with a position at a certain offset to the current item's position in the specified list
+  #
+  # Example
+  #
+  #   @todo = Todo.create
+  #   @todo_2 = Todo.create
+  #   @todo.item_at_offset(1) # returns @todo_2
+  #
+  # Returns nil if an item at the specified offset could not be found
+  item_at_offset(offset, list_name = nil)
+  
+  # Returns the last item in a list associated with the current item
+  last_item(list_name = nil)
+  
+  # Returns a boolean after determining if the current item is the last item in the specified list
+  last_item?(list_name = nil)
+  
+  # Returns the position of the last item in a specified list
+  #
+  # Returns 0 if there are no items in the specified list
+  last_position(list_name = nil)
+  
+  # Moves the current item down one position in the specified list and saves
+  move_down!(list_name = nil)
+  
+  # Moves the current item up one position in the specified list and saves
+  move_up!(list_name = nil)
+  
+  # Moves the current item down to the bottom of the specified list and saves
+  move_to_bottom!(list_name = nil)
+  
+  # Moves the current item up to the top of the specified list and saves
+  move_to_top!(list_name = nil)
+  
+  # Returns the next lower item in the specified list
+  next_item(list_name = nil)
+  
+  # Returns the previous higher item in the specified list
+  previous_item(list_name = nil)
+  
+  # Removes the current item from the specified list and saves
+  #
+  # This will set the :position to nil
+  remove_from_list!(list_name = nil)
+  
+  # Returns a boolean after determining if this item has changed any attributes specified in the :scope options
+  sortable_scope_changed?
+  
+  # Stores an array of attributes specified as a :scope that have been changed
+  sortable_scope_changes
+
+
+== Contact
+
+Problems, comments, and suggestions all welcome: shuber@huberry.com

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+desc 'Default: run the sortable tests'
+task :default => :test
+ 
+desc 'Test the sortable gem/plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+ 
+desc 'Generate documentation for the sortable gem/plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'sortable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'sortable'

data/lib/sortable.rb

@@ -0,0 +1,350 @@
+module Huberry
+  module Sortable
+    class InvalidSortableList < StandardError; end
+    
+    # Raises InvalidSortableList if <tt>list_name</tt> is not a valid sortable list
+    def assert_sortable_list_exists!(list_name)
+      raise ::Huberry::Sortable::InvalidSortableList.new("sortable list '#{list_name}' does not exist") unless sortable_lists.has_key?(list_name.to_s)
+    end
+    
+    # Allows you to sort items similar to http://github.com/rails/acts_as_list by with added support for multiple scopes and lists
+    #
+    # Accepts four options:
+    #
+    #   :column     => The name of the column that will be used to store an item's position in the list. Defaults to :position
+    #   :conditions => Any extra constraints to use if you need to specify a tighter scope than just a foreign key. Defaults to '1 = 1'
+    #   :list_name  => The name of the list (this is used when calling all sortable related instance methods). Defaults to nil
+    #   :scope      => A foreign key or an array of foreign keys to use as list constraints. Defaults to []
+    #
+    #
+    # Simple example (works just like rails/acts_as_list)
+    #
+    #   class Todo < ActiveRecord::Base
+    #     # schema
+    #     #   id           :integer
+    #     #   project_id   :integer
+    #     #   description  :string
+    #     #   position     :integer
+    #     sortable :scope => :project_id
+    #   end
+    #
+    #   @todo = Todo.create(:description => 'do something', :project_id => 1)
+    #   @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+    #   @todo_3 = Todo.create(:description => 'some other task', :project_id => 2)
+    #
+    #   @todo.position # 1
+    #   @todo_2.position # 2
+    #   @todo_3.position # 1
+    #
+    #   @todo.move_down!
+    #   @todo_2.reload
+    #
+    #   @todo.position # 2
+    #   @todo_2.position # 1
+    #   @todo_3.position # 1
+    #
+    #
+    # Example with multiple scopes - Stories may or may not be in a sprint, but if we scoped just by :sprint_id, all stories with a nil :sprint_id 
+    #                                would be sorted in one giant list instead of being sorted in each of their respective projects. Specifying an 
+    #                                array of scopes fixes this problem.
+    #
+    #   class Story < ActiveRecord::Base
+    #     # schema
+    #     #   id           :integer
+    #     #   project_id   :integer
+    #     #   sprint_id    :integer
+    #     #   description  :string
+    #     #   position     :integer
+    #     sortable :scope => [:project_id, :sprint_id]
+    #   end
+    #
+    #
+    # Example with multiple lists - Your project management software needs to allow both clients and developers to prioritize todo items separately 
+    #                               so that they can be discussed and reviewed during their next meeting. Multiple lists solves this problem.
+    #
+    #   class Todo < ActiveRecord::Base
+    #     # schema
+    #     #   id                  :integer
+    #     #   project_id          :integer
+    #     #   description         :string
+    #     #   client_priority     :integer
+    #     #   developer_priority  :integer
+    #     sortable :scope => :project_id, :column => :client_priority, :list_name => :client
+    #     sortable :scope => :project_id, :column => :developer_priority, :list_name => :developer
+    #   end
+    #
+    #   @todo = Todo.create(:description => 'do something', :project_id => 1)
+    #   @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+    #
+    #   @todo.client_priority # 1
+    #   @todo.developer_priority # 1
+    #   @todo_2.client_priority # 2
+    #   @todo_2.developer_priority # 2
+    #
+    #   @todo.move_down!(:client)
+    #   @todo_2.reload
+    #
+    #   @todo.client_priority # 2
+    #   @todo.developer_priority # 1
+    #   @todo_2.client_priority # 1
+    #   @todo_2.developer_priority # 2
+    #
+    #
+    # Any attributes specified as a <tt>:scope</tt> that are changed on an item cause the item to automatically switch lists when it is saved
+    #
+    # Example
+    #
+    #   class Todo < ActiveRecord::Base
+    #     # schema
+    #     #   id           :integer
+    #     #   project_id   :integer
+    #     #   description  :string
+    #     #   position     :integer
+    #     sortable :scope => :project_id
+    #   end
+    #
+    #   @todo = Todo.create(:description => 'do something', :project_id => 1)
+    #   @todo_2 = Todo.create(:description => 'do something else', :project_id => 1)
+    #
+    #   @todo.position # 1
+    #   @todo_2.position # 2
+    #
+    #   @todo.project_id = 2
+    #   @todo.save
+    #   @todo_2.reload
+    #
+    #   @todo.position # 1
+    #   @todo_2.position # 1
+    def sortable(options = {})
+      include InstanceMethods unless include?(InstanceMethods)
+      
+      cattr_accessor :sortable_lists unless respond_to?(:sortable_lists)
+      self.sortable_lists ||= {}
+      
+      define_attribute_methods
+      
+      options = { :column => :position, :conditions => '1 = 1', :list_name => nil, :scope => [] }.merge(options)
+      options[:scope] = [options[:scope]] unless options[:scope].is_a?(Array)
+      
+      options[:scope].each do |scope|
+        (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND (#{table_name}.#{scope} = ?) "
+        
+        unless instance_methods.include?("#{scope}_with_sortable=")
+          define_method "#{scope}_with_sortable=" do |value|
+            sortable_scope_changes << scope unless sortable_scope_changes.include?(scope) || new_record? || value == send(scope) || !self.class.sortable_lists.any? { |list_name, configuration| configuration[:scope].include?(scope) }
+            send("#{scope}_without_sortable=".to_sym, value)
+          end
+          alias_method_chain "#{scope}=".to_sym, :sortable
+        end
+      end
+      
+      self.sortable_lists[options.delete(:list_name).to_s] = options
+    end
+    
+    module InstanceMethods
+      def self.included(base)
+        base.class_eval do
+          before_create :add_to_lists
+          before_destroy :remove_from_lists
+          before_update :update_lists, :if => :sortable_scope_changed?
+          alias_method_chain :reload, :sortable
+        end
+      end
+      
+      # Adds the current item to the end of the specified list and saves
+      #
+      # If the current item is already in the list, it will remove it before adding it
+      def add_to_list!(list_name = nil)
+        remove_from_list!(list_name) if in_list?(list_name)
+        add_to_list(list_name)
+        save
+      end
+      
+      # Returns the first item in a list associated with the current item
+      def first_item(list_name = nil)
+        options = evaluate_sortable_options(list_name)
+        self.class.send("find_by_#{options[:column]}".to_sym, 1, :conditions => options[:conditions])
+      end
+      
+      # Returns a boolean after determining if the current item is the first item in the specified list
+      def first_item?(list_name = nil)
+        self == first_item(list_name)
+      end
+      
+      # Returns a boolean after determining if the current item is in the specified list
+      def in_list?(list_name = nil)
+        !new_record? && !send(evaluate_sortable_options(list_name)[:column]).nil?
+      end
+      
+      # Inserts the current item at a certain <tt>position</tt> in the specified list and saves
+      #
+      # If the current item is already in the list, it will remove it before adding it
+      #
+      # Also aliased as <tt>insert_at_position!</tt>
+      def insert_at!(position = 1, list_name = nil)
+        remove_from_list!(list_name)
+        if position > last_position(list_name)
+          add_to_list!(list_name)
+        else
+          move_lower_items(:down, position - 1, list_name)
+          send("#{evaluate_sortable_options(list_name)[:column]}=".to_sym, position)
+          save
+        end
+      end
+      alias_method :insert_at_position!, :insert_at!
+      
+      # Returns the item with a <tt>position</tt> at a certain offset to the current item's <tt>position</tt> in the specified list
+      #
+      # Example
+      #
+      #   @todo = Todo.create
+      #   @todo_2 = Todo.create
+      #   @todo.item_at_offset(1) # returns @todo_2
+      #
+      # Returns nil if an item at the specified offset could not be found
+      def item_at_offset(offset, list_name = nil)
+        options = evaluate_sortable_options(list_name)
+        in_list?(list_name) ? self.class.send("find_by_#{options[:column]}".to_sym, send(options[:column]) + offset) : nil
+      end
+      
+      # Returns the last item in a list associated with the current item
+      def last_item(list_name = nil)
+        options = evaluate_sortable_options(list_name)
+        (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND #{self.class.table_name}.#{options[:column]} IS NOT NULL "
+        self.class.find(:last, :conditions => options[:conditions], :order => options[:column].to_s)
+      end
+      
+      # Returns a boolean after determining if the current item is the last item in the specified list
+      def last_item?(list_name = nil)
+        self == last_item(list_name)
+      end
+      
+      # Returns the position of the last item in a specified list
+      #
+      # Returns 0 if there are no items in the specified list
+      def last_position(list_name = nil)
+        item = last_item(list_name)
+        item.nil? ? 0 : item.send(evaluate_sortable_options(list_name)[:column])
+      end
+      
+      # Moves the current item down one position in the specified list and saves
+      def move_down!(list_name = nil)        
+        in_list?(list_name) && (last_item?(list_name) || insert_at!(send(evaluate_sortable_options(list_name)[:column]) + 1, list_name))
+      end
+      
+      # Moves the current item up one position in the specified list and saves
+      def move_up!(list_name = nil)
+        in_list?(list_name) && (first_item?(list_name) || insert_at!(send(evaluate_sortable_options(list_name)[:column]) - 1, list_name))
+      end
+      
+      # Moves the current item down to the bottom of the specified list and saves
+      def move_to_bottom!(list_name = nil)
+        in_list?(list_name) && (last_item?(list_name) || add_to_list!(list_name))
+      end
+      
+      # Moves the current item up to the top of the specified list and saves
+      def move_to_top!(list_name = nil)
+        in_list?(list_name) && (first_item?(list_name) || insert_at!(1, list_name))
+      end
+      
+      # Returns the next lower item in the specified list
+      def next_item(list_name = nil)
+        item_at_offset(1, list_name)
+      end
+      
+      # Returns the previous higher item in the specified list
+      def previous_item(list_name = nil)
+        item_at_offset(-1, list_name)
+      end
+      
+      # Clears any <tt>sortable_scope_changes</tt> and reloads normally
+      def reload_with_sortable
+        @sortable_scope_changes = nil
+        reload_without_sortable
+      end
+      
+      # Removes the current item from the specified list and saves
+      #
+      # This will set the <tt>position</tt> to nil
+      def remove_from_list!(list_name = nil)
+        if in_list?(list_name)
+          remove_from_list(list_name)
+          save
+        else
+          false
+        end
+      end
+      
+      # Returns a boolean after determining if this item has changed any attributes specified in the <tt>:scope</tt> options
+      def sortable_scope_changed?
+        !sortable_scope_changes.empty?
+      end
+      
+      # Stores an array of attributes specified as a <tt>:scope</tt> that have been changed
+      def sortable_scope_changes
+        @sortable_scope_changes ||= []
+      end
+      
+      protected
+        
+        # Adds the current item to the specified list
+        def add_to_list(list_name = nil)
+          send("#{evaluate_sortable_options(list_name)[:column]}=".to_sym, last_position(list_name) + 1)
+        end
+        
+        # Adds the current item to all sortable lists
+        def add_to_lists
+          self.class.sortable_lists.each { |list_name, options| add_to_list(list_name) }
+        end
+        
+        # Evaluates <tt>:scope</tt> option and appends those constraints to the <tt>:conditions</tt> option
+        #
+        # Returns the evaluated options
+        def evaluate_sortable_options(list_name = nil)
+          self.class.assert_sortable_list_exists!(list_name)
+          options = self.class.sortable_lists[list_name.to_s].inject({}) { |hash, pair| hash[pair.first] = pair.last.nil? || pair.last.is_a?(Symbol) ? pair.last : pair.last.dup; hash }
+          options[:scope].each do |scope|
+            value = send(scope)
+            if value.nil?
+              (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]).gsub!(/#{scope} \= \?/, "#{scope} IS NULL")
+            else
+              options[:conditions] = [options[:conditions]] unless options[:conditions].is_a?(Array)
+              options[:conditions] << value
+            end
+          end
+          options
+        end
+        
+        # Moves items with a position lower than a certain <tt>position</tt> by an offset of 1 in the specified 
+        # <tt>direction</tt> (:up or :down) for the specified list
+        def move_lower_items(direction, position, list_name = nil)
+          options = evaluate_sortable_options(list_name)
+          (options[:conditions].is_a?(Array) ? options[:conditions].first : options[:conditions]) << " AND #{self.class.table_name}.#{options[:column]} > '#{position}' AND #{self.class.table_name}.#{options[:column]} IS NOT NULL "
+          self.class.update_all "#{options[:column]} = #{options[:column]} #{direction == :up ? '-' : '+'} 1", options[:conditions]
+        end
+        
+        # Removes the current item from the specified list
+        def remove_from_list(list_name = nil)
+          options = evaluate_sortable_options(list_name)
+          move_lower_items(:up, send(options[:column]), list_name)
+          send("#{options[:column]}=".to_sym, nil)
+        end
+        
+        # Removes the current item from all sortable lists
+        def remove_from_lists
+          self.class.sortable_lists.each { |list_name, options| remove_from_list(list_name) }
+        end
+        
+        # Removes the current item from its old lists and adds it to new lists if any attributes specified as a <tt>:scope</tt> have been changed
+        def update_lists
+          new_values = sortable_scope_changes.inject({}) { |hash, scope| value = send(scope); hash[scope] = value.nil? ? nil : value.dup; hash }
+          sortable_scope_changes.each { |scope| send("#{scope}=".to_sym, send("#{scope}_was".to_sym)) }
+          remove_from_lists
+          new_values.each { |scope, value| send("#{scope}=".to_sym, value) }
+          add_to_lists
+        end
+    end
+  end
+end
+
+ActiveRecord::Base.extend Huberry::Sortable

data/test/sortable_test.rb

@@ -0,0 +1,258 @@
+require 'test/unit'
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+require File.dirname(__FILE__) + '/../lib/sortable'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+def create_todos_table
+  silence_stream(STDOUT) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :todos do |t|
+        t.integer  :project_id
+        t.string   :action
+        t.integer  :client_priority
+        t.integer  :developer_priority
+        t.integer  :position
+      end
+    end
+  end
+end
+
+# The table needs to exist before defining the class
+create_todos_table
+
+class Todo < ActiveRecord::Base
+  sortable :scope => :project_id, :conditions => 'todos.action IS NOT NULL'
+  sortable :scope => :project_id, :column => :client_priority, :list_name => :client
+  sortable :scope => :project_id, :column => :developer_priority, :list_name => :developer
+end
+
+class SortableTest < Test::Unit::TestCase
+  
+  def setup
+    ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+    create_todos_table
+  end
+  
+  def test_should_add_to_lists
+    @todo = Todo.create
+    assert_equal 1, @todo.client_priority
+    assert_equal 1, @todo.developer_priority
+  end
+  
+  def test_should_increment_lists
+    Todo.create    
+    @todo = Todo.create
+    assert_equal 2, @todo.client_priority
+    assert_equal 2, @todo.developer_priority
+  end
+  
+  def test_should_scope_lists
+    Todo.create
+    @todo = Todo.create :project_id => 1
+    assert_equal 1, @todo.client_priority
+    assert_equal 1, @todo.developer_priority
+  end
+  
+  def test_should_remove_from_lists_on_destroy
+    Todo.create
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal 3, @todo_2.client_priority
+    assert_equal 3, @todo_2.developer_priority
+    @todo.destroy
+    @todo_2.reload
+    assert_equal 2, @todo_2.client_priority
+    assert_equal 2, @todo_2.developer_priority
+  end
+  
+  def test_should_return_first_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo, @todo_2.first_item(:client)
+    assert_equal @todo, @todo_2.first_item(:developer)
+  end
+  
+  def test_should_return_boolean_for_first_item?
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert @todo.first_item?(:client)
+    assert !@todo_2.first_item?(:client)
+  end
+  
+  def test_should_return_boolean_for_in_list?
+    @todo = Todo.new
+    assert !@todo.in_list?(:client)
+    assert @todo.save
+    assert @todo.in_list?(:client)
+    @todo.remove_from_list!(:client)
+    assert !@todo.in_list?(:client)
+  end
+  
+  def test_should_insert_at!
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    @todo_3 = Todo.create
+    @todo.insert_at!(2, :client)
+    @todo_2.reload
+    @todo_3.reload
+    assert_equal 1, @todo_2.client_priority
+    assert_equal 2, @todo.client_priority
+    assert_equal 3, @todo_3.client_priority
+  end
+  
+  def test_item_at_offset_should_return_previous_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo, @todo_2.item_at_offset(-1, :client)
+  end
+  
+  def test_item_at_offset_should_return_next_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo_2, @todo.item_at_offset(1, :client)
+  end
+  
+  def test_item_at_offset_should_return_nil_for_non_existent_offset
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_nil @todo.item_at_offset(-1, :client)
+    assert_nil @todo.item_at_offset(2, :client)
+  end
+  
+  def test_should_return_last_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo_2, @todo.last_item(:client)
+    assert_equal @todo_2, @todo.last_item(:developer)
+  end
+  
+  def test_should_return_boolean_for_last_item?
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert @todo_2.last_item?(:client)
+    assert !@todo.last_item?(:client)
+  end
+  
+  def test_should_return_last_position
+    assert_equal 0, Todo.new.last_position(:client)
+    @todo = Todo.create
+    assert_equal 1, @todo.last_position(:client)
+    Todo.create
+    assert_equal 2, @todo.last_position(:client)
+  end
+  
+  def test_should_move_down
+    @todo = Todo.create
+    Todo.create
+    assert_equal 1, @todo.client_priority
+    @todo.move_down!(:client)
+    assert_equal 2, @todo.client_priority
+  end
+  
+  def test_should_move_up
+    Todo.create
+    @todo = Todo.create
+    assert_equal 2, @todo.client_priority
+    @todo.move_up!(:client)
+    assert_equal 1, @todo.client_priority
+  end
+  
+  def test_should_move_to_bottom
+    @todo = Todo.create
+    Todo.create
+    Todo.create
+    assert_equal 1, @todo.client_priority
+    @todo.move_to_bottom!(:client)
+    assert_equal 3, @todo.client_priority
+  end
+  
+  def test_should_move_to_top
+    Todo.create
+    Todo.create
+    @todo = Todo.create
+    assert_equal 3, @todo.client_priority
+    @todo.move_to_top!(:client)
+    assert_equal 1, @todo.client_priority
+  end
+  
+  def test_should_return_next_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo_2, @todo.next_item(:client)
+    assert_nil @todo_2.next_item(:client)
+  end
+  
+  def test_should_return_previous_item
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal @todo, @todo_2.previous_item(:client)
+    assert_nil @todo.previous_item(:client)
+  end
+  
+  def test_should_clear_sortable_scope_changes_when_reloading
+    @todo = Todo.create
+    @todo.project_id = 1
+    assert @todo.sortable_scope_changed?
+    @todo.reload
+    assert !@todo.sortable_scope_changed?
+  end
+  
+  def test_should_remove_from_list
+    @todo = Todo.create
+    @todo_2 = Todo.create
+    assert_equal 1, @todo.client_priority
+    assert_equal 2, @todo_2.client_priority
+    @todo.remove_from_list!(:client)
+    @todo_2.reload
+    assert_nil @todo.client_priority
+    assert_equal 1, @todo_2.client_priority
+  end
+  
+  def test_should_return_boolean_for_sortable_scope_changed?
+    @todo = Todo.new
+    assert !@todo.sortable_scope_changed?
+    @todo.project_id = 1
+    assert !@todo.sortable_scope_changed?
+    assert @todo.save
+    @todo.reload
+    @todo.project_id = 2
+    assert @todo.sortable_scope_changed?
+  end
+  
+  def test_should_list_attrs_in_sortable_scope_changes
+    @todo = Todo.new
+    assert_equal [], @todo.sortable_scope_changes
+    @todo.project_id = 1
+    assert_equal [], @todo.sortable_scope_changes
+    assert @todo.save
+    @todo.reload
+    @todo.project_id = 2
+    assert [:project_id], @todo.sortable_scope_changes
+  end
+  
+  def test_should_raise_invalid_sortable_list_error_if_list_does_not_exist
+    @todo = Todo.create
+    assert_raises ::Huberry::Sortable::InvalidSortableList do
+      @todo.move_up!(:invalid)
+    end
+  end
+  
+  def test_should_use_conditions
+    @todo = Todo.create
+    @todo_2 = Todo.create :action => 'test'
+    @todo_3 = Todo.create
+    @todo_4 = Todo.create :action => 'test again'
+    @todo_5 = Todo.create
+    @todo_6 = Todo.create
+    assert_equal 1, @todo.position
+    assert_equal 1, @todo_2.position
+    assert_equal 2, @todo_3.position
+    assert_equal 2, @todo_4.position
+    assert_equal 3, @todo_5.position
+    assert_equal 3, @todo_6.position
+  end
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-sortable
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Allows you to sort ActiveRecord items in multiple lists with multiple scopes
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/sortable.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: false
+homepage: http://github.com/shuber/sortable
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Allows you to sort ActiveRecord items in multiple lists with multiple scopes
+test_files: 
+- test/sortable_test.rb