envied 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d3ba3eb81e06018962bb52faa7caf1fdf044aca
-  data.tar.gz: a92a83a6a9272771f39eca36b3f0126aac9fd439
+  metadata.gz: 69f7fe8ec05529012ad80743d4f247714b22d369
+  data.tar.gz: ffbe2982c00e40da4d468447305b6670721de047
 SHA512:
-  metadata.gz: 7d4643b26e39b59b534285cc8f58f0228285468ec3860c3479b0a1cd3b5041a2d7fae2b40ce176c985105d4a793f705d226eef3ccf9591bc1c87a50f9d1b90a5
-  data.tar.gz: 2407bd5bf9a1700b76d81d77de7a4de9b2b7da1fba44257119444afb9e0e08ed2e4badf19d0f8d7cdecdf314c9a3affb4ef89119d42e0f3a9426bd0ac1d10bae
+  metadata.gz: fa4e3adebfadefb43a023b953bfa0f92bb31b87199a8c6404ea0ffdcef542257b58d1981a36ed4105b9e3bb5a348f779a2b368f4c6425d9819b1106afc812b91
+  data.tar.gz: 43666f2884ea8a9bc6ffb6d1b1e24f102330d94787e9f51b72a7a6815e91802d7fa516b6eb95b405fe4c4530acb9fb8a4abbd0b066a8a89d3d87b67eb0b3a971

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.5.0 / unreleased
+
+* add Array Hash types
+
+  ```ruby
+  # in env.rb
+  ENVied.configure { variable :TAGS, :Array; variable :HASH, :Hash }
+  ENVied.require
+
+  $ HASH=a=1&b=2 TAGS=tag1,tag2 ruby -renvied -r./env.rb -e 'p ENVied.TAGS'
+  # ["tag1", "tag2"]
+  $ HASH='a=1&b=2' TAGS=tag1,tag2 ruby -renvied -r./env.rb -e 'p ENVied.HASH'
+  # {'a' => '1', 'b' => '2'}
+  ```
+
 # 0.4.0 / 2014-05-16
 
 * groups added

data/README.md

@@ -2,45 +2,38 @@
 
 ### TL;DR ensure presence and type of your app's ENV-variables.
 
-For applications that are configured via ENV-variables, this gem will provide:
+This gem will provide:
 
-* A fail-fast check for presence of required ENV-variables
-* A fail-fast check for type of required ENV-variables
+* A fail-fast check for presence of ENV-variables
+* A fail-fast check whether the values can be coerced to the correct type
 * Access to typed ENV-variables (instead of just strings)
 
-### Current status
-
-![](underconstruction.gif)
-
-## Usage
+## Quickstart
 
 ### 1) Configure
 
 Let's configure the ENV-variables we need:
 
 ```ruby
-# e.g. config/application.rb
 ENVied.configure do
   variable :FORCE_SSL, :Boolean
   variable :PORT, :Integer
 end
 ```
 
-### 2) Check for presence and type
+### 2) Check for presence and coercibility
 
 ```ruby
 ENVied.require
 ```
 
-This will throw an error if not:
-* both `ENV['FORCE_SSL']` and `ENV['PORT']` are present
-* both the values of `ENV['FORCE_SSL']` and `ENV['PORT']` can be coerced (to resp. Boolean or Integer).
-
-(The error contains exactly what ENV-variables are missing/faulty.)
+This will throw an error if:
+* not both `ENV['FORCE_SSL']` and `ENV['PORT']` are present.
+* the values can't be coerced to resp. Boolean and Integer.
 
-### 3) Use typed variables
+### 3) Use coerced variables
 
-Variables accessed via ENVied have the configured type:
+Variables accessed via ENVied are of the correct type:
 
 ```ruby
 ENVied.PORT # => 3001
@@ -52,7 +45,7 @@ ENVied.FORCE_SSL # => false
 ### Groups
 
 Groups give you more flexibility to define when variables are needed.  
-It's just like you Gemfile:
+It's similar to groups in a Gemfile:
 
 ```ruby
 ENVied.configure do
@@ -85,6 +78,8 @@ The following types are supported:
 * `:Symbol`
 * `:Date` (e.g. '2014-3-26')
 * `:Time` (e.g. '14:00')
+* `:Hash` (e.g. 'a=1&b=2' becomes `{'a' => '1', 'b' => '2'}`)
+* `:Array` (e.g. 'tag1,tag2' becomes `['tag1', 'tag2']`)
 
 ### Defaults
 
@@ -104,7 +99,7 @@ Please remember that ENVied only **reads** from ENV; it doesn't set ENV-variable
 Don't let setting a default for, say `RAILS_ENV`, give you the impression that `ENV['RAILS_ENV']` is set.  
 As a rule of thumb you should only use defaults:
 * for local development
-* for ENV-variables that your application introduces (i.e. for `ENV['DEFAULT_SENDER']` not for `ENV['REDIS_URL']`)
+* for ENV-variables that your application introduces (i.e. for `ENV['STAFF_EMAILS']` not for `ENV['REDIS_URL']`)
 
 ### A more extensive example:
 
@@ -126,7 +121,7 @@ ENVied.configure(enable_defaults: &not_production_nor_ci) do
 
   group :production do
     variable :MAIL_PAAS_USERNAME
