envied 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a2483497b0ea0cac789287167585eee37cfbd70
-  data.tar.gz: fa76d7207586ed263d2b8f1ca284b18a5711b41f
+  metadata.gz: 2f0f26f023604dac352019bbee3aecde27fc9da2
+  data.tar.gz: 653204a1873319f4e4e15420fd17e659a98e187a
 SHA512:
-  metadata.gz: c484a2e67953278b2d8ac7b50ccbc849a4b3eb22e4ec33715194fe42b58ab968cec2a808e6d5ff85d8797cbea3bb299770835c9db71cf9d9337c94e219afe475
-  data.tar.gz: 16b0ab7de0f0b6185836fefe0ee82b4a179493be2ab702721f4e25ea2edf8e5a1f69e45b4731960d5799f75e8f0686091cd8756e158e7bcfedce3a83bc15b671
+  metadata.gz: 88c894f8addd2f09ce5406048f3010b7d4bd561aad6a0bd1b8461e6d5e8170c559f314edb45aab1d3d4efec2c9afe51b705e696dacde64eaa10a2ea2a5b4f92c
+  data.tar.gz: a43d8d92ef633b6fc1b390939ce440e768dac363a4ec05b229238cebc23894ca68d8b160bca65c93d9f9007328a81c53d82d2390a99411cb627653e193d63edb

data/README.md

@@ -32,7 +32,7 @@ end
 ENVied.require!
 ```
 Excecution will halt unless ENV is something like
-`{'FORCE_SSL' => 'true', 'PORT' => '3000'}`.
+`{'FORCE_SSL' => 'false', 'PORT' => '3001'}`.
 
 A meaningful error will in this case explain what key and type is needed.
 
@@ -41,7 +41,7 @@ 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.port # => 3001
 ENVied.force_ssl # => false
 ```
 
@@ -60,16 +60,23 @@ The following types are supported:
 
 ### Defaults
 
-Variables can have defaults. It can be a value or a proc.
+In order to let other developers easily bootstrap the application, you can assign defaults to variables.
+Defaults can be a value or a `Proc` (see example below).
+
+Note that 'easily bootstrap' is rather different than 'fail-fast when not all ENV-variables are present'. Therefor it's disabled by default and you should explicitly state whén it is allowed:
 
 ```ruby
-ENVied.configure do |env|
+ENVied.configure(enable_defaults: Rails.env.development?) do |env|
   env.variable :port, :Integer, default: proc {|env, variable| env.force_ssl ? 443 : 80 }
-  env.variable :force_ssl, :Boolean, default: true
+  env.variable :force_ssl, :Boolean, default: false
 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.
+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.  
+As a rule of thumb: you should only use defaults:
+* in a development-environment
+* for ENV-variables that your application introduces (i.e. for `ENV['DEFAULT_SENDER']` not for `ENV['REDIS_URL']`)
+
 
 ## Installation
 

data/lib/envied.rb

@@ -1,5 +1,5 @@
 class ENVied
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   module Configurable
     require 'virtus'
 
@@ -30,6 +30,9 @@ class ENVied
       base.class_eval do
         include Virtus.model
 
+        class << self
+          attr_accessor :enable_defaults
+        end
       end
       base.extend ClassMethods
     end
@@ -58,19 +61,21 @@ class ENVied
         new(atts)
       end
 
+      # Define a variable.
+      #
+      # @param name [Symbol] name of the variable
+      # @param type [Symbol] type (one of :String (default), :Symbol, :Integer, :Boolean,
+      #   :Date, :Time)
+      # @param options [Hash]
+      # @option options [String, Integer, Boolean, #call] :default (nil) what value will be
+      #   used when no ENV-variable is present.
+      # @note Defaults are ignored by default, see {configure}.
+      #
       def variable(name, type = :String, options = {})
+        options.delete(:default) unless self.enable_defaults
         attribute name, type, { strict: true }.merge(options)
       end
 
-      def default_if?(cond, value = nil, &block)
-        options = { default: (value || block) }
-        cond ? options : Hash.new
-      end
-
-      def default_unless?(cond, value = nil, &block)
-        default_if?(!cond, value, &block)
-      end
-
       private
       def try_coercion(variable, value, default)
         value ||= begin
@@ -90,8 +95,20 @@ class ENVied
     attr_accessor :configuration
   end
 
-  def self.configure(&block)
+  # Configure ENVied.
+  #
+  # @param options [Hash]
+  # @option options [Boolean] :enable_defaults (false) whether or not defaults are used.
+  #
+  # @example
+  #   ENVied.configure(enable_defaults: Rails.env.development?) do
+  #     variable :force_ssl, :Boolean, default: false
+  #   end
+  #
+  def self.configure(options = {}, &block)
+    options = { enable_defaults: false }.merge(options)
     @configuration = Class.new { include Configurable }.tap do |k|
+      k.enable_defaults = options[:enable_defaults]
       k.instance_eval(&block)
     end
     # or define this thing as ENVied::Configuration? prolly not threadsafe

data/spec/envied_spec.rb

@@ -13,6 +13,11 @@ describe ENVied do
       self
     end
 
+    def configure(options = {}, &block)
+      described_class.configure(options, &block)
+      self
+    end
+
     def configured_with(hash = {})
       described_class.configure do |env|
         hash.each do |name, type|
@@ -68,13 +73,25 @@ describe ENVied do
     end
 
     describe 'variable with default' do
-      it 'can be a value' do
+      it "are disabled by default" do
         configured_with(a: [:Integer, default: 1]).and_no_ENV
+
+        expect { ENVied.a }.to raise_error
+      end
+
+      it 'can be a value' do
+        configure(enable_defaults: true) do
+          variable :a, :Integer, default: 1
+        end.and_no_ENV
+
         expect(ENVied.a).to eq 1
       end
 
       it "can be anything callable" do
-        configured_with(a: [:Integer, default: proc { 1 }]).and_no_ENV
+        configure(enable_defaults: true) do
+          variable :a, :Integer, default: proc { 1 }
+        end.and_no_ENV
+
         expect(ENVied.a).to eq 1
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gert Goet