pork 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aacd67d75401cc17261741e93e992df0ad2f3132
-  data.tar.gz: 67ff0980b2a2505762afd341d764c6fc3df8b98a
+  metadata.gz: 814a6e5d8622a7c77c53f88b539b81d77f39872f
+  data.tar.gz: 4269395ba1774b0051195edd772d1c850298da6c
 SHA512:
-  metadata.gz: 13f2ee44b10391b913fc9b967d21669d78fbb238a4935a7e95a0ef8086af402d4b4ef26dba1e94b7355ed561b773a48a64a411841604101eb2f285062de76501
-  data.tar.gz: 229a1171f3244870561f1205313bd472dacc26577997557fd00a3801b2b3f449137955d1feea5c2730979f6526fa6d06c24296a9e2d178d3ca1c03e4393b24da
+  metadata.gz: 46b0342699c72744ff5cc2fc230c13b328df33ad1593ee872a83ac4283827f27e3b42cc926be1f4a93d586df15e8f813e1cac828fb86e1119e1739abad83f3ac
+  data.tar.gz: 597fb9cbf4754d9866e55d9a7ed4c334d63c067791cfad332169341d1edcce6a7947b77dcd8173dd88732995733bbf7fabee790d11992c62a78e0c9130ac337a

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## Pork 1.0.2 -- 2014-12-09
+
+* Hash difference is much improved. Now it uses `/` to separate keys,
+  and use quotes for string keys and colons for symbol keys, so that
+  we won't be confused when comparing string hashes and symbol hashes.
+  Further more, it would show `<undefined>` for hashes missing a key,
+  and `<out-of-bound>` for arrays out of bound. Previously, hash with
+  nil values are indistinguishable with hash missing keys.
+  Thanks Chun-Yi Liu (@trantorliu).
+
 ## Pork 1.0.1 -- 2014-11-21
 
 * Fixed the failure message for hash diff.

data/README.md

@@ -848,6 +848,7 @@ Then it would always use the mode we specified.
 
 ## CONTRIBUTORS:
 
+* Chun-Yi Liu (@trantorliu)
 * Lin Jen-Shin (@godfat)
 * Josh Kalderimis (@joshk)
 

data/lib/pork/inspect.rb

@@ -6,6 +6,19 @@ module Pork
   end
 
   class Inspect < Struct.new(:flip)
+    Undefined = Object.new
+    Undefined.singleton_class.module_eval do
+      def inspect
+        '<undefined>'
+      end
+    end
+    OutOfBound = Object.new
+    OutOfBound.singleton_class.module_eval do
+      def inspect
+        '<out-of-bound>'
+      end
+    end
+
     def self.with *args
       lambda{ public_send("with_#{Pork.inspect_failure_mode}", *args) }
     end
@@ -38,7 +51,7 @@ module Pork
     def self.for_diff_hash msg, negate, result
       "\n" + result.map do |key, (expect, actual)|
         body = with_auto(expect, msg, [actual], negate)
-        "\tHash with key path: #{key.inspect}\n#{body.sub(/\A\n/, '')}"
+        "\tHash with key path: #{key}\n#{body.sub(/\A\n/, '')}"
       end.join("\n\n")
     end
 
@@ -68,13 +81,23 @@ module Pork
 
     def diff_hash expect, actual, result={}, prefix=''
       expect.inject(result) do |r, (key, e)|
-        diff_object(e, actual[key], r, "#{prefix}#{key}")
+        a = if actual.key?(key)
+          actual[key]
+        else
+          Undefined
+        end
+        diff_object(e, a, r, "#{prefix}#{key.inspect}")
       end
     end
 
     def diff_array expect, actual, result={}, prefix=''
       expect.each.with_index.inject(result) do |r, (e, idx)|
-        diff_object(e, actual[idx], r, "#{prefix}#{idx}")
+        a = if idx < actual.size
+          actual[idx]
+        else
+          OutOfBound
+        end
+        diff_object(e, a, r, "#{prefix}#{idx}")
       end
     end
 
@@ -82,9 +105,9 @@ module Pork
       return result if expect == actual
 
       if expect.kind_of?(Hash) && actual.kind_of?(Hash)
-        diff_hash(expect, actual, result, "#{prefix}:")
+        diff_hash(expect, actual, result, "#{prefix}/")
       elsif expect.kind_of?(Array) && actual.kind_of?(Array)
-        diff_array(expect, actual, result, "#{prefix}:")
+        diff_array(expect, actual, result, "#{prefix}/")
       elsif flip
         result[prefix] = [actual, expect]
       else

data/lib/pork/version.rb

@@ -1,4 +1,4 @@
 
 module Pork
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/pork.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: pork 1.0.1 ruby lib
+# stub: pork 1.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pork"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-11-21"
+  s.date = "2014-12-09"
   s.description = "Pork -- Simple and clean and modular testing library.\n\nInspired by [Bacon][].\n\n[Bacon]: https://github.com/chneukirchen/bacon"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
   "test/test_shuffle.rb"]
   s.homepage = "https://github.com/godfat/pork"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.4"
