A9n is a simple tool to keep ruby/rails application configuration maintanable. It supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. 2.1. Ruby 1.8 is not supported since version 0.1.2.
Why it's named a9n? It's a numeronym of application (where 9 stands for the number of letters between the first a and last n, similar to i18n or l10n).
Add this line to your application's Gemfile:
And then execute:
configuration.yml file into the config
directory. When none fo these files exists,
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 local file - in case of missing
A9n::MissingConfigurationVariables is thrown with the explanation what is missing.
Set application root and load configuration by adding to your
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 that to A9n by:
A9n.local_app = MyApp
You can access any variable defined in configuration files by delegating it to
defaults: email_from: 'firstname.lastname@example.org' 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@example.com` in both envs
Custom and multiple configuration files
If you want to scope configuration you may split to multiple files. All files from
config/a9n are loaded by default, but you may pass custom paths as an argument to
A9n.load('lib/facebook/api.yml', 'config/mongoid.yml'). In such cases config items are accessialbe via scope consistient with the file name.
E.g. if you have
defaults: username: "joe" api_key: "1234asdf"
you can access it by:
A9n.mandrill.username # => `joe` A9n.mandrill.api_key # => `1234asdf`
If you use capistrano and you feel safe enough to keep all your instance (e.g. staging or production) configuration in your repository you may use capistrano extentions.
Just add an instance configuration file e.g.
configuration.yml.production - extension needs to be consistient with capistrano stage, and add
to your deploy.rb file. This way
configuration.yml.<stage> will be copied and overide
configuration.yml on each deploy.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request