data_magic 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p0@data_magic --create

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'cucumber', :notification => true, :cli => '--profile default' 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,22 @@
+# 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.
+
+## 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.

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/cucumber.yml

@@ -0,0 +1 @@
+default: --no-source --color --format Cucumber::Formatter::Fuubar

data/data_magic.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/data_magic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "data_magic"
+  gem.version       = DataMagic::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Jeff Morgan"]
+  gem.email         = ["jeff.morgan@leandog.com"]
+  gem.homepage      = "http://github.com/cheezy/data_magic"
+  gem.summary       = %q{Provides datasets to application via YAML files}
+  gem.description   = %q{Provides datasets to application stored in YAML files}
+  
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'faker', '>= 1.0.1'
+
+  gem.add_development_dependency 'rspec', '>= 2.6.0'
+  gem.add_development_dependency 'cucumber', '>= 1.1.0'
+end

data/features/data_magic.feature

@@ -0,0 +1,40 @@
+Feature: Functionality of the data_magic gem
+  
+  Background:
+    Given I have read the yaml file
+    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
+
+  Scenario: Getting addresses from the yaml
+    Then the value for "street" should have a minimum of 2 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
+
+  Scenario: Getting a phone number
+    Then the value for "phone" should have a minimum of 1 word
+
+  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
+

data/features/step_definitions/data_magic_steps.rb

@@ -0,0 +1,29 @@
+class TestClass
+  include DataMagic
+end
+
+
+Given /^I have read the yaml file$/ do
+  DataMagic.load "example.yml"
+end
+
+When /^I ask for the data for "(.+)"$/ do |key|
+  @data = TestClass.new.data_for key
+end
+
+
+Then /^the value for "(.+)" should be "(.+)"$/ do |key, value|
+  @data[key].should == value
+end
+
+Then /^the value for "(.+)" should be (\d+) word|words long$/ do |key, length|
+  @data[key].split(' ').size.should == length.to_i
+end
+
+Then /^the value for "(.+)" should have a minimum of (\d+) word|wordss$/ do |key, length|
+  @data[key].split(' ').size.should >= length.to_i
+end
+
+Then /^the value for "(.+)" should exist$/ do |key|
+  @data[key].should_not be_nil
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+
+require 'rspec/expectations'
+require 'data_magic'
+
+DataMagic::Config.yml_directory = 'features/yaml'

data/features/yaml/example.yml

@@ -0,0 +1,21 @@
+dm:
+  value1: this is value 1
+  value2: this is value 2
+  full_name: ~name
+  first_name: ~first_name
+  last_name: ~last_name
+  street: ~street_address
+  city: ~city
+  state: ~state
+  state_ab: ~state_abbr
+  zip: ~zip_code
+  country: ~country
+  second_address: ~secondary_address
+  company: ~company_name
+  email: ~email
+  phone: ~phone_number
+  catch_phrase: ~catch_phrase
+  words: ~words
+  sentence: ~sentence
+  sentences: ~sentences
+  paragraphs: ~paragraphs

data/lib/data_magic.rb

@@ -0,0 +1,44 @@
+require "data_magic/version"
+require "data_magic/config"
+require "data_magic/reader"
+require "data_magic/translation"
+
+require 'faker'
+
+module DataMagic
+  include Translation
+
+  def data_for(key)
+    data = DataMagic.yml[key]
+    prep_data data
+  end
+
+  private
+
+  def prep_data(data)
+    data.each do |key, value|
+      unless value.nil?
+        data[key] = eval(value[1..-1]) if value[0] == "~"
+      end
+    end
+    data
+  end
+
+
+  class << self
+    attr_reader :yml
+    
+    #
+    # load the provided filename from the config directory
+    #
+    def load(filename)
+      @yml = reader.load_file(filename)
+    end
+
+    private
+  
+    def reader
+      @reader ||= DataMagic::Reader.new
+    end
+  end
+end

data/lib/data_magic/config.rb

