environs 1.0.1 → 1.1.0

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.2"
   - "1.9.3"
   - "2.0.0"
-  - jruby-18mode # JRuby in 1.8 mode
+  - "2.1.0"
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+notifications:
+  campfire:
+    secure: "GnEk4I+ZRjW8h7x6rtZaI/2BfhErJkeELkbjamg3a4CnRQgAKzQZUNwQL8NH\nfbxmAcVSZfVPF6unw0XMY54pgO0+6Fp6fkypaV4fpDgSJEE+6QsSJxBEPN0w\n0bkXKa7/gsRpPLx6GwkQCqSAQIf+aVB0zTV7m1spMoRE40cXZss="
+    on_success: always
+    on_failure: always

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in environs.gemspec
 gemspec
+
+gem 'coveralls', :require => false

data/README.md

@@ -1,6 +1,11 @@
 # Environs
+[![Code Climate](https://codeclimate.com/repos/51d37914c7f3a376e005daec/badges/df1a7c1a328f0eda6db1/gpa.png)](https://codeclimate.com/repos/51d37914c7f3a376e005daec/feed)
+[![Build Status](https://travis-ci.org/primedia/environs.png)](https://travis-ci.org/primedia/environs)
+[![Coverage Status](https://coveralls.io/repos/primedia/environs/badge.png?branch=dev)](https://coveralls.io/r/primedia/environs?branch=dev)
+[![Dependency Status](https://gemnasium.com/primedia/environs.png)](https://gemnasium.com/primedia/environs)
+[![Gem Version](https://badge.fury.io/rb/environs.png)](http://badge.fury.io/rb/environs)
 
-TODO: Write a gem description
+A simple wrapper around the ENV hash that by default raises an error when value requested is not set.
 
 ## Installation
 
@@ -18,7 +23,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem provides an `Env` class that dynamically retrieves environment variables based on the name of the method called on the `Env` class object. Method names are converted to `SCREAMING_SNAKE_CASE`, e.g. `Env.foo_bar` tries to retrieve `ENV['FOO_BAR']`. If a non-nil value is not returned for the key, then an error is raised. Nil values can be allowed by passing a Hash with the `allow_nil` key set to true.
+
+```ruby
+require 'environs'
+
+ENV['FOO'] = nil
+
+Env.foo
+# => 'MissingEnvVarError "The FOO environment variable is not set."'
+
+Env.foo(allow_nil: true)
+# => nil
+```
 
 ## Contributing
 

data/environs.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 end

data/lib/environs/env.rb

@@ -3,20 +3,22 @@ require 'environs/missing_env_var_error'
 class Env
   class << self
     def method_missing(method, *args, &block)
-        key = method.to_s.upcase
-      if key.match(/\w+/)
-        ENV[key] || key_not_found_response(args.first, key)
-      else
-        super
-      end
+      key = method.to_s.upcase
+      key.match(/\w+/) ? env_key(key, *args) : super
     end
 
-    def key_not_found_response(potential_hash, key)
-      if potential_hash.respond_to?(:fetch) && potential_hash.fetch(:allow_nil)
-        nil
-      else
-        raise MissingEnvVarError, "The #{key} environment variable is not set."
-      end
+    private
+
+    def env_key(key, nil_allowance = {})
+      ENV.fetch(key) { |k| key_not_found(nil_allowance, key) }
+    end
+
+    def key_not_found(nil_allowance, key)
+      nil_allowance[:allow_nil] ? nil : env_var_error(key)
+    end
+
+    def env_var_error(key)
+      raise MissingEnvVarError, "The #{key} environment variable is not set."
     end
   end
 end

data/lib/environs/version.rb

@@ -1,3 +1,3 @@
 module Environs
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/environs/env_spec.rb

@@ -1,4 +1,4 @@
-require 'environs'
+require 'spec_helper'
 
 describe Env, "#foo" do
 
@@ -7,11 +7,16 @@ describe Env, "#foo" do
     Env.foo.should eq 'bar'
   end
 
+  it "converts method name to SCREAMING_SNAKE_CASE for lookup" do
+    ENV['FOO_BAR_BAZ'] = 'bar'
+    Env.foo_bar_baz.should eq 'bar'
+  end
+
   describe "default behavior" do
 
     it "returns an error if no corresponding ENV variable is set" do
-      ENV['FOO'] = nil
-      expect { Env.foo }.to raise_error
+      ENV['FOO_NO_VALUE'] = nil
+      expect { Env.foo_no_value }.to raise_error
     end
 
   end
@@ -19,8 +24,8 @@ describe Env, "#foo" do
   describe "'allow_nil: true' is passed along" do
 
     it "returns nil if no corresponding ENV var is set" do
-      ENV['FOO'] = nil
-      Env.foo(allow_nil: true).should be_nil
+      ENV['FOO_ALLOW_NIL'] = nil
+      Env.foo_allow_nil(:allow_nil => true).should be_nil
     end
 
   end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'environs'

metadata

@@ -1,64 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: environs
 version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  version: 1.0.1
 platform: ruby
 authors:
 - Colin Rymer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-    none: false
-  name: bundler
+        version: '0'
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-    none: false
+        version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rspec
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: A simple wrapper around the ENV hash that by default raises an error
   when value requested is not set.
 email:
@@ -79,6 +79,7 @@ files:
 - lib/environs/missing_env_var_error.rb
 - lib/environs/version.rb
 - spec/environs/env_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/primedia/environs
 licenses:
 - MIT
@@ -87,17 +88,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -107,4 +108,5 @@ summary: A simple wrapper around the ENV hash that by default raises an error wh
   value requested is not set.
 test_files:
 - spec/environs/env_spec.rb
+- spec/spec_helper.rb
 has_rdoc: