From 0dd23446a32b4e4974572a39582ea4c11475b80a Mon Sep 17 00:00:00 2001
From: Igor Pstyga <igor.pstyga@gmail.com>
Date: Fri, 3 Jun 2016 04:54:34 -0700
Subject: Improve Hash#compact! documentation and tests

Make it clear what should be returned when no changes were made to the
hash.

  { c: true }.compact! # => nil
---
 activesupport/lib/active_support/core_ext/hash/compact.rb | 13 ++++++++-----
 activesupport/test/core_ext/hash_ext_test.rb              |  8 ++++++++
 2 files changed, 16 insertions(+), 5 deletions(-)

(limited to 'activesupport')

diff --git a/activesupport/lib/active_support/core_ext/hash/compact.rb b/activesupport/lib/active_support/core_ext/hash/compact.rb
index 62ea579c65..f072530e04 100644
--- a/activesupport/lib/active_support/core_ext/hash/compact.rb
+++ b/activesupport/lib/active_support/core_ext/hash/compact.rb
@@ -2,18 +2,21 @@ class Hash
   # Returns a hash with non +nil+ values.
   #
   #   hash = { a: true, b: false, c: nil }
-  #   hash.compact       # => { a: true, b: false }
-  #   hash               # => { a: true, b: false, c: nil }
-  #   { c: nil }.compact # => {}
+  #   hash.compact        # => { a: true, b: false }
+  #   hash                # => { a: true, b: false, c: nil }
+  #   { c: nil }.compact  # => {}
+  #   { c: true }.compact # => { c: true }
   def compact
     self.select { |_, value| !value.nil? }
   end
 
   # Replaces current hash with non +nil+ values.
+  # Returns nil if no changes were made, otherwise returns the hash.
   #
   #   hash = { a: true, b: false, c: nil }
-  #   hash.compact! # => { a: true, b: false }
-  #   hash          # => { a: true, b: false }
+  #   hash.compact!        # => { a: true, b: false }
+  #   hash                 # => { a: true, b: false }
+  #   { c: true }.compact! # => nil
   def compact!
     self.reject! { |_, value| value.nil? }
   end
diff --git a/activesupport/test/core_ext/hash_ext_test.rb b/activesupport/test/core_ext/hash_ext_test.rb
index f0a4c4dddc..e70680c773 100644
--- a/activesupport/test/core_ext/hash_ext_test.rb
+++ b/activesupport/test/core_ext/hash_ext_test.rb
@@ -999,6 +999,10 @@ class HashExtTest < ActiveSupport::TestCase
     h = hash_with_only_nil_values.dup
     assert_equal({}, h.compact)
     assert_equal(hash_with_only_nil_values, h)
+
+    h = @symbols.dup
+    assert_equal(@symbols, h.compact)
+    assert_equal(@symbols, h)
   end
 
   def test_compact!
@@ -1012,6 +1016,10 @@ class HashExtTest < ActiveSupport::TestCase
     h = hash_with_only_nil_values.dup
     assert_equal({}, h.compact!)
     assert_equal({}, h)
+
+    h = @symbols.dup
+    assert_equal(nil, h.compact!)
+    assert_equal(@symbols, h)
   end
 
   def test_new_with_to_hash_conversion
-- 
cgit v1.2.3