envied 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3da0d6e67da927a774c498a1042d5ee27b3ee3f9
-  data.tar.gz: 9dadd80c4f668ddb1990d0f8837b730db4ecd54c
+  metadata.gz: d25c3d2c51229b8d12b11c07e31924a88114d2d1
+  data.tar.gz: 051c4d8bf0056995e60bfcf79e727d5263b72812
 SHA512:
-  metadata.gz: c2ef13db6f79e0590da7a86217c5b5b50b4b72b993f4a6b7711feffbccf8a285e9ec20743b2fd7859e901bc495dc13623b8068446ac0664e954687eba1b6f0fd
-  data.tar.gz: d5eaf03debc9c15d30360d8ee7c2fd75dae3cbac6d92d8cd72e9adc82c8be477a8a661532e24a54d435998da5de128a013c8c1a2af38f9cd49f9f8813b97623d
+  metadata.gz: e1e84ad9166cd60b9f024f042ad9d77fcb5ebedbfa3cc1263a9f7f611dc7d943458ac974fe57d8f05201279a7a091a839c10ca21597b7e1f9e0ff382c17d1ffd
+  data.tar.gz: 8cf40ec2c6baf773b65eb3e447cb97ec5896e5731a3a33a86b19734bd6e6fe239dc59b89c709dc504803fe41d4d570ef2dfa045ab1074cf5df75eadd115d8186

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## unreleased
+
+### Added
+
+ * the `check` task uses ENV['ENVIED_GROUPS'] as default groups-option if present
+
+### Fixed
+
+ * running `check:heroku` takes Heroku's value of ENVIED_GROUPS into account
+ * calling `enable_defaults!` without arguments now does what it says
+
 ## 0.8.0 / 2014-10-04
 
 ### Added

data/README.md

@@ -2,11 +2,13 @@
 
 ### TL;DR ensure presence and type of your app's ENV-variables.
 
