envied 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ad0058d9ef3c1ac2fdb9d6e0fa5abcdfd46a357
-  data.tar.gz: 27bce5b5dec311495cfce3df7db4a165b7390ca4
+  metadata.gz: 46ff25f0ca1accf79ba7095db2e6b0232af3cb8c
+  data.tar.gz: f6f3572cb136f9d3e68affbfa4bafa839a203b05
 SHA512:
-  metadata.gz: 03de29ccf52772727c3f1e6105eff5e48636fa6e091b863b06d3dec76e5a1805d9fc35142a768b30453271082739c8296206fd976020295b6d0159c6a7d7fc09
-  data.tar.gz: 86606787ebaf0ffa25c297d9fc56da7abe352b7394d5fd1b2a2bf84d4e4e33389190a4ff236a02957dfcd3a048485b6255bdd3816103ab7c42664b8cc9a8f5ec
+  metadata.gz: 70d6e4d6fb890c88bbb18c058c487e4c9bedcc0183562e6ef466f54c96c82701f635a2b7aa0af7da32747938ba14caea1098200cbd94a9d43068d9e3d54c8f14
+  data.tar.gz: a25bdf917df7f8479733e751051a08c9289c6c8beb8acc9c9068ff5b095e33c80c03e8e473e43c1f48083cddf6e8b41dfe94a82a38050d793db49e6d8edb1be8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.7.0 / 2014-08-24
+
+* Add init:rails-task for setup in Rails applications.
+
 # 0.6.3 / 2014-08-22
 
 * Fix bug: 'false' was not a coercible value.

data/README.md

@@ -2,11 +2,25 @@
 
 ### TL;DR ensure presence and type of your app's ENV-variables.
 
-This gem will provide:
-
-* 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)
+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
+
+## Contents
+
+* [Quickstart](#quickstart)
+* [Installation](#installation)
+* [Configuration](#configuration)
+  * [Types](#types)
+  * [Groups](#groups)
+  * [Defaults](#defaults)
+* [Rails](#rails)
+* [Command-line interface](#command-line-interface)
+* [Testing](#testing)
+* [Developing](#developing)
+* [Contributing](#contributing)
 
 ## Quickstart
 
@@ -23,7 +37,7 @@ variable :PORT, :Integer
 ### 2) Check for presence and coercibility
 
 ```ruby
-# file: some file that'll be run on initialization (e.g. `config/application.rb`)
+# during initialization
 ENVied.require
 ```
 
@@ -40,6 +54,24 @@ ENVied.PORT # => 3001
 ENVied.FORCE_SSL # => false
 ```
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'envied'
+
+...then bundle:
+
+    $ bundle
+
+...then for Rails applications:
+
+    $ bundle exec envied init:rails
+
+...or for non-Rails applications:
+
+    $ bundle exec envied init
+
 ## Configuration
 
 ### Types
@@ -154,7 +186,45 @@ ENVied.require(:default, :test, :ci)
 ENVied.require(:default, ENV['RACK_ENV'], (ENV['CI'] ? :ci : :not_ci))
 ```
 
-## command-line interface
+## Rails
+
+**tl;dr** use the `init:rails`-task to generate the necessary files for a Rails app (see [installation](#installation)).
+
+---
+
+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.
+
+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(:default, ENV['RAILS_ENV'])
+
+  Rails.configuration.force_ssl = ENVied.FORCE_SSL
+end
+```
+
+## Command-line interface
 
 ```bash
 $ envied help
@@ -164,22 +234,9 @@ Commands:
   envied check:heroku:binstub  # Generates a shell script for the check:heroku-task
   envied help [COMMAND]        # Describe available commands or one specific command
   envied init                  # Generates a default Envfile in the current working directory
+  envied init:rails            # Generate all files needed for a Rails project
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'envied'
-
-...then bundle:
-
-    $ bundle
-
-...and generate the `Envfile`:
-
-    $ bundle exec envied init
-
 ## Testing
 
 ```bash
@@ -196,7 +253,6 @@ bin/rake
 bin/pry --gem
 ```
 
-
 ## Contributing
 
 1. Fork it ( http://github.com/eval/envied/fork )

data/lib/envied.rb

@@ -99,6 +99,18 @@ class ENVied
     @instance = group_configuration.new(env)
   end
 
+  def self.springified_require(*args)
+    springify { ENVied.require(*args) }
+  end
+
+  def self.springify(&block)
+    if defined?(Spring) && Spring.respond_to?(:watcher)
+      Spring.after_fork(&block)
+    else
+      block.call
+    end
+  end
+
   def self.ensure_configured!
     # Backward compat: load Envfile only when it's present
     configure_via_envfile if envfile_exist?

data/lib/envied/cli.rb

@@ -11,6 +11,12 @@ class ENVied
       template("Envfile.tt")
     end
 
+    desc "init:rails", "Generate all files needed for a Rails project"
+    define_method "init:rails" do
+      init
+      template("rails-initializer.tt", 'config/initializers/envied.rb')
+    end
+
     desc "check", "Checks whether you environment contains the defined variables"
     long_desc <<-LONG
       Checks whether defined variables are present and valid in your shell.

data/lib/envied/templates/Envfile.tt

@@ -2,3 +2,7 @@
 # enable_defaults! { ENV['RACK_ENV'] != 'production' }
 
 # variable :REDIS_URL, :String, default: 'redis://localhost:6379'
+#
+# group :production do
+#   variable :MAIL_PASS_USERNAME, :String
+# end

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

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

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -116,6 +116,7 @@ files:
 - lib/envied/cli.rb
 - lib/envied/templates/Envfile.tt
 - lib/envied/templates/heroku-env-check.tt
+- lib/envied/templates/rails-initializer.tt
 - lib/envied/version.rb
 - spec/envied_spec.rb
 - spec/spec_helper.rb