fxnet-config

Fxnet::Config

Reading (node specific) config from files and from environment variables into a Hash like structure.

Installation

Add this line to your application's Gemfile:

gem 'fxnet-config'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fxnet-config

Usage

require 'fxnet/config'

config=Fxnet::Config.new(
 dirs: ['/node/configs'],
 prefix: 'GOOD__',
 add: { 'GOOD__MYSTUFF__HERE' => 'debug' }
)

config.dig(:mystuff,:here) == 'debug'
=> true

1. It will read all json config files from all directories (the directories are read in given order, the files in sorted order) and marged into a hash.
2. It will add all environment variables to the hash that begin with the prefix ('FXNET' is default). The variables are split at '__' and form a set of keys in the config hash
3. You can access all the parts of the config tree by #dig

That's it.

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/fixingthenet/fxnet-config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Fxnet::Config project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.