Merge pull request rails#46681 from Shopify/object-with

Implement `Object#with`

Author: byroot

activesupport/CHANGELOG.md

@@ -1,3 +1,15 @@
+*   Add `Object#with` to set and restore public attributes around a block
+
+    ```ruby
+    client.timeout # => 5
+    client.with(timeout: 1) do
+      client.timeout # => 1
+    end
+    client.timeout # => 5
+    ```
+
+    *Jean Boussier*
+
 *   Remove deprecated support to generate incorrect RFC 4122 UUIDs when providing a namespace ID that is not one of the
     constants defined on `Digest::UUID`.
 

activesupport/lib/active_support/core_ext/object.rb

@@ -13,4 +13,5 @@
 require "active_support/core_ext/object/json"
 require "active_support/core_ext/object/to_param"
 require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/object/with"
 require "active_support/core_ext/object/with_options"

activesupport/lib/active_support/core_ext/object/with.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class Object
+  # Sets and restore the provided attributes around a block.
+  #
+  #   client.timeout # => 5
+  #   client.with(timeout: 1) do
+  #     client.timeout # => 1
+  #   end
+  #   client.timeout # => 5
+  #
+  # This method is a shorthand for the common begin/ensure pattern:
+  #
+  #   old_value = object.attribute
+  #   begin
+  #     object.attribute = new_value
+  #     # do things
+  #   ensure
+  #     object.attribute = old_value
+  #   end
+  #
+  # It can be used on any object as long as both the reader and writer methods
+  # are public.
+  def with(**attributes)
+    old_values = {}
+    begin
+      attributes.each do |key, value|
+        old_values[key] = public_send(key)
+        public_send("#{key}=", value)
+      end
+      yield
+    ensure
+      old_values.each do |key, old_value|
+        public_send("#{key}=", old_value)
+      end
+    end
+  end
+end

activesupport/test/core_ext/object/with_test.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "../../abstract_unit"
+require "active_support/core_ext/object/with"
+
+class BlankTest < ActiveSupport::TestCase
+  class Record
+    def initialize
+      @public_attr = :public
+      @another_public_attr = :another_public
+      @mixed_attr = :mixed
+      @protected_attr = :protected
+      @private_attr = :private
+    end
+
+    attr_accessor :public_attr, :another_public_attr
+
+    attr_reader :mixed_attr
+
+    protected
+      attr_accessor :protected_attr
+
+    private
+      attr_accessor :private_attr
+      attr_writer :mixed_attr
+  end
+
+  setup do
+    @object = Record.new
+  end
+
+  test "sets and restore attributes around a block" do
+    assert_equal :public, @object.public_attr
+    assert_equal :another_public, @object.another_public_attr
+
+    @object.with(public_attr: :changed, another_public_attr: :changed_too) do
+      assert_equal :changed, @object.public_attr
+      assert_equal :changed_too, @object.another_public_attr
+    end
+
+    assert_equal :public, @object.public_attr
+    assert_equal :another_public, @object.another_public_attr
+  end
+
+  test "restore attribute if the block raised" do
+    assert_equal :public, @object.public_attr
+    assert_equal :another_public, @object.another_public_attr
+
+    assert_raise RuntimeError do
+      @object.with(public_attr: :changed, another_public_attr: :changed_too) do
+        assert_equal :changed, @object.public_attr
+        assert_equal :changed_too, @object.another_public_attr
+        raise "Oops"
+      end
+    end
+
+    assert_equal :public, @object.public_attr
+    assert_equal :another_public, @object.another_public_attr
+  end
+
+  test "restore attributes if one of the setter raised" do
+    assert_equal :public, @object.public_attr
+    assert_equal :mixed, @object.mixed_attr
+
+    assert_raise NoMethodError do
+      @object.with(public_attr: :changed, mixed_attr: :changed_too) do
+        assert false
+      end
+    end
+
+    assert_equal :public, @object.public_attr
+    assert_equal :mixed, @object.mixed_attr
+  end
+
+  test "only works with public attributes" do
+    assert_raises NoMethodError do
+      @object.with(private_attr: :changed) { }
+    end
+
+    assert_raises NoMethodError do
+      @object.with(protected_attr: :changed) { }
+    end
+
+    assert_equal :mixed, @object.mixed_attr
+    assert_raises NoMethodError do
+      @object.with(mixed_attr: :changed) { }
+    end
+    assert_equal :mixed, @object.mixed_attr
+  end
+end