data_magic 0.22 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e3fd3732d4db189c086a0d1f249477d7dbc629
-  data.tar.gz: 902996720a2c99cfae0aff452508cc8abe6c7dc5
+  metadata.gz: f8d3f6a94411e15c7259ab68c9025824694a6ba2
+  data.tar.gz: 43d27206b78632d49b42a96264eefccd31ddc6c2
 SHA512:
-  metadata.gz: dfd5ea7be34a9deb10f2514d7f50ca4dfe998ec25346d2fdd383008235695a1756b2aa438c59945f59b3f6e7b0c5d48bf81d8a98bdfe428dc21582c51d10ca65
-  data.tar.gz: a08950ff0dc236fe3ea6161e7c62810851b6aa4fa5e67bb5f58a3d858121c367cc02abc0ba3ecd28b62722f529d7b735934fbe4bd82cd92d980d8aa2776bb8f7
+  metadata.gz: 4d1dcacb77607bf29d0e66d6a4ff95823e61995b610924a7e1e354fd597308a1252625817b00aa689a54a6f303245662d7bb9069e0a8c17671251a3f0467823e
+  data.tar.gz: fbf215b0e7d60ee954939d51a6b467542eb60fa0292331eb6b51c8d84f68b0744d6694408760592b0dbac182622d07fb25ff0cbbd8af1f2223aeecc271b8728d

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/ChangeLog

@@ -1,6 +1,11 @@
+=== Version 1.0 / 2016-11-23
+* Enhancements
+  * Allow merged to be a Hash of Hashes and find key that matches (thanks Donavan Stanley)
+  * Allow you to specify file to load with tag when using Cucumber (thanks Donavan Stanley)
+
 === Version 0.22 / 2015-12-2
 * Enhancements
-  * Better handling for nexted hash translation
+  * Better handling for nexted hash translation (thanks vveliev)
 
 === Version 0.21 / 2015-4-12
 * Enhancements

data/README.md

@@ -21,6 +21,17 @@ After setting the directory you must load a file.  This can be accomplished by c
 DataMagic.load 'filename.yml'
 ````
 
+Another way to specify the file to load is to use a _tag_ in a cucumber scenario.  You tag should take the
+form of `@datamagic_FILENAME` where `FILENAME` is replaced with the file you wish to load.  Then you can
+simply have the following code in a hook:
+
+````ruby
+Before do |scenario|
+  DataMagic.load_for_scenario(scenario)
+end
+````
+
+
 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.

data/lib/data_magic.rb

@@ -37,7 +37,18 @@ module DataMagic
     end
     data = DataMagic.yml[record]
     raise ArgumentError, "Undefined key #{key}" unless data
-    prep_data data.merge(additional).clone
+    additional.key?(record) ? prep_data(data.merge(additional[record]).clone) : prep_data(data.merge(additional).clone)
+  end
+
+  # Given a scenario, load any fixture it needs.
+  # Fixture tags should be in the form of @datamagic_FIXTUREFILE
+  def self.load_for_scenario(scenario, fixture_folder = DataMagic.yml_directory)
+    orig_yml_directory = DataMagic.yml_directory
+    DataMagic.yml_directory = fixture_folder
+    fixture_files = fixture_files_on(scenario)
+
+    DataMagic.load "#{fixture_files.last}.yml" if fixture_files.count > 0
+    DataMagic.yml_directory = orig_yml_directory
   end
 
   private
@@ -68,6 +79,24 @@ module DataMagic
     @translation ||= Translation.new parent
   end
 
+  # Load a fixture and merge it with an existing hash
+  def self.load_fixture_and_merge_with(fixture_name, base_hash, fixture_folder = DEFAULT_FIXTURE_FOLDER)
+    new_hash = load_fixture(fixture_name, fixture_folder)
+    base_hash.deep_merge new_hash
+  end
+
+  def self.fixture_tags_on(scenario)
+    # tags for cuke 2, source_tags for cuke 1
+    tags = scenario.send(scenario.respond_to?(:tags) ? :tags : :source_tags)
+    tags.map(&:name).select { |t| t =~ /@datamagic_/ }
+  end
+
+  def self.fixture_files_on(scenario)
+    # tags for cuke 2, source_tags for cuke 1
+    tags = scenario.send(scenario.respond_to?(:tags) ? :tags : :source_tags)
+    tags.map(&:name).select { |t| t =~ /@datamagic_/ }.map { |t| t.gsub('@datamagic_', '').to_sym }
+  end
+
   class << self
     attr_accessor :yml
   

