Conferrable

We have seen our applications gain more and more static configuration files over time. A common library we use on a daily basis is these configuration file loaders. Conferrable standardizes how we interact with these static YAML configuration files. It offers a simple and extendable API for dealing with the following scenarios:

Load a YAML file
Load a directory of YAML files
Load multiple YAML files

Installation

To install through Rubygems:

gem install install conferrable

You can also add this to your Gemfile:

bundle add conferrable

Examples

Simple Example

Lets say we have a configuration file located at:

<app root>/config/config.yaml

We can access this by:

config = Conferrable.get_config # config will be a hash

Note that the configuration file can also be called config.yml (three character extension).

Multiple File Example

Building on the simple example, say we have two configuration files:

<app root>/config/config1.yaml
<app root>/config/config2.yaml

We can now explicitly set the files:

files = [
  './config/config1.yaml',
  './config/config2.yaml',
]

Conferrable.set_filenames(:config, files)

config = Conferrable.get_config # config will be a hash

Alternatively, we could use a directory:

Conferrable.set_filenames(:config, './config')

config = Conferrable.get_config # config will be a hash

Note that the files will be loaded in alphabetical order.

ERB Support

If a configuration file ends in '.erb', then it will be pre-processed by the ERB templating system. For example, a file named config.yaml.erb would first be processed by ERB and then parsed as a YAML file. This is helpful when dealing with more complex YAML files.

Contributing

Development Environment Configuration

Basic steps to take to get this repository compiling:

Install Ruby (check conferrable.gemspec for versions supported)
Install bundler (gem install bundler)
Clone the repository (git clone [email protected]:bluemarblepayroll/conferrable.git)
Navigate to the root folder (cd conferrable)
Install dependencies (bundle)

Running Tests

To execute the test suite run:

bundle exec rspec spec --format documentation

Alternatively, you can have Guard watch for changes:

bundle exec guard

Also, do not forget to run Rubocop:

bundle exec rubocop

For convenience, the default rake task will run Rspec and Rubocop:

bundle exec rake

Publishing

Note: ensure you have proper authorization before trying to publish new versions.

After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:

Merge Pull Request into master
Update lib/conferrable/version.rb using semantic versioning
Install dependencies: bundle
Update CHANGELOG.md with release notes
Commit & push master to remote and ensure CI builds master successfully
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.

License

This project is MIT Licensed.