climate_control 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21d2f4ce1d74f8b2e4650cd7ab4efd3d40dac9d6
-  data.tar.gz: d14c7f5bc3b4ae309682f529c0ada07a9a874d9b
+SHA256:
+  metadata.gz: 919bb6d645214941bca1f5de4d30732891348bb76a29725e9db8ba00b6274dbc
+  data.tar.gz: 332e9222519c1c6a91d866783d4c3993c4372ffe29242f60759cf9948636d3ff
 SHA512:
-  metadata.gz: 1c533460213a9e6a4285c3daa7fade227a4a5a5e4eb9a23e41d6bb06362c60468739476dd916be6b9ec3447b3e155dc1594e0fd89597ae58935acef27b850940
-  data.tar.gz: 1a9aefaad845f0cdcb147b77cd176e81c0004d28fa17979aab312d27fe1e5251653902bc6fe05581ccd1ecab49075f122b7d029953c708af350e6ad0809f575d
+  metadata.gz: 1c5c9c97dcef22aa4923d284f196addeb1ddeb2f87c80785fd5d8a38e3f23ea7e66e11acbe265e225bf3663d36dbe500edc981d5baaf53cc872a19670dfa1878
+  data.tar.gz: c56fb5c40969ed979a485503765b33f7f4adc2d34830309502a2207dad363f4c9a0b04c5dda5cb4c56c001e80c317954a8d19b0b21fce53aa0fd84962d33c091

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on: [pull_request]
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.1, '3.0', 2.7, 2.6, 2.5]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake
+      - name: Run StandardRB
+        run: bundle exec standardrb

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,6 @@
+# Code of Conduct
+
+By participating in this project, you agree to abide by the
+[thoughtbot code of conduct][1].
+
+[1]: https://thoughtbot.com/open-source-code-of-conduct

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Joshua Clayton and thoughtbot, inc.
+Copyright (c) 2012-2021 Joshua Clayton and thoughtbot, inc.
 
 MIT License
 

data/README.md

@@ -24,15 +24,31 @@ within a block:
 ```ruby
 ClimateControl.modify CONFIRMATION_INSTRUCTIONS_BCC: 'confirmation_bcc@example.com' do
   sign_up_as 'john@example.com'
+
   confirm_account_for_email 'john@example.com'
-  current_email.should bcc_to('confirmation_bcc@example.com')
+
+  expect(current_email).to bcc_to('confirmation_bcc@example.com')
+end
+```
+
+To modify multiple environment variables:
+
+```ruby
+ClimateControl.modify CONFIRMATION_INSTRUCTIONS_BCC: 'confirmation_bcc@example.com',
+                      MAIL_FROM: 'us@example.com' do
+  sign_up_as 'john@example.com'
+
+  confirm_account_for_email 'john@example.com'
+
+  expect(current_email).to bcc_to('confirmation_bcc@example.com')
+  expect(current_email).to be_from('us@example.com')
 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
 ```
@@ -89,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
@@ -97,6 +146,8 @@ block, ensuring values are managed properly and consistently.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+This project uses [StandardRB](https://github.com/testdouble/standard) to ensure formatting.
+
 ## License
 
-climate_control is copyright 2012-2017 Joshua Clayton and thoughtbot, inc. It is free software and may be redistributed under the terms specified in the [LICENSE.txt](https://github.com/thoughtbot/climate_control/blob/master/LICENSE.txt) file.
+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.

data/climate_control.gemspec

@@ -1,23 +1,25 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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.description   = %q{Modify your ENV}
-  gem.summary       = %q{Modify your ENV easily with ClimateControl}
-  gem.homepage      = "https://github.com/thoughtbot/climate_control"
-  gem.license       = "MIT"
+  gem.name = "climate_control"
+  gem.version = ClimateControl::VERSION
+  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"
+  gem.license = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rspec", "~> 3.1.0"
-  gem.add_development_dependency "rake", "~> 10.3.2"
-  gem.add_development_dependency "simplecov", "~> 0.9.1"
+  gem.required_ruby_version = ">= 2.5.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 = "0.2.0".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

@@ -1,5 +1,7 @@
 require "spec_helper"
 
+Thing = Class.new
+
 describe "Climate control" do
   it "allows modification of the environment" do
     block_run = false
@@ -87,22 +89,22 @@ describe "Climate control" do
     # 0.25s passes
     # [other_thread] thread resolves, FOO is removed, BAZ is copied back to ENV
 
-    thread_removing_env = Thread.new do
+    thread_removing_env = Thread.new {
       with_modified_env BAZ: "buzz" do
         sleep 0.5
       end
 
       expect(ENV["BAZ"]).to be_nil
-    end
+    }
 
-    other_thread = Thread.new do
+    other_thread = Thread.new {
       sleep 0.25
       with_modified_env FOO: "bar" do
         sleep 0.5
       end
 
       expect(ENV["FOO"]).to be_nil
-    end
+    }
 
     thread_removing_env.join
     other_thread.join
@@ -111,12 +113,45 @@ 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") do
+    ret = with_modified_env(FOO: "foo") {
       with_modified_env(BAR: "bar") do
         "bar"
       end
-    end
+    }
 
     expect(ret).to eq("bar")
 
@@ -125,15 +160,14 @@ describe "Climate control" do
   end
 
   it "raises when the value cannot be assigned properly" do
-    Thing = Class.new
     message = generate_type_error_for_object(Thing.new)
 
-    expect do
+    expect {
       with_modified_env(FOO: Thing.new)
-    end.to raise_error ClimateControl::UnassignableValueError, /attempted to assign .*Thing.* to FOO but failed \(#{message}\)$/
+    }.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
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 begin
-  require 'simplecov'
+  require "simplecov"
   SimpleCov.start
 rescue LoadError
   warn "warning: simplecov gem not found; skipping coverage"

metadata

@@ -1,76 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: climate_control
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joshua Clayton
-autorequire: 
+- Dorian Marié
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-12 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.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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"
-- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
-- NEWS
+- LICENSE
 - 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
@@ -78,7 +94,7 @@ homepage: https://github.com/thoughtbot/climate_control
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,16 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.13
+signing_key:
 specification_version: 4
 summary: Modify your ENV easily with ClimateControl
 test_files:

data/.travis.yml

@@ -1,11 +0,0 @@
-rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-before_install:
-  - gem update --system
-  - gem update bundler
-install: "bundle install"
-branches:
-  only:
-    - master

data/NEWS

@@ -1,13 +0,0 @@
-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,36 +0,0 @@
-require "thread"
-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
-        begin
-          @owner = Thread.current
-          yield if block_given?
-        ensure
-          @owner = nil
-        end
-      end
-    end
-
-    private
-
-    def env
-      ENV
-    end
-  end
-end

data/lib/climate_control/modifier.rb

@@ -1,96 +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
-        begin
-          prepare_environment_for_block
-          run_block
-        ensure
-          cache_environment_after_block
-          delete_keys_that_do_not_belong
-          revert_changed_keys
-        end
-      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|
-        begin
-          @env[key] = value
-        rescue TypeError => e
-          raise UnassignableValueError,
-            "attempted to assign #{value} to #{key} but failed (#{e.message})"
-        end
-      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