From f3c84dc31692204aacac3c125dcfcc986fd961a0 Mon Sep 17 00:00:00 2001
From: Jon Leighton <j@jonathanleighton.com>
Date: Tue, 29 Nov 2011 19:40:29 +0000
Subject: Deprecate set_locking_column in favour of self.locking_column=

---
 activerecord/CHANGELOG.md                          |  1 +
 .../lib/active_record/locking/optimistic.rb        | 21 ++++++-----
 activerecord/test/cases/locking_test.rb            | 42 +++++++++++++++++++++-
 activerecord/test/models/legacy_thing.rb           |  2 +-
 4 files changed, 56 insertions(+), 10 deletions(-)

(limited to 'activerecord')

diff --git a/activerecord/CHANGELOG.md b/activerecord/CHANGELOG.md
index f6a00ab0fe..62dc19a988 100644
--- a/activerecord/CHANGELOG.md
+++ b/activerecord/CHANGELOG.md
@@ -6,6 +6,7 @@
       * `set_inheritance_column`
       * `set_sequence_name`
       * `set_primary_key`
+      * `set_locking_column`
 
     Use an assignment method instead. For example, instead of `set_table_name`, use `self.table_name=`:
 
diff --git a/activerecord/lib/active_record/locking/optimistic.rb b/activerecord/lib/active_record/locking/optimistic.rb
index 1a29ded787..531f104c02 100644
--- a/activerecord/lib/active_record/locking/optimistic.rb
+++ b/activerecord/lib/active_record/locking/optimistic.rb
@@ -51,10 +51,6 @@ module ActiveRecord
       included do
         cattr_accessor :lock_optimistically, :instance_writer => false
         self.lock_optimistically = true
-
-        class << self
-          alias_method :locking_column=, :set_locking_column
-        end
       end
 
       def locking_enabled? #:nodoc:
@@ -148,15 +144,24 @@ module ActiveRecord
           lock_optimistically && columns_hash[locking_column]
         end
 
+        def locking_column=(value)
+          @original_locking_column = @locking_column if defined?(@locking_column)
+          @locking_column          = value.to_s
+        end
+
         # Set the column to use for optimistic locking. Defaults to +lock_version+.
         def set_locking_column(value = nil, &block)
-          define_attr_method :locking_column, value, &block
-          value
+          deprecated_property_setter :locking_column, value, block
         end
 
         # The version column used for optimistic locking. Defaults to +lock_version+.
         def locking_column
-          reset_locking_column
+          reset_locking_column unless defined?(@locking_column)
+          @locking_column
+        end
+
+        def original_locking_column #:nodoc:
+          deprecated_original_property_getter :locking_column
         end
 
         # Quote the column name used for optimistic locking.
@@ -166,7 +171,7 @@ module ActiveRecord
 
         # Reset the column used for optimistic locking back to the +lock_version+ default.
         def reset_locking_column
-          set_locking_column DEFAULT_LOCKING_COLUMN
+          self.locking_column = DEFAULT_LOCKING_COLUMN
         end
 
         # Make sure the lock version column gets updated when counters are
diff --git a/activerecord/test/cases/locking_test.rb b/activerecord/test/cases/locking_test.rb
index de017022d7..4eb89b8595 100644
--- a/activerecord/test/cases/locking_test.rb
+++ b/activerecord/test/cases/locking_test.rb
@@ -11,7 +11,7 @@ class LockWithoutDefault < ActiveRecord::Base; end
 
 class LockWithCustomColumnWithoutDefault < ActiveRecord::Base
   self.table_name = :lock_without_defaults_cust
-  set_locking_column :custom_lock_version
+  self.locking_column = :custom_lock_version
 end
 
 class ReadonlyFirstNamePerson < Person
@@ -226,6 +226,46 @@ class OptimisticLockingTest < ActiveRecord::TestCase
   end
 end
 
+class SetLockingColumnTest < ActiveRecord::TestCase
+  def test_set_set_locking_column_with_value
+    k = Class.new( ActiveRecord::Base )
+    k.locking_column = "foo"
+    assert_equal "foo", k.locking_column
+
+    assert_deprecated do
+      k.set_locking_column "bar"
+    end
+    assert_equal "bar", k.locking_column
+  end
+
+  def test_set_locking_column_with_block
+    k = Class.new( ActiveRecord::Base )
+    k.locking_column = 'foo'
+
+    assert_deprecated do
+      k.set_locking_column { "lock_" + original_locking_column }
+    end
+    assert_equal "lock_foo", k.locking_column
+  end
+
+  def test_original_locking_column
+    k = Class.new(ActiveRecord::Base)
+    k.locking_column = "bar"
+
+    assert_deprecated do
+      assert_equal ActiveRecord::Locking::Optimistic::ClassMethods::DEFAULT_LOCKING_COLUMN, k.original_locking_column
+    end
+
+    k = Class.new(ActiveRecord::Base)
+    k.locking_column = "omg"
+    k.locking_column = "wtf"
+
+    assert_deprecated do
+      assert_equal "omg", k.original_locking_column
+    end
+  end
+end
+
 class OptimisticLockingWithSchemaChangeTest < ActiveRecord::TestCase
   fixtures :people, :legacy_things, :references
 
diff --git a/activerecord/test/models/legacy_thing.rb b/activerecord/test/models/legacy_thing.rb
index eaeb642d12..eead181a0e 100644
--- a/activerecord/test/models/legacy_thing.rb
+++ b/activerecord/test/models/legacy_thing.rb
@@ -1,3 +1,3 @@
 class LegacyThing < ActiveRecord::Base
-  set_locking_column :version
+  self.locking_column = :version
 end
-- 
cgit v1.2.3