envied 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d96082d1dc1fedf685dc01443f880342727f980
-  data.tar.gz: 15edf9b6d7d41abd5f694a534ff092e422cffa4f
+  metadata.gz: 803c704396a34b45112c1e893d902f616146d826
+  data.tar.gz: 2886267c88374d9b75d02920f55ca0df9e025244
 SHA512:
-  metadata.gz: 34036deeaaf2f1bb339b645ea3f6680aa72323a2e0f3c71d84da130ac8fe2d2b685cdc5f208d5c84bb7b6008d108cc121256a0c9e4806f24512cad2aa77a2e9b
-  data.tar.gz: f6768c4c9a2deab86218b9579b41af302ecd18fdd0567a94041067b8d9c4bd4ef17337fa7b1738c78f1402b8ce67a3a4f2ca0cbc7ca8e361de4d3e276dfc4f5d
+  metadata.gz: 721fa2f72d8fbba07714eaf8efdaa93bd48b045defb67fdd4d2e0a56e7d78fe132e152a68762fe1586138b6624b6c2ea16a80ab9cd16f13b7bb22f8b26750c64
+  data.tar.gz: 44567081a050048fc3eec30c4c7746999aaf9d5a26cb6c6f80480d3b4464ae88caa3be21aa1247a96c6304c0050575759bb631bfefa118a0e6ee57b939efb140

data/.rspec

@@ -1,3 +1,3 @@
 --warnings
---format documentation
+--format progress
 --color

data/.travis.yml

@@ -6,8 +6,6 @@ before_install:
   - gem update bundler
 
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.9
   - 2.2.6
   - 2.3.3

data/CHANGELOG.md

@@ -1,12 +1,19 @@
-## unreleased
+## 0.9.0 / 2017-03-01
 
