env.rb 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,69 @@
+# Env.rb
+Managing your ENVironment
+
+## Purpose
+Many modern web applications consume and post to resources that reside at other urls, often requiring
+more authentication tokens than a database password.  These passwords need to be stored in some
+location.  A common, secure location that exists outside of the source directory  is in the 
+application's runtime environment.  
+
+However, consuming a resource at a url can take up to three different variables to represent
+the location, username, and password.  If your app is consuming many endpoints the sheer
+number of variables can become overwhelming.  Remember, the average short-term memory holds
+about 7 items.  Certain production applications can have upwards of 50 to 100 ENV vars.
+
+Env.rb allows you to declare environment variables like dependencies and configure multiple 
+environments with a simple ruby DSL.  It provides tools for cleaning up existing apps, exporting
+your Envfile to a shell-compatible format, and executing scripts within your environments.
+
+## Examples
+
+### Declaring Dependecies
+
+    export "PROVIDER_PASSWORD", '1234', :group => :development, :required => false
+
+    group :development do
+      export "SERVICE_URL", 'http://username:password@www.service.com/path"
+    end
+
+    group :test do
+      export "SERVICE_URL", 'http://username:password@example.com/"
+    end
+
+### In your Ruby files
+
+    require 'env'
+
+    Env.load('../path_to_file')  
+    Env.load!                     # look for Envfile
+
+    ENV['HELLO_WORLD']            # => nil
+    Env.enforce
+    ENV['HELLO_WORLD']
+    # => EnvironmentError: HELLO_WORLD is not a declared environment dependency
+
+    ENV['TEST'] = 'overriding' 
+    # => EnvironmentError: TEST is not a declared environment dependency
+
+    Env.eval do
+      export 'TEXT', '15', :immutable => true
+      # same as export 'TEXT', '15', :mutable => false
+    end
+
+    ENV['TEST'] = 'overriding' 
+    # => EnvironmentError: variable TEST cannot be changed
+
+## Built-in support for URIs
+
+### in Envfile
+    export "SERVICE",     'http://username:password@example.com/"
+
+### in your Ruby Script 
+    ENV['SERVICE']             #=> 'http://username:password@example.com/"
+    ENV['SERVICE'].base_uri    #=> 'http://example.com/"
+    ENV['SERVICE'].url         #=> 'http://example.com/"
+    ENV['SERVICE'].user        #=> 'username'
+    ENV['SERVICE'].password    #=> 'password'
+    ENV['SERVICE'].host        #=> 'example.com'
+    ENV['SERVICE'].scheme      #=> 'http'
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+desc "start a console"
+task :console do
+  require 'irb'
+  require_relative 'lib/env'
+  ARGV.clear
+  IRB.start
+end

