acts_as_list 0.7.2 → 0.7.5

data/lib/acts_as_list/active_record/acts/list.rb

@@ -38,32 +38,30 @@ module ActiveRecord
           configuration = { column: "position", scope: "1 = 1", top_of_list: 1, add_new_at: :bottom}
           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) && configuration[:scope].to_s !~ /_id$/
+            configuration[:scope] = :"#{configuration[:scope]}_id"
+          end
 
           if configuration[:scope].is_a?(Symbol)
             scope_methods = %(
               def scope_condition
-                { :#{configuration[:scope].to_s} => send(:#{configuration[:scope].to_s}) }
+                { #{configuration[:scope]}: send(:#{configuration[:scope]}) }
               end
 
               def scope_changed?
-                changes.include?(scope_name.to_s)
+                changed.include?(scope_name.to_s)
               end
             )
           elsif configuration[:scope].is_a?(Array)
             scope_methods = %(
-              def attrs
-                %w(#{configuration[:scope].join(" ")}).inject({}) do |memo,column|
-                  memo[column.intern] = read_attribute(column.intern); memo
+              def scope_condition
+                #{configuration[:scope]}.inject({}) do |hash, column|
+                  hash.merge!({ column.to_sym => read_attribute(column.to_sym) })
                 end
               end
 
               def scope_changed?
-                (attrs.keys & changes.keys.map(&:to_sym)).any?
-              end
-
-              def scope_condition
-                attrs
+                (scope_condition.keys & changed.map(&:to_sym)).any?
               end
             )
           else
@@ -76,9 +74,9 @@ module ActiveRecord
             )
           end
 
-          class_eval <<-EOV
-            include ::ActiveRecord::Acts::List::InstanceMethods
+          quoted_position_column = connection.quote_column_name(configuration[:column])
 
+          class_eval <<-EOV, __FILE__, __LINE__ + 1
             def acts_as_list_top
               #{configuration[:top_of_list]}.to_i
             end
@@ -113,19 +111,46 @@ module ActiveRecord
               attr_accessible :#{configuration[:column]}
             end
 
-            before_destroy :reload_position
-            after_destroy :decrement_positions_on_lower_items
-            before_update :check_scope
-            after_update :update_positions
-            before_validation :check_top_position
+            scope :in_list, lambda { where(%q{#{quoted_table_name}.#{quoted_position_column} IS NOT NULL}) }
+
+            def self.decrement_all
+              update_all_with_touch %q(#{quoted_position_column} = (#{quoted_table_name}.#{quoted_position_column} - 1))
+            end
+
+            def self.increment_all
+              update_all_with_touch %q(#{quoted_position_column} = (#{quoted_table_name}.#{quoted_position_column} + 1))
+            end
+
+            def self.update_all_with_touch(updates)
+              record = new
+              attrs = record.send(:timestamp_attributes_for_update_in_model)
+              now = record.send(:current_time_from_proper_timezone)
+
+              query = attrs.map { |attr| %(\#{connection.quote_column_name(attr)} = :now) }
+              query.push updates
+              query = query.join(", ")
 
-            scope :in_list, lambda { where("#{table_name}.#{configuration[:column]} IS NOT NULL") }
+              update_all([query, now: now])
+            end
           EOV
 
+          attr_reader :position_changed
+
+          before_validation :check_top_position
+          
+          before_destroy :lock!
+          after_destroy :decrement_positions_on_lower_items
+          
+          before_update :check_scope
+          after_update :update_positions
+
+          after_commit :clear_scope_changed
+
           if configuration[:add_new_at].present?
-            self.send(:before_create, "add_to_list_#{configuration[:add_new_at]}")
+            before_create "add_to_list_#{configuration[:add_new_at]}".to_sym
           end
 
+          include ::ActiveRecord::Acts::List::InstanceMethods
         end
       end
 
@@ -221,10 +246,7 @@ module ActiveRecord
         # Return the next higher item in the list.
         def higher_item
           return nil unless in_list?
-          acts_as_list_class.unscoped do
-            acts_as_list_class.where(scope_condition).where("#{position_column} < #{(send(position_column).to_i).to_s}").
-            order("#{acts_as_list_class.table_name}.#{position_column} DESC").first
-          end
+          higher_items(1).first
         end
 
         # Return the next n higher items in the list
@@ -233,19 +255,16 @@ module ActiveRecord
           limit ||= acts_as_list_list.count
           position_value = send(position_column)
           acts_as_list_list.
-            where("#{position_column} < ?", position_value).
-            where("#{position_column} >= ?", position_value - limit).
+            where("#{quoted_table_name}.#{quoted_position_column} < ?", position_value).
+            where("#{quoted_table_name}.#{quoted_position_column} >= ?", position_value - limit).
             limit(limit).
-            order("#{acts_as_list_class.table_name}.#{position_column} ASC")
+            order("#{quoted_table_name}.#{quoted_position_column} ASC")
         end
 
         # Return the next lower item in the list.
         def lower_item
           return nil unless in_list?
-          acts_as_list_class.unscoped do
-            acts_as_list_class.where(scope_condition).where("#{position_column} > #{(send(position_column).to_i).to_s}").
-            order("#{acts_as_list_class.table_name}.#{position_column} ASC").first
-          end
+          lower_items(1).first
         end
 
         # Return the next n lower items in the list
@@ -254,10 +273,10 @@ module ActiveRecord
           limit ||= acts_as_list_list.count
           position_value = send(position_column)
           acts_as_list_list.
-            where("#{position_column} > ?", position_value).
-            where("#{position_column} <= ?", position_value + limit).
+            where("#{quoted_table_name}.#{quoted_position_column} > ?", position_value).
+            where("#{quoted_table_name}.#{quoted_position_column} <= ?", position_value + limit).
             limit(limit).
-            order("#{acts_as_list_class.table_name}.#{position_column} ASC")
+            order("#{quoted_table_name}.#{quoted_position_column} ASC")
         end
 
         # Test if this record is in a list
@@ -293,14 +312,26 @@ module ActiveRecord
           def add_to_list_top
             increment_positions_on_all_items
             self[position_column] = acts_as_list_top
+            # Make sure we know that we've processed this scope change already
+            @scope_changed = false
+            #dont halt the callback chain
+            true
           end
 
+          # A poorly named method. It will insert the item at the desired position if the position
+          # has been set manually using position=, not necessarily the bottom of the list
           def add_to_list_bottom
-            if not_in_list? || scope_changed? && !@position_changed || default_position?
+            if not_in_list? || internal_scope_changed? && !position_changed || default_position?
               self[position_column] = bottom_position_in_list.to_i + 1
             else
               increment_positions_on_lower_items(self[position_column], id)
             end
+
+            # Make sure we know that we've processed this scope change already
+            @scope_changed = false
+
+            #dont halt the callback chain
+            true
           end
 
           # Overwrite this method to define the scope of the list changes
@@ -315,11 +346,12 @@ module ActiveRecord
 
           # Returns the bottom item
           def bottom_item(except = nil)
-            conditions = scope_condition
             conditions = except ? "#{self.class.primary_key} != #{self.class.connection.quote(except.id)}" : {}
-            acts_as_list_class.unscoped do
-              acts_as_list_class.in_list.where(scope_condition).where(conditions).order("#{acts_as_list_class.table_name}.#{position_column} DESC").first
-            end
+            acts_as_list_list.in_list.where(
+              conditions
+            ).order(
+              "#{quoted_table_name}.#{quoted_position_column} DESC"
+            ).first
           end
 
           # Forces item to assume the bottom position in the list.
@@ -334,62 +366,32 @@ module ActiveRecord
 
           # This has the effect of moving all the higher items up one.
           def decrement_positions_on_higher_items(position)
-            acts_as_list_class.unscoped do
-              acts_as_list_class.where(scope_condition).where(
-                "#{position_column} <= #{position}"
-              ).update_all(
-                "#{position_column} = (#{position_column} - 1)"
-              )
-            end
+            acts_as_list_list.where("#{quoted_position_column} <= #{position}").decrement_all
           end
 
           # This has the effect of moving all the lower items up one.
           def decrement_positions_on_lower_items(position=nil)
             return unless in_list?
             position ||= send(position_column).to_i
-            acts_as_list_class.unscoped do
-              acts_as_list_class.where(scope_condition).where(
-                "#{position_column} > #{position}"
-              ).update_all(
-                "#{position_column} = (#{position_column} - 1)"
-              )
-            end
+            acts_as_list_list.where("#{quoted_position_column} > #{position}").decrement_all
           end
 
           # This has the effect of moving all the higher items down one.
           def increment_positions_on_higher_items
             return unless in_list?
-            acts_as_list_class.unscoped do
-              acts_as_list_class.where(scope_condition).where(
-                "#{position_column} < #{send(position_column).to_i}"
-              ).update_all(
-                "#{position_column} = (#{position_column} + 1)"
-              )
-            end
+            acts_as_list_list.where("#{quoted_position_column} < #{send(position_column).to_i}").increment_all
           end
 
           # This has the effect of moving all the lower items down one.
           def increment_positions_on_lower_items(position, avoid_id = nil)
             avoid_id_condition = avoid_id ? " AND #{self.class.primary_key} != #{self.class.connection.quote(avoid_id)}" : ''
 
-            acts_as_list_class.unscoped do
-              acts_as_list_class.where(scope_condition).where(
-                "#{position_column} >= #{position}#{avoid_id_condition}"
-              ).update_all(
-                "#{position_column} = (#{position_column} + 1)"
-              )
-            end
+            acts_as_list_list.where("#{quoted_position_column} >= #{position}#{avoid_id_condition}").increment_all
           end
 
           # Increments position (<tt>position_column</tt>) of all items in the list.
           def increment_positions_on_all_items
-            acts_as_list_class.unscoped do
-              acts_as_list_class.where(
-                scope_condition
-              ).update_all(
-                "#{position_column} = (#{position_column} + 1)"
-              )
-            end
+            acts_as_list_list.increment_all
           end
 
           # Reorders intermediate items to support moving an item from old_position to new_position.
@@ -402,29 +404,21 @@ module ActiveRecord
               #
               # e.g., if moving an item from 2 to 5,
               # move [3, 4, 5] to [2, 3, 4]
-              acts_as_list_class.unscoped do
-                acts_as_list_class.where(scope_condition).where(
-                  "#{position_column} > #{old_position}"
-                ).where(
-                  "#{position_column} <= #{new_position}#{avoid_id_condition}"
-                ).update_all(
-                  "#{position_column} = (#{position_column} - 1)"
-                )
-              end
+              acts_as_list_list.where(
+                "#{quoted_position_column} > #{old_position}"
+              ).where(
+                "#{quoted_position_column} <= #{new_position}#{avoid_id_condition}"
+              ).decrement_all
             else
               # Increment position of intermediate items
               #
               # e.g., if moving an item from 5 to 2,
               # move [2, 3, 4] to [3, 4, 5]
-              acts_as_list_class.unscoped do
-                acts_as_list_class.where(scope_condition).where(
-                  "#{position_column} >= #{new_position}"
-                ).where(
-                  "#{position_column} < #{old_position}#{avoid_id_condition}"
-                ).update_all(
-                  "#{position_column} = (#{position_column} + 1)"
-                )
-              end
+              acts_as_list_list.where(
+                "#{quoted_position_column} >= #{new_position}"
+              ).where(
+                "#{quoted_position_column} < #{old_position}#{avoid_id_condition}"
+              ).increment_all
             end
           end
 
@@ -453,31 +447,34 @@ module ActiveRecord
             old_position = send("#{position_column}_was").to_i
             new_position = send(position_column).to_i
 
-            return unless acts_as_list_class.unscoped do
-              acts_as_list_class.where(scope_condition).where("#{position_column} = #{new_position}").count > 1
-            end
+            return unless acts_as_list_list.where(
+              "#{quoted_position_column} = #{new_position}"
+            ).count > 1
             shuffle_positions_on_intermediate_items old_position, new_position, id
           end
 
-          # Temporarily swap changes attributes with current attributes
-          def swap_changed_attributes
-            @changed_attributes.each { |k, _| @changed_attributes[k], self[k] =
-              self[k], @changed_attributes[k] }
+          def internal_scope_changed?
+            return @scope_changed if defined?(@scope_changed)
+
+            @scope_changed = scope_changed?
+          end
+
+          def clear_scope_changed
+            remove_instance_variable(:@scope_changed) if defined?(@scope_changed)
           end
 
           def check_scope
-            if scope_changed?
-              swap_changed_attributes
+            if internal_scope_changed?
+              cached_changes = changes
+
+              cached_changes.each { |attribute, values| self[attribute] = values[0] }
               send('decrement_positions_on_lower_items') if lower_item
-              swap_changed_attributes
+              cached_changes.each { |attribute, values| self[attribute] = values[1] }
+
               send("add_to_list_#{add_new_at}")
             end
           end
 
-          def reload_position
-            self.reload
-          end
-
           # This check is skipped if the position is currently the default position from the table
           # as modifying the default position on creation is handled elsewhere
           def check_top_position
@@ -485,6 +482,16 @@ module ActiveRecord
               self[position_column] = acts_as_list_top
             end
           end
+
+          # When using raw column name it must be quoted otherwise it can raise syntax errors with SQL keywords (e.g. order)
+          def quoted_position_column
+            @_quoted_position_column ||= self.class.connection.quote_column_name(position_column)
+          end
+
+          # Used in order clauses
+          def quoted_table_name
+            @_quoted_table_name ||= acts_as_list_class.quoted_table_name
+          end
       end
     end
   end

data/lib/acts_as_list/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module Acts
     module List
-      VERSION = '0.7.2'
+      VERSION = '0.7.5'
     end
   end
 end

data/test/helper.rb

@@ -11,4 +11,11 @@ require "active_record"
 require "minitest/autorun"
 require "#{File.dirname(__FILE__)}/../init"
 
+if defined?(ActiveRecord::VERSION) &&
+  ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2
+
+  # Was removed in Rails 5 and is effectively true.
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+
 require "shared"

data/test/shared.rb

@@ -6,4 +6,5 @@ module Shared
   autoload :ArrayScopeList, 'shared_array_scope_list'
   autoload :TopAddition,    'shared_top_addition'
   autoload :NoAddition,     'shared_no_addition'
+  autoload :Quoting,        'shared_quoting'
 end

data/test/shared_list.rb

@@ -142,7 +142,7 @@ module Shared
 
     def test_update_position_when_scope_changes
       assert_equal [1, 2, 3, 4], ListMixin.where(parent_id: 5).order('pos').map(&:id)
-      parent = ListMixin.create(parent_id: 6)
+      ListMixin.create(parent_id: 6)
 
       ListMixin.where(id: 2).first.move_within_scope(6)
 
@@ -246,5 +246,11 @@ module Shared
 
       assert_equal [5, 1, 6, 2, 3, 4], ListMixin.where(parent_id: 5).order('pos').map(&:id)
     end
+
+    def test_non_persisted_records_dont_get_lock_called
+      new = ListMixin.new(parent_id: 5)
+
+      new.destroy
+    end
   end
 end

data/test/shared_quoting.rb

@@ -0,0 +1,21 @@
+module Shared
+  module Quoting
+
+    def setup
+      3.times { |counter| QuotedList.create! order: counter }
+    end
+
+    def test_create
+      assert_equal QuotedList.in_list.size, 3
+    end
+
+    # This test execute raw queries involving table name
+    def test_moving
+      item = QuotedList.first
+      item.higher_items
+      item.lower_items
+      item.send :bottom_item # Part of private api
+    end
+
+  end
+end

data/test/test_joined_list.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.verbose = false
+
+class Section < ActiveRecord::Base
+  has_many :items
+  acts_as_list
+
+  scope :visible, -> { where(visible: true) }
+end
+
+class Item < ActiveRecord::Base
+  belongs_to :section
+  acts_as_list scope: :section
+
+  scope :visible, -> { where(visible: true).joins(:section).merge(Section.visible) }
+end
+
+class JoinedTestCase < Minitest::Test
+  def setup
+    ActiveRecord::Base.connection.create_table :sections do |t|
+      t.column :position, :integer
+      t.column :visible, :boolean, default: true
+    end
+
+    ActiveRecord::Base.connection.create_table :items do |t|
+      t.column :position, :integer
+      t.column :section_id, :integer
+      t.column :visible, :boolean, default: true
+    end
+
+    ActiveRecord::Base.connection.schema_cache.clear!
+    [Section, Item].each(&:reset_column_information)
+    super
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+    super
+  end
+end
+
+# joining the relation returned by `#higher_items` or `#lower_items` to another table
+# previously could result in ambiguous column names in the query
+class TestHigherLowerItems < JoinedTestCase
+  def test_higher_items
+    section = Section.create
+    item1 = Item.create section: section
+    item2 = Item.create section: section
+    item3 = Item.create section: section
+    assert_equal item3.higher_items.visible, [item1, item2]
+  end
+
+  def test_lower_items
+    section = Section.create
+    item1 = Item.create section: section
+    item2 = Item.create section: section
+    item3 = Item.create section: section
+    assert_equal item1.lower_items.visible, [item2, item3]
+  end
+end

data/test/test_list.rb

@@ -16,9 +16,14 @@ def setup_db(position_options = {})
     t.column :state, :integer
   end
 
+  # This table is used to test table names and column names quoting
+  ActiveRecord::Base.connection.create_table 'table-name' do |t|
+    t.column :order, :integer
+  end
+
   mixins = [ Mixin, ListMixin, ListMixinSub1, ListMixinSub2, ListWithStringScopeMixin,
     ArrayScopeListMixin, ZeroBasedMixin, DefaultScopedMixin,
-    DefaultScopedWhereMixin, TopAdditionMixin, NoAdditionMixin ]
+    DefaultScopedWhereMixin, TopAdditionMixin, NoAdditionMixin, QuotedList ]
 
   mixins << EnumArrayScopeListMixin if rails_4
 
@@ -42,7 +47,13 @@ def rails_4
 end
 
 def teardown_db
-  ActiveRecord::Base.connection.tables.each do |table|
+  if ActiveRecord::VERSION::MAJOR >= 5
+    tables = ActiveRecord::Base.connection.data_sources
+  else
+    tables = ActiveRecord::Base.connection.tables
+  end
+
+  tables.each do |table|
     ActiveRecord::Base.connection.drop_table(table)
   end
 end
@@ -109,6 +120,29 @@ class NoAdditionMixin < Mixin
   acts_as_list column: "pos", add_new_at: nil, scope: :parent_id
 end
 
+##
+# The way we track changes to
+# scope and position can get tripped up
+# by someone using update_attributes within
+# a callback because it causes multiple passes
+# through the callback chain
+module CallbackMixin
+
+  def self.included(base)
+    base.send :include, InstanceMethods
+    base.after_create :change_field
+  end
+
+  module InstanceMethods
+    def change_field
+      # doesn't matter what column changes, just
+      # need to change something
+
+      self.update_attributes(active: !self.active)
+    end
+  end
+end
+
 class TheAbstractClass < ActiveRecord::Base
   self.abstract_class = true
   self.table_name = 'mixins'
@@ -126,6 +160,11 @@ end
 class TheBaseSubclass < TheBaseClass
 end
 
+class QuotedList < ActiveRecord::Base
+  self.table_name = 'table-name'
+  acts_as_list column: :order
+end
+
 class ActsAsListTestCase < Minitest::Test
   # No default test required as this class is abstract.
   # Need for test/unit.
@@ -163,6 +202,18 @@ class ListTest < ActsAsListTestCase
   end
 end
 
+class ListWithCallbackTest < ActsAsListTestCase
+
+  include Shared::List
+
+  def setup
+    ListMixin.send(:include, CallbackMixin)
+    setup_db
+    super
+  end
+
+end
+
 class ListTestWithDefault < ActsAsListTestCase
   include Shared::List
 
@@ -208,6 +259,15 @@ class ArrayScopeListTestWithDefault < ActsAsListTestCase
   end
 end
 
+class QuotingTestList < ActsAsListTestCase
+  include Shared::Quoting
+
+  def setup
+    setup_db_with_default
+    super
+  end
+end
+
 class DefaultScopedTest < ActsAsListTestCase
   def setup
     setup_db
@@ -568,3 +628,66 @@ class MultipleListsArrayScopeTest < ActsAsListTestCase
     assert_equal [1], ArrayScopeListMixin.where(:parent_id => 4, :parent_type => 'anything').order(:pos).map(&:pos)
   end
 end
+
+class TouchTest < ActsAsListTestCase
+  def setup
+    setup_db
+    4.times { ListMixin.create! updated_at: yesterday }
+  end
+
+  def now
+    Time.now.utc
+  end
+
+  def yesterday
+    1.day.ago
+  end
+
+  def updated_ats
+    ListMixin.pluck(:updated_at)
+  end
+
+  def test_moving_item_lower_touches_self_and_lower_item
+    ListMixin.first.move_lower
+    updated_ats[0..1].each do |updated_at|
+      assert_in_delta updated_at, now, 1.second
+    end
+    updated_ats[2..3].each do |updated_at|
+      assert_in_delta updated_at, yesterday, 1.second
+    end
+  end
+
+  def test_moving_item_higher_touches_self_and_higher_item
+    ListMixin.all.second.move_higher
+    updated_ats[0..1].each do |updated_at|
+      assert_in_delta updated_at, now, 1.second
+    end
+    updated_ats[2..3].each do |updated_at|
+      assert_in_delta updated_at, yesterday, 1.second
+    end
+  end
+
+  def test_moving_item_to_bottom_touches_all_other_items
+    ListMixin.first.move_to_bottom
+    updated_ats.each do |updated_at|
+      assert_in_delta updated_at, now, 1.second
+    end
+  end
+
+  def test_moving_item_to_top_touches_all_other_items
+    ListMixin.last.move_to_top
+    updated_ats.each do |updated_at|
+      assert_in_delta updated_at, now, 1.second
+    end
+  end
+
+  def test_removing_item_touches_all_lower_items
+    ListMixin.all.third.remove_from_list
+    updated_ats[0..1].each do |updated_at|
+      assert_in_delta updated_at, yesterday, 1.second
+    end
+    updated_ats[2..2].each do |updated_at|
+      assert_in_delta updated_at, now, 1.second
+    end
+  end
+end