climate_control 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1052215413e209a2ce0531a9b293d56f51df36db70688af69ae15e70571a043d
-  data.tar.gz: ed855bfdddc57fc46532edc296d9a8de6a2a3653f5b148ab10849433aeb61026
+  metadata.gz: '00584062039c6b9161ff0e4a1b61ca51e4d8742225fc611180c4effcc43959c5'
+  data.tar.gz: 99135f45c57f58d87e17480896045c00eecebd632ed64eaf18bd1964ef7d454d
 SHA512:
-  metadata.gz: e292d7055db48aaa3cf664f447c6826d3ccf59cc1142dc71a89e8b8e97dbac26d553ebd2912a1f8b2a15b3f75b71de5f3345244cc0cb2f4dd8970f47b73b12c1
-  data.tar.gz: 96f9e0f2e8193c29d708f94c1cdced3d7a1b305ae0cb781729895b838be70233a0082f767f840a5d943e5b206cc55539606de156e4b301bab787e29ab45507b4
+  metadata.gz: 01ba4ad3241cea796d408f0adb02f8c23b85771d1ce8338eedf973b95228a7cac9978218f08921915918c90a0f8f292dbb38f9401ca29de8d7a6ef3dc76d99b5
+  data.tar.gz: 9b20ce4affbcf22b6204016d31b7b54465ad5ba2a143fd2e6578d3dc5d4c80ac167c02c9ccc47d91c2a62441c5ce3037ebb13c445407876c163edaba73eb484d

data/CHANGELOG.md

@@ -5,7 +5,15 @@ 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).
 
-## Unreleased
+## 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
 

data/lib/climate_control/version.rb

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

data/lib/climate_control.rb

@@ -4,6 +4,7 @@ require "monitor"
 
 module ClimateControl
   extend self
+  extend Gem::Deprecate
 
   SEMAPHORE = Monitor.new
   private_constant :SEMAPHORE
@@ -31,10 +32,33 @@ module ClimateControl
     end
   end
 
+  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)

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
@@ -182,6 +182,16 @@ describe "Climate control" do
     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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: climate_control
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Joshua Clayton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-28 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -89,6 +89,7 @@ files:
 - lib/climate_control/errors.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:
@@ -115,4 +116,5 @@ 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