Merge pull request #23733 from bquorning/actioncontroller-parameters-equality

Deprecate AC::Parameters#== with Hash

2 files changed, 59 insertions, 12 deletions

diff --git a/actionpack/lib/action_controller/metal/strong_parameters.rb b/actionpack/lib/action_controller/metal/strong_parameters.rb
index e17189f9f9..25ec3cf5b6 100644
--- a/actionpack/lib/action_controller/metal/strong_parameters.rb
+++ b/actionpack/lib/action_controller/metal/strong_parameters.rb
@@ -144,17 +144,21 @@ module ActionController
     end
 
     # Returns true if another +Parameters+ object contains the same content and
-    # permitted flag, or other Hash-like object contains the same content. This
-    # override is in place so you can perform a comparison with `Hash`.
-    def ==(other_hash)
-      if other_hash.respond_to?(:permitted?)
-        super
+    # permitted flag.
+    def ==(other)
+      if other.respond_to?(:permitted?)
+        self.permitted? == other.permitted? && self.parameters == other.parameters
+      elsif other.is_a?(Hash)
+        ActiveSupport::Deprecation.warn <<-WARNING.squish
+          Comparing equality between `ActionController::Parameters` and a
+          `Hash` is deprecated and will be removed in Rails 5.1. Please only do
+          comparisons between instances of `ActionController::Parameters`. If
+          you need to compare to a hash, first convert it using
+          `ActionController::Parameters#new`.
+        WARNING
+        @parameters == other.with_indifferent_access
       else
-        if other_hash.is_a?(Hash)
-          @parameters == other_hash.with_indifferent_access
-        else
-          @parameters == other_hash
-        end
+        @parameters == other
       end
     end
 
@@ -597,6 +601,8 @@ module ActionController
     end
 
     protected
+      attr_reader :parameters
+
       def permitted=(new_permitted)
         @permitted = new_permitted
       end
diff --git a/actionpack/test/controller/parameters/accessors_test.rb b/actionpack/test/controller/parameters/accessors_test.rb
index 08b3d81bf0..4ef5bed30d 100644
--- a/actionpack/test/controller/parameters/accessors_test.rb
+++ b/actionpack/test/controller/parameters/accessors_test.rb
@@ -129,10 +129,51 @@ class ParametersAccessorsTest < ActiveSupport::TestCase
     assert_not @params[:person].values_at(:name).first.permitted?
   end
 
-  test "equality with another hash works" do
+  test "equality with a hash is deprecated" do
     hash1 = { foo: :bar }
     params1 = ActionController::Parameters.new(hash1)
-    assert(params1 == hash1)
+    assert_deprecated("will be removed in Rails 5.1") do
+      assert(params1 == hash1)
+    end
+  end
+
+  test "is equal to Parameters instance with same params" do
+    params1 = ActionController::Parameters.new(a: 1, b: 2)
+    params2 = ActionController::Parameters.new(a: 1, b: 2)
+    assert(params1 == params2)
+  end
+
+  test "is equal to Parameters instance with same permitted params" do
+    params1 = ActionController::Parameters.new(a: 1, b: 2).permit(:a)
+    params2 = ActionController::Parameters.new(a: 1, b: 2).permit(:a)
+    assert(params1 == params2)
+  end
+
+  test "is equal to Parameters instance with same different source params, but same permitted params" do
+    params1 = ActionController::Parameters.new(a: 1, b: 2).permit(:a)
+    params2 = ActionController::Parameters.new(a: 1, c: 3).permit(:a)
+    assert(params1 == params2)
+    assert(params2 == params1)
+  end
+
+  test 'is not equal to an unpermitted Parameters instance with same params' do
+    params1 = ActionController::Parameters.new(a: 1).permit(:a)
+    params2 = ActionController::Parameters.new(a: 1)
+    assert(params1 != params2)
+    assert(params2 != params1)
+  end
+
+  test "is not equal to Parameters instance with different permitted params" do
+    params1 = ActionController::Parameters.new(a: 1, b: 2).permit(:a, :b)
+    params2 = ActionController::Parameters.new(a: 1, b: 2).permit(:a)
+    assert(params1 != params2)
+    assert(params2 != params1)
+  end
+
+  test "equality with simple types works" do
+    assert(@params != 'Hello')
+    assert(@params != 42)
+    assert(@params != false)
   end
 
   test "inspect shows both class name and parameters" do