envied 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f7fe8ec05529012ad80743d4f247714b22d369
-  data.tar.gz: ffbe2982c00e40da4d468447305b6670721de047
+  metadata.gz: dea71b6724a7a89b51486ea15c3149ce380b171b
+  data.tar.gz: da45f75d1b3a18765f8bc05e43a321c1c140906f
 SHA512:
-  metadata.gz: fa4e3adebfadefb43a023b953bfa0f92bb31b87199a8c6404ea0ffdcef542257b58d1981a36ed4105b9e3bb5a348f779a2b368f4c6425d9819b1106afc812b91
-  data.tar.gz: 43666f2884ea8a9bc6ffb6d1b1e24f102330d94787e9f51b72a7a6815e91802d7fa516b6eb95b405fe4c4530acb9fb8a4abbd0b066a8a89d3d87b67eb0b3a971
+  metadata.gz: bb5e335de481a06773babe4c479df4b2c7ea7b19d427961a91fdb3187f4c14470628d3bcca27c652c5a01743682840b9e95722ef6eefd45e7b3602ea46a7988c
+  data.tar.gz: 82a4c9d0f3b30cc807d27038ef6f1b48ddc601d9d650e8457d6ff8b1bb25848e51ce8d6ffcab9fc5faea5eb168e55439be2187564459aa6972d05a0bef6880cd

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# 0.5.0 / unreleased
+# 0.6.0 / 2014-08-13
+
+* Configuration should now be put in `Envfile`
+
+# 0.5.0 / 2014-07-02
 
 * add Array Hash types
 

data/README.md

@@ -12,18 +12,18 @@ This gem will provide:
 
 ### 1) Configure
 
-Let's configure the ENV-variables we need:
+After [successful installation](#installation), define some variables in `Envfile`:
 
 ```ruby
-ENVied.configure do
-  variable :FORCE_SSL, :Boolean
-  variable :PORT, :Integer
-end
+# file: Envfile
+variable :FORCE_SSL, :Boolean
+variable :PORT, :Integer
 ```
 
 ### 2) Check for presence and coercibility
 
 ```ruby
+# file: some file that'll be run on initialization (e.g. `config/application.rb`)
 ENVied.require
 ```
 
@@ -42,23 +42,37 @@ ENVied.FORCE_SSL # => false
 
 ## Configuration
 
+### Types
+
+The following types are supported:
+
+* `:String` (implied)
+* `:Boolean` (e.g. '0'/'1', 'f'/'t', 'false'/'true', 'off'/'on', 'yes','no' for resp. true or false)
+* `:Integer`
+* `: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']`)
+
 ### Groups
 
 Groups give you more flexibility to define when variables are needed.  
 It's similar to groups in a Gemfile:
 
 ```ruby
-ENVied.configure do
-  variable :FORCE_SSL, :Boolean
+# file: Envfile
+variable :FORCE_SSL, :Boolean
 
-  group :production do
-    variable :NEW_RELIC_LICENSE_KEY
-  end
+group :production do
+  variable :NEW_RELIC_LICENSE_KEY
 end
+```
 
+```ruby
 # For local development you would typically do:
 ENVied.require(:default) #=> Only ENV['FORCE_SSL'] is required
-# On the server:
+# On the production server:
 ENVied.require(:default, :production) #=> ...also ENV['NEW_RELIC_LICENSE_KEY'] is required
 
 # BTW the following are equivalent:
@@ -68,19 +82,6 @@ ENVied.require('default')
 ENVied.require(nil)
 ```
 
-### Types
-
-The following types are supported:
-
-* `:String` (implied)
-* `:Boolean` (e.g. '0'/'1', 'f'/'t', 'false'/'true', 'off'/'on', 'yes','no' for resp. true or false)
-* `:Integer`
-* `: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
 
 In order to let other developers easily bootstrap the application, you can assign defaults to variables.
@@ -89,13 +90,14 @@ 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:
 
 ```ruby
-ENVied.configure(enable_defaults: ENV['RACK_ENV'] == 'development') do
-  variable :FORCE_SSL, :Boolean, default: false
-  variable :PORT, :Integer, default: proc {|envied| envied.FORCE_SSL ? 443 : 80 }
-end
+# Envfile
+enable_defaults! { ENV['RACK_ENV'] == 'development' }
+
+variable :FORCE_SSL, :Boolean, default: false
+variable :PORT, :Integer, default: proc {|envied| envied.FORCE_SSL ? 443 : 80 }
 ```
 
-Please remember that ENVied only **reads** from ENV; it doesn't set ENV-variables.
+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.  
 As a rule of thumb you should only use defaults:
 * for local development
@@ -104,36 +106,37 @@ As a rule of thumb you should only use defaults:
 ### A more extensive example:
 
 ```ruby
+# Envfile
 # We allow defaults for local development (and local tests), but want our CI
 # to mimic our production as much as possible.
 # New developers that don't have RACK_ENV set, will in this way not be presented with a huge
 # list of missing variables, as defaults are still enabled.
 not_production_nor_ci = ->{ !(ENV['RACK_ENV'] == 'production' || ENV['CI']) }
