fig_magic 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9a794f495dcbdcd59132d32cfd304c263c9c162
-  data.tar.gz: ef377b953fcb75707ec632b319f9db93f6213f83
+  metadata.gz: bf044e9dc6a0ce8bd0a41ff6e0a232e2613f8dd0
+  data.tar.gz: fd8981061fd4be2f898faf21defc21811b3b04f1
 SHA512:
-  metadata.gz: d1f4769c65d3a439df5a6df81c4126cd999fd1a2e9d9da21ee92d1c0137ff0a3aba9a2df378402236c4819e6fd4b285afbbc851da1a8ab726bd770c035198296
-  data.tar.gz: 9b0f55ed9e0807f3f8fc3710ac3da624c9cdc66ffc007b7f43fb165a3529c546232fbb6a705357e93e8f91545fa9b5605b00df65ed539ba8ea75c9a7b96038a9
+  metadata.gz: 60580d5c8822b2540e62cbec36bd9b7ee7c5fa330ca6947d750e730ce9e2d7c69a6afc012bf894aa30492ab74700d43b92bc5b76fa385dee345577fec1b75ec8
+  data.tar.gz: 0b7875cc837a6cc28026657be73a328880f2ddcda108db8b6cbe3e7c19de8ca2b76c72fa9509d42805e4de02e0abcabe34f7fce2a1ed5843a8a1222d223314b6

data/ChangeLog

@@ -1,3 +1,6 @@
+=== Version 0.3 / 2015-11-20
+Updated README to detail why this gem exists and give thanks to Jeff Morgan
+
 === Version 0.2 / 2015-11-20
 Fixed Require Statements
 

data/README.md

@@ -1,9 +1,8 @@
 # fig_magic
 
-[![Build Status](http://travis-ci.org/cheezy/fig_magic.png)](http://travis-ci.org/cheezy/fig_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.
+Jeff Morgan (@cheezy) made 2 very awesome gems called DataMagic & FigNewtown. I love them both, but I feel dirty having to do 2 initializations in my projects. initializing both for the same location & file. hate having to initialize 
+By combining the 2 gems into a single package, you can have all the functions of each gem, but only one file page set + file load. Moreover, you can use a single namespace for
+both direct hash calls & hash of hashes calls. 
 
 ## Using
 
@@ -13,7 +12,7 @@ In order to use _fig_magic_ you will have to inform the gem where it can find th
 FigMagic.yml_directory = 'data/yml'
 ````
 
-If you do not specify a directory the gem will default to using a directory named _config/data_. 
+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.
 
@@ -23,9 +22,36 @@ 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 DATA_MAGIC_FILE.  When this is set it will be used instead of the _default.yml_ file.
+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:
+
+````ruby
+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:
+````ruby
+class MyPage
+  include PageObject
+  
+  page_url "#{FigMagic.base_url("http://cheezyworld.com")}/my_page.html"
+end
+````
 
-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 _FigMagic_ module in a [page-object](https://github.com/cheezy/page-object) and then populate a page with the data.  Here's an example:
+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](https://github.com/cheezy/page-object) and then populate a page with the data.  Here's an example:
 
 ````ruby
 class MyPage
@@ -120,15 +146,15 @@ FigMagic.add_translator MyData # this line must go in the same file as the modul
 
 ## Documentation
 
-The rdocs for this project can be found at [rubydoc.info](http://rubydoc.info/github/cheezy/fig_magic/master/frames).
+The rdocs for this project can be found at [rubydoc.info](http://rubydoc.info/github/tk8817/fig_magic/master/frames).
 
-To see the changes from release to release please look at the [ChangeLog](https://raw.github.com/cheezy/fig_magic/master/ChangeLog)
+To see the changes from release to release please look at the [ChangeLog](https://raw.github.com/tk8817/fig_magic/master/ChangeLog)
 
 
 
 ## Known Issues
 
-See [http://github.com/cheezy/fig_magic/issues](http://github.com/cheezy/fig_magic/issues)
+See [http://github.com/cheezy/fig_magic/issues](http://github.com/tk8817/fig_magic/issues)
 
 ## Contributing
 
@@ -142,4 +168,4 @@ Please ensure all contributions contain proper tests.
 
 ## Copyright
 
-Copyright (c) 2012-2013 Jeffrey S. Morgan. See LICENSE for details.
+Copyright (c) 2012-2013 Jeffrey S. Morgan & Justin Commu See LICENSE for details.

data/lib/fig_magic/version.rb

@@ -1,3 +1,3 @@
 module FigMagic
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fig_magic
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Justin Commu