env_bang 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 220e4f75a1ec92e0ce04098d70ef4e163af873cf
+  data.tar.gz: e919ad22b321abf7936a2eb1f00d81d51d2078f5
+SHA512:
+  metadata.gz: 00edd476fb5125e6899e15e7c2e606d0f007bdebbf96557fe409acb0ef61d8ffa8f6d53465a5117695c955813893a645fdc407b35519e79f3dc122236e8b91a9
+  data.tar.gz: 3cc0b1d0080929e7215dc29ea449c1ca91c6b09c5fd941f6d307946a66a125567540ba457b8242b22989b4714532fe61ca8a4ab8ba3f876a4612c7d13fead935

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+bundler_args: --without=guard

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :metrics do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonathan Camenisch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+[![Build Status](https://secure.travis-ci.org/jcamenisch/ENV_BANG.png?branch=master)](https://travis-ci.org/jcamenisch/ENV_BANG)
+[![Dependency Status](https://gemnasium.com/jcamenisch/ENV_BANG.png)](https://gemnasium.com/jcamenisch/ENV_BANG)
+[![Code Climate](https://codeclimate.com/github/jcamenisch/ENV_BANG.png)](https://codeclimate.com/github/jcamenisch/ENV_BANG)
+[![Coverage Status](https://coveralls.io/repos/jcamenisch/ENV_BANG/badge.png?branch=master)](https://coveralls.io/r/jcamenisch/ENV_BANG)
+
+# ENV! 
+
+Do a bang-up job managing your environment variables.
+
+ENV! provides a thin wrapper around ENV to accomplish a few things:
+
+- Provide a central place to specify what environment variables you intend to use
+- Fail loudly with an informative error message if environment variables are not
+  properly configured.
+- Prevent an application from starting up if a needed environment variable is not set.
+  (This is especially helpful in environment like Heroku, as it prevents launch of a
+  new version of your app if it depends on missing environment variables—a problem
+  that might go unnoticed until your customers come across a 500 error.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'env_bang'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install env_bang
+
+## Usage
+
+### Basic Configuration
+
+First, configure your environment variables somewhere in your app’s
+startup process. In a Rails app, this could live in `config/initializers/env.rb`.
+
+```ruby
+ENV!.config do
+  use 'APP_HOST'
+  use 'RAILS_SECRET_TOKEN'
+  use 'STRIPE_SECRET_KEY'
+  use 'STRIPE_PUBLISHABLE_KEY'
+  # ... etc.
+end
+```
+
+A single variable can also be configured with `ENV!.use MY_VAR`, but the `ENV!.config` block
+will typically contain all the variables for your app.
+
+Once a variable is specified with `ENV!.use`, you can access it with
+
+```ruby
+ENV!['MY_VAR']
+```
+
+This will function just like accessing the environment variable directly, except that it will
+require the variable to be specified with `ENV!.use`, and present in the current environment.
+If either of these conditions is not met, a KeyError will be raised with an explanation of
+what needs to be configured.
+
+### Adding a default value
+
+In some cases, you don't need to require each environment to set a variable explicitly.
+You might have a reasonable default value that can be overridden. You can specify a default
+value with the `:default` option:
+
+```ruby
+ENV!.config do
+  # ...
+  use MAIL_DELIVERY_METHOD, default: :smtp
+  # ...
+end
+```
+
+### Adding a description
+
+When a new team members installs or deploys your project, they may run into a missing
+environment variable error. It can save them a great deal of time to include documentation
+on the missing environment variable directly in the error that is raised. To accomplish this,
+provide a description (of any length) to the `use` method:
+
+```ruby
+ENV!.config do
+  use 'RAILS_SECRET_KEY_BASE',
+      'Generate a fresh one with `SecureRandom.urlsafe_base64(64)`; see http://guides.rubyonrails.org/security.html#session-storage'
+end
+```
+
+If someone installs or deploys the app and forgets to set the RAILS_SECRET_KEY_BASE variable in
+their environment, they will see these instructions immediately upon running the app.
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/env_bang.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'env_bang/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_bang"
+  spec.version       = ENV_BANG::VERSION
+  spec.authors       = ["Jonathan Camenisch"]
+  spec.email         = ["jonathan@camenisch.net"]
+  spec.summary       = %q{Do a bang-up job managing your environment variables}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.1"
+end

data/lib/env_bang/version.rb

@@ -0,0 +1,3 @@
+class ENV_BANG
+  VERSION = "0.1"
+end

data/lib/env_bang.rb

@@ -0,0 +1,43 @@
+require "env_bang/version"
+
+class ENV_BANG
+  class << self
+    def config(&block)
+      instance_eval(&block)
+    end
+
+    def use(var, *args)
+      description = args.first.is_a?(String) && args.shift
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      unless ENV.has_key?(var)
+        ENV[var] = options.fetch(:default) do
+          message = "Missing required environment variable: #{var}"
+          message << "--#{description}" if description
+          indent = '    '
+          raise KeyError.new "\n#{indent}#{message.gsub "\n", "\n#{indent}"}\n"
+        end
+      end
+
+      used_vars << var
+    end
+
+    def used_vars
+      @used_vars ||= Set.new
+    end
+
+    def [](var)
+      raise KeyError.new("ENV_BANG is not configured to use var #{var}") unless used_vars.include?(var)
+
+      ENV[var]
+    end
+
+    def method_missing(method, *args, &block)
+      ENV.send(method, *args, &block)
+    end
+  end
+end
+
+def ENV!
+  ENV_BANG
+end

data/test/env_bang_test.rb

@@ -0,0 +1,47 @@
+require_relative 'test_helper'
+
+describe ENV_BANG do
+  it "Raises exception if unconfigured ENV var requested" do
+    ENV['UNCONFIGURED'] = 'unconfigured'
+    proc { ENV!['UNCONFIGURED'] }.must_raise KeyError
+  end
+
+  it "Raises exception if configured ENV var is not present" do
+    ENV.delete('NOT_PRESENT')
+
+    proc {
+      ENV!.config do
+        use 'NOT_PRESENT'
+      end
+    }.must_raise KeyError
+  end
+
+  it "Includes provided description in error message" do
+    ENV.delete('NOT_PRESENT')
+
+    e = proc {
+      ENV!.config do
+        use 'NOT_PRESENT', 'You need a NOT_PRESENT var in your ENV'
+      end
+    }.must_raise(KeyError)
+    e.message.must_include 'You need a NOT_PRESENT var in your ENV'
+  end
+
+  it "Uses provided default value if ENV var not already present" do
+    ENV.delete('WASNT_PRESENT')
+
+    ENV!.config do
+      use 'WASNT_PRESENT', default: 'a default value'
+    end
+    ENV!['WASNT_PRESENT'].must_equal 'a default value'
+  end
+
+  it "Returns actual value from ENV if present" do
+    ENV['PRESENT'] = 'present in environment'
+
+    ENV!.config do
+      use 'PRESENT', default: "You won't need this."
+    end
+    ENV!['PRESENT'].must_equal 'present in environment'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'env_bang'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: env_bang
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jonathan Camenisch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: ''
+email:
+- jonathan@camenisch.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env_bang.gemspec
+- lib/env_bang.rb
+- lib/env_bang/version.rb
+- test/env_bang_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Do a bang-up job managing your environment variables
+test_files:
+- test/env_bang_test.rb
+- test/test_helper.rb