env.rb 0.0.4 → 0.0.5

data/README.md

@@ -20,9 +20,30 @@ your Envfile to a shell-compatible format, and executing scripts within your env
 
 ## Examples
 
-### Declaring Dependecies
+### Explictly declaring your environment
 
-    export "PROVIDER_PASSWORD", '1234', :group => :development, :required => false
+#### Envfile
+    import 'TEST'
+    export 'TEXT', '15'
+
+#### Use
+
+    require 'env'
+
+    ENV['HELLO_WORLD']            # => nil
+    ENV['TEST'] = 5
+    Env.load!                     # look for Envfile
+
+    ENV['HELLO_WORLD']
+    # => EnvironmentError: HELLO_WORLD is not a declared dependency
+
+    ENV['TEST']  # => 5 
+    ENV['TEXT']  # => 15 
+    
+### Groups
+#### Envfile
+
+    export "PROVIDER_PASSWORD", '1234', :group => :development
 
     group :development do
       export "SERVICE_URL", 'http://username:password@www.service.com/path"
@@ -32,35 +53,36 @@ your Envfile to a shell-compatible format, and executing scripts within your env
       export "SERVICE_URL", 'http://username:password@example.com/"
     end
 
-### In your Ruby files
+#### Use
+    Env.load!                     
+     -same as-
+    Env.load! :default
 
-    require 'env'
+    Env.load! :default, :test
+    ENV['SERVICE_URL']    # => 'http://username:password@example.com/"
 
-    Env.load('../path_to_file')  
-    Env.load!                     # look for Envfile
+    Env.load! :development
+    ENV['SERVICE_URL']    # => 'http://username:password@www.service.com/path"
 
-    ENV['HELLO_WORLD']            # => nil
-    Env.enforce
-    ENV['HELLO_WORLD']
-    # => EnvironmentError: HELLO_WORLD is not a declared dependency
+### Mutability
 
-    ENV['TEST'] = 'overriding' 
-    # => EnvironmentError: TEST is not a declared dependency
+#### Envfile
+    export 'TEXT', '15', :mutable => false
+    export 'TEXT', '15', :immutable => false
 
-    Env.instance_eval do
-      export 'TEXT', '15'
-      # same as export 'TEXT', '15', :mutable => false
-    end
+#### Use
+
+    ENV['TEST']  # => 15 
 
     ENV['TEST'] = 'overriding' 
     # => EnvironmentError: variable TEST cannot be changed
 
 ## Built-in support for URIs
 
-### in Envfile
+### Envfile
     export "SERVICE",     'http://username:password@example.com/"
 
-### in your Ruby Script 
+### Use
     ENV['SERVICE']             #=> 'http://username:password@example.com/"
     ENV['SERVICE'].base_uri    #=> 'http://example.com/"
     ENV['SERVICE'].url         #=> 'http://example.com/"

data/lib/env/version.rb

@@ -1,3 +1,3 @@
 module Env
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/env.rb

@@ -17,6 +17,7 @@ module Env
       @@enforced      = false
       @@groups        = Hash.new { |hash, key| hash[key] = [] }
       @@default_group = :default
+      @@callback      = nil
     end
 
     def [](key)
@@ -63,7 +64,8 @@ module Env
       end
     end
 
-    def load!(*groups)
+    def load!(*groups, &block)
+      @@callback = block if block_given? 
       @@enforced or Env.enforce
       eval File.read("Envfile") if File.exist?("Envfile")
       groups = [:default] if groups.empty?
@@ -102,6 +104,7 @@ module Env
 
     private 
     def _raise(key)
+      return @@callback.call(key) if @@callback
       raise EnvironmentError, "#{key} is not a declared dependency, add it to your Envfile"
     end
 

data/spec/import_spec.rb

@@ -50,7 +50,7 @@ describe Env, '::import' do
       Env.load!
     end
 
-    it "should import TMP, TEMP, and RACK" do
+    it "should import TMP, TEMP, and :rack" do
       heroku.each do |var|
         lambda { ENV[var] }.should_not raise_error
       end

data/spec/load_spec.rb

@@ -28,4 +28,23 @@ describe Env, '::load!' do
       ENV['FOO'].should == 'bar'
     end 
   end
+
+  context "when passed a block" do
+    before do
+      envfile("")
+      @name = nil
+      Env.load! { |name| @name = name }
+    end
+
+    it "should not raise and error by default" do
+      lambda { ENV['FOO'] }.should_not raise_error
+    end
+
+    it "should pass the undeclared depencdies's key to the block" do
+      ENV['FOO']
+      @name.should == 'FOO'
+      ENV['bar']
+      @name.should == 'bar'
+    end
+  end
 end

data/spec/uri_spec.rb

@@ -33,7 +33,7 @@ describe Env, 'uri support' do
       ENV['FOO'].url.should == 'http://this.domain.example.com'
     end
 
-    it "should respond to #scheme with the scheme'" do
+    it "should respond to #scheme with the scheme" do
       ENV['FOO'].scheme.should == 'http'
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 -07:00
+date: 2011-08-19 00:00:00.000000000 -07:00
 default_executable: 
 dependencies: []
 description: Allows your to manage many ENV vars by declaring them as dependencies