env-conf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9df5435035857289037f37777072719bbf03be22
+  data.tar.gz: ac4f1828b1977324d88817f0cb0e66d761e16c18
+SHA512:
+  metadata.gz: 7cfa1abae140f8a877dc8ee1ef51989b8b342a02a0269e66042b8db80cec4d6d7eef253f94c7aeb7915cc40bc2e677bde86189b2a64ce3d919a55beb9cc9a11d
+  data.tar.gz: 7a9830f7ea6a82972cd738e62fe2f41addb0941dd2517fed19e6302be5d79f9990efed6f5bdfb3aa3240428c6d5281377a2d27f30dca7a060f3dfdedf62449d7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in env-conf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Continanza
+
+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,58 @@
+# env-conf
+## a better `Config`
+
+Provides a better way to configure the application than simply pulling
+strings from `ENV`.
+
+#### defaults
+
+```ruby
+Config[:foo]
+# => nil
+
+Config.default(:foo, 'bar')
+Config[:foo]
+# => 'bar'
+Config['FOO']
+# => 'bar'
+```
+
+#### type casts
+
+Returns `nil` when undefined, otherwise casts to indicated type.
+
+```ruby
+Config.int(:max_connections)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'env-conf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install env-conf
+
+## Usage
+
+```ruby
+require 'env-conf'
+
+Config[:foo]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/env-conf/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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/env-conf.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'env-conf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "env-conf"
+  spec.version       = Config::VERSION
+  spec.authors       = ["Chris Continanza"]
+  spec.email         = ["christopher.continanza@gmail.com"]
+  spec.summary       = %q{Use ENV vars for Configuration}
+  spec.description   = %q{Follwing 12-factor principles, we use the ENV vars for configuration.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/env-conf/version.rb

@@ -0,0 +1,6 @@
+# Unset Ruby's deprecated Config class to make room for ours
+Object.send(:remove_const, :Config) if defined?(Config)
+
+module Config
+  VERSION = '0.0.1'
+end

data/lib/env-conf.rb

@@ -0,0 +1,169 @@
+require_relative './env-conf/version'
+
+module Config
+  @@defaults = {}
+
+  # Get a Config value
+  #
+  # This is the preferred and uniform way to access config vars because
+  # defaults are included in the lookup
+  #
+  # Uses defaults if available.  Converts upper-case ENV var names
+  # to lower-case default names.
+  #
+  # Order of precedence is:
+  # 1) app's local ENV
+  # 2) default values
+  #
+  # Config[:foo] == nil
+  #
+  # Config.default(:foo, 'bar')
+  # Config[:foo] == 'bar'
+  #
+  # ENV['FOO'] = 'baz'
+  # Config[:foo] == 'baz'
+  #
+  # @param key [Symbol] The lower-case name of the ENV value
+  # @return [String] The value of the ENV value or default.
+  def self.[](name)
+    var_name = name.to_s.upcase
+    default_name = name.to_s.downcase.to_sym
+    ENV[var_name] || @@defaults[default_name]
+  end
+
+  # Reset defaults values
+  def self.reset!
+    @@defaults = {}
+  end
+
+  # An environment variable.
+  #
+  # @param name [String] The name of the environment variable to fetch a
+  #   value for.
+  # @return [String] The value of the environment variable or nil if no
+  #   match is available.
+  def self.env(name)
+    self[name]
+  end
+
+  # Set a default
+  # Defaults are supplied when accessing via Config[:varname]
+  #
+  # @param key [Symbol/String] The lower-case name of the default
+  # @return [String] The value of the default
+  def self.default(key, value)
+    @@defaults[key.to_s.downcase.to_sym] = value
+  end
+
+  # Get all the defaults
+  # @return [Hash] The current set of defaults
+  def self.defaults
+    @@defaults
+  end
+
+  # An environment variable.
+  #
+  # @param name [String] The name of the environment variable to fetch a
+  #   value for.
+  # @raise [RuntimeError] Raised if the environment variable is not defined.
+  # @return [String] The value of the environment variable.
+  def self.env!(name)
+    self[name] || raise("missing #{name}")
+  end
+
+  # The `RACK_ENV` environment variable is used to determine whether the
+  # service is in production mode or not.
+  #
+  # @return [Bool] True if the service is in production mode.
+  def self.production?
+    self['RACK_ENV'] == 'production'
+  end
+
+  # The `RACK_ENV` environment variable is used to determine whether the
+  # service is in test mode or not.
+  #
+  # @return [Bool] True if the service is in test mode.
+  def self.test?
+    self['RACK_ENV'] == 'test'
+  end
+
+  # The `APP_NAME` env var is used to identify which codebase is
+  # running in librato.  This usually matches the name of the repository.
+  #
+  # @return [String] The name of the app
+  def self.app_name
+    env("APP_NAME")
+  end
+
+  # The `APP_DEPLOY` env var is used to identify which deploy of the codebase is
+  # running in librato.  This usually matches the name of the environment such
+  # as local, production, staging, etc.
+  #
+  # @return [String] The deploy/environment of the app
+  def self.app_deploy
+    env("APP_DEPLOY")
+  end
+
+  # The port to listen on for web requests.
+  #
+  # @return [Fixnum] The port to listen on for web requests.
+  def self.port
+    env!("PORT").to_i
+  end
+
+  # The database URL from the environment.
+  #
+  # @param kind [String] Optionally, the leading name of `*_DATABASE_URL`
+  #   environment variable.  Defaults to `DATABASE_URL`.
+  # @raise [RuntimeError] Raised if the environment variable is not defined.
+  def self.database_url(kind = '')
+    kind = "#{kind}_".upcase unless kind.empty?
+    env!("#{kind}DATABASE_URL")
+  end
+
+  # An environment variable converted to a Fixnum.
+  #
+  # @param name [String] The name of the environment variable to fetch a
+  #   Fixnum for.
+  # @return [Fixnum] The number or nil if the value couldn't be coerced to a
+  #   Fixnum.
+  def self.int(name)
+    self[name] && self[name].to_i
+  end
+
+  # Comma-separated words converted to an array.
+  #
+  # @param name [String] The name of the environment variable to fetch an
+  #   array for.
+  # @raise [RuntimeError] Raised if the environment variable is not defined.
+  # @return [Array] An array of values.
+  def self.array(name)
+    env(name).to_s.split(',')
+  end
+
+  # An environment variable converted to a bool.
+  #
+  # @param name [String] The name of the environment variable to fetch a
+  #   boolean for.
+  # @return [bool] True if the value is `true`, otherwise false.
+  def self.bool?(name)
+    self[name] == true || self[name] == 'true'
+  end
+
+  # An environment variable converted to a time.
+  #
+  # @param name [String|Symbol] The name of the environment variable to fetch a
+  #   boolean for.
+  # @return [Time] Time if the value is parseable, otherwise false.
+  def self.time(name)
+    self[name] && Time.parse(self[name])
+  end
+
+  # An environment variable converted to a URI.
+  #
+  # @param name [String|Symbol] The name of the environment variable.
+  # @return [URI] URI if the value is parseable, otherwise false.
+  def self.uri(name)
+    self[name] && URI.parse(self[name])
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,216 @@
+# note: this would all go in a test/helper if we had 
+# more than one test file
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'env-conf'
+
+module EnvironmentHelpers
+  # Override an environment variable in the current test.
+  def set_env(key, value)
+    overrides[key] = ENV[key] unless overrides.has_key?(key)
+    ENV[key] = value
+  end
+
+  # Restore the environment back to its state before tests ran.
+  def teardown
+    overrides.each { |key, value| ENV[key] = value }
+    super
+  end
+
+  private
+  # The overridden environment variables to restore when the test finishes.
+  def overrides
+    @overrides ||= {}
+  end
+end
+
+# end note
+
+class ConfigTest < Minitest::Test
+  include EnvironmentHelpers
+
+  def teardown
+    super
+    Config.reset!
+  end
+
+  # Config.env returns the value matching the specified environment
+  # variable name.
+  def test_env
+    ENV['VALUE'] = 'value'
+    set_env('VALUE', 'value')
+    assert_equal(Config.env('VALUE'), 'value')
+    ENV['VALUE'] = nil
+  end
+
+  # Config[] returns the value matching the specified environment
+  # variable name.
+  def test_brackets
+    set_env('VALUE', 'value')
+    assert_equal(Config[:value], 'value')
+    assert_equal(Config['VALUE'], 'value')
+  end
+
+  # Config.env return nil if an unknown environment variable is
+  # requested.
+  def test_env_with_unknown_name
+    assert_equal(Config.env('UNKNOWN'), nil)
+  end
+
+  # Config.env! returns the value matching the specified environment
+  # variable name.
+  def test_env!
+    set_env('VALUE', 'value')
+    assert_equal(Config.env!('VALUE'), 'value')
+  end
+
+  # Config.env! raises a RuntimeError if an unknown environment
+  # variable is requested.
+  def test_env_with_unknown_name!
+    error = assert_raises RuntimeError do
+      Config.env!('UNKNOWN')
+    end
+    assert_equal(error.message, 'missing UNKNOWN')
+  end
+
+  # Config.production? is true when RACK_ENV=production.
+  def test_production_mode
+    set_env 'RACK_ENV', nil
+    refute Config.production?
+    set_env 'RACK_ENV', 'production'
+    assert Config.production?
+  end
+
+  # Config.test? is true when RACK_ENV=test.
+  def test_test_mode
+    set_env 'RACK_ENV', nil
+    refute Config.test?
+    set_env 'RACK_ENV', 'test'
+    assert Config.test?
+  end
+
+  # Returns DATABASE_URL with no params.
+  def test_database_url
+    set_env 'DATABASE_URL', "postgres:///foo"
+    assert_equal(Config.database_url, 'postgres:///foo')
+  end
+
+  # Returns #{kind}_DATABASE_URL with one param
+  def test_database_url_takes_and_capitalizes_params
+    set_env 'FOO_DATABASE_URL', "postgres:///foo"
+    assert_equal(Config.database_url('foo'), 'postgres:///foo')
+    assert_equal(Config.database_url(:foo), 'postgres:///foo')
+  end
+
+  # Config.database_url raises a RuntimeError if no DATABASE_URL
+  # environment variables is defined.
+  def test_database_url_raises_when_not_found
+    assert_raises RuntimeError do
+      Config.database_url('foo')
+    end
+  end
+
+  # Config.app_name returns the value of the APP_NAME environment
+  # variable.
+  def test_app_name
+    set_env 'APP_NAME', "my-app"
+    assert_equal('my-app', Config.app_name)
+  end
+
+  # Config.app_deploy returns the value of the APP_DEPLOY environment
+  # variable.
+  def test_app_deploy
+    set_env 'APP_DEPLOY', "test"
+    assert_equal('test', Config.app_deploy)
+  end
+
+  # Config.port raises a RuntimeError if no `PORT` environment variable
+  # is defined.
+  def test_port_raises
+    assert_raises RuntimeError do
+      Config.port
+    end
+  end
+
+  # Config.port converts the value from the environment to a Fixnum
+  def test_port_convert_to_int
+    set_env 'PORT', "3000"
+    assert_equal(3000, Config.port)
+  end
+
+  # Config.int(VAR) returns nil or VAR as integer.
+  def test_int
+    assert_equal(nil, Config.int('FOO'))
+    set_env 'FOO', "3000"
+    assert_equal(3000, Config.int('FOO'))
+    assert_equal(3000, Config.int(:foo))
+  end
+
+  # Config.time returns nil or VAR as time
+  def test_time
+    assert_equal(nil, Config.time('T'))
+=begin
+    set_env 'T', '2000'
+    assert_equal(Time.utc(2000), Config.time(:t))
+    set_env 'T', '2000-2'
+    assert_equal(Time.utc(2000,2), Config.time(:t))
+=end
+    set_env 'T', '2000-2-2'
+    assert_equal(Time.new(2000,2,2), Config.time(:t))
+
+    set_env 'T', '2000-2-2T11:11'
+    assert_equal(Time.new(2000,2,2,11,11), Config.time(:t))
+  end
+
+  # Config.time returns nil or VAR as URI
+  def test_uri
+    assert_equal(nil, Config.uri('URL'))
+    set_env 'URL', 'http://user:password@the-web.com/path/to/greatness?foo=bar'
+    uri = Config.uri('URL')
+    assert_equal('http', uri.scheme)
+    assert_equal('the-web.com', uri.host)
+    assert_equal('/path/to/greatness', uri.path)
+    assert_equal('foo=bar', uri.query)
+    assert_equal(80, uri.port)
+    assert_equal('user', uri.user)
+    assert_equal('password', uri.password)
+  end
+
+  # Config.array loads a comma-separated list of words into an array of
+  # strings.
+  def test_array
+    set_env 'ARRAY', ''
+    assert_equal([], Config.array('ARRAY'))
+    set_env 'ARRAY', 'apple'
+    assert_equal(['apple'], Config.array('ARRAY'))
+    set_env 'ARRAY', 'apple,orange,cherry'
+    assert_equal(['apple', 'orange', 'cherry'], Config.array('ARRAY'))
+  end
+
+  # Config.bool?(var) is only true if the value of var is the string
+  # 'true'.  If the var is absent or any other value, it evaluates to false.
+  def test_bool_returns_true
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+    set_env 'VAULT_BOOLEAN_VAR', 'true'
+    assert_equal(true, Config.bool?('VAULT_BOOLEAN_VAR'))
+
+    Config.default(:foo, true)
+    assert_equal(true, Config.bool?(:foo))
+  end
+
+  # Config.bool?(var) is false if the value of var is anything other
+  # than the string 'true'.
+  def test_bool_returns_false
+    set_env 'VAULT_BOOLEAN_VAR', 'false'
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+    set_env 'VAULT_BOOLEAN_VAR', 'foo'
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+    set_env 'VAULT_BOOLEAN_VAR', '1'
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+
+    Config.default(:foo, false)
+    assert_equal(false, Config.bool?(:foo))
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: env-conf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Continanza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Follwing 12-factor principles, we use the ENV vars for configuration.
+email:
+- christopher.continanza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env-conf.gemspec
+- lib/env-conf.rb
+- lib/env-conf/version.rb
+- test/config_test.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.2.2
+signing_key: 
+specification_version: 4
+summary: Use ENV vars for Configuration
+test_files:
+- test/config_test.rb