climate_control 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac4a1d4fe272e5369855d9d80c8bfd764b752f27d1bdfad2b19a607d5f0a44e
-  data.tar.gz: 8945986d5956f681810ef8a5f164323a3cd2a48e82368618c292f3c6fc7a6caa
+  metadata.gz: 919bb6d645214941bca1f5de4d30732891348bb76a29725e9db8ba00b6274dbc
+  data.tar.gz: 332e9222519c1c6a91d866783d4c3993c4372ffe29242f60759cf9948636d3ff
 SHA512:
-  metadata.gz: c36a6b4ead29b23f93c95457e56f6bc3fd6c5cd596f66fe8243e736edcc5a11cfe9fd5fe62b1cf5fc8cd0c7f4fe72c051c0560338a6496e30c56b3cf095c92ec
-  data.tar.gz: cbdf93ff0a149ef67129db0ac0f25838f02c7d2faf6dea87f8ce0acaf54848fb129f4d1b8cbf0ad40c50358cd2186e5a726b2fed5d82fbc9de2c765f4a9bf94d
+  metadata.gz: 1c5c9c97dcef22aa4923d284f196addeb1ddeb2f87c80785fd5d8a38e3f23ea7e66e11acbe265e225bf3663d36dbe500edc981d5baaf53cc872a19670dfa1878
+  data.tar.gz: c56fb5c40969ed979a485503765b33f7f4adc2d34830309502a2207dad363f4c9a0b04c5dda5cb4c56c001e80c317954a8d19b0b21fce53aa0fd84962d33c091

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

@@ -48,7 +48,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 +105,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

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.1.0".freeze
 end

data/lib/climate_control.rb

@@ -1,16 +1,44 @@
-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
 
-  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
+      middle = {}
+      copy environment_overrides
+      middle = ENV.to_hash
+      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 env
+    ENV
+  end
+
+  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

@@ -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,7 @@ 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)
+  def with_modified_env(options = {}, &block)
     ClimateControl.modify(options, &block)
   end
 

metadata

@@ -1,91 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: climate_control
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Joshua Clayton
+- Dorian Marié
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2022-05-26 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/spec_helper.rb
@@ -108,7 +109,7 @@ 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

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