@@ -0,0 +1,26 @@
+module DataMagic
+  module Config
+
+    class << self
+      attr_accessor :data_magic_yml_directory
+
+      #
+      # retrieve the yml_directory - the location where all of the yml
+      # files will be located.
+      #
+      def yml_directory
+        @data_magic_yml_directory ||= 'config'
+      end
+
+      #
+      # set the yml_directory - this is where the gem will look for
+      # all of the yml files.
+      #
+      def yml_directory=(value)
+        @data_magic_yml_directory = value
+      end
+      
+    end
+    
+  end
+end

data/lib/data_magic/reader.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+module DataMagic
+  class Reader
+    #
+    # load a file from the config directory and parse into a hash
+    #
+    def load_file(filename)
+      yml = YAML.load_file "#{::DataMagic::Config.yml_directory}/#{filename}"
+    end
+  end
+end
+

data/lib/data_magic/translation.rb

@@ -0,0 +1,130 @@
+module DataMagic
+  module Translation
+    #
+    # return a random name (first and last)
+    #
+    def name
+      Faker::Name.name
+    end
+
+    #
+    # return a random first name
+    #
+    def first_name
+      Faker::Name.first_name
+    end
+
+    #
+    # return a random last name
+    #
+    def last_name
+      Faker::Name.last_name
+    end
+
+    #
+    # return a random street address
+    #
+    def street_address
+      Faker::Address.street_address
+    end
+
+    #
+    # return a random secondary address
+    #
+    def secondary_address
+      Faker::Address.secondary_address
+    end
+
+    #
+    # return a random city
+    #
+    def city
+      Faker::Address.city
+    end
+
+    #
+    # return a random state
+    #
+    def state
+      Faker::Address.state
+    end
+
+    #
+    # return a random state abbreviation
+    #
+    def state_abbr
+      Faker::Address.state_abbr
+    end
+
+    #
+    # return a random zip code
+    #
+    def zip_code
+      Faker::Address.zip_code
+    end
+
+    #
+    # return a random country
+    #
+    def country
+      Faker::Address.country
+    end
+
+
+    #
+    # return a random company name
+    #
+    def company_name
+      Faker::Company.name
+    end
+
+    #
+    # return a random catch phrase
+    #
+    def catch_phrase
+      Faker::Company.catch_phrase
+    end
+
+    #
+    # return random words - default is 3 words
+    #
+    def words(number = 3)
+      Faker::Lorem.words(number).join(' ')
+    end
+
+    #
+    # return a random sentence - default minimum word count is 4
+    #
+    def sentence(min_word_count = 4)
+      Faker::Lorem.sentence(min_word_count)
+    end
+
+    #
+    # return random sentences - default is 3 sentences
+    #
+    def sentences(sentence_count = 3)
+      Faker::Lorem.sentences(sentence_count).join(' ')
+    end
+
+    #
+    # return random paragraphs - default is 3 paragraphs
+    #
+    def paragraphs(paragraph_count = 3)
+      Faker::Lorem.paragraphs(paragraph_count).join('\n\n')
+    end
+
+    #
+    # return a random email address
+    #
+    def email
+      Faker::Internet.email
+    end
+
+    #
+    # return a random phone number
+    #
+    def phone_number
+      Faker::PhoneNumber.phone_number
+    end
+  end
+end

data/lib/data_magic/version.rb

@@ -0,0 +1,3 @@
+module DataMagic
+  VERSION = "0.1"
+end

data/spec/lib/data_magic_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe DataMagic do
+  context "when configuring the yml directory" do
+    it "should default to a directory named config" do
+      DataMagic::Config.yml_directory.should == 'config'
+    end
+
+    it "should store a yml directory" do
+      DataMagic::Config.yml_directory = 'test_dir'
+      DataMagic::Config.yml_directory.should == 'test_dir'
+    end
+  end
+
+  context "when reading yml files" do
+    it "should read files from the config directory" do
+      DataMagic::Config.yml_directory = 'test'
+      YAML.should_receive(:load_file).with("test/fname").and_return({})
+      DataMagic.load("fname")
+    end
+  end
+end

