has_features 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+test/test.db

data/README

@@ -0,0 +1,18 @@
+HasFeatures
+==========
+
+This is a minor variation on acts_as_list, with a terrible name. If the position is nil then the object is not featured. 
+
+
+Example
+=======
+
+  class Authors < ActiveRecord::Base
+    has_features
+  end
+  
+  Authors.featured
+
+
+blatantly borrowed from acts_as_list (https://github.com/swanandp/acts_as_list) which is (c) David Heinemeier Hansson
+Copyright (c) 2012 Seth Faxon, released under the MIT license

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run has_features unit tests.'
+task :default => :test
+
+desc 'Test the has_features gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/has_features.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'has_features/version'
+
+Gem::Specification.new do |s|
+
+  # Description Meta...
+  s.name        = 'has_features'
+  s.version     = ActiveRecord::Has::Features::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Seth Faxon']
+  s.email       = ['seth.faxon@gmail.com']
+  s.homepage    = 'http://github.com/sfaxon/has_features'
+  s.summary     = %q{A gem allowing a active_record model to have an ordered list of featured items.}
+  s.description = %q{Based on acts_as_list, but allows nil elements to be not a part of the featuerd list.}
+  s.rubyforge_project = 'has_features'
+
+
+  # Load Paths...
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+
+  # Dependencies (installed via 'bundle install')...
+  s.add_development_dependency("bundler", ["~> 1.0.0"])
+  s.add_development_dependency("activerecord", [">= 3.0.0"])
+  s.add_development_dependency("rdoc")
+  s.add_development_dependency("sqlite3")
+end

data/init.rb

@@ -0,0 +1,2 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require 'has_features'

data/lib/has_features.rb

@@ -0,0 +1,2 @@
+require 'has_features/active_record/has/features'
+ActiveRecord::Base.class_eval { include ActiveRecord::Has::Features }

data/lib/has_features/active_record/has/features.rb

@@ -0,0 +1,280 @@
+module ActiveRecord
+  module Has #:nodoc:
+    module Features #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # This +has+ extension provides the capabilities for sorting and reordering a number of objects in a list.
+      # The class that has this specified needs to have a +featured_position+ column defined as an integer on
+      # the mapped database table.
+      #
+      # Todo list example:
+      #
+      #   class TodoList < ActiveRecord::Base
+      #     has_many :todo_items, :order => "featured_position"
+      #   end
+      #
+      #   class Author < ActiveRecord::Base
+      #     belongs_to :todo_list
+      #     has_features :scope => :organization
+      #   end
+      #
+      #   author.featured = true
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * +column+ - specifies the column name to use for keeping the featured_position integer (default: +featured_position+)
+        # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt> 
+        #   (if it hasn't already been added) and use that as the foreign key restriction. It's also possible 
+        #   to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
+        #   Example: <tt>has_features :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
+        def has_features(options = {})
+          configuration = { :column => "featured_position", :scope => "1 = 1" }
+          configuration.update(options) if options.is_a?(Hash)
+
+          configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+
+          if configuration[:scope].is_a?(Symbol)
+            scope_condition_method = %(
+              def scope_condition
+                self.class.send(:sanitize_sql_hash_for_conditions, { :#{configuration[:scope].to_s} => send(:#{configuration[:scope].to_s}) })
+              end
+            )
+          elsif configuration[:scope].is_a?(Array)
+            scope_condition_method = %(
+              def scope_condition
+                attrs = %w(#{configuration[:scope].join(" ")}).inject({}) do |memo,column| 
+                  memo[column.intern] = send(column.intern); memo
+                end
+                self.class.send(:sanitize_sql_hash_for_conditions, attrs)
+              end
+            )
+          else
+            scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end"
+          end
+
+          class_eval <<-EOV
+            include ActiveRecord::Has::Features::InstanceMethods
+            
+            def featured_position_column
+              '#{configuration[:column]}'
+            end
+            
+            def has_features_class
+              ::#{self.name}
+            end
+            
+            scope :featured, order("#{configuration[:column]} asc").where("#{configuration[:column]} is not null")
+
+            #{scope_condition_method}
+            
+            before_destroy :decrement_positions_on_lower_featured_items
+          EOV
+        end
+      end
+
+      # All the methods available to a record that has had <tt>has_features</tt> specified. Each method works
+      # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
+      # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
+      # the first in the list of all chapters.
+      module InstanceMethods
+        # Insert the item at the given position (defaults to the top position of 1).
+        def feature_at(position = 1)
+          feature_at_position(position)
+        end
+
+        # Swap positions with the next lower item, if one exists.
+        def move_lower
+          return unless lower_item
+
+          has_features_class.transaction do
+            lower_item.decrement_position
+            increment_position
+          end
+        end
+
+        # Swap positions with the next higher item, if one exists.
+        def move_higher
+          return unless higher_item
+
+          has_features_class.transaction do
+            higher_item.increment_position
+            decrement_position
+          end
+        end
+
+        # Move to the bottom of the list. If the item is already in the list, the items below it have their
+        # position adjusted accordingly.
+        def move_to_bottom
+          return unless in_list?
+          has_features_class.transaction do
+            decrement_positions_on_lower_featured_items
+            assume_bottom_position
+          end
+        end
+
+        # Move to the top of the list. If the item is already in the list, the items above it have their
+        # position adjusted accordingly.
+        def move_to_top
+          return unless in_list?
+          has_features_class.transaction do
+            increment_positions_on_higher_items
+            assume_top_position
+          end
+        end
+
+        # Removes the item from the list.
+        def unfeature
+          if in_list?
+            decrement_positions_on_lower_featured_items
+            update_attribute featured_position_column, nil
+          end
+        end
+
+        # Increase the position of this item without adjusting the rest of the list.
+        def increment_position
+          return unless in_list?
+          update_attribute featured_position_column, self.send(featured_position_column).to_i + 1
+        end
+
+        # Decrease the position of this item without adjusting the rest of the list.
+        def decrement_position
+          return unless in_list?
+          update_attribute featured_position_column, self.send(featured_position_column).to_i - 1
+        end
+
+        # Return +true+ if this object is the first in the list.
+        def first?
+          return false unless in_list?
+          self.send(featured_position_column) == 1
+        end
+
+        # Return +true+ if this object is the last in the list.
+        def last?
+          return false unless in_list?
+          self.send(featured_position_column) == bottom_position_in_list
+        end
+
+        # Return the next higher item in the list.
+        def higher_item
+          return nil unless in_list?
+          has_features_class.find(:first, :conditions =>
+            "#{scope_condition} AND #{featured_position_column} = #{(send(featured_position_column).to_i - 1).to_s}"
+          )
+        end
+
+        # Return the next lower item in the list.
+        def lower_item
+          return nil unless in_list?
+          has_features_class.find(:first, :conditions =>
+            "#{scope_condition} AND #{featured_position_column} = #{(send(featured_position_column).to_i + 1).to_s}"
+          )
+        end
+
+        # Test if this record is in a list
+        def in_list?
+          !send(featured_position_column).nil?
+        end
+        
+        def featured=(val)
+          if true == val || "true" == val
+            add_to_list_bottom
+            save
+          else
+            unfeature
+          end
+        end
+        
+        def featured?
+          !self.send(featured_position_column).nil?
+        end
+        alias_method :featured, :featured?
+        
+        def feature
+          add_to_list_bottom
+        end
+
+        private
+          def add_to_list_top
+            increment_positions_on_all_items
+          end
+
+          def add_to_list_bottom
+            self[featured_position_column] = bottom_position_in_list.to_i + 1
+             # update_attribute(featured_position_column, bottom_position_in_list.to_i + 1)
+          end
+
+          # Overwrite this method to define the scope of the list changes
+          def scope_condition() "1" end
+
+          # Returns the bottom position number in the list.
+          #   bottom_position_in_list    # => 2
+          def bottom_position_in_list(except = nil)
+            item = bottom_item(except)
+            item ? item.send(featured_position_column) : 0
+          end
+
+          # Returns the bottom item
+          def bottom_item(except = nil)
+            conditions = scope_condition
+            conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
+            has_features_class.find(:first, :conditions => conditions, :order => "#{featured_position_column} DESC")
+          end
+
+          # Forces item to assume the bottom position in the list.
+          def assume_bottom_position
+            update_attribute(featured_position_column, bottom_position_in_list(self).to_i + 1)
+          end
+
+          # Forces item to assume the top position in the list.
+          def assume_top_position
+            update_attribute(featured_position_column, 1)
+          end
+
+          # This has the effect of moving all the higher items up one.
+          def decrement_positions_on_higher_items(position)
+            has_features_class.update_all(
+              "#{featured_position_column} = (#{featured_position_column} - 1)", "#{scope_condition} AND #{featured_position_column} <= #{position}"
+            )
+          end
+
+          # This has the effect of moving all the lower items up one.
+          def decrement_positions_on_lower_featured_items
+            return unless in_list?
+            has_features_class.update_all(
+              "#{featured_position_column} = (#{featured_position_column} - 1)", "#{scope_condition} AND #{featured_position_column} > #{send(featured_position_column).to_i}"
+            )
+          end
+
+          # This has the effect of moving all the higher items down one.
+          def increment_positions_on_higher_items
+            return unless in_list?
+            has_features_class.update_all(
+              "#{featured_position_column} = (#{featured_position_column} + 1)", "#{scope_condition} AND #{featured_position_column} < #{send(featured_position_column).to_i}"
+            )
+          end
+
+          # This has the effect of moving all the lower items down one.
+          def increment_positions_on_lower_items(position)
+            has_features_class.update_all(
+              "#{featured_position_column} = (#{featured_position_column} + 1)", "#{scope_condition} AND #{featured_position_column} >= #{position}"
+           )
+          end
+
+          # Increments position (<tt>featured_position_column</tt>) of all items in the list.
+          def increment_positions_on_all_items
+            has_features_class.update_all(
+              "#{featured_position_column} = (#{featured_position_column} + 1)",  "#{scope_condition}"
+            )
+          end
+
+          def feature_at_position(position)
+            unfeature
+            increment_positions_on_lower_items(position)
+            self.update_attribute(featured_position_column, position)
+          end
+      end 
+    end
+  end
+end

data/lib/has_features/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Has
+    module Features
+      VERSION = "0.1.0"
+    end
+  end
+end

data/test/list_test.rb

@@ -0,0 +1,523 @@
+require 'test/unit'
+
+require 'rubygems'
+gem 'activerecord', '>= 3.0.0'
+require 'active_record'
+require 'ruby-debug'
+
+require File.join(File.dirname(__FILE__), '../lib/has_features')
+require File.join(File.dirname(__FILE__), 'schema')
+
+class FeaturedTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    (1..4).each { |counter| FeaturedMixin.create! :pos => counter, :parent_id => 5 }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_reordering
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_lower
+    assert_equal [1, 3, 2, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_higher
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(1).move_to_bottom
+    assert_equal [2, 3, 4, 1], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(1).move_to_top
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_to_bottom
+    assert_equal [1, 3, 4, 2], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(4).move_to_top
+    assert_equal [4, 1, 3, 2], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  end
+
+  def test_move_to_bottom_with_next_to_last_item
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+    FeaturedMixin.find(3).move_to_bottom
+    assert_equal [1, 2, 4, 3], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  end
+
+  def test_next_prev
+    assert_equal FeaturedMixin.find(2), FeaturedMixin.find(1).lower_item
+    assert_nil FeaturedMixin.find(1).higher_item
+    assert_equal FeaturedMixin.find(3), FeaturedMixin.find(4).higher_item
+    assert_nil FeaturedMixin.find(4).lower_item
+  end
+
+  def test_injection
+    item = FeaturedMixin.new(:parent_id => 1)
+    assert_equal '"mixins"."parent_id" = 1', item.scope_condition
+    assert_equal "pos", item.featured_position_column
+  end
+
+  def test_insert
+    new = FeaturedMixin.create(:parent_id => 20)
+    assert_equal nil, new.pos
+    assert !new.first?
+    assert !new.last?
+  end
+  
+  def test_featuring
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 1, new.pos
+    assert new.featured?
+    assert new.featured
+    assert new.first?
+    assert new.last?
+
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 2, new.pos
+    assert !new.first?
+    assert new.last?
+
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 3, new.pos
+    assert !new.first?
+    assert new.last?
+
+    new = FeaturedMixin.create(:parent_id => 0)
+    new.featured = true
+    assert_equal 1, new.pos
+    assert new.first?
+    assert new.last?
+  end
+  
+  def test_unfeaturing
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 1, new.pos
+    new.featured = false
+    assert_nil new.pos
+  end
+
+  def test_feature_at
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 1, new.pos
+
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 2, new.pos
+
+    new = FeaturedMixin.create(:parent_id => 20)
+    new.featured = true
+    assert_equal 3, new.pos
+
+    new4 = FeaturedMixin.create(:parent_id => 20)
+    new4.featured = true
+    assert_equal 4, new4.pos
+
+    new4.feature_at(3)
+    assert_equal 3, new4.pos
+
+    new.reload
+    assert_equal 4, new.pos
+
+    new.feature_at(2)
+    assert_equal 2, new.pos
+
+    new4.reload
+    assert_equal 4, new4.pos
+
+    new5 = FeaturedMixin.create(:parent_id => 20)
+    new5.featured = true
+    assert_equal 5, new5.pos
+
+    new5.feature_at(1)
+    assert_equal 1, new5.pos
+
+    new4.reload
+    assert_equal 5, new4.pos
+  end
+
+  def test_delete_middle
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).destroy
+
+    assert_equal [1, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    assert_equal 1, FeaturedMixin.find(1).pos
+    assert_equal 2, FeaturedMixin.find(3).pos
+    assert_equal 3, FeaturedMixin.find(4).pos
+
+    FeaturedMixin.find(1).destroy
+
+    assert_equal [3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    assert_equal 1, FeaturedMixin.find(3).pos
+    assert_equal 2, FeaturedMixin.find(4).pos
+  end
+
+  def test_with_string_based_scope
+    new = FeaturedWithStringScopeMixin.create(:parent_id => 500)
+    new.featured = true
+    assert_equal 1, new.pos
+    assert new.first?
+    assert new.last?
+  end
+
+  def test_nil_scope
+    new1, new2, new3 = FeaturedMixin.create, FeaturedMixin.create, FeaturedMixin.create
+    new1.featured = true
+    new2.featured = true
+    new3.featured = true
+    new2.move_higher
+    assert_equal [new2, new1, new3], FeaturedMixin.where('parent_id IS NULL').order('pos')
+  end
+
+  def test_unfeature_should_then_fail_in_list? 
+    assert_equal true, FeaturedMixin.find(1).in_list?
+    FeaturedMixin.find(1).unfeature
+    assert_equal false, FeaturedMixin.find(1).in_list?
+  end 
+  
+  def test_unfeature_should_set_position_to_nil 
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  
+    FeaturedMixin.find(2).unfeature 
+  
+    assert_equal [2, 1, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  
+    assert_equal 1,   FeaturedMixin.find(1).pos
+    assert_equal nil, FeaturedMixin.find(2).pos
+    assert_equal 2,   FeaturedMixin.find(3).pos
+    assert_equal 3,   FeaturedMixin.find(4).pos
+  end 
+  
+  def test_remove_before_destroy_does_not_shift_lower_items_twice 
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  
+    FeaturedMixin.find(2).unfeature 
+    FeaturedMixin.find(2).destroy 
+  
+    assert_equal [1, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+  
+    assert_equal 1, FeaturedMixin.find(1).pos
+    assert_equal 2, FeaturedMixin.find(3).pos
+    assert_equal 3, FeaturedMixin.find(4).pos
+  end 
+  
+  def test_before_destroy_callbacks_do_not_update_position_to_nil_before_deleting_the_record
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    # We need to trigger all the before_destroy callbacks without actually
+    # destroying the record so we can see the affect the callbacks have on
+    # the record.
+    list = FeaturedMixin.find(2)
+    if list.respond_to?(:run_callbacks)
+      list.run_callbacks(:destroy)
+    else
+      list.send(:callback, :before_destroy)
+    end
+
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5).order('pos').map(&:id)
+
+    assert_equal 1, FeaturedMixin.find(1).pos
+    assert_equal 2, FeaturedMixin.find(2).pos
+    assert_equal 2, FeaturedMixin.find(3).pos
+    assert_equal 3, FeaturedMixin.find(4).pos
+  end
+
+end
+
+class FeaturedSubTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    (1..4).each { |i| ((i % 2 == 1) ? FeaturedMixinSub1 : FeaturedMixinSub2).create! :pos => i, :parent_id => 5000 }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_reordering
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_lower
+    assert_equal [1, 3, 2, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_higher
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(1).move_to_bottom
+    assert_equal [2, 3, 4, 1], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(1).move_to_top
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).move_to_bottom
+    assert_equal [1, 3, 4, 2], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(4).move_to_top
+    assert_equal [4, 1, 3, 2], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+  end
+
+  def test_move_to_bottom_with_next_to_last_item
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+    FeaturedMixin.find(3).move_to_bottom
+    assert_equal [1, 2, 4, 3], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+  end
+
+  def test_next_prev
+    assert_equal FeaturedMixin.find(2), FeaturedMixin.find(1).lower_item
+    assert_nil FeaturedMixin.find(1).higher_item
+    assert_equal FeaturedMixin.find(3), FeaturedMixin.find(4).higher_item
+    assert_nil FeaturedMixin.find(4).lower_item
+  end
+
+  def test_injection
+    item = FeaturedMixin.new("parent_id"=>1)
+    assert_equal '"mixins"."parent_id" = 1', item.scope_condition
+    assert_equal "pos", item.featured_position_column
+  end
+
+  def test_feature_at
+    new = FeaturedMixin.create("parent_id" => 20)
+    new.featured = true
+    assert_equal 1, new.pos
+
+    new = FeaturedMixinSub1.create("parent_id" => 20)
+    new.featured = true
+    assert_equal 2, new.pos
+
+    new = FeaturedMixinSub2.create("parent_id" => 20)
+    new.featured = true
+    assert_equal 3, new.pos
+
+    new4 = FeaturedMixin.create("parent_id" => 20)
+    new4.featured = true
+    assert_equal 4, new4.pos
+
+    new4.feature_at(3)
+    assert_equal 3, new4.pos
+
+    new.reload
+    assert_equal 4, new.pos
+
+    new.feature_at(2)
+    assert_equal 2, new.pos
+
+    new4.reload
+    assert_equal 4, new4.pos
+
+    new5 = FeaturedMixinSub1.create("parent_id" => 20)
+    new5.featured = true
+    assert_equal 5, new5.pos
+
+    new5.feature_at(1)
+    assert_equal 1, new5.pos
+
+    new4.reload
+    assert_equal 5, new4.pos
+  end
+
+  def test_delete_middle
+    assert_equal [1, 2, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    FeaturedMixin.find(2).destroy
+
+    assert_equal [1, 3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    assert_equal 1, FeaturedMixin.find(1).pos
+    assert_equal 2, FeaturedMixin.find(3).pos
+    assert_equal 3, FeaturedMixin.find(4).pos
+
+    FeaturedMixin.find(1).destroy
+
+    assert_equal [3, 4], FeaturedMixin.where(:parent_id => 5000).order('pos').map(&:id)
+
+    assert_equal 1, FeaturedMixin.find(3).pos
+    assert_equal 2, FeaturedMixin.find(4).pos
+  end
+
+end
+
+class ArrayScopeFeaturedTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    (1..4).each { |counter| ArrayScopeFeaturedMixin.create! :pos => counter, :parent_id => 5, :parent_type => 'ParentClass' }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_reordering
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(2).move_lower
+    assert_equal [1, 3, 2, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(2).move_higher
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(1).move_to_bottom
+    assert_equal [2, 3, 4, 1], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(1).move_to_top
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(2).move_to_bottom
+    assert_equal [1, 3, 4, 2], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(4).move_to_top
+    assert_equal [4, 1, 3, 2], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  end
+
+  def test_move_to_bottom_with_next_to_last_item
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+    ArrayScopeFeaturedMixin.find(3).move_to_bottom
+    assert_equal [1, 2, 4, 3], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  end
+
+  def test_next_prev
+    assert_equal ArrayScopeFeaturedMixin.find(2), ArrayScopeFeaturedMixin.find(1).lower_item
+    assert_nil ArrayScopeFeaturedMixin.find(1).higher_item
+    assert_equal ArrayScopeFeaturedMixin.find(3), ArrayScopeFeaturedMixin.find(4).higher_item
+    assert_nil ArrayScopeFeaturedMixin.find(4).lower_item
+  end
+
+  def test_injection
+    item = ArrayScopeFeaturedMixin.new(:parent_id => 1, :parent_type => 'ParentClass')
+    assert_equal '"mixins"."parent_id" = 1 AND "mixins"."parent_type" = \'ParentClass\'', item.scope_condition
+    assert_equal "pos", item.featured_position_column
+  end
+
+  def test_insert
+    ArrayScopeFeaturedMixin.destroy_all
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 1, new.pos
+    assert new.first?
+    assert new.last?
+
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 2, new.pos
+    assert !new.first?
+    assert new.last?
+
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 3, new.pos
+    assert !new.first?
+    assert new.last?
+
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 0, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 1, new.pos
+    assert new.first?
+    assert new.last?
+  end
+
+  def test_feature_at
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert new.featured?
+    assert new.featured
+    assert_equal 1, new.pos
+
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 2, new.pos
+
+    new = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new.featured = true
+    assert_equal 3, new.pos
+
+    new4 = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new4.featured = true
+    assert_equal 4, new4.pos
+
+    new4.feature_at(3)
+    assert_equal 3, new4.pos
+
+    new.reload
+    assert_equal 4, new.pos
+
+    new.feature_at(2)
+    assert_equal 2, new.pos
+
+    new4.reload
+    assert_equal 4, new4.pos
+
+    new5 = ArrayScopeFeaturedMixin.create(:parent_id => 20, :parent_type => 'ParentClass')
+    new5.featured = true
+    assert_equal 5, new5.pos
+
+    new5.feature_at(1)
+    assert_equal 1, new5.pos
+
+    new4.reload
+    assert_equal 5, new4.pos
+  end
+
+  def test_delete_middle
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    ArrayScopeFeaturedMixin.find(2).destroy
+
+    assert_equal [1, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    assert_equal 1, ArrayScopeFeaturedMixin.find(1).pos
+    assert_equal 2, ArrayScopeFeaturedMixin.find(3).pos
+    assert_equal 3, ArrayScopeFeaturedMixin.find(4).pos
+
+    ArrayScopeFeaturedMixin.find(1).destroy
+
+    assert_equal [3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+
+    assert_equal 1, ArrayScopeFeaturedMixin.find(3).pos
+    assert_equal 2, ArrayScopeFeaturedMixin.find(4).pos
+  end
+  
+  def test_unfeature_should_then_fail_in_list? 
+    assert_equal true, ArrayScopeFeaturedMixin.find(1).in_list?
+    ArrayScopeFeaturedMixin.find(1).unfeature
+    assert_equal false, ArrayScopeFeaturedMixin.find(1).in_list?
+  end 
+  
+  def test_unfeature_should_set_position_to_nil 
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  
+    ArrayScopeFeaturedMixin.find(2).unfeature 
+  
+    assert_equal [2, 1, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  
+    assert_equal 1,   ArrayScopeFeaturedMixin.find(1).pos
+    assert_equal nil, ArrayScopeFeaturedMixin.find(2).pos
+    assert_equal 2,   ArrayScopeFeaturedMixin.find(3).pos
+    assert_equal 3,   ArrayScopeFeaturedMixin.find(4).pos
+  end 
+  
+  def test_remove_before_destroy_does_not_shift_lower_items_twice 
+    assert_equal [1, 2, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  
+    ArrayScopeFeaturedMixin.find(2).unfeature 
+    ArrayScopeFeaturedMixin.find(2).destroy 
+  
+    assert_equal [1, 3, 4], ArrayScopeFeaturedMixin.where(:parent_id => 5, :parent_type => 'ParentClass').order('pos').map(&:id)
+  
+    assert_equal 1, ArrayScopeFeaturedMixin.find(1).pos
+    assert_equal 2, ArrayScopeFeaturedMixin.find(3).pos
+    assert_equal 3, ArrayScopeFeaturedMixin.find(4).pos
+  end 
+  
+end
+

data/test/schema.rb

@@ -0,0 +1,59 @@
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby' ? 'jdbcsqlite3' : 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :mixins, :force => true do |t|
+      t.integer :pos
+      t.integer :parent_id
+      t.string :parent_type
+      t.timestamp
+    end
+  end
+end
+
+def setup_db
+  CreateSchema.suppress_messages do
+    CreateSchema.migrate(:up)
+  end
+end
+
+setup_db
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Mixin < ActiveRecord::Base
+end
+
+class FeaturedMixin < Mixin
+  self.table_name = 'mixins'
+  
+  has_features :column => "pos", :scope => :parent
+end
+
+class FeaturedMixinSub1 < FeaturedMixin
+end
+
+class FeaturedMixinSub2 < FeaturedMixin
+end
+
+class FeaturedWithStringScopeMixin < ActiveRecord::Base
+  self.table_name = 'mixins'
+
+  has_features :column => "pos", :scope => 'parent_id = #{parent_id}'
+end
+
+class ArrayScopeFeaturedMixin < Mixin
+  self.table_name = 'mixins'
+
+  has_features :column => "pos", :scope => [:parent_id, :parent_type]
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: has_features
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Seth Faxon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70252332686700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70252332686700
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70252332683660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70252332683660
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70252332682960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252332682960
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70252332682000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252332682000
+description: Based on acts_as_list, but allows nil elements to be not a part of the
+  featuerd list.
+email:
+- seth.faxon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README
+- Rakefile
+- has_features.gemspec
+- init.rb
+- lib/has_features.rb
+- lib/has_features/active_record/has/features.rb
+- lib/has_features/version.rb
+- test/list_test.rb
+- test/schema.rb
+homepage: http://github.com/sfaxon/has_features
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: has_features
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: A gem allowing a active_record model to have an ordered list of featured
+  items.
+test_files:
+- test/list_test.rb
+- test/schema.rb