-...
+* Support multiple groups [#16](../../pull/16)
+* Replaced rack dependency with stdlib solution using CGI for supporting hash type
+* Now requiring Ruby 2.1.x and up
+* Added float type which resolves [#30](../../pull/30)
+* Added uri type [#22](../../pull/22)
+* Updated extractor to find interpolated ENV vars which fixes [#21](../../pull/21)
+* Various typo fixes [#24](../../pull/24) and [#28](../../pull/28)
+* Resolved warnings when running tests
 
 ## 0.8.2 / 2017-02-21
 
 ### Added
 
- * Rails 5 support
+ * Rails 5 support [#25](../../pull/25)
 
 ### Fixed
 

data/README.md

@@ -1,4 +1,4 @@
-# ENVied [![travis](https://secure.travis-ci.org/eval/envied.png?branch=master)](https://secure.travis-ci.org/#!/eval/envied)
+# ENVied [![Build Status](https://travis-ci.org/eval/envied.svg?branch=master)](https://travis-ci.org/eval/envied)
 
 ### TL;DR ensure presence and type of your app's ENV-variables.
 
@@ -46,8 +46,8 @@ ENVied.require
 ```
 
 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.
+* both `ENV['FORCE_SSL']` and `ENV['PORT']` are *not present*.
+* the values *cannot* be coerced to a boolean and integer.
 
 ### 3) Use coerced variables
 
@@ -85,24 +85,30 @@ The following types are supported:
 * `:string` (implied)
 * `:boolean` (e.g. '0'/'1', 'f'/'t', 'false'/'true', 'off'/'on', 'no'/'yes' for resp. false and true)
 * `:integer`
+* `:float`
 * `: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']`)
+* `:uri` (e.g. 'http://www.google.com' becomes `URI.parse('http://www.google.com')`
 
 ### Groups
 
-Groups give you more flexibility to define when variables are needed.  
+Groups give you more flexibility to define when variables are needed.
 It's similar to groups in a Gemfile:
 
 ```ruby
 # file: Envfile
-variable :FORCE_SSL, :boolean
+variable :FORCE_SSL, :boolean, default: 'false'
 
 group :production do
   variable :SECRET_KEY_BASE
 end
+
+group :development, :staging do
+  variable :DEV_KEY
+end
 ```
 
 ```ruby
@@ -131,7 +137,7 @@ ENVied.require(nil)
 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 quite the opposite of 'fail-fast when not all ENV-variables are present'. Therefor you should explicitly state whén defaults are allowed:
+Note that 'easily bootstrap' is quite the opposite of 'fail-fast when not all ENV-variables are present'. Therefore you should explicitly state when defaults are allowed:
 
 ```ruby
 # Envfile
@@ -142,7 +148,7 @@ variable :PORT, :integer, default: proc {|envied| envied.FORCE_SSL ? 443 : 80 }
 ```
 
 Please remember that ENVied only **reads** from ENV; it doesn't mutate ENV.
-Don't let setting a default for, say `RAILS_ENV`, give you the impression that `ENV['RAILS_ENV']` is set.  
+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 are solely used by your application (i.e. for `ENV['STAFF_EMAILS']`, not for `ENV['RAILS_ENV']`)
@@ -189,7 +195,7 @@ The easiest/quickest is to run:
 $ heroku config | bundle exec envied check:heroku
 ```
 
-This is equivalent to having the heroku config as your local environment and running `envied check --groups default production`.
+This is equivalent to having the heroku config as your local environment and running `envied check:heroku --groups default production`.
 
 You want to run this right before a deploy to Heroku. This prevents that your app will crash during bootup because ENV-variables are missing from heroku config.
 
@@ -208,10 +214,7 @@ $ ./bin/heroku-env-check && git push live master
 
 ```bash
 bundle install
-
 bundle exec rspec
-# or
-bundle exec rake
 ```
 
 ## Developing
@@ -222,8 +225,8 @@ bundle exec pry --gem
 
 ## Contributing
 
-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`)
-5. Create new Pull Request
+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`
+5. Create a new pull request for your feature branch

data/envied.gemspec

@@ -6,8 +6,8 @@ require "envied/version"
 Gem::Specification.new do |spec|
   spec.name          = "envied"
   spec.version       = ENVied::VERSION
-  spec.authors       = ["Gert Goet"]
-  spec.email         = ["gert@thinkcreate.nl"]
+  spec.authors       = ["Gert Goet", "Javier Julio"]
+  spec.email         = ["gert@thinkcreate.nl", "jjfutbol@gmail.com"]
   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"
@@ -18,9 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 2.1.9"
   spec.add_dependency "coercible", "~> 1.0"
-  spec.add_dependency "rack", ">= 1.4", (RUBY_VERSION < "2.2.2" ? "< 2" : "< 3")
   spec.add_dependency "thor", "~> 0.15"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/examples/extensive_envfile

@@ -12,8 +12,26 @@ variable :RACK_ENV
 
 variable :FORCE_SSL, :boolean, default: 'false'
 variable :PORT, :integer, default: '3000'
+
+variable :TAGS, :array, default: 'tag1,tag2'
+# ENVied.TAGS
+# => ['tag1', 'tag2']
+
 # generate the default value using the value of PORT:
-variable :PUBLIC_HOST_WITH_PORT, :string, default: proc {|envied| "localhost:#{envied.PORT}" }
+variable :PUBLIC_HOST_WITH_PORT, :string, default: proc { |envied|
+  "localhost:#{envied.PORT}"
+}
+
+# Or better yet, use the URI type:
+variable :SITE_URI, :uri, default: 'http://localhost:5000/'
+# So with that you could now do:
+# ```
+# config.action_mailer.default_url_options = {
+#   protocol: ENVied.SITE_URI.scheme,
+#   host: ENVied.SITE_URI.host
+# }
+# config.action_mailer.asset_host = ENVied.SITE_URI.to_s
+# ```
 
 group :production do
   variable :MAIL_PAAS_USERNAME

data/lib/envied/cli.rb

@@ -25,10 +25,10 @@ class ENVied
     def extract
       globs = options[:globs]
       globs << "{test,spec}/*" if options[:tests]
-      var_occurences = ENVied::EnvVarExtractor.new(globs: globs).extract
+      var_occurrences = ENVied::EnvVarExtractor.new(globs: globs).extract
 
-      puts "Found %d occurrences of %d variables:" % [var_occurences.values.flatten.size, var_occurences.size]
-      var_occurences.sort.each do |var, occs|
+      puts "Found %d occurrences of %d variables:" % [var_occurrences.values.flatten.size, var_occurrences.size]
+      var_occurrences.sort.each do |var, occs|
         puts var
         occs.sort_by{|i| i[:path].size }.each do |occ|
           puts "* %s:%s" % occ.values_at(:path, :line)

data/lib/envied/coercer.rb

@@ -8,8 +8,13 @@ class ENVied::Coercer
     end
 
     def to_hash(str)
-      require 'rack/utils'
-      ::Rack::Utils.parse_query(str)
+      require 'cgi'
+      ::CGI.parse(str).map { |key, values| [key, values[0]] }.to_h
+    end
+
+    def to_uri(str)
+      require 'uri'
+      ::URI.parse(str)
     end
   end
   Coercible::Coercer::String.send(:include, CoercerExts)
@@ -38,7 +43,7 @@ class ENVied::Coercer
 
   def self.supported_types
     @supported_types ||= begin
-      [:hash, :array, :time, :date, :symbol, :boolean, :integer, :string].sort
+      [:hash, :array, :time, :date, :symbol, :boolean, :integer, :string, :uri, :float].sort
     end
   end
 

data/lib/envied/configuration.rb

@@ -45,9 +45,11 @@ class ENVied
       variables << ENVied::Variable.new(name, type, options)
     end
 
-    def group(name, &block)
-      @current_group = name.to_sym
-      yield
+    def group(*names, &block)
+      names.each do |name|
+        @current_group = name.to_sym
+        yield
+      end
     ensure
       @current_group = nil
     end

data/lib/envied/env_var_extractor.rb

@@ -24,7 +24,7 @@ class ENVied
       new(options.merge(globs: Array(globs))).extract
     end
 
-    # Greps all ENV-variables from non-comment-parts of line.
+    # Greps all ENV-variables from a line of text.
     # Captures 'A' in lines like `ENV['A']`, but also `ENV.fetch('A')`.
     #
     # @param line [String] the line to grep
@@ -32,17 +32,14 @@ class ENVied
     # @example
     #   extractor.new.capture_variables("config.force_ssl = ENV['FORCE_SSL']")
     #   # => ["FORCE_SSL"]
-    #   extractor.new.capture_variables("# comment about ENV['FORCE_SSL']")
-    #   # => []
     #
     # @return [Array<String>] the names o
     def capture_variables(line)
-      noncomment, _ = line.split("#", 2)
-      noncomment.scan(/ENV(?:\[|\.fetch\()['"]([^'"]+)['"]/).flatten
+      line.scan(/ENV(?:\[|\.fetch\()['"]([^'"]+)['"]/).flatten
     end
 
     # Extract all keys recursively from files found via `globs`.
-    # Any occurence of `ENV['A']` or `ENV.fetch('A')` in code (not in comments), will result
+    # Any occurrence of `ENV['A']` or `ENV.fetch('A')`, will result
     # in 'A' being extracted.
     #
     # @param globs [Array<String>] the collection of globs

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

data/spec/coercer_spec.rb

@@ -28,6 +28,15 @@ describe ENVied::Coercer do
       end
     end
 
+    describe 'float coercion' do
+      let(:coerce){ coerce_to(:Float) }
+
+      it 'converts strings to floats' do
+        expect(coerce['1.05']).to eq 1.05
+        expect(coerce['-1.234']).to eq(-1.234)
+      end
+    end
+
     describe 'boolean coercion' do
       let(:coerce){ coerce_to(:Boolean) }
 
@@ -95,5 +104,13 @@ describe ENVied::Coercer do
         end
       end
     end
+
+    describe 'uri coercion' do
+      let(:coerce){ coerce_to(:Uri) }
+
+      it 'converts strings to uris' do
+        expect(coerce['http://www.google.com']).to be_a(URI)
+      end
+    end
   end
 end

data/spec/env_var_extractor_spec.rb

@@ -10,9 +10,9 @@ describe ENVied::EnvVarExtractor do
     {
       %{self.a = ENV['A']} => %w(A),
       %{self.a = ENV["A"]} => %w(A),
+      %{self.a = ENV.fetch('A')]} => %w(A),
       %{self.a = ENV.fetch("A")]} => %w(A),
-      %{self.a = ENV.fetch("A")]} => %w(A),
-      %{# self.a = ENV["A"]} => %w(),
+      %{# self.a = ENV["A"]} => %w(A),
       %{self.a = ENV["A"] && self.b = ENV["B"]} => %w(A B),
       %{self.a = ENV["A3"]} => %w(A3)
     }.each do |line, expected|

data/spec/envied_spec.rb

@@ -96,7 +96,7 @@ describe ENVied do
       specify do
         expect {
           envied_require
-        }.to raise_error(/The following environment variables should be set: a/)
+        }.to raise_error(RuntimeError, 'The following environment variables should be set: a.')
       end
     end
 
@@ -114,7 +114,7 @@ describe ENVied do
       it 'raises error when configuring variable of unknown type' do
         expect {
           configured_with(A: :Fixnum)
-        }.to raise_error
+        }.to raise_error(ArgumentError, /Variable type \(of A\) should be one of \[/)
       end
     end
 
@@ -192,7 +192,7 @@ describe ENVied do
 
           expect {
             envied_require
-          }.to raise_error
+          }.to raise_error(RuntimeError, 'The following environment variables should be set: A.')
         end
 
         it 'is ignored if ENV is provided' do
@@ -283,7 +283,7 @@ describe ENVied do
 
           expect {
             described_class.bar
-          }.to raise_error
+          }.to raise_error(NoMethodError)
         end
 
         it 'requires variables without a group when requiring the default group' do
@@ -295,6 +295,28 @@ describe ENVied do
         end
       end
 
+      context 'a variable in multiple groups' do
+        before do
+          configure do
+            variable :moar
+
+            group :foo, :moo do
+              variable :bar
+            end
+          end.and_no_ENV
+        end
+
+        it 'is required when requiring any of the groups' do
+          expect {
+            envied_require(:foo)
+          }.to raise_error(/bar/)
+
+          expect {
+            envied_require(:moo)
+          }.to raise_error(/bar/)
+        end
+      end
+
       describe 'Hashable' do
         before do
           configure do
@@ -322,7 +344,7 @@ describe ENVied do
           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 }.to raise_error
+            expect { envied_require }.to raise_error(RuntimeError, 'The following environment variables should be set: baz.')
           end
         end
       end
@@ -339,6 +361,20 @@ describe ENVied do
           expect(ENVied.moar).to eq ['a',' b',' and, c']
         end
       end
+
+      describe 'URIable' do
+        before do
+          configure do
+            variable :site_url, :Uri
+          end.and_ENV('site_url' => 'https://www.google.com')
+          envied_require
+        end
+
+        it 'yields a URI from string' do
+          expect(ENVied.site_url).to be_a URI
+          expect(ENVied.site_url.host).to eq 'www.google.com'
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Gert Goet
+- Javier Julio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coercible
@@ -24,26 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +84,7 @@ dependencies:
 description: Ensure presence and type of your app's ENV-variables.
 email:
 - gert@thinkcreate.nl
+- jjfutbol@gmail.com
 executables:
 - envied
 extensions: []
@@ -147,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="