env_vars 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edb62ff44a63e4c934b684ce185c368f5c7e033d
-  data.tar.gz: 3ea149485a9c4e3a6de43346e86089344b997eea
+  metadata.gz: ea60318c5b3551b75421b50696aeda6d9fe2262d
+  data.tar.gz: 58a80b5e1c90243a78921512ce6f1b6b579dc459
 SHA512:
-  metadata.gz: de7f9410fce327186d147d664630417ddc153338b726ccf81afafd8d3a970762ffccf910ce99e5fc400e00641006c6617194401841781bca1dad748c72adfdce
-  data.tar.gz: b566be6e2e9f4a2479d2def53c9ff68c10dd7e7b5fc478802d896e6c73ae5cf0a02d7e1359e8942bc6d5ebd9582b9180ee1a24d66f8b91406dfcacf3237eb4d7
+  metadata.gz: fd932edac1256b348f2575243632971f496e07e561a3e5edfc52180aa118c770357e052c556bc4bb2d84a8a148825435bf514a367689debdadbee8b241046e19
+  data.tar.gz: b04854b098b359b9a38a1e621b38d3d05ebe814a65cd0621abee30c41ce70099d62cb22e581ab25fb900568c83773eafa76b556123e06260b4682e3b6c910bab

data/.travis.yml

@@ -4,5 +4,16 @@ sudo: false
 notifications:
   email: false
 rvm:
-  - 2.2.2
+- 2.4.2
+- 2.3.5
+- 2.2.8
 before_install: gem install bundler
+before_script:
+- "curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter"
+- "chmod +x ./cc-test-reporter"
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+env:
+  global:
+    secure: hRsybxCL3vUEhYtEdUIJ6pPyFaeVH/Tc1crVXJ0JCmem/rSv/PHS0jUzb8R4EiQKdwFFDgEciASW71XwpesIoY+KbUPfjvG9M8NnKscSuTpX/9CAVvoEoLzUtHYV5VNx6St2YTb1nStXhvGqBN0y5VNil9t5q9NIEM65eSgZuO7lvzAGgvUHYOkmljHqHb2rXejdAJ5k3NVbKPU3fByGGxvO9SiJ4RLWWpNhCwCWjVlds5+wffiHO2ojWdfLYikaIIcuqZzcyYuKUch16guPfz8+AsYpqHTsf+s81UnNKLk3Ut9zl5JoxCkkTSt1ZzAHNEceR4KXgRYxFZh3uHg8fXrYqdc4A4tgHqsndXeZnEFFnmAlOvjbGldtYoSjzJGBaSxKei9mZbeFy6ytlwZeMp22hBwflFUlbxF/O8IpvSRAq1M4QG1nfEfKCXhyFCmOaeS1BcgcFLzXiDYibCnAfLmK/EMa5V+zo4USjiRmzSBmQFdNk91x+zOGRQOz6lt3s6OEm98FHh/J9Y4tQ9DkkhwS6x9MuSfdjEQkyhvB2xsl9SOfdlU5Ork+FBkRFGlYtiAcHwVa6e0ikJCAGFW2xVqKwq9dT/Wvg4VNtkCmJORdsuxZf/Jtgh2k5gjFi7ZO4mViIxMjIAQqUA/+XR9dFxuAfSZC6FJG4l4ixqvmNoM=

data/README.md

@@ -1,6 +1,10 @@
 # Env::Vars
 