+For the rationale behind this project, see this [blogpost](http://www.gertgoet.com/2014/10/14/envied-or-how-i-stopped-worrying-about-ruby-s-env.html).
+
 ## Features:
 
 * check for presence and correctness of ENV-variables
 * access to typed ENV-variables (integers, booleans etc. instead of just strings)
-* check the presence and correctness of Heroku config
+* check the presence and correctness of a Heroku config
 
 ## Contents
 
@@ -19,6 +21,7 @@
   * [More examples](#more-examples)
 * [Rails](#rails--spring)
 * [Command-line interface](#command-line-interface)
+* [How do I...?](#how-do-i)
 * [Testing](#testing)
 * [Developing](#developing)
 * [Contributing](#contributing)
@@ -151,46 +154,15 @@ As a rule of thumb you should only use defaults:
 
 ## Rails & Spring
 
-**tl;dr** use the `init:rails`-task to generate the necessary files for a Rails app (see [installation](#installation)).  
-Remember: the environment as seen by Spring is not up-to-date until *after* initialization - this is good enough for checking the environment, but too late to use it to configure your app.
-
----
-
-With the [Spring](https://github.com/rails/spring) preloader (which is part of the default Rails setup nowadays) it's a bit tricky when to do `ENVied.require`.
-
-The first time you execute a command (say `bin/rails console`), Spring will start the server from which subsequent commands fork from.  
-Currently [a bug in Spring](https://github.com/rails/spring/pull/267#issue-28580171) causes the initialization of the forked process to use the server's `ENV` instead of the actual `ENV`.  
-
-So if your `ENV` is not valid the first time you start Spring...:
-
-    # spring server *not* running
-    $ bin/rails console
-    # spring server started
-    # error raised: Please set the following ENV-variables: FORCE_SSL (RuntimeError)
-
-...it won't be valid for subsequent commands (even when you provide the correct variables):
-
-    # spring server still running
-    # FORCE_SSL=1 bin/rails console
-    # error raised: Please set the following ENV-variables: FORCE_SSL (RuntimeError)
-
-So while doing a `ENVied.require` in `config/application.rb` would seem perfectly fine, it won't work in the default 'springified' Rails setup.
+Long story short: Checking the presence of ENV variables using `ENVied.require` *will* work (use the `init:rails`-task and you're all set).  
+What won't work: relying on values from `ENV` (and thus `ENVied`) somewhere in `config/**/*.rb` **if these values vary between environments**.
 
-The workaround (which the `init:rails`-task will generate) is to move the `ENVied.require` to Spring's `after_fork`-callback.  
-If you want to change Rails' config based on ENV-variables you should put this in an `after_fork`-callback as well:
-
-```ruby
-# config/initializers/envied.rb as generated by 'bundle exec envied init:rails'
-ENVied.springify do
-  ENVied.require(*ENV['ENVIED_GROUPS'] || Rails.groups)
-
-  # Put any initialization based on ENV-variables below, e.g.:
-  # Rails.configuration.force_ssl = ENVied.FORCE_SSL
-end
-```
+See this [wiki-page](https://github.com/eval/envied/wiki/Spring-gotchas) for more background info.
 
 ## Command-line interface
 
+For help on a specific command, use `envied help <command>`.
+
 ```bash
 $ envied help
 Commands:
@@ -204,6 +176,41 @@ Commands:
   envied version, --version, -v  # Shows version number
 ```
 
+## How do I
+
+### ...find all ENV-variables my app is currently using?
+
+```
+$ bundle exec envied extract
+```
+
+This comes in handy when you're not using ENVied yet. It will find all `ENV['EKY']` and `ENV.fetch('KEY')` statements in your project.
+
+It assumes a standard project layout (see the default value for the globs-option).
+
+### ...check the config of a Heroku app?
+
+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`.
+
+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.
+
+You can turn the above into a handy binstub like so:
+```
+$ bundle exec envied check:heroku:binstub
+# created bin/heroku-env-check
+```
+
+This way you can do stuff like:
+```
+$ ./bin/heroku-env-check && git push live master
+```
+
 ## Testing
 
 ```bash

data/lib/envied.rb

@@ -8,33 +8,45 @@ require 'envied/configuration'
 class ENVied
   class << self
     attr_reader :env, :config
+    alias_method :required?, :env
   end
 
   def self.require(*args)
-    env!(*args)
-    error_on_missing_variables!
-    error_on_uncoercible_variables!
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    requested_groups = (args && !args.empty?) ? args : ENV['ENVIED_GROUPS']
+    env!(requested_groups, options)
+    error_on_missing_variables!(options)
+    error_on_uncoercible_variables!(options)
+
+    ensure_spring_after_fork_require(args, options)
   end
 
-  def self.env!(*args)
+  def self.env!(requested_groups, options = {})
     @env = begin
-      options = args.last.is_a?(Hash) ? args.pop : {}
       config = options.fetch(:config) { Configuration.load }
-      groups = required_groups(*args)
+      groups = required_groups(*requested_groups)
       EnvProxy.new(config, groups: groups)
     end
   end
 
-  def self.error_on_missing_variables!
+  def self.error_on_missing_variables!(options = {})
     names = env.missing_variables.map(&:name)
-    raise "The following environment variables should be set: #{names * ', '}" if names.any?
+    if names.any?
+      msg = "The following environment variables should be set: #{names * ', '}."
+      msg << "\nPlease make sure to stop Spring before retrying." if spring_enabled? && !options[:via_spring]
+      raise msg
+    end
   end
 
-  def self.error_on_uncoercible_variables!
+  def self.error_on_uncoercible_variables!(options = {})
     errors = env.uncoercible_variables.map do |v|
       "%{name} ('%{value}' can't be coerced to %{type})" % {name: v.name, value: env.value_to_coerce(v), type: v.type }
     end
-    raise "The following environment variables are not coercible: #{errors.join(", ")}" if errors.any?
+    if errors.any?
+      msg = "The following environment variables are not coercible: #{errors.join(", ")}."
+      msg << "\nPlease make sure to stop Spring before retrying." if spring_enabled? && !options[:via_spring]
+      raise msg
+    end
   end
 
   def self.required_groups(*groups)
@@ -43,7 +55,18 @@ class ENVied
     result.any? ? result.map(&:to_sym) : [:default]
   end
 
+  def self.ensure_spring_after_fork_require(args, options = {})
+    if spring_enabled? && !options[:via_spring]
+      Spring.after_fork { ENVied.require(args, options.merge(:via_spring => true)) }
+    end
+  end
+
   def self.springify(&block)
+    if defined?(ActiveSupport::Deprecation.warn) && !required?
+      ActiveSupport::Deprecation.warn(<<-MSG)
+It's no longer recommended to `ENVied.require` within ENVied.springify's block. Please re-run `envied init:rails` to upgrade.
+MSG
+    end
     if spring_enabled?
       Spring.after_fork(&block)
     else

data/lib/envied/cli.rb

@@ -52,8 +52,13 @@ INIT
     define_method "init:rails" do
       puts "Writing Envfile to #{File.expand_path('Envfile')}"
       template("Envfile.tt")
-
-      template("rails-initializer.tt", 'config/initializers/envied.rb')
+      inject_into_file "config/application.rb", "\nENVied.require(*ENV['ENVIED_GROUPS'] || Rails.groups)", after: /^ *Bundler.require.+$/
+      legacy_initializer = Dir['config/initializers/*envied*.rb'].first
+      if legacy_initializer && File.exists?(legacy_initializer)
+        puts "Removing 'ENVied.require' from #{legacy_initializer.inspect}."
+        puts "(you might want to remove the whole file)"
+        comment_lines legacy_initializer, /ENVied.require/
+      end
     end
 
     desc "check", "Checks whether you environment contains required variables"
@@ -63,7 +68,7 @@ INIT
       On success the process will exit with status 0.
       Else the missing/invalid variables will be shown, and the process will exit with status 1.
     LONG
-    option :groups, type: :array, default: %w(default), banner: 'default production'
+    option :groups, type: :array, desc: "uses ENV['ENVIED_GROUPS'] as default if present", default: ENV['ENVIED_GROUPS'] || %w(default), banner: 'default production'
     option :quiet, type: :boolean, desc: 'Communicate success of the check only via the exit status.'
     def check
       ENVied.require(*options[:groups])
@@ -100,10 +105,13 @@ ERR
       heroku_env = Hash[config.split("\n")[1..-1].each_with_object([]) do |i, res|
         res << i.split(":", 2).map(&:strip)
       end]
+
       ENV.replace({}).update(heroku_env)
-      ENVied.require(*options[:groups])
+
+      requested_groups = ENV['ENVIED_GROUPS'] || options[:groups]
+      ENVied.require(*requested_groups)
       unless options[:quiet]
-        puts "All variables for group(s) #{options[:groups]} are present and valid in your Heroku app"
+        puts "All variables for group(s) #{requested_groups} are present and valid in your Heroku app"
       end
     end
 

data/lib/envied/configuration.rb

@@ -3,11 +3,19 @@ class ENVied
     attr_reader :current_group, :defaults_enabled, :coercer
 
     def initialize(options = {}, &block)
-      @defaults_enabled = options.fetch(:enable_defaults, false)
       @coercer = options.fetch(:coercer, Coercer.new)
+      @defaults_enabled = options.fetch(:enable_defaults, defaults_enabled_default)
       instance_eval(&block) if block_given?
     end
 
+    def defaults_enabled_default
+      if ENV['ENVIED_ENABLE_DEFAULTS'].nil?
+        false
+      else
+        @coercer.coerce(ENV['ENVIED_ENABLE_DEFAULTS'], :boolean)
+      end
+    end
+
     def self.load(options = {})
       envfile = File.expand_path('Envfile')
       new(options).tap do |v|
@@ -15,8 +23,8 @@ class ENVied
       end
     end
 
-    def enable_defaults!(value = nil, &block)
-      @defaults_enabled = (value.nil? ? block : value)
+    def enable_defaults!(value = true, &block)
+      @defaults_enabled = block_given? ? block.call : value
     end
 
     def defaults_enabled?

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/spec/envied_spec.rb

@@ -128,6 +128,13 @@ describe ENVied do
           expect(subject.defaults_enabled?).to_not be
         end
 
+        it 'yields ENV["ENVIED_ENABLE_DEFAULTS"] if not set otherwise' do
+          stub_const("ENV", {'ENVIED_ENABLE_DEFAULTS' => '1'})
+          configure
+
+          expect(subject.defaults_enabled?).to be
+        end
+
         it 'can be enabled via #configure' do
           configure(enable_defaults: true){ }
 
@@ -135,7 +142,7 @@ describe ENVied do
         end
 
         it 'can be enabled via a configure-block' do
-          configure { self.enable_defaults!(true) }
+          configure { self.enable_defaults! }
 
           expect(subject.defaults_enabled?).to be
         end
@@ -197,13 +204,28 @@ describe ENVied do
       end
     end
 
+    describe "::required?" do
+      it 'yields true-ish when ::require is called' do
+        expect {
+          envied_require
+        }.to change { ENVied.required? }.from(nil).to(anything)
+      end
+    end
+
     describe "groups" do
       describe 'requiring' do
+
         it 'yields :default when nothing passed to require' do
           envied_require
           expect(ENVied.env.groups).to eq [:default]
         end
 
+        it 'takes ENV["ENVIED_GROUPS"] into account when nothing passed to require' do
+          and_ENV('ENVIED_GROUPS' => 'baz')
+          envied_require
+          expect(ENVied.env.groups).to eq [:baz]
+        end
+
         it 'yields groupnames passed to it as string' do
           envied_require('bar')
           expect(ENVied.env.groups).to eq [:bar]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-04 00:00:00.000000000 Z
+date: 2014-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coercible
@@ -121,7 +121,6 @@ files:
 - lib/envied/env_var_extractor.rb
 - lib/envied/templates/Envfile.tt
 - lib/envied/templates/heroku-env-check.tt
-- lib/envied/templates/rails-initializer.tt
 - lib/envied/variable.rb
 - lib/envied/version.rb
 - spec/coercer_spec.rb

data/lib/envied/templates/rails-initializer.tt

@@ -1,6 +0,0 @@
-ENVied.springify do
-  ENVied.require(*ENV['ENVIED_GROUPS'] || Rails.groups)
-
-  # Put any initialization based on ENV-variables below, e.g.:
-  # Rails.configuration.force_ssl = ENVied.FORCE_SSL
-end