data/lib/data_magic/version.rb

@@ -1,3 +1,3 @@
 module DataMagic
-  VERSION = "0.22"
+  VERSION = "1.0"
 end

data/spec/lib/data_magic_spec.rb

@@ -4,6 +4,21 @@ class UserPage
   include DataMagic
 end
 
+class MockScenario
+  attr_accessor :tags
+  def initialize(tags)
+    @tags = tags
+  end
+end
+
+class MockTag
+  attr_reader :name, :line
+  def initialize(name, line)
+    @name = name
+    @line = line
+  end
+end
+
 describe DataMagic do
   context "when configuring the yml directory" do
     before(:each) do
@@ -28,9 +43,10 @@ describe DataMagic do
 
   context "when reading yml files" do
     it "should read files from the config directory" do
-      DataMagic.yml_directory = 'test'
-      expect(File).to receive(:read).with("test/fname").and_return('test')
-      DataMagic.load("fname")
+      DataMagic.yml = nil
+      DataMagic.load("user.yml")
+      data = UserPage.new.data_for "valid"
+      expect(data.keys.sort).to eq(['job','name'])
     end
 
     it "should default to reading a file named default.yml" do
@@ -48,6 +64,17 @@ describe DataMagic do
       expect(data.keys.sort).to eq(['job','name'])
       ENV['DATA_MAGIC_FILE'] = nil
     end
+
+    it 'should merge additional data to the same key if not present in addtional' do
+      DataMagic.yml_directory = 'config/data'
+      data = UserPage.new.data_for 'user/valid', {'job' => 'Overlord'}
+      expect(data['job']).to eq('Overlord')
+    end
+    it 'should merge additional data to resulting hash if present in additional data' do
+      DataMagic.yml_directory = 'config/data'
+      data = UserPage.new.data_for 'user/valid', { 'valid' => {'job' => 'Overlord'} }
+      expect(data['job']).to eq('Overlord')
+    end
   end
 
   context "namespaced keys" do
@@ -57,4 +84,27 @@ describe DataMagic do
       expect(data.keys.sort).to eq(['job','name'])
     end
   end
+
+  context "loading fixtures for cucumber scenarios" do
+    it "loads the fixture for a scenario" do
+      DataMagic.yml_directory = 'config/data'
+      scenario = MockScenario.new([MockTag.new('@tag', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario
+    end
+
+    it "uses the last fixture listed for a scenario if multiple exist" do
+      scenario = MockScenario.new([MockTag.new('@fixture_default', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario
+    end
+
+    it "allows you to force loading from a different folder without stepping on the global folder" do
+      DataMagic.yml_directory = 'features'
+      scenario = MockScenario.new([MockTag.new('@tag', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario, 'config/data'
+      expect(DataMagic.yml_directory).to eq('features')
+    end
+  end
 end

data/spec/lib/translation_spec.rb

@@ -23,8 +23,12 @@ describe "DataMagic translations" do
     end
 
     it "should default to use a file named 'default.yml'" do
+      hsh = double('hash')
       DataMagic.yml_directory = 'test'
-      expect(File).to receive(:read).with("test/default.yml").and_return('test')
+      expect(File).to receive(:read).with("test/default.yml")
+      expect(ERB).to receive(:new).and_return hsh
+      expect(hsh).to receive(:result)
+      expect(YAML).to receive(:load).and_return(test: 'test')
       expect(DataMagic).to receive(:yml).and_return(nil)
       expect(DataMagic).to receive(:yml).and_return({'key' => {'field' => 'value'}})
       expect(example.data_for('key')).to have_field_value 'value'

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: data_magic
 version: !ruby/object:Gem::Version
-  version: '0.22'
+  version: '1.0'
 platform: ruby
 authors:
 - Jeff Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: yml_reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 description: Provides datasets to application stored in YAML files
@@ -73,11 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Guardfile
@@ -114,17 +114,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides datasets to application via YAML files