hash_dealer 1.2.6 → 1.3.0

data/Guardfile

@@ -3,7 +3,7 @@
 
 guard 'rspec', :version => 2, :cli => "--color --format nested" do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec" }
   watch('spec/spec_helper.rb')  { "spec" }
 
   # Rails example

data/README.rdoc

@@ -1,8 +1,90 @@
-= hash_factory
+= hash_dealer
 
-Description goes here.
+== A library for creating reusable, extendable Hash-like objects for testing
 
-== Contributing to hash_factory
+== Defining HashDealers
+
+Everyone has a favorite Hash Dealer - here is how you create your template.  Note that any method can be used in your definition
+
+  HashDealer.define(:variable) do
+    a("test_a")
+    b("test_b")
+  end
+  
+Once you have your HashDealer - ask him to roll one up for you
+  
+  HashDealer.roll(:variable) => {:a => "test_a", :b => "test_b"}
+  
+If you'd like to customize your Hash - just pass in some options
+
+  HashDealer.roll(:variable, :a => "My own Kief") => {:a => "My own Kief", :b => "test_b"}
+  
+=== Dynamic Hashes
+
+Sometimes you'd like dynamic values for your Hash - or to use another HashDealer that you want to be dynamic - to do so, use a block inside your HashDealer definition
+
+  HashDealer.define(:dynamic) do
+    abc {Kernel.rand(100)}
+  end
+  
+  HashDealer.roll(:dynamic) => {:abc => 12}
+  HashDealer.roll(:dynamic) => {:abc => 32}
+  
+=== Nested Hashes
+HashDealer does not evaluate your defined Hashes until they are called - so you can use other HashDealers that are not yet loaded in your HashDealer definitions
+
+  HashDealer.define(:b) do
+    hash_a(HashDealer.roll(:a))
+  end
+
+  HashDealer.define(:a) do
+    a("123")
+  end
+  
+  HashDealer.roll(:b) => {:hash_a => {:a => "123"}}
+  
+=== Inheritance
+
+HashDealers can inherit from one another using the :parent option in their definitions
+
+  HashDealer.define(:variable_2, :parent => :variable) do
+    a("variable_2")
+    my_var("abc")
+  end
+  
+  HashDealer.roll(:variable_2) => {:a => "variable_2", :b => "test_b", :my_var => "abc"}
+  
+=== Elements other than Hashes
+Sometimes you need to ask your dealer for something other than Hash - just define a root element 
+
+  HashDealer.define(:crack) do
+    root([1,2,3])
+  end
+  
+  HashDealer.roll(:crack) => [1,2,3]
+
+== Rspec Matchers
+
+One goal of HashDealer is to allow you to define dynamic matchers to ensure that JSON responses from interfacing APIs follow a consistent format
+
+E.g.
+
+  response = {:id => 1, :name => "My Name", :email => "dan.langevin@lifebooker.com"}
+  {:id => 1, :name => ":name", :email => ":email"}.matcher.should match_response(response)
+  
+We don't care about the actual content of the fields, just that they are of the same type (generally) and that the hashes have the same fields
+
+Similarly
+  
+  response = [{:id => 1, :name => "My Name", :email => "dan.langevin@lifebooker.com"}, {:id => 2, :name => "Another Developer", :email => "wbartosch@lifebooker.com"}]
+  [{:id => 1, :name => ":name", :email => ":email"}].matcher.should match_response(response)
+
+We don't care how many elements there are in the array (we might get back 100 records from our test), just that they have the correct format
+
+=== The matcher method
+To achieve this, we use the .matcher method, which is defined on a Hash, String, Numeric and Array and should match_response(x) as an Rspec Matcher
+
+== Contributing to hash_dealer
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -14,6 +96,6 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2011 Dan Langevin. See LICENSE.txt for
+Copyright (c) 2011 Lifebooker, Inc. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-1.2.6
+1.3.0

data/hash_dealer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash_dealer}
-  s.version = "1.2.6"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Langevin"]
-  s.date = %q{2011-08-25}
+  s.date = %q{2011-08-26}
   s.description = %q{Like Factory Girl but for Hashes only}
   s.email = %q{dan.langevin@lifebooker.com}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/hash_dealer.rb",
     "lib/matcher.rb",
     "lib/path_string.rb",
+    "lib/variable_array.rb",
     "spec/lib/hash_dealer_spec.rb",
     "spec/lib/matcher_spec.rb",
     "spec/lib/path_string_spec.rb",

data/lib/core_extensions.rb

@@ -25,14 +25,15 @@ class String
 end
 
 class Hash
-  def pathify_strings!
+  def pathify_strings
     self.each_pair do |k,v|
       if v.is_a?(Array) || v.is_a?(Hash)
