Sha256: 7223d5cf2cf7d138106dfad0787751923d1a2091476bf053cd4b423c8d27558b

Contents?: true

Size: 1.41 KB

Versions: 3

Compression:

Stored size: 1.41 KB

Contents

# Figly

A simple config gem to use in either rails or any other ruby gem.

## Installation

Add this line to your application's Gemfile:

    gem 'figly'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install figly

## Usage

The only setup that's required is to set the path of you're configuration file that must be in YAML. Just throw the following code into an initializer:

    Figly.setup "path/to/config.yml"

If you're config looks like this:

    some_key: 234
	nest1:
	  nest2:
	    nest3: Yay

You can do the following:

    Figly::Settings.some_key
    #=> 234
    
    Figly::Settings.nest1
    #=> {"nest2" => {"nest3" => "Yay"}}
    
    Figly::Settings.nest1.nest2.nest3
    #=> "Yay"

## Testing    

If you want to contribute start by making sure the tests work. Also if you want to isolate the bundled gems to the sandbox (the path below is already in the .gitignore), run:

    bundle install --path vendor/bundle

To access a REPL environment that loads the libraries as well as does the initial setup with the `spec/support/config.yml` set as the path:

    ./bin/console
    
To run tests:

    rspec spec
    
## Contributing

1. Fork it ( https://github.com/onetwopunch/figly/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
figly-1.0.2 README.md
figly-1.0.1 README.md
figly-1.0.0.beta.0 README.md