smart_env 0.0.1 → 2.0.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage

data/Gemfile

@@ -1,7 +1,6 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in env.gemspec
+source :gemcutter
 gemspec
 
-gem 'ruby-debug19'
-gem 'rspec'
+group :development do
+  gem 'ruby-debug19', :platform => :mri_19
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2010 Blake Mizerany, Keith Rarick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -1,17 +1,55 @@
 # SmartEnv
 
+    gem install smart_env
+  
+    require 'smart_env'
+
 ## Purpose
 Attach hooks to your ENV vars and wrap them in Proxy Objects.
 
-## Example
+## Example with built-in URI Proxy
+    ENV.use(SmartEnv::UriProxy)
+
     ENV['SERVICE'] = 'http://username:password@example.com:3000/"
 
     ENV['SERVICE']             #=> 'http://username:password@example.com:3000/"
-    ENV['SERVICE'].base_uri    #=> 'http://example.com/"
-    ENV['SERVICE'].url         #=> 'http://example.com/"
+    ENV['SERVICE'].base_uri    #=> 'http://example.com:3000"
     ENV['SERVICE'].user        #=> 'username'
     ENV['SERVICE'].password    #=> 'password'
     ENV['SERVICE'].host        #=> 'example.com'
     ENV['SERVICE'].scheme      #=> 'http'
     ENV['SERVICE'].port        #=> 3000
 
+## Add your own Proxies
+
+### With a block
+    class TestProxy
+      def initialize(key, value)
+      end
+    end
+
+    ENV.use(TestProxy).when { |key, value| key == 'FOO' }
+
+    ENV['FOO'] = 'bar'
+    ENV['FOO'].class           #=> TestProxy
+
+### Or by implementing ::when
+
+    class TestProxy
+      def initialize(key, value)
+      end
+      
+      def self.when(key, value)
+        key == 'FOO'
+      end
+    end
+    ENV.use(TestProxy)
+
+    ENV['FOO'] = 'bar'
+    ENV['FOO'].class           #=> TestProxy
+## License
+
+SmartENV distributed under the terms of the MIT License. See [LICENSE][] for details.
+
+[LICENSE]: /csquared/smart_env/blob/master/LICENSE
+

data/Rakefile

@@ -1 +1,21 @@
+require 'bundler'
+Bundler.require
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/lib/smart_env/auto.rb

@@ -0,0 +1,3 @@
+require 'smart_env'
+
+ENV.extend SmartEnv

data/lib/smart_env/uri_proxy.rb

@@ -1,21 +1,35 @@
 require 'uri'
+require 'cgi'
 require 'forwardable'
 
+class BasicObject
+  instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
+end unless defined?(BasicObject)
+
 module SmartEnv
   class UriProxy < BasicObject
+    attr_reader :params
     extend ::Forwardable
     def_delegators :@uri, *(::URI::Generic::COMPONENT + [:user, :password])
 
-    def initialize(uri)
+    def initialize(_key, uri)
       @original = uri
       @uri = ::URI.parse(uri)
