envied 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a82b4ddfab5f725abe511edb302a7f82e74a31
-  data.tar.gz: b1627d78490f9ee58372b53c8699fecf572b36ef
+  metadata.gz: 36d17e2dd8294749d6092e79e10c5e4ba738e30e
+  data.tar.gz: 20154eb0fc0d036ba2fd0e05016db9442304d944
 SHA512:
-  metadata.gz: 9275f7c89ccd8159d921aae002558fa7eaedff0831944481c80a18d5c320cfc81fad2e7e049a81c78c349e463f8c5d19cf4143b4f1e98247a389ef3f694722b5
-  data.tar.gz: 0e98638933ffa8fdb57278ab0d6b1172ef62e6148eef582cf994727d70f62ab1faeedf931353a1bf38246cc85940979527bcdd79213b058297a9235f294cddc4
+  metadata.gz: 9a7b3f6e04cb7faf1704feff910ca6aa30b68ea416d1427de0b2a977477467c0da1791fd34f89ab823d999a5389d1e026ef04e9036bb9adb5e48f545d9aea224
+  data.tar.gz: 5e513482e36a44737af281bf239f19b55f8b007f9e03cca22e4c632b5b08c6b6b49a55dea140b393b4745a142b3e28c9655ae72e12dae515d639a56b968d2735

data/README.md

@@ -41,10 +41,36 @@ A meaningful error will in this case explain what key and type is needed.
 Variables accessed via ENVied have the configured type:
 
 ```ruby
-ENVied.port => 1
-ENVied.force_ssl => false
+ENVied.port # => 1
+ENVied.force_ssl # => false
 ```
 
+## Configuration
+
+### Types
+
+The following types are supported:
+
+* `:String` (implied)
+* `:Boolean` (e.g. '0'/'1', 'f'/'t', 'false'/'true', 'off'/'on', 'yes','no' for resp. true or false)
+* `:Integer`
+* `:Symbol`
+* `:Date` (e.g. '2014-3-26')
+* `:Time` (e.g. '14:00')
+
+### Defaults
+
+Variables can have defaults. It can be value or a proc (with arity 0, 1 or 2).
+
+```ruby
+ENVied.configure do |env|
+  env.variable :port, :Integer, default: ->(env, variable){ env.force_ssl ? 443 : 80 }
+  env.variable :force_ssl, :Boolean, default: true
+end
+```
+
+Please remember that ENVied only **reads** from ENV; don't let setting a default for, say `rails_env`, give you or your team the impression that `ENV['RAILS_ENV']` is set.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/envied.rb

@@ -1,5 +1,5 @@
 class ENVied
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
   module Configurable
     require 'virtus'
 
@@ -44,7 +44,10 @@ class ENVied
       def parse_env(env)
         atts = attribute_set.map(&:name).each_with_object({}) do |name, result|
           @variable = attribute_set[name]
-          unless result[name] = env[name.to_s] || env[name.to_s.upcase]
+          has_default = !!@variable.options[:default]
+          var_value = env[name.to_s] || env[name.to_s.upcase]
+          result[name] = var_value if var_value
+          if !(result[name] || has_default)
             raise VariableMissingError, @variable
           end
         end
@@ -55,8 +58,23 @@ class ENVied
       end
 
       def variable(name, type = :String, options = {})
+        options[:default] &&= flexible_arity(options[:default])
         attribute name, type, { strict: true }.merge(options)
       end
+
+      protected
+      def flexible_arity(default)
+        return default unless default.respond_to?(:call)
+
+        case default.arity
+        when 1
+          ->(env, _){ default[env] }
+        when 0
+          ->(*){ default[] }
+        else
+          default
+        end
+      end
     end
   end
 

data/spec/envied_spec.rb

@@ -16,7 +16,7 @@ describe ENVied do
     def configured_with(hash = {})
       described_class.configure do |env|
         hash.each do |name, type|
-          env.variable(name, type)
+          env.variable(name, *type)
         end
       end
       self
@@ -50,7 +50,7 @@ describe ENVied do
         }.to raise_error(ENVied::Configurable::VariableMissingError)
       end
 
-      it 'raises EnvMissing when interacted with and configured variable not present in ENV' do
+      it 'raises EnvMissing when interacted with' do
         expect {
           ENVied.any_missing_method
         }.to raise_error(ENVied::Configurable::VariableMissingError)
@@ -66,5 +66,30 @@ describe ENVied do
         }.to raise_error(ENVied::Configurable::VariableTypeError)
       end
     end
+
+    describe 'variable with default' do
+      it 'can be a value' do
+        configured_with(a: [:Integer, default: 1]).and_no_ENV
+        expect(ENVied.a).to eq 1
+      end
+
+      (0..2).each do |arity|
+        it "can be a proc with arity #{arity}" do
+          default = begin
+            case arity
+            when 2
+              ->(a,b){ 1 }
+            when 1
+              ->(a){ 1 }
+            when 0
+              ->(){ 1 }
+            end
+          end
+
+          configured_with(a: [:Integer, default: default]).and_no_ENV
+          expect(ENVied.a).to eq 1
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ENV on EPO