-    variable :DATABASE_URL, :Symbol
+    variable :DATABASE_URL
   end
 
   group :ci do

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{ENV on EPO. Or: ensure presence and type of your app's ENV-variables.}
+  spec.summary       = %q{Ensure presence and type of ENV-variables}
+  spec.description   = %q{Ensure presence and type of your app's ENV-variables.}
   spec.homepage      = "https://github.com/eval/envied"
   spec.license       = "MIT"
 
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "virtus", '~> 1.0.1'
+  spec.add_dependency "rack"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", '3.0.0.beta2'
+  spec.add_development_dependency "rspec", '~> 3.0.0'
 end

data/lib/envied.rb

@@ -1,11 +1,25 @@
 require 'virtus'
 
 class ENVied
+  module Hashable
+    def to_hash
+      require 'rack/utils'
+      ::Rack::Utils.parse_nested_query(self)
+    end
+  end
+
+  module Arrayable
+    def to_a
+      self.split(/(?<!\\), ?/).map{|i| i.gsub(/\\,/,',') }
+    end
+  end
+
   class Configuration
     include Virtus.model
 
     def self.variable(name, type = :String, options = {})
-      options = { strict: true, group: self.current_group }.merge(options)
+      options = { default: nil, strict: true, group: self.current_group }.merge(options)
+      type = Array if type == :Array
       attribute(name, type, options)
     end
 
@@ -36,7 +50,7 @@ class ENVied
   def self.configuration(options = {}, &block)
     if block_given?
       @configuration = build_configuration(&block).tap do |c|
-        options.each{|k, v| c.public_send("#{k}=", v) }
+        options.each {|k, v| c.public_send("#{k}=", v) }
       end
     end
     @configuration ||= build_configuration
@@ -70,7 +84,7 @@ class ENVied
         @attribute_set << v
       end
     end
-    @instance = group_configuration.new(ENV.to_hash)
+    @instance = group_configuration.new(env)
   end
 
   def self.error_on_missing_variables!
@@ -80,6 +94,7 @@ class ENVied
   end
 
   def self.error_on_uncoercible_variables!
+    # TODO default values should have defined type
     if non_coercible_variables.any?
       single_error = "ENV['%{name}'] ('%{value}' can't be coerced to %{type})"
       errors = non_coercible_variables.map do |v|
@@ -92,7 +107,13 @@ class ENVied
   end
 
   def self.env_value(variable)
-    ENV[variable.name.to_s]
+    env[variable.name.to_s]
+  end
+
+  def self.env
+    @env ||= begin
+      Hash[ENV.to_hash.map {|k,v| [k, v.dup.extend(Hashable, Arrayable)] }]
+    end
   end
 
   def self.env_value_or_default(variable)

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/envied_spec.rb

@@ -6,6 +6,19 @@ describe ENVied do
   it { should respond_to :require }
   it { should respond_to :configure }
 
+  before do
+    reset_env
+    reset_configuration
+  end
+
+  def reset_configuration
+    ENVied.instance_eval { @configuration = nil }
+  end
+
+  def reset_env
+    ENVied.instance_eval { @env = nil }
+  end
+
   context 'configured' do
 
     def unconfigured
@@ -14,13 +27,11 @@ describe ENVied do
     end
 
     def configure(options = {}, &block)
-      described_class.instance_eval { @configuration = nil }
       described_class.configure(options, &block)
       self
     end
 
     def configured_with(hash = {})
-      described_class.instance_eval { @configuration = nil }
       described_class.configure do
         hash.each do |name, type|
           variable(name, *type)
@@ -148,6 +159,7 @@ describe ENVied do
         end
       end
     end
+
     describe "groups" do
       context 'a variable in a group' do
         before do
@@ -189,6 +201,51 @@ describe ENVied do
           end
         end
       end
+
+      describe 'Hashable' do
+        before do
+          configure do
+            variable :foo, :Hash
+            variable :bar, :Hash
+          end.and_ENV('foo' => 'a=1&b=&c', 'bar' => '')
+          ENVied.require
+        end
+
+        it 'yields hash from string' do
+          expect(ENVied.foo).to eq Hash['a'=> '1', 'b' => '', 'c' => nil]
+        end
+
+        it 'yields hash from an empty string' do
+          expect(ENVied.bar).to eq Hash.new
+        end
+
+        context 'with defaults enabled' do
+          before do
+            configure(enable_defaults: true) do
+              variable :baz, :Hash
+            end.and_no_ENV
+          end
+
+          it 'has no default by default' do
+            # fixes a bug where variables of type :Hash had a default even
+            # when none was configured.
+            expect { ENVied.require(:default) }.to raise_error
+          end
+        end
+      end
+
+      describe 'Arrayable' do
+        before do
+          configure do
+            variable :moar, :Array
+          end.and_ENV('moar' => 'a, b, and\, c')
+          ENVied.require
+        end
+
+        it 'yields array from string' do
+          expect(ENVied.moar).to eq ['a','b','and, c']
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,17 +70,17 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
-description: 'ENV on EPO. Or: ensure presence and type of your app''s ENV-variables.'
+        version: 3.0.0
+description: Ensure presence and type of your app's ENV-variables.
 email:
 - gert@thinkcreate.nl
 executables: []
@@ -106,10 +120,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
-summary: ENV on EPO
+summary: Ensure presence and type of ENV-variables
 test_files:
 - spec/envied_spec.rb
 - spec/spec_helper.rb