env_bang 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4a31d98f7b91fa5c4bbad7088e70e2acb7b8403
-  data.tar.gz: e4285280d46906f66d633a79ec99297ef7fdc132
+  metadata.gz: 75f9cc5013ad1fb2d5f0ee0662da09b492e28470
+  data.tar.gz: 30f9f2473f6d747fb9079082221d0fffd94560c7
 SHA512:
-  metadata.gz: 825091731f2bcd8b74aa435a2612d099a936797840fb3a035097254c9897049984614aaf14619f53e1960425e7998ffe661aaed8e17f8f45d2140c8cdffe089f
-  data.tar.gz: bdb5e802b7e705a9d84b55a1bcdb11b6ffe58ee9b67494f9202a73935caa5aedeea254261af8de852d459bfc6115a28dbd5cbc700b8961ae9863aa7c0e8cc94f
+  metadata.gz: 485ac95c1327653a3b9e0224e728202484217ab3753267b6f8457c3065c00fbd75d2b9b25d72d26b426fba9da90e03fdcd82ff371dce348ab5c4c2c6af1ce4e5
+  data.tar.gz: 82e8491ea7ad0a668c6b57cd388b56e1e0eb516a3bfcef0b817ac0205d50a1036f4e1c908a3ff87f1f119a39e9c1f172456758b03f9c44c8ee93b8f9e829ada3

data/.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 rvm:
-  - 2.0.0
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
 bundler_args: --without=guard
+cache: bundler

data/README.md

@@ -11,48 +11,55 @@ 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 all your app’s environment variables.
-- Fail loudly and helpfully if environment variables are missing.
+- Fail loudly and helpfully if any 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.)
+  continue running the old code until the server is configured for a new revision.)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
-    gem 'env_bang'
+```ruby
+gem 'env_bang'
+```
 
-And then execute:
+Or for Rails apps, use `env_bang-rails` instead for more convenience:
 
-    $ bundle
+```ruby
+gem 'env_bang-rails
+```
 
-Or install it yourself as:
+And then execute:
 
-    $ gem install env_bang
+```sh
+$ bundle
+```
 
 ## Usage
 
 ### Basic Configuration
 
 First, configure your environment variables somewhere in your app’s
-startup process. In a Rails app, this could live in `config/initializers/env.rb`.
+startup process. If you use the env_bang-rails gem, place this in `config/env.rb`
+to load before application configuration.
+
+Example configuration:
 
 ```ruby
 ENV!.config do
-  use 'APP_HOST'
-  use 'RAILS_SECRET_TOKEN'
-  use 'STRIPE_SECRET_KEY'
-  use 'STRIPE_PUBLISHABLE_KEY'
+  use :APP_HOST
+  use :RAILS_SECRET_TOKEN
+  use :STRIPE_SECRET_KEY
+  use :STRIPE_PUBLISHABLE_KEY
   # ... etc.
 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.
+will typically be a cleaner place for all the variables for your app.
 
-Once a variable is specified with `ENV!.use`, access it with
+Once a variable is specified with the `use` method, access it with
 
 ```ruby
 ENV!['MY_VAR']
@@ -65,13 +72,13 @@ is not met, a KeyError will be raised with an explanation of what needs to be co
 ### Adding a default value
 
 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:
+environment to ommit the variable for default behavios. You can accomplish this with the
+`:default` option:
 
 ```ruby
 ENV!.config do
   # ...
-  use MAIL_DELIVERY_METHOD, default: :smtp
+  use :MAIL_DELIVERY_METHOD, default: 'smtp'
   # ...
 end
 ```
@@ -79,9 +86,8 @@ end
 ### Adding a description
 
 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
