sortifiable 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,3 +1,14 @@
+*0.1.1 (February 7th, 2011)
+
+* Use the class in which act_as_list is called
+
+* Wrap list updates inside a transaction block
+
+* Don't include instance methods in all models
+
+* Don't add acts_as_list callbacks to all models
+
+
 *0.1.0 (February 6th, 2011)
 
-* First release
+* First release

data/lib/sortifiable/version.rb

@@ -1,3 +1,3 @@
 module Sortifiable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/sortifiable.rb

@@ -1,4 +1,3 @@
-require 'active_support/concern'
 require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/hash/reverse_merge'
@@ -24,14 +23,12 @@ require 'sortifiable/version'
 #   todo_list.first.move_to_bottom
 #   todo_list.last.move_higher
 module Sortifiable
-  extend ActiveSupport::Concern
-
-  included do
-    class_attribute :acts_as_list_options, :instance_writer => false
-    self.acts_as_list_options = {}
-
-    before_create :add_to_list_bottom
-    before_destroy :decrement_position_on_lower_items, :if => :in_list?
+  def self.included(base) #:nodoc:
+    base.extend(ClassMethods)
+    base.class_eval do
+      class_attribute :acts_as_list_options, :instance_writer => false
+      self.acts_as_list_options = {}
+    end
   end
 
   module ClassMethods
@@ -70,6 +67,12 @@ module Sortifiable
         options[:scope] = "#{options[:scope]}_id".to_sym
       end
 
+      options[:class] = self
+
+      include InstanceMethods
+      before_create :add_to_list_bottom
+      before_destroy :decrement_position_on_lower_items, :if => :in_list?
+
       self.acts_as_list_options = options
     end
   end
@@ -79,189 +82,199 @@ module Sortifiable
   # 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.
-
-  # Add the item to the end of the list
-  def add_to_list
-    remove_from_list if in_list?
-    update_attribute(position_column, last_position + 1)
-  end
-
-  # Returns the current position
-  def current_position
-    send(position_column).to_i
-  end
-
-  # Decrease the position of this item without adjusting the rest of the list.
-  def decrement_position
-    in_list? && update_attribute(position_column, current_position - 1)
-  end
-
-  # Return +true+ if this object is the first in the list.
-  def first?
-    in_list? && current_position == 1
-  end
-  alias_method :top?, :first?
-
-  # Returns the first item in the list
-  def first_item
-    list_scope.first
-  end
-  alias_method :top_item, :first_item
-
-  # Return the next higher item in the list.
-  def higher_item
-    item_at_offset(-1)
-  end
-  alias_method :previous_item, :higher_item
-
-  # Return items lower than this item or an empty array if it is the last item
-  def higher_items
-    list_scope.where(["#{quoted_position_column} < ?", current_position]).all
-  end
-
-  # Test if this record is in a list
-  def in_list?
-    !new_record? && !send(position_column).nil?
-  end
-
-  # Increase the position of this item without adjusting the rest of the list.
-  def increment_position
-    in_list? && update_attribute(position_column, current_position + 1)
-  end
-
-  # Insert the item at the given position (defaults to the top position of 1).
-  def insert_at(position = 1)
-    if position > 0
-      remove_from_list
-      if position > last_position
-        add_to_list
-      else
-        increment_position_on_lower_items(position - 1)
-        update_attribute(position_column, position)
+  module InstanceMethods
+    # Add the item to the end of the list
+    def add_to_list
+      list_class.transaction do
+        remove_from_list if in_list?
+        update_attribute(position_column, last_position + 1)
       end
-    else
-      false
     end
-  end
-
-  # Return the item at the offset specified from the current position
-  def item_at_offset(offset)
-    in_list? ? offset_scope(offset).first : nil
-  end
-
-  # Return +true+ if this object is the last in the list.
-  def last?
-    in_list? && current_position == last_position
-  end
-  alias_method :bottom?, :last?
 
-  # Returns the bottom item
-  def last_item
-    list_scope.last
-  end
-  alias_method :bottom_item, :last_item
+    # Returns the current position
+    def current_position
+      send(position_column).to_i
+    end
 
-  # Returns the bottom position in the list.
-  def last_position
-    item = last_item
-    item ? item.current_position : 0
-  end
-  alias_method :bottom_position, :last_position
+    # Decrease the position of this item without adjusting the rest of the list.
+    def decrement_position
+      in_list? && update_attribute(position_column, current_position - 1)
+    end
 
-  # Return the next lower item in the list.
-  def lower_item
-    item_at_offset(1)
-  end
-  alias_method :next_item, :lower_item
+    # Return +true+ if this object is the first in the list.
+    def first?
+      in_list? && current_position == 1
+    end
+    alias_method :top?, :first?
 
-  # Return items lower than this item or an empty array if it is the last item
-  def lower_items
-    list_scope.where(["#{quoted_position_column} > ?", current_position]).all
-  end
+    # Returns the first item in the list
+    def first_item
+      list_scope.first
+    end
+    alias_method :top_item, :first_item
 
-  # Swap positions with the next higher item, if one exists.
-  def move_higher
-    in_list? && (first? || insert_at(current_position - 1))
-  end
-  alias_method :move_up, :move_higher
+    # Return the next higher item in the list.
+    def higher_item
+      item_at_offset(-1)
+    end
+    alias_method :previous_item, :higher_item
 
-  # Swap positions with the next lower item, if one exists.
-  def move_lower
-    in_list? && (last? || insert_at(current_position + 1))
-  end
-  alias_method :move_down, :move_lower
+    # Return items lower than this item or an empty array if it is the last item
+    def higher_items
+      list_scope.where(["#{quoted_position_column} < ?", current_position]).all
+    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
-    in_list? && (last? || add_to_list)
-  end
+    # Test if this record is in a list
+    def in_list?
+      !new_record? && !send(position_column).nil?
+    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
-    in_list? && (first? || insert_at(1))
-  end
+    # Increase the position of this item without adjusting the rest of the list.
+    def increment_position
+      in_list? && update_attribute(position_column, current_position + 1)
+    end
 
-  # Removes the item from the list.
-  def remove_from_list
-    if in_list?
-      decrement_position_on_lower_items
-      update_attribute(position_column, nil)
-    else
-      false
+    # Insert the item at the given position (defaults to the top position of 1).
+    def insert_at(position = 1)
+      if position > 0
+        list_class.transaction do
+          remove_from_list
+          if position > last_position
+            add_to_list
+          else
+            increment_position_on_lower_items(position - 1)
+            update_attribute(position_column, position)
+          end
+        end
+      else
+        false
+      end
     end
-  end
 
-  private
-    def add_to_list_bottom #:nodoc:
-      send("#{position_column}=".to_sym, last_position + 1)
+    # Return the item at the offset specified from the current position
+    def item_at_offset(offset)
+      in_list? ? offset_scope(offset).first : nil
     end
 
-    def base_scope #:nodoc:
-      self.class.unscoped.where(scope_condition)
+    # Return +true+ if this object is the last in the list.
+    def last?
+      in_list? && current_position == last_position
     end
+    alias_method :bottom?, :last?
 
-    def decrement_position_on_lower_items #:nodoc:
-      lower_scope(current_position).update_all(position_update('- 1'))
+    # Returns the bottom item
+    def last_item
+      list_scope.last
     end
+    alias_method :bottom_item, :last_item
 
-    def increment_position_on_lower_items(position) #:nodoc:
-      lower_scope(position).update_all(position_update('+ 1'))
+    # Returns the bottom position in the list.
+    def last_position
+      item = last_item
+      item ? item.current_position : 0
     end
+    alias_method :bottom_position, :last_position
 
-    def list_scope #:nodoc:
-      base_scope.order(position_column).where("#{quoted_position_column} IS NOT NULL")
+    # Return the next lower item in the list.
+    def lower_item
+      item_at_offset(1)
     end
+    alias_method :next_item, :lower_item
 
-    def lower_scope(position) #:nodoc:
-      base_scope.where(["#{quoted_position_column} > ?", position])
+    # Return items lower than this item or an empty array if it is the last item
+    def lower_items
+      list_scope.where(["#{quoted_position_column} > ?", current_position]).all
     end
 
-    def offset_scope(offset) #:nodoc:
-      base_scope.where(position_column => current_position + offset)
+    # Swap positions with the next higher item, if one exists.
+    def move_higher
+      in_list? && (first? || insert_at(current_position - 1))
     end
+    alias_method :move_up, :move_higher
 
-    def position_column #:nodoc:
-      acts_as_list_options[:column]
+    # Swap positions with the next lower item, if one exists.
+    def move_lower
+      in_list? && (last? || insert_at(current_position + 1))
     end
+    alias_method :move_down, :move_lower
 
-    def position_update(direction) #:nodoc:
-      "#{quoted_position_column} = (#{quoted_position_column} #{direction})"
+    # 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
+      in_list? && (last? || add_to_list)
     end
 
-    def quoted_position_column #:nodoc:
-      connection.quote_column_name(position_column)
+    # 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
+      in_list? && (first? || insert_at(1))
     end
 
-    def scope_condition #:nodoc:
-      if acts_as_list_options[:scope].is_a?(String)
-        instance_eval("\"#{acts_as_list_options[:scope]}\"")
+    # Removes the item from the list.
+    def remove_from_list
+      if in_list?
+        list_class.transaction do
+          decrement_position_on_lower_items
+          update_attribute(position_column, nil)
+        end
       else
-        Array.wrap(acts_as_list_options[:scope]).inject({}){ |m,k| m[k] = send(k); m }
+        false
       end
     end
 
