climate_control 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac4a1d4fe272e5369855d9d80c8bfd764b752f27d1bdfad2b19a607d5f0a44e
-  data.tar.gz: 8945986d5956f681810ef8a5f164323a3cd2a48e82368618c292f3c6fc7a6caa
+  metadata.gz: '00584062039c6b9161ff0e4a1b61ca51e4d8742225fc611180c4effcc43959c5'
+  data.tar.gz: 99135f45c57f58d87e17480896045c00eecebd632ed64eaf18bd1964ef7d454d
 SHA512:
-  metadata.gz: c36a6b4ead29b23f93c95457e56f6bc3fd6c5cd596f66fe8243e736edcc5a11cfe9fd5fe62b1cf5fc8cd0c7f4fe72c051c0560338a6496e30c56b3cf095c92ec
-  data.tar.gz: cbdf93ff0a149ef67129db0ac0f25838f02c7d2faf6dea87f8ce0acaf54848fb129f4d1b8cbf0ad40c50358cd2186e5a726b2fed5d82fbc9de2c765f4a9bf94d
+  metadata.gz: 01ba4ad3241cea796d408f0adb02f8c23b85771d1ce8338eedf973b95228a7cac9978218f08921915918c90a0f8f292dbb38f9401ca29de8d7a6ef3dc76d99b5
+  data.tar.gz: 9b20ce4affbcf22b6204016d31b7b54465ad5ba2a143fd2e6578d3dc5d4c80ac167c02c9ccc47d91c2a62441c5ce3037ebb13c445407876c163edaba73eb484d

data/.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', 2.7, 2.6, 2.5]
+        ruby-version: [3.1, '3.0', 2.7, 2.6, 2.5]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby-version }}

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.2.0 / 2022-07-15
+
+- Added: `ClimateControl.unsafe_modify` for a thread-unsafe version of
+  `ClimateControl.modify` (useful for minitest-around for instance)
+- Deprecates `ClimateControl.env`, `ENV` should be used instead
+
+## 1.1.1 / 2022-05-28
+
+- Fixed: ENV was not restored if an error was thrown when assigning ENV
+
+## 1.1.0 / 2022-05-26
+
+- Refactor to use `Monitor` instead of `Mutex`
+- Add documentation about thread-safety
+- Allow ClimateControl.modify to be called without environment variables
+- Add test for concurrent access needed to be inside block
+- Relax development dependencies
+
+## 1.0.1 / 2021-05-26
+
+- Require minimum Ruby version of 2.5.0
+
+# 1.0.0 / 2021-03-06
+
+- Commit to supporting latest patch versions of Ruby 2.5+
+- Improve documentation
+- Format code with StandardRB
+- Bump gem dependencies
+
+# 0.2.0 / 2017-05-12
+
+- Allow nested environment changes in the same thread
+
+# 0.1.0 / 2017-01-07
+
+- Remove ActiveSupport dependency
+
+# 0.0.4 / 2017-01-06
+
+- Improved thread safety
+- Handle TypeErrors during assignment
+- Improve documentation
+
+# 0.0.1 / 2012-11-28
+
+- Initial release

data/CODEOWNERS

@@ -0,0 +1 @@
+* @dorianmariefr

data/README.md

@@ -1,5 +1,7 @@
 # Climate Control
 