-along with the error that is raised. To accomplish this, provide a description (of any
-length) to the `use` method:
+environment variable error. Save them time by including documentation along with the error
+that is raised. To accomplish this, provide a description (of any length) to the `use` method:
 
 ```ruby
 ENV!.config do
@@ -93,6 +99,74 @@ end
 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.
 
+### Automatic type conversion
+
+ENV! can convert your environment variables for you, keeping that tedium out of your application
+code. To specify a type, use the `:class` option:
+
+```ruby
+ENV!.config do
+  use :COPYRIGHT_YEAR,       class: Integer
+  use :MEMCACHED_SERVERS,    class: Array
+  use :MAIL_DELIVERY_METHOD, class: Symbol, default: :smtp
+  use :DEFAULT_FRACTION,     class: Float
+  use :ENABLE_SOUNDTRACK,    class: :boolean
+end
+```
+
+Note that arrays will be derived by splitting the value on commas (','). To get arrays
+of a specific type of value, use the `:of` option:
+
+```ruby
+ENV!.config do
+  use :YEARS_OF_INTEREST, class: Array, of: Integer
+end
+```
+
+#### Default type conversion behavior
+
+If you don’t specify a `:class` option for a variable, ENV! defaults to a special
+type conversion called `:StringUnlessFalsey`. This coversion returns a string, unless
+the value is a "falsey" string ('false', 'no', 'off', '0', 'disable', or 'disabled').
+To turn off this magic for one variable, pass in `class: String`. To disable it globally,
+set
+
+```ruby
+ENV!.config do
+  Classes.default_class = String
+end
+
+#### Custom type conversion
+
+Suppose your app needs a special type conversion that doesn’t come with ENV_BANG. You can
+implement the conversion yourself with the `add_class` method in the `ENV!.config` block.
+For example, to convert one of your environment variables to type `Set`, you could write
+the following configuration:
+
+```sh
+# In your environment:
+export NUMBER_SET=1,3,5,7,9
+```
+
+```ruby
+# In your env.rb configuration file:
+require 'set'
+
+ENV!.config do
+  add_class Set do |value, options|
+    Set.new self.Array(value, options || {})
+  end
+
+  use :NUMBER_SET, class: Set, of: Integer
+end
+```
+
+```ruby
+# Somewhere in your application:
+ENV!['NUMBER_SET']
+#=> #<Set: {1, 3, 5, 7, 9}>
+```
+
 ## Contributing
 
 1. Fork it

data/lib/env_bang.rb

@@ -12,6 +12,7 @@ class ENV_BANG
     end
 
     def use(var, *args)
+      var = var.to_s
       description = args.first.is_a?(String) && args.shift
       options = args.last.is_a?(Hash) ? args.pop : {}
 
@@ -39,6 +40,7 @@ class ENV_BANG
     end
 
     def [](var)
+      var = var.to_s
       raise KeyError.new("ENV_BANG is not configured to use var #{var}") unless vars.has_key?(var)
 
       Classes.cast ENV[var], vars[var]
@@ -47,12 +49,30 @@ class ENV_BANG
     def method_missing(method, *args, &block)
       ENV.send(method, *args, &block)
     end
+
+    def add_class(klass, &block)
+      Classes.send :define_singleton_method, klass.to_s, &block
+    end
+
+    def default_class
+      Classes.default_class
+    end
+
+    def default_class=(value)
+      Classes.default_class = value
+    end
   end
 
   module Classes
     class << self
+      attr_writer :default_class
+
+      def default_class
+        @default_class ||= :StringUnlessFalsey
+      end
+
       def cast(value, options = {})
-        public_send(:"#{options.fetch(:class, :StringUnlessFalsey)}", value, options)
+        public_send(:"#{options.fetch(:class, default_class)}", value, options)
       end
 
       def boolean(value, options)

data/lib/env_bang/version.rb

@@ -1,3 +1,3 @@
 class ENV_BANG
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/test/env_bang_test.rb

@@ -117,6 +117,31 @@ describe ENV_BANG do
       ENV!['FALSE'].class.must_equal String
     end
 
+    it "allows default class to be overridden" do
+      ENV!.config { default_class = String }
+      ENV['FALSE'] = falsey_values.sample
+      ENV!.use 'FALSE', class: String
+
+      ENV!['FALSE'].class.must_equal String
+    end
+
+    it "allows addition of custom types" do
+      require 'set'
+
+      ENV['NUMBER_SET'] = '1,3,5,7,9'
+      ENV!.config do
+        add_class Set do |value, options|
+          Set.new self.Array(value, options || {})
+        end
+
+        use :NUMBER_SET, class: Set, of: Integer
+      end
+
+      ENV!['NUMBER_SET'].must_equal Set.new [1, 3, 5, 7, 9]
+    end
+  end
+
+  describe "Hash-like behavior" do
     it "provides configured keys" do
       ENV['VAR1'] = 'something'
       ENV['VAR2'] = 'something else'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_bang
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Jonathan Camenisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake