adamjonas / a9n

Simple tool for managing extra configuration in ruby/rails apps.

A9n

Simple tool for managing extra configuration in ruby/rails apps. Supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. Ruby 1.8 is not supported in version 0.1.2 and higher.

Installation

Add this line to your application's Gemfile:

gem 'a9n'

And then execute:

$ bundle

Add configuration.yml.example and/or configuration.yml file into the config directory. When none fo these files exists, A9n::MissingConfigurationFile exception is thrown. If both file exist, content of configuration.yml is validated. It means that all keys existing in example file must exist in base file - in case of missing keysA9n::MissingConfigurationVariables is thrown with information about missing keys.

Set application root and load configuration by adding to your application.rb or environment.rb right after budler requires:

A9n.root = File.expand_path('../..', __FILE__)
A9n.load

It works with Rails by default. If you want to use A9n with non-rails app you may need to tell it A9n:

A9n.local_app = MyApp

Usage

You can access any variable defined in configuration files but delegating it to A9n. E.g:

defaults:
  email_from: '[email protected]'
production:
  app_host: 'knapo.net'
development:
  app_host: 'localhost:3000'

is accessible by:

A9n.app_host   # => `knapo.net` in production and `localhost:3000` in development
A9n.email_from # => `[email protected]` in all envs

Custom and multiple configuration files

If you need to load config from custom files (e.g config/mongo.yml, config/other.yml and config/custom_dir/extra.yml), add:

A9n.load('mongo.yml', 'other.yml', 'custom_dir/extra')

and the configuration is availble under mongo, other and extra scopes:

A9n.mongo.varname

A9n.other.varname

A9n.extra.varname

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Contributors

• Grzegorz Świrski
• Jakub Łopusiński