env_bang 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 220e4f75a1ec92e0ce04098d70ef4e163af873cf
-  data.tar.gz: e919ad22b321abf7936a2eb1f00d81d51d2078f5
+  metadata.gz: f61fe363d185a95ba2baba7dfe930515d5b484ae
+  data.tar.gz: a89ea79b5655e95d808c5c18bd362e2c671010a9
 SHA512:
-  metadata.gz: 00edd476fb5125e6899e15e7c2e606d0f007bdebbf96557fe409acb0ef61d8ffa8f6d53465a5117695c955813893a645fdc407b35519e79f3dc122236e8b91a9
-  data.tar.gz: 3cc0b1d0080929e7215dc29ea449c1ca91c6b09c5fd941f6d307946a66a125567540ba457b8242b22989b4714532fe61ca8a4ab8ba3f876a4612c7d13fead935
+  metadata.gz: 8fe82b08b5a0646f74a1507d5c086be3782f0efb46d289263fc81eca1427dc0760029114e973188d6b03774a1065bbabc1da14132dbe77ca0f41ca8721702df6
+  data.tar.gz: 9c61fb918a554319585259bc50d09537b89d0dbd5457209fdad34042bde68a34709da0bb2755ed7b781d5e6b1d248d4904e5c49f3154bb33714281bb6902d0bf

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/env_bang.png)](https://rubygems.org/gems/env_bang)
 [![Build Status](https://secure.travis-ci.org/jcamenisch/ENV_BANG.png?branch=master)](https://travis-ci.org/jcamenisch/ENV_BANG)
 [![Dependency Status](https://gemnasium.com/jcamenisch/ENV_BANG.png)](https://gemnasium.com/jcamenisch/ENV_BANG)
 [![Code Climate](https://codeclimate.com/github/jcamenisch/ENV_BANG.png)](https://codeclimate.com/github/jcamenisch/ENV_BANG)
@@ -9,13 +10,13 @@ Do a bang-up job managing your environment variables.
 
 ENV! provides a thin wrapper around ENV to accomplish a few things:
 
-- Provide a central place to specify what environment variables you intend to use
-- Fail loudly with an informative error message if environment variables are not
-  properly configured.
-- Prevent an application from starting up if a needed environment variable is not set.
-  (This is especially helpful in environment like Heroku, as it prevents launch of a
-  new version of your app if it depends on missing environment variables—a problem
-  that might go unnoticed until your customers come across a 500 error.)
+- Provide a central place to specify all your app’s environment variables.
+- Fail loudly and helpfully if environment variables are missing.
+- Prevent an application from starting up with missing environment variables.
+  (This is especially helpful in environments like Heroku, as your app will
+  continue running the old code until the server is configured for a new revision.
+  You discover the missing variable immediately instead of your customers 
+  discovering it for you later.)
 
 ## Installation
 
@@ -51,22 +52,21 @@ end
 A single variable can also be configured with `ENV!.use MY_VAR`, but the `ENV!.config` block
 will typically contain all the variables for your app.
 
-Once a variable is specified with `ENV!.use`, you can access it with
+Once a variable is specified with `ENV!.use`, access it with
 
 ```ruby
 ENV!['MY_VAR']
 ```
 
-This will function just like accessing the environment variable directly, except that it will
-require the variable to be specified with `ENV!.use`, and present in the current environment.
-If either of these conditions is not met, a KeyError will be raised with an explanation of
-what needs to be configured.
+This will function just like accessing `ENV` directly, except that it will require the variable
+to have been specified, and be present in the current environment. If either of these conditions
+is not met, a KeyError will be raised with an explanation of what needs to be configured.
 
 ### Adding a default value
 
-In some cases, you don't need to require each environment to set a variable explicitly.
-You might have a reasonable default value that can be overridden. You can specify a default
-value with the `:default` option:
+For some variables, you’ll want to include a default value in your code, and allow each
+environment to specify the variable only if the default needs to be overriden. You can
+accomplish this with the `:default` option:
 
 ```ruby
 ENV!.config do
@@ -78,10 +78,10 @@ end
 
 ### Adding a description
 
-When a new team members installs or deploys your project, they may run into a missing
+When a new team member installs or deploys your project, they may run into a missing
 environment variable error. It can save them a great deal of time to include documentation
-on the missing environment variable directly in the error that is raised. To accomplish this,
-provide a description (of any length) to the `use` method:
+along with the error that is raised. To accomplish this, provide a description (of any
+length) to the `use` method:
 
 ```ruby
 ENV!.config do
@@ -90,8 +90,8 @@ ENV!.config do
 end
 ```
 
-If someone installs or deploys the app and forgets to set the RAILS_SECRET_KEY_BASE variable in
-their environment, they will see these instructions immediately upon running the app.
+Now if someone installs or deploys the app without setting the RAILS_SECRET_KEY_BASE variable,
+they will see these instructions immediately upon running the app.
 
 ## Contributing
 

data/env_bang.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jonathan Camenisch"]
   spec.email         = ["jonathan@camenisch.net"]
   spec.summary       = %q{Do a bang-up job managing your environment variables}
-  spec.description   = %q{}
-  spec.homepage      = ""
+  spec.description   = %q{ENV! provides a thin wrapper around ENV to encourage central, self-documenting configuration and helpful error message.}
+  spec.homepage      = "https://github.com/jcamenisch/ENV_BANG"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/env_bang/version.rb

@@ -1,3 +1,3 @@
 class ENV_BANG
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/lib/env_bang.rb

@@ -11,31 +11,57 @@ class ENV_BANG
       options = args.last.is_a?(Hash) ? args.pop : {}
 
       unless ENV.has_key?(var)
-        ENV[var] = options.fetch(:default) do
-          message = "Missing required environment variable: #{var}"
-          message << "--#{description}" if description
-          indent = '    '
-          raise KeyError.new "\n#{indent}#{message.gsub "\n", "\n#{indent}"}\n"
-        end
+        ENV[var] = options.fetch(:default) { formatted_error(var, description) }.to_s
       end
 
-      used_vars << var
+      # Store the variable, converted to requested class
+      klass = :"#{options.fetch(:class, String)}"
+      vars[var] = Classes.cast ENV[var], klass, options
     end
 
-    def used_vars
-      @used_vars ||= Set.new
+    def formatted_error(var, description)
+      message = "Missing required environment variable: #{var}"
+      message << "\n#{description}" if description
+      indent = '    '
+      raise KeyError.new "\n#{indent}#{message.gsub "\n", "\n#{indent}"}\n"
+    end
+
+    def vars
+      @vars ||= {}
     end
 
     def [](var)
-      raise KeyError.new("ENV_BANG is not configured to use var #{var}") unless used_vars.include?(var)
+      raise KeyError.new("ENV_BANG is not configured to use var #{var}") unless vars.has_key?(var)
 
-      ENV[var]
+      vars[var]
     end
 
     def method_missing(method, *args, &block)
       ENV.send(method, *args, &block)
     end
   end
+
+  module Classes
+    class << self
+      def cast(value, klass, options = {})
+        public_send(:"#{klass}", value, options)
+      end
+
+      def boolean(value, options)
+        !(value =~ /^(|0|disabled?|false|no|off)$/i)
+      end
+
+      def Array(value, options)
+        klass = options.fetch(:of, String)
+        value.split(',').map { |value| cast(value.strip, klass) }
+      end
+
+      # Delegate methods like Integer(), Float(), String(), etc. to the Kernel module
+      def method_missing(klass, value, options, &block)
+        Kernel.send(klass, value)
+      end
+    end
+  end
 end
 
 def ENV!

data/test/env_bang_test.rb

@@ -44,4 +44,63 @@ describe ENV_BANG do
     end
     ENV!['PRESENT'].must_equal 'present in environment'
   end
+
+  describe "Type casting" do
+    let(:truthy_values) { %w[true on yes yo yup anything] }
+    let(:falsey_values) { %w[false no off disable disabled 0] << '' }
+    let(:integers) { %w[0 1 10 -42 -55] }
+    let(:floats) { %w[0.1 1.3 10 -42.3 -55] }
+
+    it "Casts Integers" do
+      integer = integers.sample
+      ENV['INTEGER'] = integer
+      ENV!.use 'INTEGER', class: Integer
+
+      ENV!['INTEGER'].must_equal integer.to_i
+    end
+
+    it "Casts Floats" do
+      float = floats.sample
+      ENV['FLOAT'] = float
+      ENV!.use 'FLOAT', class: Float
+
+      ENV!['FLOAT'].must_equal float.to_f
+      ENV!['FLOAT'].class.must_equal Float
+    end
+
+    it "Casts Arrays" do
+      ENV['ARRAY'] = 'one,two , three, four'
+      ENV!.use 'ARRAY', class: Array
+
+      ENV!['ARRAY'].must_equal %w[one two three four]
+    end
+
+    it "Casts Arrays of Integers" do
+      ENV['INTEGERS'] = integers.join(',')
+      ENV!.use 'INTEGERS', class: Array, of: Integer
+
+      ENV!['INTEGERS'].must_equal integers.map(&:to_i)
+    end
+
+    it "Casts Arrays of Floats" do
+      ENV['FLOATS'] = floats.join(',')
+      ENV!.use 'FLOATS', class: Array, of: Float
+
+      ENV!['FLOATS'].must_equal floats.map(&:to_f)
+    end
+
+    it "Casts false" do
+      ENV['TRUE'] = truthy_values.sample
+      ENV!.use 'TRUE', class: :boolean
+
+      ENV!['TRUE'].must_equal true
+    end
+
+    it "Casts false" do
+      ENV['FALSE'] = falsey_values.sample
+      ENV!.use 'FALSE', class: :boolean
+
+      ENV!['FALSE'].must_equal false
+    end
+  end
 end

data/test/test_helper.rb

@@ -1,9 +1,9 @@
 require 'simplecov'
 require 'coveralls'
 
+require 'minitest/autorun'
 require 'minitest/spec'
 require 'minitest/pride'
-require 'minitest/autorun'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_bang
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Jonathan Camenisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-description: ''
+description: ENV! provides a thin wrapper around ENV to encourage central, self-documenting
+  configuration and helpful error message.
 email:
 - jonathan@camenisch.net
 executables: []
@@ -56,7 +57,7 @@ files:
 - lib/env_bang/version.rb
 - test/env_bang_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/jcamenisch/ENV_BANG
 licenses:
 - MIT
 metadata: {}