+  s.rubygems_version = "2.4.5"
   s.summary = "Pork -- Simple and clean and modular testing library."
   s.test_files = [
   "test/test_bacon.rb",

data/test/test_inspect.rb

@@ -21,6 +21,51 @@ describe Pork::Inspect do
       should.eq "String#==(\n#{n}a#{n+1}\n> b\n) to return false"
   end
 
+  would '#diff_hash with nil and <undefined>' do
+    z = 'z'*80
+    a, b = {:z => z, :a => nil}, {:z => z}
+    Pork::Inspect.with_auto(a, :==, [b], false).should.start_with? <<-MSG.chop
+
+\tHash with key path: :a
+nil.==(<undefined>) to return true
+    MSG
+
+    Pork::Inspect.with_auto(b, :==, [a], false).should.start_with? <<-MSG.chop
+
+\tHash with key path: :a
+<undefined>.==(nil) to return true
+    MSG
+  end
+
+  would '#diff_hash with nil and <out-of-bound>' do
+    z = 'z'*80
+    a, b = {:a => {:b => [z, nil]}}, {:a => {:b => [z]}}
+    Pork::Inspect.with_auto(a, :==, [b], false).should.start_with? <<-MSG.chop
+
+\tHash with key path: :a/:b/1
+nil.==(<out-of-bound>) to return true
+    MSG
+
+    Pork::Inspect.with_auto(b, :==, [a], false).should.start_with? <<-MSG.chop
+
+\tHash with key path: :a/:b/1
+<out-of-bound>.==(nil) to return true
+    MSG
+  end
+
+  would '#diff_hash with string keys and symbol keys' do
+    z = 'z'*80
+    a, b = {:a => z}, {'a' => z}
+    Pork::Inspect.with_auto(a, :==, [b], false).should.start_with? <<-MSG.chop
+
+\tHash with key path: :a
+#{z.inspect}.==(\n<undefined>) to return true
+
+\tHash with key path: "a"
+<undefined>.==(#{z.inspect}) to return true
+    MSG
+  end
+
   would '#diff_hash' do
     a = {"category_chats"=>[{"category_name"=>"Cat", "experts_url"=>"cat-experts", "chat_list"=>[{"mentee"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"example", "name"=>"Example", "level"=>"mentor", "rating"=>0.0, "role"=>"user", "avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm?s=64&d=mm"}, "mentor"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"menmen", "name"=>"Menmen", "level"=>"mentor", "rating"=>0.0, "role"=>"mentor", "avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm?s=64&d=mm"}, "chatroom_id"=>"8c3dd9387dd30499a4053e07e4a41be4", "chatroom_firebase_id"=>"49c31f7444e199bdaea610dbe518d329"}]}], "longterm"=>[{"rate"=>"3.00", "credit"=>"7.00", "valid_from"=>1416148781, "valid_to"=>1416235181, "mentee"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"example", "name"=>"Example", "level"=>"mentor", "rating"=>0.0, "role"=>"user", "avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm?s=64&d=mm"}, "mentor"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"menmen", "name"=>"Menmen", "level"=>"mentor", "rating"=>0.0, "role"=>"mentor", "avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm?s=64&d=mm"}, "chatroom_id"=>"8c3dd9387dd30499a4053e07e4a41be4", "chatroom_firebase_id"=>"49c31f7444e199bdaea610dbe518d329"}], "my"=>[], "recent_chats"=>[{"request"=>{}, "type"=>"message", "id"=>"e71bca4b-a617-4edc-9816-7fc3034c64ea", "content"=>"hi", "created_at"=>"2014-11-16T14:39:41Z", "read_at"=>nil, "sender"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"example", "name"=>"Example", "level"=>"mentor", "rating"=>0.0, "role"=>"user", "avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm?s=64&d=mm"}, "receiver"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"menmen", "name"=>"Menmen", "level"=>"mentor", "rating"=>0.0, "role"=>"mentor", "avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm?s=64&d=mm"}, "chatroom_id"=>"8c3dd9387dd30499a4053e07e4a41be4", "chatroom_firebase_id"=>"49c31f7444e199bdaea610dbe518d329"}]}
 
@@ -29,12 +74,12 @@ describe Pork::Inspect do
     f = expect.raise(Pork::Failure){ expect(a, 'Additional Message').eq(b) }
     expect(f.message).eq <<-MSG.sub(/\AExpect/, 'Expect ').chop
 Expect
-\tHash with key path: "category_chats:0:chat_list:0:mentor"
+\tHash with key path: "category_chats"/0/"chat_list"/0/"mentor"
 {"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"menmen", "name"=>"Menmen", "level"=>"mentor", "rating"=>0.0, "role"=>"mentor", "avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/556611444ab1143c8ad30206fda3926f?d=mm?s=64&d=mm"}.==(
-nil) to return true
+<undefined>) to return true
 
-\tHash with key path: "my:0"
-nil.==({"mentee"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"example", "name"=>"Example", "level"=>"mentor", "rating"=>0.0, "role"=>"user", "avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm?s=64&d=mm"}, "chatroom_id"=>"8c3dd9387dd30499a4053e07e4a41be4", "chatroom_firebase_id"=>"49c31f7444e199bdaea610dbe518d329"}) to return true
+\tHash with key path: "my"/0
+<out-of-bound>.==({"mentee"=>{"timezone_str"=>"+00:00", "timezone_offset"=>0, "timezone_display"=>"UTC (+00:00)", "username"=>"example", "name"=>"Example", "level"=>"mentor", "rating"=>0.0, "role"=>"user", "avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm", "small_avatar_url"=>"https://www.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?d=mm?s=64&d=mm"}, "chatroom_id"=>"8c3dd9387dd30499a4053e07e4a41be4", "chatroom_firebase_id"=>"49c31f7444e199bdaea610dbe518d329"}) to return true
 Additional Message
     MSG
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pork
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: muack
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pork -- Simple and clean and modular testing library.