+![GitHub Actions CI](https://github.com/thoughtbot/climate_control/actions/workflows/ci.yml/badge.svg)
+
 Easily manage your environment.
 
 ## Installation
@@ -48,7 +50,7 @@ end
 To use with RSpec, you could define this in your spec:
 
 ```ruby
-def with_modified_env(options, &block)
+def with_modified_env(options = {}, &block)
   ClimateControl.modify(options, &block)
 end
 ```
@@ -105,6 +107,39 @@ manner becomes more difficult:
 Climate Control modifies environment variables only within the context of the
 block, ensuring values are managed properly and consistently.
 
+## Thread-safety
+
+When using threads, for instance when running tests concurrently in the same
+process, you may need to wrap your code inside `ClimateControl.modify` blocks,
+e.g.:
+
+```ruby
+first_thread = Thread.new do
+  ClimateControl.modify(SECRET: "1") do
+    p ENV["SECRET"] # => "1"
+    sleep 2
+    p ENV["SECRET"] # => "1"
+  end
+end
+
+second_thread = Thread.new do
+  ClimateControl.modify({}) do
+    sleep 1
+    p ENV["SECRET"] # => nil
+    sleep 1
+    p ENV["SECRET"] # => nil
+  end
+end
+
+first_thread.join
+second_thread.join
+```
+
+> The modification wraps ENV in a mutex. If there's contention (the env being used - including potentially mutating values), it blocks until the value is freed (we shift out of the Ruby block).
+>
+> <cite><a href="https://github.com/thoughtbot/climate_control/issues/32#issuecomment-800713686">Josh Clayton</a></cite>
+
+
 ## Contributing
 
 1. Fork it
@@ -118,3 +153,18 @@ This project uses [StandardRB](https://github.com/testdouble/standard) to ensure
 ## License
 
 climate_control is copyright 2012-2021 Joshua Clayton and thoughtbot, inc. It is free software and may be redistributed under the terms specified in the [LICENSE](https://github.com/thoughtbot/climate_control/blob/main/LICENSE) file.
+
+About thoughtbot
+----------------
+
+![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
+
+climate_control is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community] or
+[hire us][hire] to design, develop, and grow your product.
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github

data/climate_control.gemspec

@@ -5,8 +5,8 @@ require "climate_control/version"
 Gem::Specification.new do |gem|
   gem.name = "climate_control"
   gem.version = ClimateControl::VERSION
-  gem.authors = ["Joshua Clayton"]
-  gem.email = ["joshua.clayton@gmail.com"]
+  gem.authors = ["Joshua Clayton", "Dorian Marié"]
+  gem.email = ["joshua.clayton@gmail.com", "dorian@dorianmarie.fr"]
   gem.description = "Modify your ENV"
   gem.summary = "Modify your ENV easily with ClimateControl"
   gem.homepage = "https://github.com/thoughtbot/climate_control"
@@ -18,8 +18,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.5.0"
 
-  gem.add_development_dependency "rspec", "~> 3.10.0"
-  gem.add_development_dependency "rake", "~> 12.3.3"
-  gem.add_development_dependency "simplecov", "~> 0.9.1"
-  gem.add_development_dependency "standard", "~> 1.0.0"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "standard"
 end

data/lib/climate_control/version.rb

@@ -1,3 +1,3 @@
 module ClimateControl
-  VERSION = "1.0.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/climate_control.rb

@@ -1,16 +1,72 @@
-require "climate_control/environment"
 require "climate_control/errors"
-require "climate_control/modifier"
 require "climate_control/version"
+require "monitor"
 
 module ClimateControl
-  @@env = ClimateControl::Environment.new
+  extend self
+  extend Gem::Deprecate
 
-  def self.modify(environment_overrides, &block)
-    Modifier.new(env, environment_overrides, &block).process
+  SEMAPHORE = Monitor.new
+  private_constant :SEMAPHORE
+
+  def modify(environment_overrides = {}, &block)
+    environment_overrides = environment_overrides.transform_keys(&:to_s)
+
+    SEMAPHORE.synchronize do
+      previous = ENV.to_hash
+
+      begin
+        copy environment_overrides
+      ensure
+        middle = ENV.to_hash
+      end
+
+      block.call
+    ensure
+      after = ENV
+      (previous.keys | middle.keys | after.keys).each do |key|
+        if previous[key] != after[key] && middle[key] == after[key]
+          ENV[key] = previous[key]
+        end
+      end
+    end
   end
 
-  def self.env
-    @@env
+  def unsafe_modify(environment_overrides = {}, &block)
+    environment_overrides = environment_overrides.transform_keys(&:to_s)
+
+    previous = ENV.to_hash
+
+    begin
+      copy environment_overrides
+    ensure
+      middle = ENV.to_hash
+    end
+
+    block.call
+  ensure
+    after = ENV
+    (previous.keys | middle.keys | after.keys).each do |key|
+      if previous[key] != after[key] && middle[key] == after[key]
+        ENV[key] = previous[key]
+      end
+    end
+  end
+
+  def env
+    ENV
+  end
+
+  deprecate :env, "ENV", 2022, 10
+
+  private
+
+  def copy(overrides)
+    overrides.each do |key, value|
+      ENV[key] = value
+    rescue TypeError => e
+      raise UnassignableValueError,
+        "attempted to assign #{value} to #{key} but failed (#{e.message})"
+    end
   end
 end

data/spec/acceptance/climate_control_spec.rb

@@ -5,7 +5,7 @@ Thing = Class.new
 describe "Climate control" do
   it "allows modification of the environment" do
     block_run = false
-    ClimateControl.modify FOO: "bar" do
+    with_modified_env FOO: "bar" do
       expect(ENV["FOO"]).to eq "bar"
       block_run = true
     end
@@ -113,6 +113,39 @@ describe "Climate control" do
     expect(ENV["BAZ"]).to be_nil
   end
 
+  it "handles threads accessing the same key wrapped in a block" do
+    first_thread = Thread.new {
+      with_modified_env do
+        with_modified_env CONFLICTING_KEY: "1" do
+          sleep 0.5
+          expect(ENV["CONFLICTING_KEY"]).to eq("1")
+        end
+
+        expect(ENV["CONFLICTING_KEY"]).to be_nil
+      end
+    }
+
+    second_thread = Thread.new {
+      with_modified_env do
+        sleep 0.25
+        expect(ENV["CONFLICTING_KEY"]).to be_nil
+
+        with_modified_env CONFLICTING_KEY: "2" do
+          expect(ENV["CONFLICTING_KEY"]).to eq("2")
+          sleep 0.5
+          expect(ENV["CONFLICTING_KEY"]).to eq("2")
+        end
+
+        expect(ENV["CONFLICTING_KEY"]).to be_nil
+      end
+    }
+
+    first_thread.join
+    second_thread.join
+
+    expect(ENV["CONFLICTING_KEY"]).to be_nil
+  end
+
   it "is re-entrant" do
     ret = with_modified_env(FOO: "foo") {
       with_modified_env(BAR: "bar") do
@@ -134,7 +167,32 @@ describe "Climate control" do
     }.to raise_error ClimateControl::UnassignableValueError, /attempted to assign .*Thing.* to FOO but failed \(#{message}\)$/
   end
 
-  def with_modified_env(options, &block)
+  it "restores the ENV even when an error was raised when assigning values" do
+    ENV["KEY_TO_OVERRIDE"] = "initial_value_1"
+    ENV["KEY_THAT_WILL_ERROR_OUT"] = "initial_value_2"
+
+    expect {
+      with_modified_env(
+        KEY_TO_OVERRIDE: "overwriten_value_1",
+        KEY_THAT_WILL_ERROR_OUT: :value_that_will_error_out
+      ) {}
+    }.to raise_error ClimateControl::UnassignableValueError
+
+    expect(ENV["KEY_TO_OVERRIDE"]).to eq("initial_value_1")
+    expect(ENV["KEY_THAT_WILL_ERROR_OUT"]).to eq("initial_value_2")
+  end
+
+  it "doesn't block on nested modify calls" do
+    with_modified_env(SMS_DEFAULT_COUNTRY_CODE: nil) do
+      with_modified_env(SMS_DEFAULT_COUNTRY_CODE: "++56") do
+        expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++56")
+      end
+
+      expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++41")
+    end
+  end
+
+  def with_modified_env(options = {}, &block)
     ClimateControl.modify(options, &block)
   end
 

data/spec/acceptance/unsafe_modify_spec.rb

@@ -0,0 +1,186 @@
+require "spec_helper"
+
+describe "ClimateControl#unsafe_modify" do
+  it "allows modification of the environment" do
+    block_run = false
+    with_modified_env FOO: "bar" do
+      expect(ENV["FOO"]).to eq "bar"
+      block_run = true
+    end
+
+    expect(ENV["FOO"]).to be_nil
+    expect(block_run).to be true
+  end
+
+  it "modifies the environment" do
+    with_modified_env VARIABLE_1: "bar", VARIABLE_2: "qux" do
+      expect(ENV["VARIABLE_1"]).to eq "bar"
+      expect(ENV["VARIABLE_2"]).to eq "qux"
+    end
+
+    expect(ENV["VARIABLE_1"]).to be_nil
+    expect(ENV["VARIABLE_2"]).to be_nil
+  end
+
+  it "allows for environment variables to be assigned within the block" do
+    with_modified_env VARIABLE_1: "modified" do
+      ENV["ASSIGNED_IN_BLOCK"] = "assigned"
+    end
+
+    expect(ENV["ASSIGNED_IN_BLOCK"]).to eq "assigned"
+  end
+
+  it "reassigns previously set environment variables" do
+    ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"] = "original"
+    expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "original"
+
+    with_modified_env VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV: "overridden" do
+      expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "overridden"
+    end
+
+    expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "original"
+  end
+
+  it "persists the change when overriding the variable in the block" do
+    with_modified_env VARIABLE_MODIFIED_AND_THEN_ASSIGNED: "modified" do
+      ENV["VARIABLE_MODIFIED_AND_THEN_ASSIGNED"] = "assigned value"
+    end
+
+    expect(ENV["VARIABLE_MODIFIED_AND_THEN_ASSIGNED"]).to eq "assigned value"
+  end
+
+  it "resets environment variables even if the block raises" do
+    expect {
+      with_modified_env FOO: "bar" do
+        raise "broken"
+      end
+    }.to raise_error("broken")
+
+    expect(ENV["FOO"]).to be_nil
+  end
+
+  it "preserves environment variables set within the block" do
+    ENV["CHANGED"] = "old value"
+
+    with_modified_env IRRELEVANT: "ignored value" do
+      ENV["CHANGED"] = "new value"
+    end
+
+    expect(ENV["CHANGED"]).to eq "new value"
+  end
+
+  it "returns the value of the block" do
+    value = with_modified_env VARIABLE_1: "bar" do
+      "value inside block"
+    end
+
+    expect(value).to eq "value inside block"
+  end
+
+  it "handles threads correctly" do
+    # failure path without mutex
+    # [thread_removing_env] BAZ is assigned
+    # 0.25s passes
+    # [other_thread] FOO is assigned and ENV is copied (which includes BAZ)
+    # 0.25s passes
+    # [thread_removing_env] thread resolves and BAZ is removed from env; other_thread still retains knowledge of BAZ
+    # 0.25s passes
+    # [other_thread] thread resolves, FOO is removed, BAZ is copied back to ENV
+
+    thread_removing_env = Thread.new {
+      with_modified_env BAZ: "buzz" do
+        sleep 0.5
+      end
+
+      expect(ENV["BAZ"]).to be_nil
+    }
+
+    other_thread = Thread.new {
+      sleep 0.25
+      with_modified_env FOO: "bar" do
+        sleep 0.5
+      end
+
+      expect(ENV["FOO"]).to be_nil
+    }
+
+    thread_removing_env.join
+    other_thread.join
+
+    expect(ENV["FOO"]).to be_nil
+    expect(ENV["BAZ"]).to be_nil
+  end
+
+  it "is re-entrant" do
+    ret = with_modified_env(FOO: "foo") {
+      with_modified_env(BAR: "bar") do
+        "bar"
+      end
+    }
+
+    expect(ret).to eq("bar")
+
+    expect(ENV["FOO"]).to be_nil
+    expect(ENV["BAR"]).to be_nil
+  end
+
+  it "raises when the value cannot be assigned properly" do
+    message = generate_type_error_for_object(Thing.new)
+
+    expect {
+      with_modified_env(FOO: Thing.new)
+    }.to raise_error ClimateControl::UnassignableValueError, /attempted to assign .*Thing.* to FOO but failed \(#{message}\)$/
+  end
+
+  it "restores the ENV even when an error was raised when assigning values" do
+    ENV["KEY_TO_OVERRIDE"] = "initial_value_1"
+    ENV["KEY_THAT_WILL_ERROR_OUT"] = "initial_value_2"
+
+    expect {
+      with_modified_env(
+        KEY_TO_OVERRIDE: "overwriten_value_1",
+        KEY_THAT_WILL_ERROR_OUT: :value_that_will_error_out
+      ) {}
+    }.to raise_error ClimateControl::UnassignableValueError
+
+    expect(ENV["KEY_TO_OVERRIDE"]).to eq("initial_value_1")
+    expect(ENV["KEY_THAT_WILL_ERROR_OUT"]).to eq("initial_value_2")
+  end
+
+  it "doesn't block on nested modify calls" do
+    with_modified_env(SMS_DEFAULT_COUNTRY_CODE: nil) do
+      with_modified_env(SMS_DEFAULT_COUNTRY_CODE: "++56") do
+        expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++56")
+      end
+
+      expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++41")
+    end
+  end
+
+  def with_modified_env(options = {}, &block)
+    ClimateControl.unsafe_modify(options, &block)
+  end
+
+  def generate_type_error_for_object(object)
+    message = nil
+
+    begin
+      "1" + object
+    rescue TypeError => e
+      message = e.message
+    end
+
+    message
+  end
+
+  around do |example|
+    old_env = ENV.to_hash
+
+    example.run
+
+    ENV.clear
+    old_env.each do |key, value|
+      ENV[key] = value
+    end
+  end
+end

metadata

@@ -1,93 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: climate_control
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Joshua Clayton
+- Dorian Marié
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 description: Modify your ENV
 email:
 - joshua.clayton@gmail.com
+- dorian@dorianmarie.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
-- NEWS
 - README.md
 - Rakefile
 - climate_control.gemspec
 - lib/climate_control.rb
-- lib/climate_control/environment.rb
 - lib/climate_control/errors.rb
-- lib/climate_control/modifier.rb
 - lib/climate_control/version.rb
 - spec/acceptance/climate_control_spec.rb
+- spec/acceptance/unsafe_modify_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/thoughtbot/climate_control
 licenses:
@@ -108,10 +110,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: Modify your ENV easily with ClimateControl
 test_files:
 - spec/acceptance/climate_control_spec.rb
+- spec/acceptance/unsafe_modify_spec.rb
 - spec/spec_helper.rb

data/NEWS

@@ -1,22 +0,0 @@
-1.0.1 (May 26, 2021)
-  Require minimum Ruby version of 2.5.0
-
-1.0.0 (March 6, 2021)
-  Commit to supporting latest patch versions of Ruby 2.5+
-  Improve documentation
-  Format code with StandardRB
-  Bump gem dependencies
-
-0.2.0 (May 12, 2017)
-  Allow nested environment changes in the same thread
-
-0.1.0 (January 7, 2017)
-  Remove ActiveSupport dependency
-
-0.0.4 (January 6, 2017)
-  Improved thread safety
-  Handle TypeErrors during assignment
-  Improve documentation
-
-0.0.1 (November 28, 2012)
-  Initial release

data/lib/climate_control/environment.rb

@@ -1,33 +0,0 @@
-require "forwardable"
-
-module ClimateControl
-  class Environment
-    extend Forwardable
-
-    def initialize
-      @semaphore = Mutex.new
-      @owner = nil
-    end
-
-    def_delegators :env, :[]=, :to_hash, :[], :delete
-
-    def synchronize
-      if @owner == Thread.current
-        return yield if block_given?
-      end
-
-      @semaphore.synchronize do
-        @owner = Thread.current
-        yield if block_given?
-      ensure
-        @owner = nil
-      end
-    end
-
-    private
-
-    def env
-      ENV
-    end
-  end
-end

data/lib/climate_control/modifier.rb

@@ -1,92 +0,0 @@
-module ClimateControl
-  class Modifier
-    def initialize(env, environment_overrides = {}, &block)
-      @environment_overrides = stringify_keys(environment_overrides)
-      @block = block
-      @env = env
-    end
-
-    def process
-      @env.synchronize do
-        prepare_environment_for_block
-        run_block
-      ensure
-        cache_environment_after_block
-        delete_keys_that_do_not_belong
-        revert_changed_keys
-      end
-    end
-
-    private
-
-    def prepare_environment_for_block
-      @original_env = clone_environment
-      copy_overrides_to_environment
-      @env_with_overrides_before_block = clone_environment
-    end
-
-    def run_block
-      @block.call
-    end
-
-    def copy_overrides_to_environment
-      @environment_overrides.each do |key, value|
-        @env[key] = value
-      rescue TypeError => e
-        raise UnassignableValueError,
-          "attempted to assign #{value} to #{key} but failed (#{e.message})"
-      end
-    end
-
-    def keys_to_remove
-      @environment_overrides.keys
-    end
-
-    def keys_changed_by_block
-      @keys_changed_by_block ||= OverlappingKeysWithChangedValues.new(@env_with_overrides_before_block, @env_after_block).keys
-    end
-
-    def cache_environment_after_block
-      @env_after_block = clone_environment
-    end
-
-    def delete_keys_that_do_not_belong
-      (keys_to_remove - keys_changed_by_block).each { |key| @env.delete(key) }
-    end
-
-    def revert_changed_keys
-      (@original_env.keys - keys_changed_by_block).each do |key|
-        @env[key] = @original_env[key]
-      end
-    end
-
-    def clone_environment
-      @env.to_hash
-    end
-
-    def stringify_keys(env)
-      env.each_with_object({}) do |(key, value), hash|
-        hash[key.to_s] = value
-      end
-    end
-
-    class OverlappingKeysWithChangedValues
-      def initialize(hash_1, hash_2)
-        @hash_1 = hash_1 || {}
-        @hash_2 = hash_2
-      end
-
-      def keys
-        overlapping_keys.select do |overlapping_key|
-          @hash_1[overlapping_key] != @hash_2[overlapping_key]
-        end
-      end
-
-      private
-
-      def overlapping_keys
-        @hash_2.keys & @hash_1.keys
-      end
-    end
-  end
-end