ENV Hash Configuration

ENV Hash Configuration is a trivial gem that makes it easy to transmogrify ENV into a configuration object suitable for application consumption.

Why use environment variables for configuration? The Twelve-Factor App explains the advantages.

Installation

Add this line to your application's Gemfile:

gem 'env_hash_config'

And then execute:

$ bundle

Or install it yourself as:

$ gem install env_hash_config

Usage

require 'env_hash_config'

config = EnvHashConfig.create

To specify default options:

EnvHashConfig.create default_options: { default: value }

To convert values into booleans:

EnvHashConfig.create boolean_options: [:boolean_one, :boolean_two]

The case sensitive string 'true' is the only value converted into true; all other values are converted into false. If you want a boolean option to default to true (instead of accessing an unknown key returning the falsey nil), add it to default_values, e.g. default_values: { boolean_one: true }.

To convert values into integers:

EnvHashConfig.create integer_options: [:integer_one, :integer_two]

To convert comma separated values into arrays:

EnvHashConfig.create array_options: [:array_one, :array_two]

To preprocess options:

EnvHashConfig.create do |h|
  h[:sum] = h[:integer_one] + h[:integer_two]
  h.delete :integer_one
  h.delete :integer_two
  h
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dinosaurjr10/env_hash_config.

License

The gem is available as open source under the terms of the MIT License.