data/env.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "env/version"
+
+Gem::Specification.new do |s|
+  s.name        = "env.rb"
+  s.version     = Env::VERSION
+  s.authors     = ["Chris Continanza"]
+  s.email       = ["christopher.continanza@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Manage your ENV with ease}
+  s.description = %q{Allows your to manage many ENV vars by declaring them as dependencies on ENV vars and then enforcing those dependencies.  Supports wrapping URIs with support methods.}
+
+  s.rubyforge_project = "env.rb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/env.rb

@@ -0,0 +1,87 @@
+require "env/version"
+require 'uri'
+require 'forwardable'
+
+class EnvironmentError < StandardError
+end
+
+module Env
+  @@dependencies = []
+  @@env          = {}
+  @@enforced     = false
+
+  class << self
+    def [](key)
+      _raise(key) unless dependencies.include? key 
+      @@env[key]
+    end
+
+    def []=(key,value)
+      _raise(key) unless dependencies.include? key 
+      @@env[key] = uri?(value) ? proxify(value) : value
+    end
+
+    def export(key, value = nil)
+      @@dependencies << key
+      @@env[key] = uri?(value) ? proxify(value) : value
+    end
+
+    def load!
+      @@enforced or Env.enforce
+      eval File.read("Envfile") if File.exist?("Envfile")
+      File.exist?("Envfile")
+    end
+
+    def enforce
+      class << ENV
+        alias_method :get, :[]  
+        alias_method :set, :[]= 
+
+        def [](key)
+          Env[key]
+        end
+
+        def []=(key, value)
+          Env[key] = value
+        end
+      end
+      @@enforced = true
+    end
+
+    private 
+    def _raise(key)
+      raise EnvironmentError, "#{key} is not a declared depency, add it to your Envfile"
+    end
+
+    def uri?(value)
+      value.to_s.match(/^\w+:\/\//)
+    end
+
+    def proxify(value)
+      UriProxy.new(value)
+    end
+
+    def dependencies
+      @@dependencies
+    end
+  end
+
+  class UriProxy < BasicObject
+    extend ::Forwardable
+    def_delegators :@uri, :scheme, :user, :password, :host
+
+    def initialize(uri)
+      @original = uri
+      @uri = ::URI.parse(uri)
+    end
+
+    def base_uri
+      "#{@uri.scheme}://#{@uri.host}"
+    end
+    alias url base_uri
+
+    def method_missing(method, *args, &block)
+      @original.send(method, *args, &block) 
+    end
+  end
+end

data/lib/env/version.rb

@@ -0,0 +1,3 @@
+module Env
+  VERSION = "0.0.1"
+end

data/spec/enforce_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../lib/env'
+
+describe Env, "::enforce" do
+  before { Env.enforce }
+
+  it "should not allow references to undeclared variables" do
+    lambda { ENV['UNDECLARED_VARIABLE'] }.should raise_error(EnvironmentError)
+  end 
+
+  context "with uninitialized dependency FOO" do
+    before do 
+      Env.instance_eval do
+        export 'FOO'
+      end
+    end
+
+    it "should return nil for ENV['FOO']" do
+      ENV['FOO'].should eql(nil)
+    end
+
+    it "should allow you to set it" do
+      ENV['FOO'] = 'bar'
+      ENV['FOO'].should eql('bar')
+    end
+  end
+
+  context "with initialized dependency FOO=bar" do
+    before do 
+      Env.instance_eval do
+        export 'FOO', 'bar'
+      end
+    end
+
+    it "should return 'bar' for ENV['FOO']" do
+      ENV['FOO'].should eql('bar')
+    end
+  end
+end

data/spec/load_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../lib/env'
+
+describe Env, '::load!' do
+  def envfile(string)
+    File.open("Envfile", 'w') do |f|
+      f << string
+    end
+  end
+
+  it "should return false" do
+    Env.load!.should be_false
+  end
+
+  context "with a simple Envfile" do
+    before do
+      envfile(%{
+        export 'FOO', 'bar'
+      })
+    end
+
+    after { File.unlink('Envfile') }
+
+    it "should return true" do
+      Env.load!.should be_true
+    end
+
+    it "should load Envfile in this directory" do
+      Env.load!
+      Env.enforce
+      ENV['FOO'].should == 'bar'
+    end 
+  end
+end

data/spec/uri_spec.rb

@@ -0,0 +1,52 @@
+require_relative '../lib/env'
+
+describe Env, 'uri support' do
+  context "with a value FOO that is not a URI" do
+    before do
+      Env.instance_eval do
+        export 'FOO', 'bar'
+      end
+      Env.enforce
+    end
+
+    it "should not wrap it" do
+      lambda { ENV['FOO'].scheme }.should raise_error(::NoMethodError)
+    end
+  end
+
+  context "with a value FOO that is a URI" do
+    URL = 'http://username:password@this.domain.example.com/path?var=val'
+
+    before do
+      Env.instance_eval do
+        export 'FOO', URL
+      end
+      Env.enforce
+    end
+
+    it "should leave the original value unchanged" do
+      ENV['FOO'].should == URL
+    end
+
+    it "should return scheme://host for #base_uri and #url" do
+      ENV['FOO'].base_uri.should == 'http://this.domain.example.com'
+      ENV['FOO'].url.should == 'http://this.domain.example.com'
+    end
+
+    it "should respond to #scheme with the scheme'" do
+      ENV['FOO'].scheme.should == 'http'
+    end
+
+    it "should respond to #host with the host" do
+      ENV['FOO'].host.should == 'this.domain.example.com'
+    end
+
+    it "should respond to #password with the password" do
+      ENV['FOO'].password.should == 'password'
+    end
+
+    it "should respond to #user with the user" do
+      ENV['FOO'].user.should == 'username'
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: env.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Continanza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-04 00:00:00.000000000 -07:00
+default_executable: 
+dependencies: []
+description: Allows your to manage many ENV vars by declaring them as dependencies
+  on ENV vars and then enforcing those dependencies.  Supports wrapping URIs with
+  support methods.
+email:
+- christopher.continanza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- env.gemspec
+- lib/env.rb
+- lib/env/version.rb
+- spec/enforce_spec.rb
+- spec/load_spec.rb
+- spec/uri_spec.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+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: env.rb
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Manage your ENV with ease
+test_files:
+- spec/enforce_spec.rb
+- spec/load_spec.rb
+- spec/uri_spec.rb