climate_control 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 115ebcc91a993cd77c6f7d635c98cbcca37e304a
+  data.tar.gz: 99ea065056db3051e559fc120754bad454f5dbf4
+SHA512:
+  metadata.gz: af4aa1f76d2c0056d53f407a71df8a0135354d2b5aa126440c791252252cb02d54a4bb7f278bc320f1959e4985967d8c82e7275e9f81cd2f3893f594656fa08c
+  data.tar.gz: 70320c9af644facb62efbd6710ddf624f41f44ccdcaf92aa1e1156d2f3f7eff5c66c3cf238b6e6194da42225fe4f4995f503d6e6fbffbf009f80c7125566dd15

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+bin
 .bundle
 .config
 .yardoc

data/{.travisci.yml → .travis.yml}

@@ -1,9 +1,10 @@
-language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.5
 before_install:
   - gem update --system
+install: "bundle install"
 branches:
   only:
     - master

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in climate_control.gemspec
 gemspec

data/LICENSE.txt

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

data/NEWS

@@ -1,2 +1,7 @@
+0.0.4 (January 6, 2017)
+  Improved thread safety
+  Handle TypeErrors during assignment
+  Improve documentation
+
 0.0.1 (November 28, 2012)
   Initial release

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-`ClimateControl` can be used to temporarily assign environment variables
+Climate Control can be used to temporarily assign environment variables
 within a block:
 
 ```ruby
@@ -76,6 +76,19 @@ block, except for the overrides. Transparency is crucial because the code
 executed within the block is not for `ClimateControl` to manage or modify. See
 the tests for more detail about the specific behaviors.
 
+## Why Use Climate Control?
+
+By following guidelines regarding environment variables outlined by the
+[twelve-factor app](http://12factor.net/config), testing code in an isolated
+manner becomes more difficult:
+
+* avoiding modifications and testing values, we introduce mystery guests
+* making modifications and testing values, we introduce risk as environment
+  variables represent global state
+
+Climate Control modifies environment variables only within the context of the
+block, ensuring values are managed properly and consistently.
+
 ## Contributing
 
 1. Fork it
@@ -86,4 +99,4 @@ the tests for more detail about the specific behaviors.
 
 ## License
 
-climate_control is copyright 2012 Joshua Clayton and thoughtbot, inc. It is free software and may be redistributed under the terms specified in the LICENSE.txt file.
+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.

data/Rakefile

@@ -1,5 +1,5 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:rspec)
 

data/climate_control.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'climate_control/version'
+require "climate_control/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = 'climate_control'
+  gem.name          = "climate_control"
   gem.version       = ClimateControl::VERSION
-  gem.authors       = ['Joshua Clayton']
-  gem.email         = ['joshua.clayton@gmail.com']
+  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.homepage      = "https://github.com/thoughtbot/climate_control"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
+  gem.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport', '>= 3.0'
-  gem.add_development_dependency 'rspec', '~> 2.11'
-  gem.add_development_dependency 'rake', '~> 0.9.2'
-  gem.add_development_dependency 'simplecov', '~> 0.7.1'
+  gem.add_dependency "activesupport", ">= 3.0"
+  gem.add_development_dependency "rspec", "~> 3.1.0"
+  gem.add_development_dependency "rake", "~> 10.3.2"
+  gem.add_development_dependency "simplecov", "~> 0.9.1"
 end

data/lib/climate_control.rb

@@ -1,8 +1,16 @@
-require 'climate_control/modifier'
-require 'climate_control/version'
+require "climate_control/environment"
+require "climate_control/errors"
+require "climate_control/modifier"
+require "climate_control/version"
 
 module ClimateControl
+  @@env = ClimateControl::Environment.new
+
   def self.modify(environment_overrides, &block)
-    Modifier.new(environment_overrides, &block).process
+    Modifier.new(env, environment_overrides, &block).process
+  end
+
+  def self.env
+    @@env
   end
 end

data/lib/climate_control/environment.rb

@@ -0,0 +1,21 @@
+require "thread"
+require "active_support/core_ext/module/delegation"
+
+module ClimateControl
+  class Environment
+    def initialize
+      @semaphore = Mutex.new
+    end
+
+    delegate :[]=, :to_hash, :[], :delete, to: :env
+    delegate :synchronize, to: :semaphore
+
+    private
+
+    attr_reader :semaphore
+
+    def env
+      ENV
+    end
+  end
+end

data/lib/climate_control/errors.rb

@@ -0,0 +1,3 @@
+module ClimateControl
+  class UnassignableValueError < ArgumentError; end
+end

data/lib/climate_control/modifier.rb

@@ -1,20 +1,23 @@
-require 'active_support/core_ext/hash/keys'
+require "active_support/core_ext/hash/keys"
 
 module ClimateControl
   class Modifier
-    def initialize(environment_overrides = {}, &block)
+    def initialize(env, environment_overrides = {}, &block)
       @environment_overrides = environment_overrides.dup.stringify_keys!
       @block = block
+      @env = env
     end
 
     def process
-      begin
-        prepare_environment_for_block
-        run_block
-      ensure
-        cache_environment_after_block
-        delete_keys_that_do_not_belong
-        revert_changed_keys
+      @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
 
@@ -32,7 +35,12 @@ module ClimateControl
 
     def copy_overrides_to_environment
       @environment_overrides.each do |key, value|
-        ENV[key] = value
+        begin
+          @env[key] = value
+        rescue TypeError => e
+          raise UnassignableValueError,
+            "attempted to assign #{value} to #{key} but failed (#{e.message})"
+        end
       end
     end
 
@@ -49,22 +57,22 @@ module ClimateControl
     end
 
     def delete_keys_that_do_not_belong
-      (keys_to_remove - keys_changed_by_block).each {|key| ENV.delete(key) }
+      (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]
+        @env[key] = @original_env[key]
       end
     end
 
     def clone_environment
-      ENV.to_hash
+      @env.to_hash
     end
 
     class OverlappingKeysWithChangedValues
       def initialize(hash_1, hash_2)
-        @hash_1 = hash_1
+        @hash_1 = hash_1 || {}
         @hash_2 = hash_2
       end
 

data/lib/climate_control/version.rb

@@ -1,3 +1,3 @@
 module ClimateControl
-  VERSION = '0.0.3'
+  VERSION = "0.0.4"
 end

data/spec/acceptance/climate_control_spec.rb

@@ -1,14 +1,149 @@
-require 'spec_helper'
+require "spec_helper"
 
-describe 'Climate control' do
-  it 'allows modification of the environment' do
+describe "Climate control" do
+  it "allows modification of the environment" do
     block_run = false
-    ClimateControl.modify FOO: 'bar' do
-      expect(ENV['FOO']).to eq 'bar'
+    ClimateControl.modify 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
+    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
+
+    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 do
+      with_modified_env BAZ: "buzz" do
+        sleep 0.5
+      end
+
+      expect(ENV["BAZ"]).to be_nil
+    end
+
+    other_thread = Thread.new do
+      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
+
+    expect(ENV["FOO"]).to be_nil
+    expect(ENV["BAZ"]).to be_nil
+  end
+
+  it "raises when the value cannot be assigned properly" do
+    Thing = Class.new
+    message = generate_type_error_for_object(Thing.new)
+
+    expect do
+      with_modified_env(FOO: Thing.new)
+    end.to raise_error ClimateControl::UnassignableValueError, /attempted to assign .*Thing.* to FOO but failed \(#{message}\)$/
+  end
+
+  def with_modified_env(options, &block)
+    ClimateControl.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

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
-require 'simplecov'
-SimpleCov.start
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+  warn "warning: simplecov gem not found; skipping coverage"
+end
 
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
 $LOAD_PATH << File.join(File.dirname(__FILE__))
 
-require 'rubygems'
-require 'rspec'
-require 'climate_control'
-
-Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
+require "rubygems"
+require "rspec"
+require "climate_control"

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: climate_control
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Joshua Clayton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
 description: Modify your ENV
 email:
 - joshua.clayton@gmail.com
@@ -82,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travisci.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - NEWS
@@ -91,37 +82,36 @@ files:
 - 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/lib/climate_control/modifier_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/thoughtbot/climate_control
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.6.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Modify your ENV easily with ClimateControl
 test_files:
 - spec/acceptance/climate_control_spec.rb
-- spec/lib/climate_control/modifier_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/lib/climate_control/modifier_spec.rb

@@ -1,83 +0,0 @@
-require 'spec_helper'
-
-describe ClimateControl::Modifier do
-  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
-
-    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
-
-  def with_modified_env(options, &block)
-    ClimateControl::Modifier.new(options, &block).process
-  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