# data_magic

[![Build Status](http://travis-ci.org/cheezy/data_magic.png)](http://travis-ci.org/cheezy/data_magic)

An easy to use gem that provides datasets that can be used by your application
and tests.  The data is stored in yaml files.

## Using

In order to use _data_magic_ you will have to inform the gem where it can find the yaml files.  You can do this with the following code:

````ruby
DataMagic.yml_directory = 'data/yml'
````

If you do not specify a directory the gem will default to using a directory named _config_. You should only have to set the directory once.

After setting the directory you must load a file.  This can be accomplished by calling the _load_ method.

````ruby
DataMagic.load 'filename.yml'
````

If you do not specify a filename the gem will attempt to use a file named _default.yml_.  If you are using this for testing you will more than likely want to call load before each test to load the proper data for the spcific test.

The final thing to do is use the data.  The gem has a _data_for_ method that will return the data for a specific key.  The most common way to use this is to include the _DataMagic_ module in a [page-object](https://github.com/cheezy/page-object) and then populate a page with the data.  Here's an example:

````ruby
class MyPage
  include PageObject
  include DataMagic
  
  ...
  
  def populage_page
    populate_page_with data_for :my_page
  end
end
````

Notice that I am including the module on line 3.  On lin 8 I am calling the _data_for_ method passing the key _:my_page_.  The _populate_page_with_ method is a part of the page-object gem.

In order to access the data directly you can just call the method on the module like this:

````ruby
  my_data = DataMagic.data_for :my_test
````

## Known Issues

See [http://github.com/cheezy/data_magic/issues](http://github.com/cheezy/data_magic/issues)

## Contributing

Please ensure all contributions contain proper tests.

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

## Copyright

Copyright (c) 2012 Jeffrey S. Morgan. See LICENSE for details.