Sha256: 2f71a714b7f7ebb630e15fc62d75ff09f349f49a957954f013c77c6a61a76a2a

Contents?: true

Size: 1.46 KB

Versions: 2

Compression:

Stored size: 1.46 KB

Contents

# A9n

[![Build status](https://secure.travis-ci.org/knapo/a9n.png)](https://travis-ci.org/knapo/a9n)

Simple tool for managing ruby/rails application configurations.

## 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
keys`A9n::MissingConfigurationVariables` is thrown with information about 
missing keys.

Load configuration by adding to your `application.rb` or `environment.rb` right
after budler requires:

    A9n.load

This step is not required, but recommended, as it configuration is loaded and
verified on evironment load.

It works with `Rails` by default. If you want to use `A9n` with non-rails app
you 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:

    production:
      app_host: 'http://knapo.net'

is accessible by:

    A9n.app_host

## 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

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
a9n-0.0.8 README.md
a9n-0.0.7 README.md