data_magic 0.5 → 0.6

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - ree
+  - ruby-head

data/ChangeLog

@@ -1,3 +1,7 @@
+=== Version 0.6 / 2012-5-4
+* Fixes
+  * Minor fix so it works properly with ruby 1.8.7
+
 === Version 0.5 / 2012-3-24
 * Enhancements
   * Added ability to use symbol for the key in the data_for method

data/README.md

@@ -1,8 +1,51 @@
 # 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)

data/data_magic.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_dependency 'faker', '>= 1.0.1'
+  gem.add_dependency 'yml_reader', '>= 0.1'
 
   gem.add_development_dependency 'rspec', '>= 2.6.0'
   gem.add_development_dependency 'cucumber', '>= 1.1.0'

data/features/data_magic.feature

@@ -41,3 +41,25 @@ Feature: Functionality of the data_magic gem
   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"

data/features/step_definitions/data_magic_steps.rb

@@ -31,3 +31,8 @@ end
 Then /^the value for "(.+)" should exist$/ do |key|
   @data[key].should_not be_nil
 end
+
+
+When /^I load the file "(.+)"$/ do |file_name|
+  DataMagic.load file_name
+end

data/features/support/env.rb

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

data/features/yaml/another.yml

@@ -0,0 +1,9 @@
+other_file:
+  name: Sneezy
+  address: 555 Easy Money Drive
+  email: sneezy@example.com
+
+more_info:
+  name: Wheezy
+  address: 999 Alergy Ave
+  email: wheezy@example.com

data/features/yaml/example.yml

@@ -21,3 +21,8 @@ dm:
   paragraphs: ~paragraphs
   bool_true: true
   bool_false: false
+
+other:
+  name: Cheezy
+  address: 123 Main Street
+  email: cheezy@example.com

data/lib/data_magic.rb

@@ -2,11 +2,13 @@ require "data_magic/version"
 require "data_magic/config"
 require "data_magic/reader"
 require "data_magic/translation"
+require 'yml_reader'
 
 require 'faker'
 
 module DataMagic
   include Translation
+  extend YmlReader
 
   def data_for(key, additional={})
     DataMagic.load('default.yml') unless DataMagic.yml
@@ -20,27 +22,18 @@ module DataMagic
     data.each do |key, value|
       unless value.nil?
         next unless value.respond_to? '[]'
-        data[key] = eval(value[1..-1]) if value[0] == "~"
+        data[key] = eval(value[1..-1]) if value[0,1] == "~"
       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
+    def default_directory
+      'config'
     end
   end
+
 end

data/lib/data_magic/config.rb

@@ -9,7 +9,9 @@ module DataMagic
       # files will be located.
       #
       def yml_directory
-        @data_magic_yml_directory ||= 'config'
+        $stderr.puts "*** DEPRECATION WARNING"
+        $stderr.puts "*** DataMagic::Config has being deprecated and will be removed soon."
+        $stderr.puts "*** Please use DataMagic.yml_directory."
       end
 
       #
@@ -17,7 +19,9 @@ module DataMagic
       # all of the yml files.
       #
       def yml_directory=(value)
-        @data_magic_yml_directory = value
+        $stderr.puts "*** DEPRECATION WARNING"
+        $stderr.puts "*** DataMagic::Config has being deprecated and will be removed soon."
+        $stderr.puts "*** Please use DataMagic.yml_directory=."
       end
       
     end

data/lib/data_magic/reader.rb

@@ -6,7 +6,7 @@ module DataMagic
     # 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}"
+      YAML.load_file "#{::DataMagic::Config.yml_directory}/#{filename}"
     end
   end
 end

data/lib/data_magic/version.rb

@@ -1,3 +1,3 @@
 module DataMagic
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

data/spec/lib/data_magic_spec.rb

@@ -2,19 +2,23 @@ require 'spec_helper'
 
 describe DataMagic do
   context "when configuring the yml directory" do
+    before(:each) do
+      DataMagic.yml_directory = nil
+    end
+    
     it "should default to a directory named config" do
-      DataMagic::Config.yml_directory.should == 'config'
+      DataMagic.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'
+      DataMagic.yml_directory = 'test_dir'
+      DataMagic.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'
+      DataMagic.yml_directory = 'test'
       YAML.should_receive(:load_file).with("test/fname").and_return({})
       DataMagic.load("fname")
     end

data/spec/lib/translation_spec.rb

@@ -23,7 +23,7 @@ describe "DataMagic translations" do
     end
 
     it "should default to use a file named 'default.yml'" do
-      DataMagic::Config.yml_directory = 'test'
+      DataMagic.yml_directory = 'test'
       YAML.should_receive(:load_file).with("test/default.yml").and_return({})
       DataMagic.should_receive(:yml).and_return(nil)
       DataMagic.should_receive(:yml).and_return({'key' => {'field' => 'value'}})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_magic
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00.000000000 Z
+date: 2012-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70164234201940 !ruby/object:Gem::Requirement
+  requirement: &70359185872900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70164234201940
+  version_requirements: *70359185872900
+- !ruby/object:Gem::Dependency
+  name: yml_reader
+  requirement: &70359185871820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359185871820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70164234201180 !ruby/object:Gem::Requirement
+  requirement: &70359185869020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70164234201180
+  version_requirements: *70359185869020
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70164234200380 !ruby/object:Gem::Requirement
+  requirement: &70359185868240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70164234200380
+  version_requirements: *70359185868240
 description: Provides datasets to application stored in YAML files
 email:
 - jeff.morgan@leandog.com
@@ -54,6 +65,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - ChangeLog
 - Gemfile
 - Guardfile
@@ -65,6 +77,7 @@ files:
 - features/data_magic.feature
 - features/step_definitions/data_magic_steps.rb
 - features/support/env.rb
+- features/yaml/another.yml
 - features/yaml/example.yml
 - lib/data_magic.rb
 - lib/data_magic/config.rb
@@ -102,6 +115,7 @@ test_files:
 - features/data_magic.feature
 - features/step_definitions/data_magic_steps.rb
 - features/support/env.rb
+- features/yaml/another.yml
 - features/yaml/example.yml
 - spec/lib/data_magic_spec.rb
 - spec/lib/translation_spec.rb