fig_magic

Jeff Morgan made 2 very awesome gems called DataMagic & FigNewtown. I love them both, but I feel dirty having to do 2 initializations in my projects. By combining the 2 gems into a single package, you can have all the functions of each gem, but only one dir set + file load. Moreover, you can use a single namespace for both direct hash calls & hash of hashes calls.

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

FigMagic.yml_directory = 'data/yml'

If you do not specify a directory the gem will default to using a directory named _config/.

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

FigMagic.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 specific test, or use the namespaced keys method, detailed below.

Another option is to set an environment variable FIG_MAGIC_FILE. When this is set it will be used instead of the default.yml file.

Next we simply begin calling methods on the FigMagic module that match our keys. Let's assume the system_test.yml file contains the following entries:

base_url:  http://system_test.mycompany.com
database_user: cheezy
database_password: secret

In our code we can call methods that match the keys. Here is an example PageObject where we are using the base_url entry:

class MyPage
  include PageObject
  
  page_url "#{FigMagic.base_url}/my_page.html"
end

We can also supply default values which will be returned if the property does not exist:

class MyPage
  include PageObject
  
  page_url "#{FigMagic.base_url("http://cheezyworld.com")}/my_page.html"
end

If you have more complex data then you can utilize the data_for method that will return the data for a specific key. The most common way to use this is to include the FigMagic module in a page-object and then populate a page with the data. Here's an example:

class MyPage
  include PageObject
  include FigMagic
  
  ...
  
  def populate_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.

To organize your data into namespaces, and load that data just in time for testing, use namespaced keys instead:

  page.populate_page_with data_for "user_form/valid"

This will load user_form.yml, and populate the page with the valid: record therein.

Your data might look something like this:

my_page:
  name: Cheezy
  address: 123 Main Street
  email: cheezy@example.com
  pay_type: 'Credit card'

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

  page = MyPage.new
  my_data = page.data_for :my_test

You can call one of many built-in methods in your yaml file to randomize the data. Here is an example of how you would randomize the above yaml:

my_page:
  name: ~full_name
  address: ~street_address
  email: ~email_address
  pay_type: ~randomize ['Credit card', 'Purchase order', 'Check']

Here is a list of the built-in methods:

If you wish to add your own built-in methods you can simply pass a module to FigMagic and all of the methods will be available.

module MyData
  def abc
    'abc'
  end
end
   
FigMagic.add_translator MyData # this line must go in the same file as the module
    
# can now use ~abc in my yml files

The rdocs for this project can be found at rubydoc.info.

To see the changes from release to release please look at the ChangeLog

See http://github.com/tk8817/fig_magic/issues

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 (c) 2012-2013 Jeffrey S. Morgan & Justin Commu See LICENSE for details.