strenv 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ea50a7c635563c02fa4d773f5ae03d0a2094051
-  data.tar.gz: 6d3d41c921f2c1884dfbae1ee9ecb9f93a056729
+  metadata.gz: 551902e59c197db790faced972427d5b57c19deb
+  data.tar.gz: d39af32e84d01fe291851af6e6626ef85010ec63
 SHA512:
-  metadata.gz: 4f138db3790030270a6800e904b797b1e3055a10229e23735d2c4f12ed1925be8267288dc7f201c055b1ec0c70a7c1eedf0a0f10fc9fa9d273ed69b1175602bd
-  data.tar.gz: 4695da4923c2042d18a8a8ea8f6e505d07a929ed127557dff2880317bcfefe41b282d1b7232193e697d8db2b66676fa41ad5867d9c19ac0ee7f5350b3da49c73
+  metadata.gz: 3050cea82f79968f5c5c5cf29dcbfcd722dcaee687553331e8838d47fd67808a454a882d763def5a136b39a480506d0e1fdfeffd5aa2e27400600cdab7f88628
+  data.tar.gz: 73f8ae4d7844219957b245ea85eb92e83a03939b2c5a82179208ca20711680f3ddf89c49edc404e4a34a4fac7597bcf1e250ce29f12a3c2dc7fa204526751cb6

data/lib/strenv.rb

@@ -2,7 +2,7 @@
 # often go together. We avoid an extra item in the namespace
 # and an extra assignment.
 module STRICT_ENV
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   MalformedKey = Class.new(RuntimeError)
   MissingVariable = Class.new(RuntimeError)
   
@@ -16,7 +16,19 @@ module STRICT_ENV
     ENV[key]
   end
   
-  # Run a block protecting the contents of the environment variables
+  # Run a block protecting the contents of the environment variables. This is especially useful for
+  # tests/specs that excercise methods that depend on environment variable state.
+  # Use this as a wrapper block in "around" aspects. For example, for RSpec:
+  #
+  #   RSpec.configure do |c|
+  #     c.around(:each) do |example|
+  #       STRICT_ENV.with_protected_env { example.run }
+  #     end
+  #   end
+  # 
+  # Note that this may play up with your editor features if it mutates environment variables
+  # based on the position in the script and it runs in the same environment as your objects
+  # under test (TextMate does this).
   def with_protected_env(&blk)
     preserved = ENV.to_h.dup
     yield

data/spec/strenv_spec.rb

@@ -6,7 +6,24 @@ describe "STRICT_ENV" do
     expect(is_defined).to eq('constant')
   end
   
-  context 'STRICT_ENV#[]' do
+  context 'STRICT_ENV.with_protected_env' do
+    it 'protects the ENV hash from modification' do
+      old_envars = ENV.to_h.dup
+      STRICT_ENV.with_protected_env do
+        old_envars.each_pair do |key, _|
+          r = "garbled-#{SecureRandom.hex(64)}"
+          ENV[key] = r # HAVOC!
+          expect(ENV[key]).to eq(r)
+        end
+      end
+      
+      ENV.each_pair do | k, v|
+        expect(v).not_to match(/^garbled\-/), "#{k} should have been restored"
+      end
+    end
+  end
+  
+  context 'STRICT_ENV[]' do
     it 'proxies calls to [] to ENV' do
       ENV.keys.each do | key |
         expect(STRICT_ENV[key]).to eq(ENV[key])

data/strenv.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "strenv"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2014-07-14"
+  s.date = "2014-07-15"
   s.description = "Creates a STRICT_ENV constant that you can query for environment variables and get meaningful exceptions"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strenv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec