add hash_eq matcher for nicer hash diffs

Author: alexconlin

Gemfile

@@ -11,6 +11,7 @@ group :development do
   gem 'ci_reporter_rspec', '1.0.0'
   gem 'pry'
   gem 'pry-byebug'
+  gem 'hashdiff'
   gem 'rake', '10.1.0'
   gem 'syck' if RUBY_VERSION.split('.').first.to_i > 1
 end

Gemfile.lock

@@ -30,6 +30,7 @@ GEM
       CFPropertyList (~> 2.2)
     git (1.7.0)
       rchardet (~> 1.8)
+    hashdiff (1.0.1)
     hiera (1.3.4)
       json_pure
     json (2.3.0)
@@ -88,6 +89,7 @@ PLATFORMS
 DEPENDENCIES
   ci_reporter_rspec (= 1.0.0)
   collimator (= 0.0.3)
+  hashdiff
   mcollective-client (= 2.8.2)
   orc!
   pry

spec/matchers/hash_eq.rb

@@ -0,0 +1,23 @@
+require 'hashdiff'
+
+RSpec::Matchers.define :hash_eq do |expected|
+  match do |actual|
+    expect(expected).to eq(actual)
+  end
+  failure_message do |actual|
+    diff = Hashdiff.diff(expected, actual)
+    message = "Expected hashes to be identical, diff is:"
+    diff.each do |change|
+      message << "\n"
+      case change[0]
+      when "-"
+        message << "- #{change[1]} => #{change[2]}"
+      when "+"
+        message << "+ #{change[1]} => #{change[2]}"
+      when "~"
+        message << "~ #{change[1]}: #{change[2]} -> #{change[3]}"
+      end
+    end
+    message
+  end
+end