eq_json 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ec463196fe5607b1e9b24b069a789c237c4dd28
-  data.tar.gz: aa249d10540740c92146fc97766617812409cefa
+  metadata.gz: 54c360affa2fa9e451be2b9c0765921b6e47d8cf
+  data.tar.gz: 287c476265ac3839bd51f65f3a4457d5b21bc02f
 SHA512:
-  metadata.gz: 2a431e39d5628ab69001a5fde73f84713227395baac64f038cf7d29ed443c758ae492397637e053836bbf4564ba810408ae31ef0b2e76eda70ffe2762a5883e0
-  data.tar.gz: 17f55e32ef6021a364cae492e213fd50b733114234fa74067891dfcb4888ac2672fde88b82c917f157e3c173d37c834e737de0366f73ab9a27e1130f19360f71
+  metadata.gz: ce546a2c31702fe243970f867241ebf234c5897b997bb6c226068f348e6c071a45892d921d6f1e3a047f84acf9fa1966bb7f1d1d261945a0826f83f570ad4f03
+  data.tar.gz: 252d2b5eb57a2bdea5ad22cf2eab566edcc11e8248143e184bf352fe692bb00907f6a975d096a7ecfd0a515a6de9a4dfdbeb0afe5f565e20a8399baad6ce311c

data/.gitignore

@@ -14,3 +14,4 @@ mkmf.log
 .idea
 *.iml
 *.gem
+out

data/README.md

@@ -2,7 +2,7 @@
 
 <!-- [![Build Status](https://travis-ci.org/jadekler/eq_wo_order.svg?branch=master)](https://travis-ci.org/jadekler/eq_wo_order) -->
 
-RSpec equality matcher that JSON.  Outputs meaningful failure messages.
+RSpec equality matcher that is JSON aware.  Outputs meaningful failure messages.
 
 
 ## Installation
@@ -56,8 +56,58 @@ expected = {
   }
 }
 
-expect(expected).to eq_json(actual)
+expect(actual).to eq_json(expected)
 ```
+
+There is also a special json array matcher.  This is used to match json arrays which are arrays of JSON
+objects which have a key.  The key is used to compare objects in the array.  The matcher looks for items in
+the actual using the key.  It then compares the expected item and actual item that it found via the key.
+  The key is passed in to the matcher with the expected value.  In the example
+below a JSON array of book objects is being compared.  Each book has a bookId which is used by the matcher to
+do the compare of expected and actual
+```ruby
+  actualArray = [
+        {
+            bookId: "1",
+            name: "Harry Potter and the Sorcerer's Stone",
+            author: "J.K. Rowling"
+        },
+        {
+            bookId: "2",
+            name: "Eragon",
+            author: "Christopher Paolini",
+        },
+        {
+            bookId: "3",
+            name: "The Fellowship of the Ring",
+            author: "J.R.R. Tolkien"
+
+        }
+    ]
+
+    expectedArray = [
+        {
+            bookId: "3",
+            name: "The Fellowship of the Ring",
+            author: "J.R.R. Tolkien"
+
+        },
+        {
+            bookId: "1",
+            name: "Harry Potter and the Sorcerer's Stone",
+            author: "J.K. Rowling"
+        },
+        {
+            bookId: "2",
+            name: "Eragon",
+            author: "Christopher Paolini"
+        }
+    ]
+
+    expect(actualArray).to eq_json_array_with_key(expectedArray, :bookId)
+
+```
+
 # More Documentation
 [Keynote Slides](https://github.com/davidmrhodes/eq_json/blob/master/doc/eqJsonPresentation.key)
 

data/TODO.txt

@@ -1,31 +1,19 @@
-1) Implement array equals
-    a) make sure to test that arrays with same objects but different number of
-    same objects is not equal.  Must test with same number of total objects in
-    array
 
-2) Document that did not use matcher DSL.  Easier to test if just used class.
-
-3)  Look to see on diff what should get actual is green or red?
+1)  Look to see on diff what should get actual is green or red?
     Answer:  expected is - in red
 
-4) If object is a string and is multi line use differ in failure_message
+2) If object is a string and is multi line use differ in failure_message
 
-5) test for json object combinations of (do for actual also)
+3) test for json object combinations of (do for actual also)
        first key in map not in expected
        middle key in map not in expected
        last key in map not in expected
 
-6) Do I need to check expected and actual are valid josn?
-
+4) Do I need to check expected and actual are valid josn?
 
-7) Add comparable function with an selection criteria for and id to compare arrays
 
-8) If objects are large write them to a files in temp
-Could be done via configuration to find if configuration exists:
+5) Add comparable function with an selection criteria for and id to compare arrays
 
-if RSpec.configuration.methods.include? :json_debug_config
-   puts "json_debug_config #{RSpec.configuration.json_debug_config}"
-end
+6) Had suggestion to make color brighter red
 
-Then put this in spec_helper:
-c.json_debug_config=true
+7) Had suggestion to print out sorted json in debug mode.

data/eq_json.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name        = 'eq_json'
-  s.version     = '1.0.2'
-  s.date        = '2016-02-29'
-  s.summary     = 'RSpec equality matcher that to compare JSON'
+  s.version     = '2.0.0'
+  s.date        = '2017-05-12'
+  s.summary     = 'RSpec equality matcher that compares JSON'
   s.description = 'RSpec equality matcher that deeply compares JSON. Examples at github.com/davidmrhodes/eq_json'
    s.authors     = ['David M. Rhodes']
   s.email       = 'barnaby71@gmail.com'
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'rspec', '~> 3.0'
+  s.add_runtime_dependency 'json', '~> 1.7'
   s.add_development_dependency 'bundler', '~> 1.7'
   s.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/array_with_key_message_gen.rb

@@ -0,0 +1,54 @@
+require 'colorizer'
+
+class ArrayWithKeyMessageGen
+
+  def initialize(matcher)
+    @matcher = matcher
+    @colorizer = EqJsonColorizer.new
+  end
+
+  def generateFailureMessage(expectedItem, eqFailureMessage)
+    return "#{@matcher.key} #{expectedItem[@matcher.key]}\n" +
+        eqFailureMessage
+  end
+
+  def generateExpectedNotInActual(expectedItem)
+    return "#{@matcher.key} #{expectedItem[@matcher.key]} not found in actual\n" +
+        "Expected: #{expectedItem.to_json}\n"
+  end
+
+  def generateExpectedItemMissingKey(expectedItem)
+    return "Tester error expected item does not have key #{@matcher.key}.\n" +
+        "Expected item: #{expectedItem.to_json}\n"
+  end
+
+
+  def generateDifferentSizeArrays()
+    objectsNotInExpected = getObjectsNotIn(@matcher.actual, @matcher.expected);
+    objectsNotInActual = getObjectsNotIn(@matcher.expected, @matcher.actual);
+
+    jsonErrorInfo = "Array size does not match. Expected #{@matcher.expected.length} actual #{@matcher.actual.length}\n"
+
+    unless objectsNotInExpected.empty?
+      jsonErrorInfo << "expected does not contain #{@matcher.key}s #{objectsNotInExpected}\n"
+    end
+
+    unless objectsNotInActual.empty?
+      jsonErrorInfo << "actual does not contain #{@matcher.key}s #{objectsNotInActual}\n"
+    end
+
+    return jsonErrorInfo
+  end
+
+  def getObjectsNotIn(array1, array2)
+    missing = []
+    array1.each do |item1|
+      item2 = array2.find {|item| item[@matcher.key] == item1[@matcher.key]}
+      if item2.nil?
+        missing.push(item1[@matcher.key])
+      end
+    end
+    return missing
+  end
+end
+

data/lib/debug_dumper.rb

@@ -0,0 +1,22 @@
+require 'tmpdir'
+
+class EqJsonDebugDumper
+
+  def initialize(matcher)
+    @matcher = matcher
+  end
+
+  def dump
+    dumpToFile('expected', @matcher.expected)
+    dumpToFile('actual', @matcher.actual)
+    dumpToFile('currentExpectedObj', @matcher.currentExpectedObj)
+    dumpToFile('currentActualObj', @matcher.currentActualObj)
+  end
+
+  def dumpToFile(baseName, jsonHash)
+    fileName = Dir.tmpdir() + File::SEPARATOR + "#{baseName}.json"
+    File.open(fileName, "w") do |file|
+      file.print JSON.pretty_generate(jsonHash)
+    end
+  end
+end

data/lib/eq_json.rb

@@ -1,8 +1,9 @@
 require 'pp'
 require 'message_generator'
 require 'eq_json_array'
+require 'debug_dumper'
 
-class EqualWithOutOrderJson
+class EqualJson
 
   attr_accessor :actual, :expected, :jsonPath, :jsonPathRoot, :currentActualObj,
                 :currentExpectedObj, :currentJsonKey
@@ -21,6 +22,12 @@ class EqualWithOutOrderJson
   end
 
   def failure_message
+    if RSpec.configuration.methods.include? :json_debug_config
+      if RSpec.configuration.json_debug_config?
+        debugDumper = EqJsonDebugDumper.new(self)
+        debugDumper.dump()
+      end
+    end
     return @failureMessage
   end
 
@@ -138,5 +145,7 @@ class EqualWithOutOrderJson
 end
 
 def eq_json(*args)
-  EqualWithOutOrderJson.new(*args)
+  EqualJson.new(*args)
 end
+
+

data/lib/eq_json_array_with_key.rb

@@ -0,0 +1,59 @@
+require 'pp'
+require 'message_generator'
+require 'debug_dumper'
+require 'eq_json'
+require 'array_with_key_message_gen'
+
+class EqualJsonArrayWithKey
+
+  attr_accessor :actual, :expected, :key
+
+  def initialize(expected, key)
+    unless key.is_a? Symbol
+      raise "Key should be a symbol"
+    end
+    @expected = expected
+    @key = key
+    @messageGenerator = ArrayWithKeyMessageGen.new(self)
+  end
+
+  def matches?(actual)
+    @actual = actual
+
+    unless actual.length == expected.length
+      @failureMessage = @messageGenerator.generateDifferentSizeArrays()
+      return false
+    end
+
+    @expected.each() do |expectedItem|
+      puts "expectedItem[key] #{expectedItem[@key]}"
+      if expectedItem[@key].nil?
+        puts "got here dmr"
+        @failureMessage = @messageGenerator.generateExpectedItemMissingKey(expectedItem)
+        return false
+      end
+
+      actualItem = actual.find {|item| item[@key] == expectedItem[@key]}
+      if actualItem.nil?
+        @failureMessage = @messageGenerator.generateExpectedNotInActual(expectedItem)
+        return false;
+      end
+      @eqJsonMatcher=EqualJson.new(expectedItem)
+      if !@eqJsonMatcher.matches?(actualItem)
+        @failureMessage = @messageGenerator.generateFailureMessage(expectedItem, @eqJsonMatcher.failure_message)
+        return false;
+      end
+    end
+
+    return true;
+  end
+
+  def failure_message
+    return @failureMessage
+  end
+
+end
+
+def eq_json_array_with_key(*args)
+  EqualJsonArrayWithKey.new(*args)
+end

data/spec/features/eq_json_spec.rb

@@ -18,7 +18,7 @@ describe 'test objects not same type' do
 
     actualJson=actual.to_json
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 
@@ -75,7 +75,7 @@ describe 'test single level json objects' do
         author: 'J.K. Rowling'
     }
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 
@@ -107,7 +107,7 @@ describe 'test single level json objects' do
         name: 'Harry Potter and the Sorcerer\'s Stone',
     }
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 
@@ -140,7 +140,7 @@ describe 'test single level json objects' do
         name: 'Harry Potter and the Sorcerer\'s Stone',
     }
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 
@@ -175,7 +175,7 @@ describe 'test single level json objects' do
     }
 
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 
@@ -210,7 +210,7 @@ describe 'test single level json objects' do
         author: 'J.K. Rowling'
     }
 
-    customMatcher=EqualWithOutOrderJson.new(expected)
+    customMatcher=EqualJson.new(expected)
 
     expect(customMatcher.matches?(actual)).to eq(false)
 

data/spec/features/test_eq_json_array_with_key_size_mismatch_spec.rb

@@ -0,0 +1,208 @@
+require 'json'
+require 'eq_json_array_with_key'
+require 'spec_helper.rb'
+
+describe 'test arrays not the same size' do
+
+  it 'actual contains more items than expected' do
+
+    actual = {
+        bookSeller: "amazon",
+        bookWholeSellers: {
+            publisherInfo: {
+                name: "ACME Publisher Inc.",
+                publishDate: {
+                    month: 3,
+                    day: 23,
+                    year: 2015
+                },
+                products: {
+                    books: [
+                        {
+                            bookId: "1",
+                            name: "Harry Potter and the Sorcerer's Stone",
+                            author: "J.K. Rowling"
+                        },
+                        {
+                            bookId: "2",
+                            name: "Eragon",
+                            author: "Christopher Paolini",
+                        },
+                        {
+                            bookId: "4",
+                            name: "Effective Java",
+                            authoer: "Cannot Remember"
+                        },
+                        {
+                            bookId: "5",
+                            name: "The HP Way",
+                            authoer: "Bill and Dave"
+                        },
+                        {
+                            bookId: "3",
+                            name: "The Fellowship of the Ring",
+                            author: "J.R.R. Tolkien"
+
+                        }
+                    ]
+                }
+            }
+        },
+        url: "www.amazon.com"
+
+    }
+    actualArray = actual[:bookWholeSellers][:publisherInfo][:products][:books]
+
+    expected = {
+        bookSeller: "amazon",
+        bookWholeSellers: {
+            publisherInfo: {
+                name: "ACME Publisher Inc.",
+                publishDate: {
+                    month: 3,
+                    day: 23,
+                    year: 2015
+                },
+                products: {
+                    books: [
+                        {
+                            bookId: "3",
+                            name: "The Fellowship of the Ring",
+                            author: "J.R.R. Tolkien"
+
+                        },
+                        {
+                            bookId: "1",
+                            name: "Harry Potter and the Sorcerer's Stone",
+                            author: "J.K. Rowling"
+                        },
+                        {
+                            bookId: "2",
+                            name: "Eragon",
+                            author: "Christopher Paolini"
+                        }
+                    ]
+                }
+            }
+        },
+        url: "www.amazon.com"
+    }
+
+    expectedArray = expected[:bookWholeSellers][:publisherInfo][:products][:books]
+
+
+    customMatcher=EqualJsonArrayWithKey.new(expectedArray, :bookId)
+
+    expect(customMatcher.matches?(actualArray)).to eq(false)
+
+    expectedJson=expected.to_json;
+    actualJson=actual.to_json;
+
+    String expectedErrorMessage= "Array size does not match. Expected 3 actual 5\n" +
+        "expected does not contain bookIds [\"4\", \"5\"]\n"
+
+    expect(customMatcher.failure_message).to eq(expectedErrorMessage)
+
+    expect(actualArray).not_to eq_json_array_with_key(expectedArray, :bookId)
+
+  end
+
+  it 'expected contains more items than actual' do
+
+    actual = {
+        bookSeller: "amazon",
+        bookWholeSellers: {
+            publisherInfo: {
+                name: "ACME Publisher Inc.",
+                publishDate: {
+                    month: 3,
+                    day: 23,
+                    year: 2015
+                },
+                products: {
+                    books: [
+                        {
+                            bookId: "1",
+                            name: "Harry Potter and the Sorcerer's Stone",
+                            author: "J.K. Rowling"
+                        },
+                        {
+                            bookId: "2",
+                            name: "Eragon",
+                            author: "Christopher Paolini",
+                        },
+                        {
+                            bookId: "3",
+                            name: "The Fellowship of the Ring",
+                            author: "J.R.R. Tolkien"
+
+                        }
+                    ]
+                }
+            }
+        },
+        url: "www.amazon.com"
+
+    }
+    actualArray = actual[:bookWholeSellers][:publisherInfo][:products][:books]
+
+    expected = {
+        bookSeller: "amazon",
+        bookWholeSellers: {
+            publisherInfo: {
+                name: "ACME Publisher Inc.",
+                publishDate: {
+                    month: 3,
+                    day: 23,
+                    year: 2015
+                },
+                products: {
+                    books: [
+                        {
+                            bookId: "3",
+                            name: "The Fellowship of the Ring",
+                            author: "J.R.R. Tolkien"
+
+                        },
+                        {
+                            bookId: "1",
+                            name: "Harry Potter and the Sorcerer's Stone",
+                            author: "J.K. Rowling"
+                        },
+                        {
+                            bookId: "2",
+                            name: "Eragon",
+                            author: "Christopher Paolini"
+                        },
+                        {
+                            bookId: "5",
+                            name: "The HP Way",
+                            authoer: "Bill and Dave"
+                        }
+                    ]
+                }
+            }
+        },
+        url: "www.amazon.com"
+    }
+
+    expectedArray = expected[:bookWholeSellers][:publisherInfo][:products][:books]
+
+
+    customMatcher=EqualJsonArrayWithKey.new(expectedArray, :bookId)
+
+    expect(customMatcher.matches?(actualArray)).to eq(false)
+
+    expectedJson=expected.to_json;
+    actualJson=actual.to_json;
+
+    String expectedErrorMessage= "Array size does not match. Expected 4 actual 3\n" +
+        "actual does not contain bookIds [\"5\"]\n"
+
+    expect(customMatcher.failure_message).to eq(expectedErrorMessage)
+
+    expect(actualArray).not_to eq_json_array_with_key(expectedArray, :bookId)
+
+  end
+
+end