data/spec/lib/translation_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+class TestSubject
+  include DataMagic
+end
+
+describe "DataMagic translations" do
+  context "when delivering data" do
+    let(:example) { TestSubject.new }
+
+    def set_field_value(value)
+      DataMagic.should_receive(:yml).and_return({'key' => {'field' => value}})
+    end
+    
+    it "should deliver the hash from the yaml" do
+      set_field_value 'value'
+      example.data_for('key').should have_field_value 'value'
+    end
+
+
+    context "translating random names" do
+      it "should add a name" do
+        Faker::Name.should_receive(:name).and_return('Joseph')
+        set_field_value '~name'
+        example.data_for('key').should have_field_value 'Joseph'
+      end
+
+      it "should add first name" do
+        Faker::Name.should_receive(:first_name).and_return('Sam')
+        set_field_value '~first_name'
+        example.data_for('key').should have_field_value 'Sam'
+      end
+
+      it "should add last name" do
+        Faker::Name.should_receive(:last_name).and_return('Smith')
+        set_field_value '~last_name'
+        example.data_for('key').should have_field_value 'Smith'
+      end
+    end
+
+    context "translating random addresses" do
+      it "should add a street address" do
+        Faker::Address.should_receive(:street_address).and_return("123 Main")
+        set_field_value '~street_address'
+        example.data_for('key').should have_field_value '123 Main'
+      end
+
+      it "should add a city" do
+        Faker::Address.should_receive(:city).and_return('Cleveland')
+        set_field_value '~city'
+        example.data_for('key').should have_field_value 'Cleveland'
+      end
+
+      it "should add a state" do
+        Faker::Address.should_receive(:state).and_return('Ohio')
+        set_field_value '~state'
+        example.data_for('key').should have_field_value 'Ohio'
+      end
+
+      it "should add a state abbreviation" do
+        Faker::Address.should_receive(:state_abbr).and_return('OH')
+        set_field_value '~state_abbr'
+        example.data_for('key').should have_field_value 'OH'
+      end
+
+      it "should add a zip code" do
+        Faker::Address.should_receive(:zip_code).and_return('11111')
+        set_field_value '~zip_code'
+        example.data_for('key').should have_field_value '11111'
+      end
+
+      it "should add a country" do
+        Faker::Address.should_receive(:country).and_return("United States")
+        set_field_value '~country'
+        example.data_for('key').should have_field_value 'United States'
+      end
+
+      it "should add a secondary address" do
+        Faker::Address.should_receive(:secondary_address).and_return('2nd floor')
+        set_field_value '~secondary_address'
+        example.data_for('key').should have_field_value '2nd floor'
+      end
+    end
+
+    context "translating company names" do
+      it "should add a company name" do
+        Faker::Company.should_receive(:name).and_return('LeanDog')
+        set_field_value '~company_name'
+        example.data_for('key').should have_field_value 'LeanDog'
+      end
+    end
+
+    context "translating email address" do
+      it "should add an email address" do
+        Faker::Internet.should_receive(:email).and_return('buddy@example.com')
+        set_field_value '~email'
+        example.data_for('key').should have_field_value 'buddy@example.com'
+      end
+    end
+    
+    context "translating phone numbers" do
+      it "shold add a phone number" do
+        Faker::PhoneNumber.should_receive(:phone_number).and_return('555-555-5555')
+        set_field_value '~phone_number'
+        example.data_for('key').should have_field_value '555-555-5555'
+      end
+    end
+
+    context "translating random phrases" do
+      it "should add a catch phrase" do
+        Faker::Company.should_receive(:catch_phrase).and_return('Ruby is cool')
+        set_field_value '~catch_phrase'
+        example.data_for('key').should have_field_value 'Ruby is cool'
+      end
+
+      it "should add random words" do
+        Faker::Lorem.should_receive(:words).and_return(['random', 'words'])
+        set_field_value '~words'
+        example.data_for('key').should have_field_value 'random words'
+      end
+
+      it "should default to returning 3 words" do
+        set_field_value '~words'
+        example.data_for('key')['field'].split.size.should == 3
+      end
+
+      it "should allow you to specify the number of words" do
+        set_field_value '~words(4)'
+        example.data_for('key')['field'].split.size.should == 4
+      end
+
+      it "should add a random sentence" do
+        Faker::Lorem.should_receive(:sentence).and_return('a sentence')
+        set_field_value '~sentence'
+        example.data_for('key').should have_field_value 'a sentence'
+      end
+
+      it "should default to returning a minimum of 4 words" do
+        set_field_value '~sentence'
+        example.data_for('key')['field'].split.size.should >= 4
+      end
+
+      it "should allow you to specify a minimum word count" do
+        set_field_value '~sentence(20)'
+        example.data_for('key')['field'].split.size.should >= 20
+      end
+
+      it "should add sentences" do
+        Faker::Lorem.should_receive(:sentences).and_return(['this is sentences'])
+        set_field_value '~sentences'
+        example.data_for('key').should have_field_value 'this is sentences'
+      end
+
+      it "should default to returning a default of 3 sentences" do
+        set_field_value '~sentences'
+        example.data_for('key')['field'].split('.').size.should >= 3
+      end
+
+      it "should allow you to specify the number of  sentences" do
+        set_field_value '~sentences(10)'
+        example.data_for('key')['field'].split('.').size.should >= 10
+      end
+
+      it "should add a paragraphs" do
+        Faker::Lorem.should_receive(:paragraphs).and_return(['this is a paragraph'])
+        set_field_value '~paragraphs'
+        example.data_for('key').should have_field_value 'this is a paragraph'
+      end
+
+      it "should return 3 paragraphs by default" do
+        set_field_value '~paragraphs'
+        example.data_for('key')['field'].split('\n\n').size.should == 3
+      end
+
+      it "should allow you to specify the number of paragraphs" do
+        set_field_value '~paragraphs(10)'
+        example.data_for('key')['field'].split('\n\n').size.should == 10
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if ENV['coverage']
+  raise "simplecov only works on Ruby 1.9" unless RUBY_VERSION =~ /^1\.9/
+
+  require 'simplecov'
+  SimpleCov.start { add_filter "spec/" }
+end
+
+require 'rspec'
+
+require 'data_magic'
+
+RSpec::Matchers.define :have_field_value do |expected|
+  match do |actual|
+    actual['field'] == expected
+  end
+  
+  failure_message_for_should do |actual|
+    "expected '#{expected}' to equal the field value '#{actual['field']}'"
+  end
+  
+  failure_message_for_should_not do |actual|
+    "expected '#{expected}' to not equal to field value '#{actual['field']}'"
+  end
+end
+
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: data_magic
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &70166151279480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70166151279480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70166151278860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70166151278860
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70166151278280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70166151278280
+description: Provides datasets to application stored in YAML files
+email:
+- jeff.morgan@leandog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- cucumber.yml
+- data_magic.gemspec
+- features/data_magic.feature
+- features/step_definitions/data_magic_steps.rb
+- features/support/env.rb
+- features/yaml/example.yml
+- lib/data_magic.rb
+- lib/data_magic/config.rb
+- lib/data_magic/reader.rb
+- lib/data_magic/translation.rb
+- lib/data_magic/version.rb
+- spec/lib/data_magic_spec.rb
+- spec/lib/translation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cheezy/data_magic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides datasets to application via YAML files
+test_files:
+- features/data_magic.feature
+- features/step_definitions/data_magic_steps.rb
+- features/support/env.rb
+- features/yaml/example.yml
+- spec/lib/data_magic_spec.rb
+- spec/lib/translation_spec.rb
+- spec/spec_helper.rb