MONGOID-5302 Replace Hash#update_values with ActiveSupport's transform_values! (#5234)

* Hash#update_values can be replaced with ActiveSupport#transform_values!

* MONGOID-5302 add docs removing the methods

* MONGOID-5302 fix docs

Co-authored-by: shields <[email protected]>
Co-authored-by: Neil Shweky <[email protected]>

Author: johnnyshields

docs/release-notes/mongoid-8.0.txt

@@ -336,3 +336,10 @@ to have been used outside of Mongoid:
 - ``Mongoid::Extensions::Date::EPOCH``
 - ``Mongoid::Extensions::Time::EPOCH``
 - ``Mongoid::Factory::TYPE``
+
+
+Removed ``Array#update_values`` and ``Hash#update_values`` methods
+------------------------------------------------------------------
+
+The previously deprecated ``Array#update_values`` and ``Hash#update_values``
+methods have been removed in Mongoid 8.

lib/mongoid/contextual/map_reduce.rb

@@ -121,7 +121,7 @@ def js_mode
       # @return [ MapReduce ] The map/reduce object.
       def out(location)
         normalized = location.dup
-        normalized.update_values do |value|
+        normalized.transform_values! do |value|
           value.is_a?(::Symbol) ? value.to_s : value
         end
         @map_reduce = @map_reduce.out(normalized)

lib/mongoid/criteria/queryable/extensions/array.rb

@@ -108,18 +108,6 @@ def __sort_pair__
             { first => last.to_direction }
           end
 
-          # Update all the values in the hash with the provided block.
-          #
-          # @example Update the values in place.
-          #   [ 1, 2, 3 ].update_values(&:to_s)
-          #
-          # @param [ Proc ] block The block to execute on each value.
-          #
-          # @return [ Array ] the array.
-          def update_values(&block)
-            replace(map(&block))
-          end
-
           private
 
           # Converts the array to a multi-dimensional array.

lib/mongoid/criteria/queryable/extensions/hash.rb

@@ -134,20 +134,6 @@ def __expand_complex__
             replacement
           end
 
-          # Update all the values in the hash with the provided block.
-          #
-          # @example Update the values in place.
-          #   { field: "1" }.update_values(&:to_i)
-          #
-          # @param [ Proc ] block The block to execute on each value.
-          #
-          # @return [ Hash ] the hash.
-          def update_values(&block)
-            each_pair do |key, value|
-              store(key, block[value])
-            end
-          end
-
           private
 
           # Apply the provided strategy for the hash with the given object.

lib/mongoid/criteria/queryable/selectable.rb

@@ -852,7 +852,7 @@ def expr_query(criterion)
         # @param [ Hash ] criterion The criterion.
         def typed_override(criterion, operator)
           if criterion
-            criterion.update_values do |value|
+            criterion.transform_values! do |value|
               yield(value)
             end
           end

lib/mongoid/extensions/hash.rb

@@ -11,7 +11,7 @@ module Hash
       #
       # @return [ Hash ] The converted hash.
       def __evolve_object_id__
-        update_values(&:__evolve_object_id__)
+        transform_values!(&:__evolve_object_id__)
       end
 
       # Mongoizes each value in the hash to an object id if it is convertable.
@@ -24,7 +24,7 @@ def __mongoize_object_id__
         if id = self['$oid']
           BSON::ObjectId.from_string(id)
         else
-          update_values(&:__mongoize_object_id__)
+          transform_values!(&:__mongoize_object_id__)
         end
       end
 
@@ -220,7 +220,7 @@ module ClassMethods
         # @return [ Hash ] The object mongoized.
         def mongoize(object)
           return if object.nil?
-          evolve(object.dup).update_values { |value| value.mongoize }
+          evolve(object.dup).transform_values!(&:mongoize)
         end
 
         # Can the size of this object change?

lib/mongoid/fields.rb

@@ -693,10 +693,8 @@ def create_translations_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations=") do |value|
             attribute_will_change!(name)
-            if value
-              value.update_values do |_value|
-                field.type.mongoize(_value)
-              end
+            value&.transform_values! do |_value|
+              field.type.mongoize(_value)
             end
             attributes[name] = value
           end

spec/mongoid/criteria/queryable/extensions/array_spec.rb

@@ -503,23 +503,4 @@
       end
     end
   end
-
-  describe "#update_values" do
-
-    let(:array) do
-      [ 1, 2, 3 ]
-    end
-
-    let(:updated) do
-      array.update_values(&:to_s)
-    end
-
-    it "replaces each of the values with the result of the block" do
-      expect(updated).to eq([ "1", "2", "3" ])
-    end
-
-    it "returns the same instance of the array" do
-      expect(updated).to equal(array)
-    end
-  end
 end

spec/mongoid/criteria/queryable/extensions/hash_spec.rb

@@ -311,19 +311,4 @@
       end
     end
   end
-
-  describe "#update_values" do
-
-    let(:hash) do
-      { field: "1" }
-    end
-
-    before do
-      hash.update_values(&:to_i)
-    end
-
-    it "updates each value in the hash" do
-      expect(hash).to eq({ field: 1 })
-    end
-  end
 end