-[![build status](https://travis-ci.org/fnando/env_vars.svg)](https://travis-ci.org/fnando/env_vars)
+[![Travis-CI](https://travis-ci.org/fnando/env_vars.png)](https://travis-ci.org/fnando/env_vars)
+[![Code Climate](https://codeclimate.com/github/fnando/env_vars/badges/gpa.svg)](https://codeclimate.com/github/fnando/env_vars)
+[![Test Coverage](https://codeclimate.com/github/fnando/env_vars/badges/coverage.svg)](https://codeclimate.com/github/fnando/env_vars/coverage)
+[![Gem](https://img.shields.io/gem/v/env_vars.svg)](https://rubygems.org/gems/env_vars)
+[![Gem](https://img.shields.io/gem/dt/env_vars.svg)](https://rubygems.org/gems/env_vars)
 
 Access environment variables. Also includes presence validation, type coercion and default values.
 
@@ -40,7 +44,8 @@ If you're going to use `env_vars` as your main configuration object, you can als
 ```ruby
 Config = Env::Vars.new do
   optional :redis_url, string, "redis://127.0.0.1"
-  property :redis, -> { Redis.new }
+  property :redis, -> { Redis.new } # pass an object that responds to #call
+  property(:now) { Time.now }       # or pass a block.
 end
 
 Config.redis.set("key", "value")
@@ -48,6 +53,27 @@ Config.redis.get("key")
 #=> "value"
 ```
 
+Values are cached by default. If you want to dynamically generate new values, set `cache: false`.
+
+```ruby
+Config = Env::Vars.new do
+  property(:uuid, cache: false) { SecureRandom.uuid }
+end
+```
+
+### Types
+
+You can coerce values to the following types:
+
+- `string`: Is the default. E.g. `optional :name, string`.
+- `int`: E.g. `optional :timeout, int`.
+- `float`: E.g. `optional :wait, float`.
+- `bool`: E.g. `optional :force_ssl, bool`. Any of `yes`, `true` or `1` is considered as `true`. Any other value will be coerced to `false`.
+- `symbol`: E.g. `optional :app_name, symbol`.
+- `array`: E.g. `optional :chars, array` or `optional :numbers, array(int)`. The environment variable must be something like `a,b,c`.
+
+### Dotenv integration
+
 If you're using [dotenv](https://rubygems.org/gems/dotenv), you can simply require `env_vars/dotenv`. This will load environment variables from `.env.local.%{environment}`, `.env.local`, `.env.%{environment}` and `.env` files, respectively. You _must_ add `dotenv` to your `Gemfile`.
 
 ```ruby
@@ -77,7 +103,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/env_vars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/env_vars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/env_vars.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "simplecov"
 end

data/lib/env_vars.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 module Env
   class Vars
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
     BOOL_TRUE = ["yes", "true", "1", true]
     BOOL_FALSE = ["no", "false"]
 
     MissingEnvironmentVariable = Class.new(StandardError)
+    MissingCallable = Class.new(StandardError)
 
-    def initialize(&block)
+    def initialize(env = ENV, &block)
+      @env = env
       instance_eval(&block)
     end
 
@@ -18,16 +22,8 @@ module Env
       validate!(env_var, required)
 
       define_singleton_method(name) do
-        value = ENV[env_var] || default
-
-        case type
-        when bool
-          BOOL_TRUE.include?(value)
-        when int
-          Integer(value) if !BOOL_FALSE.include?(value) && value
-        else
-          value
-        end
+        return default unless @env.key?(env_var)
+        coerce(type, @env[env_var])
       end
 
       aliases.each do |alias_name|
@@ -36,7 +32,8 @@ module Env
     end
 
     def validate!(env_var, required)
-      raise MissingEnvironmentVariable, "#{env_var} is not defined" if required && !ENV.key?(env_var)
+      return unless required
+      raise MissingEnvironmentVariable, "#{env_var} is not defined" unless @env.key?(env_var)
     end
 
     def mandatory(name, type, aliases: [])
@@ -47,9 +44,16 @@ module Env
       set(name, type, default, aliases: aliases)
     end
 
-    def property(name, func)
-      value = func.call
-      define_singleton_method(name) { value }
+    def property(name, func = nil, cache: true, &block)
+      callable = (func || block)
+      raise MissingCallable, "arg[1] must respond to #call or pass a block" unless callable
+
+      if cache
+        value = callable.call
+        define_singleton_method(name) { value }
+      else
+        define_singleton_method(name) { callable.call }
+      end
     end
 
     def int
@@ -63,5 +67,51 @@ module Env
     def bool
       :bool
     end
+
+    def symbol
+      :symbol
+    end
+
+    def float
+      :float
+    end
+
+    def array(type = string)
+      [:array, type]
+    end
+
+    private
+
+    def coerce_to_string(value)
+      value
+    end
+
+    def coerce_to_bool(value)
+      BOOL_TRUE.include?(value)
+    end
+
+    def coerce_to_int(value)
+      Integer(value) if !BOOL_FALSE.include?(value) && value
+    end
+
+    def coerce_to_float(value)
+      Float(value) if value
+    end
+
+    def coerce_to_symbol(value)
+      value && value.to_sym
+    end
+
+    def coerce_to_array(value, type)
+      value && value.split(/, */).map {|v| coerce(type, v) }
+    end
+
+    def coerce(type, value)
+      main_type, sub_type = type
+      args = [value]
+      args << sub_type if sub_type
+
+      send("coerce_to_#{main_type}", *args)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_vars
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access environment variables. Also includes presence validation, type
   coercion and default values.
 email:
@@ -104,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Access environment variables. Also includes presence validation, type coercion