+      @params = ::CGI.parse(@uri.query.to_s)
+      @params.each do |key, values|
+        @params[key] = values.first if values.size == 1
+      end
+    end
+
+    #for SmartEnv
+    def self.when(key, value)
+      value.match(/^\w+:\/\//) 
     end
 
-    def base_uri
+    def base_uri(port = true)
       base = "#{@uri.scheme}://#{@uri.host}"
-      (@uri.port ? "#{base}:#{@uri.port}" : base) + '/'
+      port ? "#{base}:#{@uri.port}" : base
     end
-    alias url base_uri
 
     def method_missing(method, *args, &block)
       @original.send(method, *args, &block) 

data/lib/smart_env/version.rb

@@ -1,3 +1,3 @@
 module SmartEnv
-  VERSION = "0.0.1"
+  VERSION = "2.0.0"
 end

data/lib/smart_env.rb

@@ -2,57 +2,49 @@ require "smart_env/version"
 require "smart_env/uri_proxy"
 
 module SmartEnv
-  extend self
+  attr_accessor :registry
 
-  @@loaded   = false
-  @@registry = []
+  def clear_registry
+    @registry = empty_registry
+  end
 
-  def reset_registry
-    @@registry = [
-      [lambda{ |k,v| v.match(/^\w+:\/\//) }, UriProxy]
-    ]
+  def empty_registry
+    []
   end
 
   def use(klass)
     @class = klass
+    if @class.respond_to? :when
+      registry << [@class, lambda { |k,v| @class.when(k,v)  }]
+    end
     self
   end
 
   def when(&block)
-    raise "Block must take 0 or 2 arguments" unless ( block.arity == 0 || block.arity == 2)
-    @@registry << [block, @class]
+    raise "Block must take 0 or 2 arguments: key and value" unless (block.arity < 1 || block.arity == 2)
+    registry << [@class, block]
     self
   end
 
-  def [](key)
-    value = ENV.get(key)
-    @@registry.each do |condition, klass|
-      result = condition.call(key, value) rescue false
-      return klass.new(value) if result
-    end
-    value
+  def registry
+    @registry ||= empty_registry
   end
 
-  def unload!
-    class << ENV
-      alias_method :[], :get  
-      alias_method :[]=, :set
-    end
-    @@loaded = false
-  end
+  def self.extended(base)
+    raise RuntimeError.new("#{base.inspect} doesn't respond to #[]") \
+      unless base.respond_to? :[]
 
-  def load!
-    reset_registry
-    return if @@loaded
-    class << ENV
-      alias_method :get, :[]  
+    class << base
+      alias_method :__get, :[]  
 
       def [](key)
-        SmartEnv[key]
+        value = __get(key)
+        registry.each do |klass, condition|
+          result = condition.call(key, value) rescue false
+          value  = klass.new(key, value) if value && result
+        end
+        value
       end
     end
-    @@loaded = true
   end
 end
-
-SmartEnv.load!

data/smart_env.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |s|
   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"]
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'rcov'
 end

data/spec/decoration_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe SmartEnv, 'decoration' do
+  before do
+    class PassOne < String
+      attr_accessor :one
+      def initialize(key, value)
+        @one = true
+        super(value)
+      end
+    end
+
+    class PassTwo < PassOne
+      attr_accessor :two
+      def initialize(key, value)
+        @two = true
+        super
+      end
+    end
+
+    ENV.use(PassOne).when{ true }
+    ENV.use(PassTwo).when{ true }
+  end
+
+  it "should pass successive value to all callbacks that match" do
+    ENV['FOO'] = "bar"
+    ENV['FOO'].one.should be_true
+    ENV['FOO'].two.should be_true
+  end
+end

data/spec/load_unload_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SmartEnv, 'load/unload' do 
+  before do
+    class PassOne < String
+      attr_accessor :one
+      def initialize(key, value)
+        @one = true
+        super(value)
+      end
+    end
+
+    @env = {} 
+  end
+
+  context "on extend" do
+    before do
+      @env.extend SmartEnv
+    end
+
+    after do
+      @env.clear_registry if @env
+    end
+
+    it "should not bleed" do
+      ENV['FOO'] = 'bar'
+      @env['FOO'] = 'bar'
+      @env.use(PassOne).when{ true }
+
+      ENV['FOO'].should_not respond_to :one
+      @env['FOO'].one.should be_true
+    end
+  end
+
+  context "::clear_registry" do
+    before do
+      @env.extend SmartEnv
+      @env.use(PassOne).when{ true }
+    end
+
+    it "should clear the hooks" do
+      @env.clear_registry
+      @env['FOO'].should_not respond_to :one
+    end 
+  end
+end

data/spec/registry_spec.rb

@@ -1,25 +1,49 @@
 require 'spec_helper'
+shared_examples_for "all proxies" do
 
-describe SmartEnv, 'registering your own Proxies' do
-  before do
-    class TestProxy
-      def initialize(value)
-      end
-    end
-    SmartEnv.use(TestProxy).when { |key, value| key == 'FOO' }
-  end
-
-  it "should use the specified proxy when the block returns true" do
+  it "should use the specified proxy when the block or when returns true" do
     ENV['FOO'] = 'bar'
     ENV['FOO'].should be_a(TestProxy)
     ENV['BAR'] = 'bar'
     ENV['BAR'].should == 'bar'
     ENV['BAR'].should be_a(String)
   end
+end
+
+describe SmartEnv, 'registering your own Proxies' do
+  context 'with a bloack' do
+    before do
+      class TestProxy
+        def initialize(key, value)
+        end
+      end
+      ENV.use(TestProxy).when { |key, value| key == 'FOO' }
+    end
 
-  it "raises error if the block doens't have two args" do
-    lambda { SmartEnv.use(TestProxy).when { |k,v,x| name == 'FOO' } }.should raise_error
-    lambda { SmartEnv.use(TestProxy).when { |value| name == 'FOO' } }.should raise_error
-    lambda { SmartEnv.use(TestProxy).when { false } }.should_not raise_error
+    it_should_behave_like "all proxies"
+
+    it "raises error if the block doens't have two args" do
+      lambda { ENV.use(TestProxy).when { |k,v,x| name == 'FOO' } }.should raise_error
+      lambda { ENV.use(TestProxy).when { |value| name == 'FOO' } }.should raise_error
+      lambda { ENV.use(TestProxy).when { false } }.should_not raise_error
+    end
+  end
+
+  context 'with a class that implements ::when' do
+    before do
+      class TestProxy
+        def initialize(key, value)
+        end
+        
+        def self.when(key, value)
+          key == 'FOO'
+        end
+      end
+      ENV.use(TestProxy)
+    end
+
+    it_should_behave_like "all proxies"
   end
 end
+
+

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
-require_relative '../lib/smart_env'
+require File.expand_path('../../lib/smart_env', __FILE__)
+require 'rspec/core'
+require 'smart_env/auto'
 
 RSpec.configure do |config|
-  config.after(:each) { SmartEnv.reset_registry }
+  config.after(:each) do
+    ENV.clear_registry
+  end
 end

data/spec/uri_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe SmartEnv, 'uri support' do
+  before do
+    ENV.use(SmartEnv::UriProxy)
+  end
+
   context "with a value FOO that is not a URI" do
     before do
       ENV['FOO'] = 'bar'
@@ -12,7 +16,6 @@ describe SmartEnv, 'uri support' do
   end
 
   context "with a value FOO that is a URI" do
-
     before do
       @url = 'http://username:password@this.domain.example.com:3000/path?var=val'
       ENV['FOO'] = @url
@@ -22,9 +25,14 @@ describe SmartEnv, 'uri support' 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:3000/'
-      ENV['FOO'].url.should == 'http://this.domain.example.com:3000/'
+    it "should return scheme://host:port for #base_uri" do
+      ENV['FOO'].base_uri.should == 'http://this.domain.example.com:3000'
+      ENV['FOO'] = @url.gsub(':3000','')
+      ENV['FOO'].base_uri.should == 'http://this.domain.example.com:80'
+    end
+
+    it "should return scheme://host for #base_uri(false)" do
+      ENV['FOO'].base_uri(false).should == 'http://this.domain.example.com'
     end
 
     it "should respond to #scheme with the scheme" do
@@ -46,5 +54,9 @@ describe SmartEnv, 'uri support' do
     it "should respond to #port with the port" do
       ENV['FOO'].port.should == 3000
     end
+
+    it "should expose params via the #params method" do
+      ENV['FOO'].params['var'].should == 'val'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_env
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000 -07:00
-default_executable: 
-dependencies: []
+date: 2012-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70268106271400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70268106271400
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70268106270940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70268106270940
 description: Allows you to register Proxy classes for ENV vars by using blocks to
   match keys and values
 email:
@@ -22,16 +43,19 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/smart_env.rb
+- lib/smart_env/auto.rb
 - lib/smart_env/uri_proxy.rb
 - lib/smart_env/version.rb
 - smart_env.gemspec
+- spec/decoration_spec.rb
+- spec/load_unload_spec.rb
 - spec/registry_spec.rb
 - spec/spec_helper.rb
 - spec/uri_spec.rb
-has_rdoc: true
 homepage: ''
 licenses: []
 post_install_message: 
@@ -44,19 +68,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3361827544882758592
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3361827544882758592
 requirements: []
 rubyforge_project: smart_env
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Lazily proxy ENV values
 test_files:
+- spec/decoration_spec.rb
+- spec/load_unload_spec.rb
 - spec/registry_spec.rb
 - spec/spec_helper.rb
 - spec/uri_spec.rb