-ENVied.configure(enable_defaults: &not_production_nor_ci) do
-  # Your code will likely not use ENVied.RACK_ENV (better use Rails.env),
-  # we want it to be present though; heck, we're using it in this file!
-  variable :RACK_ENV
-
-  variable :FORCE_SSL, :Boolean, default: false
-  variable :PORT, :Integer, default: 3000
-  # generate the default value using the value of PORT:
-  variable :PUBLIC_HOST_WITH_PORT, :String, default: proc {|envied| "localhost:#{envied.PORT}" }
-
-  group :production do
-    variable :MAIL_PAAS_USERNAME
-    variable :DATABASE_URL
-  end
-
-  group :ci do
-    # ci-only stuff
-  end
-
-  group :not_ci do
-    # CI needs no puma-threads, and sidekiq-stuff etc.
-    # Define that here:
-    variable :MIN_THREADS, :Integer, default: 1
-    # more...
-  end
+enable_defaults(&not_production_nor_ci)
+
+# Your code will likely not use ENVied.RACK_ENV (better use Rails.env),
+# we want it to be present though; heck, we're using it in this file!
+variable :RACK_ENV
+
+variable :FORCE_SSL, :Boolean, default: false
+variable :PORT, :Integer, default: 3000
+# generate the default value using the value of PORT:
+variable :PUBLIC_HOST_WITH_PORT, :String, default: proc {|envied| "localhost:#{envied.PORT}" }
+
+group :production do
+  variable :MAIL_PAAS_USERNAME
+  variable :DATABASE_URL
+end
+
+group :ci do
+  # ci-only stuff
+end
+
+group :not_ci do
+  # CI needs no puma-threads, and sidekiq-stuff etc.
+  # Define that here:
+  variable :MIN_THREADS, :Integer, default: 1
+  # more...
 end
 
 # Depending on our situation, we can now require the groups needed:
@@ -158,10 +161,14 @@ Add this line to your application's Gemfile:
 
     gem 'envied'
 
-And then execute:
+Then bundle:
 
     $ bundle
 
+And generate the `Envfile`:
+
+    $ bundle exec envied init
+
 ## Testing
 
 ```bash

data/envied.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "virtus", '~> 1.0.1'
-  spec.add_dependency "rack"
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_dependency "virtus", '~> 1.0'
+  spec.add_dependency "rack", "~> 1.4"
+  spec.add_dependency "thor", "~> 0.15"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", '~> 3.0.0'
+  spec.add_development_dependency "rspec", '~> 3.0'
 end

data/lib/envied.rb

@@ -1,3 +1,5 @@
+require 'envied/version'
+require 'envied/cli'
 require 'virtus'
 
 class ENVied
@@ -36,9 +38,14 @@ class ENVied
         @enable_defaults
     end
 
+    def self.enable_defaults!(value = nil, &block)
+      value ||= block if block_given?
+      @enable_defaults = value
+    end
+
     class << self
-      attr_writer :enable_defaults
       alias_method :defaults_enabled?, :enable_defaults
+      alias_method :enable_defaults=, :enable_defaults!
       attr_accessor :current_group
     end
 
@@ -56,8 +63,12 @@ class ENVied
     @configuration ||= build_configuration
   end
 
+  def self.configure(options = {}, &block)
+    deprecation_warning "ENVied.configure will be deprecated. Please generate an Envfile instead (see the envied command)."
+    configuration(options, &block)
+  end
+
   class << self
-    alias_method :configure, :configuration
     attr_accessor :required_groups
   end
 
@@ -75,6 +86,7 @@ class ENVied
     else
       self.required_groups = [:default]
     end
+    ensure_configured!
     error_on_missing_variables!
     error_on_uncoercible_variables!
 
@@ -87,6 +99,23 @@ class ENVied
     @instance = group_configuration.new(env)
   end
 
+  def self.ensure_configured!
+    # Backward compat: load Envfile only when it's present
+    configure_via_envfile if envfile_exists?
+  end
+
+  def self.envfile
+    File.expand_path('Envfile')
+  end
+
+  def self.envfile_exists?
+    File.exists?(envfile)
+  end
+
+  def self.configure_via_envfile
+    configuration { eval(File.read(ENVied.envfile)) }
+  end
+
   def self.error_on_missing_variables!
     if missing_variable_names.any?
       raise "Please set the following ENV-variables: #{missing_variable_names.sort.join(',')}"
@@ -190,4 +219,8 @@ class ENVied
   def self.respond_to_missing?(method, include_private = false)
     @instance.respond_to?(method) || super
   end
+
+  def self.deprecation_warning(msg)
+    puts "DEPRECATION WARNING: #{msg}"
+  end
 end

data/lib/envied/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+
+class ENVied
+  class Cli < Thor
+    include Thor::Actions
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "init", "Generate a default Envfile in the current working directory."
+    def init
+      puts "Writing new Envfile to #{File.expand_path('Envfile')}"
+      template("Envfile.tt")
+    end
+  end
+end

data/lib/envied/templates/Envfile.tt

@@ -0,0 +1,4 @@
+# A sample Envfile
+# enable_defaults! { ENV['RACK_ENV'] != 'production' }
+
+# variable :REDIS_URL, :String, default: 'redis://localhost:6379'

data/lib/envied/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,18 +86,19 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 description: Ensure presence and type of your app's ENV-variables.
 email:
 - gert@thinkcreate.nl
-executables: []
+executables:
+- envied
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,12 +109,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/envied
 - envied.gemspec
 - lib/envied.rb
+- lib/envied/cli.rb
+- lib/envied/templates/Envfile.tt
 - lib/envied/version.rb
 - spec/envied_spec.rb
 - spec/spec_helper.rb
-- underconstruction.gif
 homepage: https://github.com/eval/envied
 licenses:
 - MIT
@@ -112,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -120,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.0
 signing_key: 
 specification_version: 4
 summary: Ensure presence and type of ENV-variables