envied 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e27f5b1d1bd52afb55a1bf4f4f7a106ad32d76da
-  data.tar.gz: 055de0816f2bb6be30d74f8a20574aa627a51391
+  metadata.gz: 79a82b4ddfab5f725abe511edb302a7f82e74a31
+  data.tar.gz: b1627d78490f9ee58372b53c8699fecf572b36ef
 SHA512:
-  metadata.gz: 9757b92de7e3dbe3d235032058898c8cae8a2a91e0086b55709545ea079a6c6074cb35d68d34076d892f356489e41ed63fd1924150b04de69650737e05818db1
-  data.tar.gz: fb544d1f4fe81a2fcb9e3b345328cad98c1cd306c81c0af4bdac85bea64df2891994dd78f61c6a93e4179b3c291403efdb3d97b2206bdb19bf9beb27db76d2a2
+  metadata.gz: 9275f7c89ccd8159d921aae002558fa7eaedff0831944481c80a18d5c320cfc81fad2e7e049a81c78c349e463f8c5d19cf4143b4f1e98247a389ef3f694722b5
+  data.tar.gz: 0e98638933ffa8fdb57278ab0d6b1172ef62e6148eef582cf994727d70f62ab1faeedf931353a1bf38246cc85940979527bcdd79213b058297a9235f294cddc4

data/README.md

@@ -1,48 +1,60 @@
-# ENVied or ENV on EPO
+# ENVied
 
-### TL;DR `ENVied` will improve your life drama-ti-cally.
+### TL;DR ensure presence and type of your app's ENV-variables.
 
-Say you're nicely configuring your app via ENV-variables, 'ey?  
-Then maybe, just like me, you had the itch to check whether all variables your app needs, are present.  
-Or you sometimes wish that ENV-variables should not only contain strings, but integers and booleans.
+For applications that are configured via ENV-variables, this gem will provide:
 
-Wooha! You really should try `ENVied`.
+* A fail-fast check for presence of required ENV-variables
+* A fail-fast check for type of required ENV-variables
+* Access to typed ENV-variables (instead of just strings)
 
-![](underconstruction.gif)
-
-## Installation
-
-Add this line to your application's Gemfile:
+### Current status
 
-    gem 'envied'
+![](underconstruction.gif)
 
-And then execute:
+## Usage
 
-    $ bundle
+### 1) Configure
 
-## Usage
+Let's configure the ENV-variables we need:
 
 ```ruby
-# in config/application.rb
-# somewhere after 'Bundler.require(*Rails.groups)':
+# e.g. config/application.rb
 ENVied.configure do |env|
   env.variable :force_ssl, :Boolean
   env.variable :port, :Integer
 end
+```
 
-# require! will raise when ENV is *not* something like
-# {'FORCE_SSL' => 'true', 'PORT' => '3000'}
+### 2) Check for presence and type
+
+```ruby
 ENVied.require!
+```
+Excecution will halt unless ENV is something like
+`{'FORCE_SSL' => 'true', 'PORT' => '3000'}`.
 
-# existing app config starts here
-module Blog
-  class Application < Rails::Application
-    config.force_ssl = ENVied.force_ssl
-    ...
-  end
-end
+A meaningful error will in this case explain what key and type is needed.
+
+### 3) Use typed variables
+
+Variables accessed via ENVied have the configured type:
+
+```ruby
+ENVied.port => 1
+ENVied.force_ssl => false
 ```
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'envied'
+
+And then execute:
+
+    $ bundle
+
 ## Testing
 
 ```bash
@@ -62,7 +74,7 @@ bin/pry --gem
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/envied/fork )
+1. Fork it ( http://github.com/eval/envied/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/envied.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ENVied::VERSION
   spec.authors       = ["Gert Goet"]
   spec.email         = ["gert@thinkcreate.nl"]
-  spec.summary       = %q{ENV on epo}
-  spec.description   = %q{no, really}
+  spec.summary       = %q{ENV on EPO}
+  spec.description   = %q{ENV on EPO. Or: ensure presence and type of your app's ENV-variables.}
   spec.homepage      = "https://github.com/eval/envied"
   spec.license       = "MIT"
 

data/lib/envied.rb

@@ -1,10 +1,30 @@
 class ENVied
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   module Configurable
     require 'virtus'
 
-    class EnvMissing < StandardError;end
-    class EnvWrongType < StandardError;end
+    class VariableError < StandardError
+      attr_reader :variable
+      def initialize(variable)
+        @variable = variable
+      end
+
+      def variable_type
+        variable.type.to_s.split("::").last
+      end
+    end
+
+    class VariableMissingError < VariableError
+      def message
+        "Please provide ENV['#{variable.name.to_s.upcase}'] of type #{variable_type}"
+      end
+    end
+
+    class VariableTypeError < VariableError
+      def message
+        "ENV['#{variable.name.to_s.upcase}'] should be of type #{variable_type}"
+      end
+    end
 
     def self.included(base)
       base.class_eval do
@@ -14,30 +34,27 @@ class ENVied
     end
 
     module ClassMethods
-      # Creates an instance of Configuration.
+      # Creates a configuration instance from env.
       #
-      # Will raise EnvMissing for variables Configuration defined
-      # but are missing from env.
+      # Will raise VariableMissingError for variables not present in ENV.
       #
-      # Will raise EnvWrongType for variables that can't be coerced to the
-      # type defined in Configuration.
+      # Will raise VariableTypeError for variables whose ENV-value can't be coerced to the configured type.
       #
       # @param env [Hash] the env
       def parse_env(env)
         atts = attribute_set.map(&:name).each_with_object({}) do |name, result|
-          @current_att = name
+          @variable = attribute_set[name]
           unless result[name] = env[name.to_s] || env[name.to_s.upcase]
-            raise EnvMissing, "Please provide ENV['#{name.to_s.upcase}']"
+            raise VariableMissingError, @variable
           end
         end
+
         new(atts)
       rescue Virtus::CoercionError => e
-        configured_type = attribute_set[@current_att].options[:primitive]
-        raise EnvWrongType,
-          "ENV['#{@current_att.to_s.upcase}'] should be of type %s" % configured_type
+        raise VariableTypeError, @variable
       end
 
-      def variable(name, type = String, options = {})
+      def variable(name, type = :String, options = {})
         attribute name, type, { strict: true }.merge(options)
       end
     end

data/spec/envied_spec.rb

@@ -47,13 +47,13 @@ describe ENVied do
       it 'raises EnvMissing on calling required!' do
         expect {
           ENVied.require!
-        }.to raise_error(ENVied::Configurable::EnvMissing)
+        }.to raise_error(ENVied::Configurable::VariableMissingError)
       end
 
       it 'raises EnvMissing when interacted with and configured variable not present in ENV' do
         expect {
           ENVied.any_missing_method
-        }.to raise_error(ENVied::Configurable::EnvMissing)
+        }.to raise_error(ENVied::Configurable::VariableMissingError)
       end
     end
 
@@ -63,7 +63,7 @@ describe ENVied do
       specify do
         expect {
           ENVied.a
-        }.to raise_error(ENVied::Configurable::EnvWrongType)
+        }.to raise_error(ENVied::Configurable::VariableTypeError)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -66,7 +66,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.0.0.beta2
-description: no, really
+description: 'ENV on EPO. Or: ensure presence and type of your app''s ENV-variables.'
 email:
 - gert@thinkcreate.nl
 executables: []
@@ -106,7 +106,7 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: ENV on epo
+summary: ENV on EPO
 test_files:
 - spec/envied_spec.rb
 - spec/spec_helper.rb