fig_magic 0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+fig_magic

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.7

data/ChangeLog

@@ -0,0 +1,2 @@
+=== Version 0.1 / 2012-1-21
+Initial Release

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+gem 'growl'
+gem 'guard-rspec'
+gem 'guard-cucumber'
+gem 'fuubar'
+gem 'fuubar-cucumber'
+
+# Specify your gem's dependencies in fig_magic.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', cmd: 'rspec --color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'cucumber', :notification => true, :cli => '--profile focus' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/.+\.rb$})                   { 'features' }
+  watch(%r{^features/yaml/.+$})             { 'features' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeffrey S. Morgan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+# 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.
+
+## Using
+
+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:
+
+````ruby
+FigMagic.yml_directory = 'data/yml'
+````
+
+If you do not specify a directory the gem will default to using a directory named _config/data_. 
+
+After setting the directory you must load a file.  This can be accomplished by calling the _load_ method.
+
+````ruby
+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.
+
+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:
+
+````ruby
+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:
+
+````ruby
+  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:
+
+````ruby
+  page = MyPage.new
+  my_data = page.data_for :my_test
+````
+
+## Data generators
+
+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:
+
+| built-in methods | built-in methods |
+| --- | --- |
+| first_name  last_name |
+| last_name | full_name | 
+| name_prefix | name_suffix | 
+| title | street_address(include_secondary=false) |
+| secondary_address | city |
+| state | state_abbr |
+| zip_code | country |
+| company_name | catch_phrase |
+| words(number = 3) | sentence(min_word_count = 4) |
+| sentences(sentence_count = 3) | paragraphs(paragraph_count = 3) |
+| characters(character_count = 255) | email_address(name = nil) | 
+| domain_name | url | 
+| user_name | 
+| phone_number | cell_phone | 
+| randomize([]) | randomize(1..4) | 
+| mask -  #=num a=lower A=upper |
+| today(format = '%D') | tomorrow(format = '%D') |
+| yesterday(format = '%D') | 
+| 3.days_from_today(format = '%D') | 3.days_ago(format = '%D') |
+| month | month_abbr | 
+| day_of_week | day_of_week_abbr |
+| sequential([]) | sequential(1..4)|
+
+
+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.
+
+````ruby
+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
+````
+
+## Documentation
+
+The rdocs for this project can be found at [rubydoc.info](http://rubydoc.info/github/cheezy/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)
+
+
+
+## Known Issues
+
+See [http://github.com/cheezy/fig_magic/issues](http://github.com/cheezy/fig_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-2013 Jeffrey S. Morgan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+Cucumber::Rake::Task.new(:features, "Run features") do |t|
+  t.profile = "default"
+end
+
+desc 'Run all specs and cukes'
+task :test => ['spec', 'features']
+
+task :lib do
+  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
+end
+
+task :default => :test

data/config/data/default.yml

@@ -0,0 +1,3 @@
+dm:
+  value1: this is value 1
+  value2: this is value 2

data/config/data/user.yml

@@ -0,0 +1,3 @@
+valid:
+  name: Testy McTesterson
+  job: Tester

data/config/environments/default.yml

@@ -0,0 +1 @@
+base_url: 'http://cheezyworld.com'

data/config/yaml/sample.yml

@@ -0,0 +1 @@
+from_the_env_file: read from the env file

data/config/yaml/test_config.yml

@@ -0,0 +1,14 @@
+base_url: 'http://cheezyworld.com'
+
+database:
+  username: steve
+  password: secret
+
+first:
+  second:
+    third: foo
+    fourth: bar
+
+port: 1234
+set_flag: true
+cleared_flag: false

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --no-source --color --format pretty
+focus: --no-source --color --format pretty --tags @focus

data/features/data_magic.feature

@@ -0,0 +1,124 @@
+Feature: Functionality of the fig_magic gem
+  
+  Background:
+    Given I have read the yaml file from features/yaml
+    When I ask for the data for "dm"
+
+  Scenario: Getting basic data from the yaml
+    Then the value for "value1" should be "this is value 1"
+    And the value for "value2" should be "this is value 2"
+
+  Scenario: Getting names from the yaml
+    Then the value for "full_name" should have a minimum of 2 words
+    And the value for "first_name" should be 1 word long
+    And the value for "last_name" should be 1 word long
+    And the value for "name_prefix" should be 1 word long
+    And the value for "name_suffix" should be 1 word long
+    And the value for "title" should have a minimum of 3 words
+
+  Scenario: Getting addresses from the yaml
+    Then the value for "street" should have a minimum of 2 words
+    And the value for "street_plus" should have a minimum of 4 words
+    And the value for "city" should have a minimum of 1 word
+    And the value for "state" should have a minimum of 1 word
+    And the value for "state_ab" should be 1 word long
+    And the value for "zip" should be 1 word long
+    And the value for "country" should have a minimum of 1 word
+    And the value for "second_address" should have a minimum of 1 words
+
+  Scenario: Getting a company name from the yaml
+    Then the value for "company" should have a minimum of 1 word
+
+  Scenario: Getting an email address from the yaml
+    Then the value for "email" should be 1 word long
+    And the value for "email_plus" should include "buddy"
+    And the value for "domain_name" should be 1 word long
+    And the value for "user_name" should be 1 word long
+    And the value for "url" should include "http://"
+
+  Scenario: Getting a phone number
+    Then the value for "phone" should be a phone number
+    And the value for "cell" should be a phone number
+
+  Scenario: Random phrases
+    Then the value for "catch_phrase" should exist
+    And the value for "words" should exist
+    And the value for "sentence" should exist
+    And the value for "sentences" should exist
+    And the value for "paragraphs" should exist
+    And the value for "characters" should be 255 characters long
+
+  Scenario: Boolean values
+    Then the value for "bool_true" should be true
+    And the value for "bool_false" should be false
+
+  Scenario: Reading multiple data segments
+    When I ask for the data for "other"
+    Then the value for "name" should be "Cheezy"
+    And the value for "address" should be "123 Main Street"
+    And the value for "email" should be "cheezy@example.com"
+
+  Scenario: Reading from multiple yml files
+    When I load the file "another.yml"
+    And I ask for the data for "other_file"
+    Then the value for "name" should be "Sneezy"
+    And the value for "address" should be "555 Easy Money Drive"
+    And the value for "email" should be "sneezy@example.com"
+
+  Scenario: Reading multiple entries from same file
+    When I load the file "another.yml"
+    And I ask for the data for "other_file"
+    Then the value for "name" should be "Sneezy"
+    When I ask for the data for "more_info"
+    Then the value for "name" should be "Wheezy"
+    And the value for "address" should be "999 Alergy Ave"
+    And the value for "email" should be "wheezy@example.com"
+
+  Scenario: Returning a randomly selected value from an array
+    Then the value for "random" should be either "Tom", "Dick", or "Harry"
+    And the value for "range" should be between 1 and 5
+
+  Scenario: Returning a sequential value from an array
+    Then the first value for the sequential data should be "first"
+    When I ask for the data again
+    Then the second value for the sequential data should be "second"
+    When I ask for the data again
+    Then the third value for the sequential data should be "third"
+
+  Scenario: Returning a value based on a mask
+    Then the value for "mask" should begin with 3 numbers
+    And the value for "mask" should have 3 upper case letters after a dash
+    And the value for "mask" should end with 3 lower case letters
+
+  Scenario: Returning dates
+    Then the value for "today" should be today's date
+    And the value for "tomorrow" should be tomorrow's date
+    And the value for "yesterday" should be yesterday's date
+
+  Scenario: Specifying number of days from today
+    Then the value for "5daysfromtoday" should be five days from today
+    And the value for "5daysago" should be five days ago
+
+  Scenario: Getting a random month name
+    Then the value for "some_month" should be a valid month
+    
+  Scenario: Getting a random month abbreviation
+    Then the value for "month_abbr" should be a valid month abbreviation
+
+  Scenario: Getting a random day name
+    Then the value for "some_day" should be a valid day
+
+  Scenario: Getting a random day abbreviation
+    Then the value for "day_abbr" should be a valid day abbreviation
+
+  Scenario: It should allow one to add new translator methods
+    When I add the blah translator
+    Then the value for "blah" should be "foobar"
+
+  Scenario: Getting values from nested entries
+    Then the nested value for this is_nested should be "Nested Value"
+
+  Scenario: Should be able to call the translator methods on FigMagic module
+    Then I should be able to call the full_name translator
+    And I should be able to call the state translator
+    And I should be able to call the today translator

data/features/defaults.feature

@@ -0,0 +1,8 @@
+Feature: Default file and directory functionality of the fig_magic gem
+  
+  Scenario: Using the default file and directory
+    Given I have read the default yaml file from the default location
+    When I ask for the data for "dm"
+    Then the value for "value1" should be "this is value 1"
+    And the value for "value2" should be "this is value 2"
+

data/features/fig_newton.feature

@@ -0,0 +1,85 @@
+Feature: Functionality of the fig_newton gem
+
+  Scenario: Getting basic configuration data from a yml config file
+    Given I have read the configuration file
+    When I ask for the value for "base_url"
+    Then I should see "http://cheezyworld.com"
+
+  Scenario: Requesting data that does not exist should result in error
+    Given I have read the configuration file
+    When I ask for a value that does not exist named "does_not_exist"
+    Then I should raise a NoMethodError exception
+
+  Scenario: Getting the default filename from an environment variable
+    Given I have an environment variable named "FIG_NEWTON_FILE" set to "sample.yml"
+    When I ask for the value for "from_the_env_file"
+    Then I should see "read from the env file"
+
+  Scenario: Using a file that has the same name as the hostname
+    Given I have a yml file that is named after the hostname
+    When I ask for the value for "from_the_hostname_file"
+    Then I should see "read from the hostname file"
+    And I should remove the file
+
+  Scenario: Requesting data that contains a node of additional data
+    Given I have read the configuration file
+    When I ask for the value for "database"
+    Then I should have a node
+    And the "username" value for the node should be "steve"
+    And the "password" value for the node should be "secret"
+
+  Scenario: Requesting data from multiple nested data
+    Given I have read the configuration file
+    When I ask for the value for "first"
+    And I ask for the node value for "second"
+    Then the "third" value for the node should be "foo"
+    And the "fourth" value for the node should be "bar"
+
+  Scenario: Using default directory and file
+    Given I have read the default file from the default directory
+    When I ask for the value for "base_url"
+    Then I should see "http://cheezyworld.com"
+
+  Scenario:  Requesting a numerical value
+    Given I have read the configuration file
+    When I ask for the value for "port"
+    Then I should see 1234
+
+  Scenario: Requesting a true boolean value
+    Given I have read the configuration file
+    When I ask for the value for "set_flag"
+    Then I should see true
+
+  Scenario: Requesting a false boolean value
+    Given I have read the configuration file
+    When I ask for the value for "cleared_flag"
+    Then I should see false
+
+  Scenario:  Requesting data from a node can be converted to a hash
+    Given I have read the configuration file
+    When I ask for the value for "database"
+    Then I should have a node
+    And the hash of values should look like:
+      | username | steve  |
+      | password | secret |
+
+  Scenario: Requesting data that does not exist but has a default value should return the default value
+    Given I have read the configuration file
+    When I ask for a value that does not exist named "does_not_exist" that has a default value "the default value"
+    Then I should see "the default value"
+
+  Scenario: Requesting data that does not exist but has a default block should return the block result
+    Given I have read the configuration file
+    When I ask for a value that does not exist named "does_not_exist" that has a default block returning "the default value"
+    Then I should see "the default value"
+
+  Scenario: Requesting data that does not exist but has a default lambda should return the lambda result
+    Given I have read the configuration file
+    When I ask for a value that does not exist named "does_not_exist" that has a default lambda returning "the default value"
+    Then I should see "the default value"
+    And the lambda should be passed the property "does_not_exist"
+
+  Scenario: Requesting data that does not exist but has a default proc should return the proc result
+    Given I have read the configuration file
+    When I ask for a value that does not exist named "does_not_exist" that has a default proc returning "the default value"
+    Then I should see "the default value"

data/features/step_definitions/data_magic_steps.rb

@@ -0,0 +1,164 @@
+class TestClass
+  include FigMagic
+end
+
+
+Given /^I have read the yaml file from features\/yaml$/ do
+  FigMagic.yml_directory = 'features/yaml'
+  FigMagic.load "example.yml"
+end
+
+Given /^I have read the default yaml file from the default location$/ do
+
+end
+
+When /^I ask for the data for "(.+)"$/ do |key|
+  TestClass.instance_variable_set "@private_firstsecond_index", 0
+  @tc = TestClass.new
+  @data = @tc.data_for key
+end
+
+
+Then /^the value for "(.+)" should be "(.+)"$/ do |key, value|
+  expect(@data[key]).to eql value
+end
+
+Then /^the value for "(.+)" should be (true|false)$/ do |key, value|
+  expect(@data[key]).to eql eval(value)
+end
+
+Then /^the value for "(.+)" should be (\d+) word|words long$/ do |key, length|
+  expect(@data[key].split(' ').size).to eql length.to_i
+end
+
+Then /^the value for "(.+)" should have a minimum of (\d+) word|wordss$/ do |key, length|
+  expect(@data[key].split(' ').size).to be >= length.to_i
+end
+
+Then /^the value for "(.*?)" should be (\d+) characters long$/ do |key, length|
+  expect(@data[key].length).to eql length.to_i
+end
+
+Then /^the value for "(.+)" should exist$/ do |key|
+  expect(@data[key]).not_to be_nil
+end
+
+When /^I load the file "(.+)"$/ do |file_name|
+  FigMagic.yml_directory = 'config/data'
+  FigMagic.load file_name
+end
+
+Then /^the value for "(.*?)" should be either "(.*?)", "(.*?)", or "(.*?)"$/ do |key, vala, valb, valc|
+  expect([vala, valb, valc]).to include @data[key]
+end
+
+Then /^the value for "(.*?)" should be between (\d+) and (\d+)$/ do |key, low, high|
+  value = @data[key]
+  expect(value).to be >= low.to_i
+  expect(value).to be <= high.to_i
+end
+
+Then /^the value for "(.*?)" should begin with (\d+) numbers$/ do |key, num|
+  value = @data[key]
+  expect(value[0,num.to_i].is_integer).to be true
+end
+
+Then /^the value for "(.*?)" should have (\d+) upper case letters after a dash$/ do |key, num|
+  value = @data[key]
+  expect(value[4,num.to_i].upcase).to eql value[4,3]
+end
+
+Then /^the value for "(.*?)" should end with (\d+) lower case letters$/ do |key, num|
+  value = @data[key]
+  expect(value[-1 * num.to_i,num.to_i].downcase).to eql value[-3,3]
+end
+
+Then /^the value for "(.*?)" should include "(.*?)"$/ do |key, value|
+  expect(@data[key]).to include value
+end
+
+Then /^the value for "(.*?)" should be today\'s date$/ do |key|
+  expect(@data[key]).to eql Date.today.strftime('%D')
+end
+
+Then /^the value for "(.*?)" should be tomorrow\'s date$/ do |key|
+  tomorrow = Date.today + 1
+  expect(@data[key]).to eql tomorrow.strftime('%D')
+end
+
+Then /^the value for "(.*?)" should be yesterday\'s date$/ do |key|
+  yesterday = Date.today - 1
+  expect(@data[key]).to eql yesterday.strftime('%D')
+end
+
+Then /^the value for "(.*?)" should be five days from today$/ do |key|
+  the_day = Date.today + 5
+  expect(@data[key]).to eql the_day.strftime('%D')
+end
+
+Then /^the value for "(.*?)" should be five days ago$/ do |key|
+  the_day = Date.today - 5
+  expect(@data[key]).to eql the_day.strftime('%D')
+end
+
+Then /^the value for "(.*?)" should be a valid month$/ do |key|
+  months = %w[January February March April May June July August September October November December]
+  expect(months).to include @data[key]
+end
+
+Then /^the value for "(.*?)" should be a valid month abbreviation$/ do |key|
+  months = %w[Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec]
+  expect(months).to include @data[key]
+end
+
+Then /^the value for "(.*?)" should be a valid day$/ do |key|
+  days = %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday]
+  expect(days).to include @data[key]
+end
+
+Then /^the value for "(.*?)" should be a valid day abbreviation$/ do |key|
+  days = %w[Sun Mon Tue Wed Thu Fri Sat]
+  expect(days).to include @data[key]
+end
+
+When /^I add the blah translator$/ do
+  module Blah
+    def blah
+      'foobar'
+    end
+  end
+  FigMagic.add_translator(Blah)
+
+  class TranslatorAdded
+    include FigMagic
+  end
+  ta = TranslatorAdded.new
+  @data = ta.data_for 'dynamic'
+end
+
+Then(/^the (?:first|second|third) value for the sequential data should be "(.*?)"$/) do |value|
+  expect(@data['ordered']).to eql value
+end
+
+When(/^I ask for the data again$/) do
+  @data = @tc.data_for 'dm'
+end
+
+Then(/^the nested value for this is_nested should be "(.*?)"$/) do |value|
+  expect(@data['this']['is_nested']).to eql value
+end
+
+Then(/^the value for "(.*?)" should be a phone number$/) do |value|
+  phone = @data[value]
+  if phone.split(' ').length == 2
+    expect(phone).to include "("
+    expect(phone).to include ")"
+  else
+    expect(phone.split(' ').length).to eql 1
+  end
+end
+
+Then(/^I should be able to call the (.+) translator$/) do |method|
+  value = FigMagic.send method
+  expect(value).not_to be_empty
+end