+    private
+      def add_to_list_bottom #:nodoc:
+        send("#{position_column}=".to_sym, last_position + 1)
+      end
+
+      def base_scope #:nodoc:
+        list_class.unscoped.where(scope_condition)
+      end
+
+      def decrement_position_on_lower_items #:nodoc:
+        lower_scope(current_position).update_all(position_update('- 1'))
+      end
+
+      def increment_position_on_lower_items(position) #:nodoc:
+        lower_scope(position).update_all(position_update('+ 1'))
+      end
+
+      def list_class #:nodoc:
+        acts_as_list_options[:class]
+      end
+
+      def list_scope #:nodoc:
+        base_scope.order(position_column).where("#{quoted_position_column} IS NOT NULL")
+      end
+
+      def lower_scope(position) #:nodoc:
+        base_scope.where(["#{quoted_position_column} > ?", position])
+      end
+
+      def offset_scope(offset) #:nodoc:
+        base_scope.where(position_column => current_position + offset)
+      end
+
+      def position_column #:nodoc:
+        acts_as_list_options[:column]
+      end
+
+      def position_update(direction) #:nodoc:
+        "#{quoted_position_column} = (#{quoted_position_column} #{direction})"
+      end
+
+      def quoted_position_column #:nodoc:
+        connection.quote_column_name(position_column)
+      end
+
+      def scope_condition #:nodoc:
+        if acts_as_list_options[:scope].is_a?(String)
+          instance_eval("\"#{acts_as_list_options[:scope]}\"")
+        else
+          Array.wrap(acts_as_list_options[:scope]).inject({}){ |m,k| m[k] = send(k); m }
+        end
+      end
+  end
 end
 
 ActiveRecord::Base.send(:include, Sortifiable)

data/test/sortifiable_test.rb

@@ -10,6 +10,7 @@ def setup_db
   silence_stream(STDOUT) do
     ActiveRecord::Schema.define(:version => 1) do
       create_table :mixins do |t|
+        t.column :type, :string
         t.column :pos, :integer
         t.column :parent_id, :integer
         t.column :parent_type, :string
@@ -31,7 +32,7 @@ setup_db
 class Mixin < ActiveRecord::Base
 end
 
-class ListMixin < Mixin
+class ListMixin < ActiveRecord::Base
   acts_as_list :column => "pos", :scope => :parent
   set_table_name "mixins"
   default_scope order(:pos)
@@ -46,10 +47,9 @@ end
 class ListWithStringScopeMixin < ActiveRecord::Base
   acts_as_list :column => "pos", :scope => 'parent_id = #{parent_id}'
   set_table_name "mixins"
-  default_scope order(:pos)
 end
 
-class ArrayScopeListMixin < Mixin
+class ArrayScopeListMixin < ActiveRecord::Base
   acts_as_list :column => "pos", :scope => [:parent_id, :parent_type]
   set_table_name "mixins"
   default_scope order(:pos)
@@ -57,6 +57,31 @@ end
 
 teardown_db
 
+class NonListTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_callbacks_are_not_added_to_all_models
+    Mixin.create! :pos => 1, :parent_id => 5
+    assert_equal 1, Mixin.first.id
+
+    Mixin.find(1).destroy
+    assert_equal [], Mixin.all
+  end
+
+  def test_instance_methods_are_not_included_in_all_models
+    Mixin.create! :pos => 1, :parent_id => 5
+    assert_equal false, Mixin.first.respond_to?(:in_list?)
+  end
+
+end
+
 class ListTest < Test::Unit::TestCase
 
   def setup
@@ -267,13 +292,23 @@ class ListSubTest < Test::Unit::TestCase
 
   def setup
     setup_db
-    (1..4).each { |i| ((i % 2 == 1) ? ListMixinSub1 : ListMixinSub2).create! :pos => i, :parent_id => 5000 }
+    (1..4).each do |i|
+      klass = ((i % 2 == 1) ? ListMixinSub1 : ListMixinSub2)
+      klass.create! :pos => i, :parent_id => 5000
+    end
   end
 
   def teardown
     teardown_db
   end
 
+  def test_sti_class
+    assert_instance_of ListMixinSub1, ListMixin.find(1)
+    assert_instance_of ListMixinSub2, ListMixin.find(2)
+    assert_instance_of ListMixinSub1, ListMixin.find(3)
+    assert_instance_of ListMixinSub2, ListMixin.find(4)
+  end
+
   def test_reordering
     assert_equal [1, 2, 3, 4], ListMixin.where('parent_id = 5000').map(&:id)
 
@@ -381,6 +416,10 @@ class ListSubTest < Test::Unit::TestCase
     assert_equal [], ListMixin.find(4).lower_items.map(&:id)
   end
 
+  def test_list_class
+    assert_equal [1, 2, 3, 4], ListMixin.all.map(&:pos)
+  end
+
 end
 
 class ArrayScopeListTest < Test::Unit::TestCase

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sortifiable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andrew White