-        v.pathify_strings!
+        self[k] = v.pathify_strings
       elsif v.instance_of?(String) || v.is_a?(Numeric)
         self[k] = PathString.new(URI.decode(v.to_s))
       end
     end
+    self
   end
   # recursively get a matcher for each value
   def matcher(opts = {})
@@ -52,17 +53,35 @@ class Hash
   end
 end
 class Array
-  def pathify_strings!
-    self.each_with_index do |v,k|
-      if v.is_a?(Array) || v.is_a?(Hash)
-        v.pathify_strings!
+  def pathify_strings
+    if self.first == ":matcher"
+      val = VariableArray.new(self)
+    else
+      val = self
+    end
+    val.each_with_index do |v,k|
+      if v.is_a?(Array)  || v.is_a?(Hash)
+        val[k] = v.pathify_strings
       elsif v.instance_of?(String) || v.is_a?(Numeric)
-        self[k] = PathString.new(URI.decode(v.to_s))
+        val[k] = PathString.new(URI.decode(v.to_s))
       end
     end
+    val
   end
   # call matcher on all of the elements
   def matcher(opts = {})
-    self.collect(&:matcher)
+    self.unshift(":matcher")
+    VariableArray.new(self.collect(&:matcher))
   end
-end
+  # we want this to apply to both :eql? and ==
+  alias_method :eql?, :==
+  # we want this to add decorator behavior to ==, proxying to VariableArray if possible
+  define_method "==_with_variable_array" do |other|
+    return other == self if other.is_a?(VariableArray)
+    self.send("==_without_variable_array",other)
+  end
+  # Equivalent to:
+  # alias_method_chain "==", "variable_array"
+  alias_method "==_without_variable_array", :==
+  alias_method :==, "==_with_variable_array"
+end

data/lib/hash_dealer.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../path_string', __FILE__)
+require File.expand_path('../variable_array', __FILE__)
 require File.expand_path('../core_extensions', __FILE__)
 require File.expand_path('../matcher', __FILE__)
 
@@ -13,11 +14,12 @@ class HashDealer
   
   # define a method of the request factory
   def self.define(name, opts = {},  &block)
-    self.hashes[name] = self.new(opts, &block)
+    self.hashes[name] = [opts, block]
   end
   
   def self.roll(name, *args)
     raise Exception.new("No HashDealer called #{name}") unless self.hashes[name]
+    self.hashes[name] = self.new(self.hashes[name][0], &self.hashes[name][1]) unless self.hashes[name].is_a?(HashDealer)
     self.hashes[name]._attributes(*args)
   end
   

data/lib/path_string.rb

@@ -28,7 +28,7 @@ class PathString < String
   
   def self.as_sorted_json(val)
     val = self.sort_json(val)
-    val.pathify_strings!
+    val = val.pathify_strings
     val
   end
   

data/lib/variable_array.rb

@@ -0,0 +1,11 @@
+class VariableArray < Array
+  def ==(other)
+    if other.is_a?(Array)
+      comp = self[1..(self.length - 1)]
+      return true if comp.first == other.first
+    else
+      super
+    end
+  end
+  alias_method :eql?, :==
+end

data/spec/lib/hash_dealer_spec.rb

@@ -130,4 +130,15 @@ describe HashDealer do
     HashDealer.roll(:test)[:attributes].should eql("test")
     HashDealer.roll(:test).matcher[:attributes].should eql(":test")
   end
+  
+  it "should allow the use of a HashDealer in the definition of another before the first is defined" do
+    HashDealer.define(:b) do
+      hash_a(HashDealer.roll(:a))
+    end
+    HashDealer.define(:a) do
+      a("123")
+    end
+    HashDealer.roll(:b).should eql({:hash_a => {:a => "123"}})
+  end
+  
 end

data/spec/lib/matcher_spec.rb

@@ -14,4 +14,9 @@ describe "match_resonse Matcher" do
     {"a" => ":b"}.should match_list([{"a" => "test"}, {"a" => "test2"}])
   end
   
+  it "should match using wildcards for variable length arrays" do
+    {"a" => ["a"]}.matcher.should match_response({"a" => ["a", "b", "c", "d"]})
+    {"a" => [{"a" => "b"}]}.matcher.should match_response({"a" => [{"a" => "c"},{"a" => "x"},{"a" => "y"}]})
+  end
+  
 end

metadata

@@ -2,7 +2,7 @@
 name: hash_dealer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors: 
 - Dan Langevin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-25 00:00:00 Z
+date: 2011-08-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -112,6 +112,7 @@ files:
 - lib/hash_dealer.rb
 - lib/matcher.rb
 - lib/path_string.rb
+- lib/variable_array.rb
 - spec/lib/hash_dealer_spec.rb
 - spec/lib/matcher_spec.rb
 - spec/lib/path_string_spec.rb
@@ -129,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3331694246731303035
+      hash: -979585820027461548
       segments: 
       - 0
       version: "0"