muack 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa632f54941b0ba538198221b3d03ec320e9df35
-  data.tar.gz: 386833604c697560c445c7df2ec677f5a5159cf2
+  metadata.gz: 309cafc82b9f7538884fa099e8ab6827d183afcf
+  data.tar.gz: 64a20f3374a9c72abe10c4c7a78f26651c04c09b
 SHA512:
-  metadata.gz: 3c3ea805f32a36c9ec6bc82af5a705bae2ff4cbb059ab71c3dd2c1ed638784ee84d98ea244de4c95b72558e9da2256944c5d853aa9c9ea72f4c98b47014909bc
-  data.tar.gz: ba26968d9d944c7263160bf6583d8a0cfdd1def6711122b90ef59d5af108c5696869d5f283ab40de9120602ca76b4a8c01408bc4fdcf882049a4cc8b26f8db18
+  metadata.gz: 312fd3143189a03c2c8d1fbe85a74296ccc71fd8247d09fc83ea8a5fc4ba3407fde7f7507e9c58d611cc476457b02d8b8ad614d1c6f9555694f2037c783eccc9
+  data.tar.gz: 658d76b3ddac4ad03c10f643f8e16f996d1250862995037c4460abf586423b1e389e851bf4f376004187dbe1069b765428b8993d9175130db5627be586a50c7c

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## Muack 1.4.0 -- 2015-11-21
+
+### Incompatible changes / Enhancement
+
+* Spies would now do pattern matching like stubs for matching
+  method arguments. This could be an incompatible change if you're
+  relying on spies checking the order for the same method calls.
+  This change would make spies and stubs more similar. If you are
+  really into a specific order, use mocks instead.
+
 ## Muack 1.3.2 -- 2015-06-11
 
 * Fixed a bug for `where`, `having`, and `allowing` which should distinguish

data/README.md

@@ -1,4 +1,4 @@
-# Muack [![Build Status](https://secure.travis-ci.org/godfat/muack.png?branch=master)](http://travis-ci.org/godfat/muack) [![Coverage Status](https://coveralls.io/repos/godfat/muack/badge.png?branch=master)](https://coveralls.io/r/godfat/muack?branch=master)
+# Muack [![Build Status](https://secure.travis-ci.org/godfat/muack.png?branch=master)](http://travis-ci.org/godfat/muack) [![Coverage Status](https://coveralls.io/repos/godfat/muack/badge.png?branch=master)](https://coveralls.io/r/godfat/muack?branch=master) [![Join the chat at https://gitter.im/godfat/muack](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/muack)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 
@@ -39,9 +39,9 @@ Here's a quick example using [Pork][].
 require 'pork/auto'
 require 'muack'
 
-include Muack::API
-
 describe 'Hello' do
+  include Muack::API
+
   before{ Muack.reset  }
   after { Muack.verify }
 
@@ -98,7 +98,7 @@ p obj.name     # 'obj'
 p Muack.verify # true
 ```
 
-Which is roughly semantically equivalent to using a stub with a spy:
+Which is similar to using a stub with a spy:
 
 ``` ruby
 obj = Object.new
@@ -143,6 +143,11 @@ p Muack.verify # true
 However you should not mix mocks and stubs with the same method, or you
 might encounter some unexpected result. Jump to _Caveat_ for more detail.
 
+The other differences for stubs and spies, please check
+[Pattern Matching for stubs and spies][pattern-matching].
+In short, stubs and spies would do some kind of pattern matching,
+making the order of the same method irrelevant.
+
 On the other hand, stubs aren't limited to testing. If we want to monkey
 patching something, stubs could be useful as we don't care how many times
 the injected methods are called. Jump to _Muack as a mocky patching library_
@@ -326,7 +331,7 @@ If the order is reversed, then it would always return the original value,
 because the proxy would always match, and Muack would stop searching the
 next stub.
 
-[pattern-matching]: #arguments-verifiers-satisfy
+[pattern-matching]: #pattern-matching-for-stubs-and-spies
 
 #### any_instance_of mode
 
@@ -446,7 +451,7 @@ p Muack.verify # true
 
 Note that it does not make sense to specify `times` for stubs, because
 stubs don't care about times. Spies do, though. So this is also
-semantically equivalent to below:
+similar to below:
 
 ``` ruby
 obj = Object.new
@@ -708,6 +713,8 @@ obj.say{ |msg| p msg } # 'Hi'
 p Muack.verify  # true
 ```
 
+#### Pattern Matching for stubs and spies
+
 Moreover, we could also have stubs on the same method for different
 arguments. We could think of this as a sort of pattern matching, and Muack
 would try to find the best matched stub for us.
@@ -722,7 +729,8 @@ p Muack.verify # true
 ```
 
 If `obj.find(2)` is called and Muack cannot find a matched stub, it would
-raise a `Muack::Unexpected` and list the candidates for us.
+raise a `Muack::Unexpected` and list the candidates for us. This also
+applies to spies.
 
 However, What if we don't want to be so exact? Then we should use verifiers.
 We'll introduce each of them in next section. Note that verifiers
@@ -1114,7 +1122,7 @@ Consider we have two classes:
 
 ```  ruby
 Food = Class.new
-User = Class.new{ attr_accessor :food }
+User = Class.new(Struct.new(:food))
 ```
 
 And we could make sure User#food is always a kind of `Food` by putting this
@@ -1141,7 +1149,7 @@ verifiers. For example, we could do this to check if the food is frozen:
 
 ``` ruby
 Food = Class.new
-User = Class.new{ attr_accessor :food }
+User = Class.new(Struct.new(:food))
 
 FoodFrozen = Class.new(Muack::Satisfying) do
   def match actual_arg

data/lib/muack/mock.rb

@@ -61,14 +61,7 @@ module Muack
             Unexpected.new(object, [defi], msg, actual_args))
         end
       else
-        defis = __mock_disps[msg]
-        if expected = defis.find{ |d| __mock_check_args(d.args, actual_args) }
-          Mock.__send__(:raise, # Too many times
-            Expected.new(object, expected, defis.size, defis.size+1))
-        else
-          Mock.__send__(:raise, # Wrong argument
-            Unexpected.new(object, defis, msg, actual_args))
-        end
+        __mock_failed(msg, actual_args)
       end
     end
 
@@ -178,6 +171,17 @@ module Muack
       target.__send__(privilege, defi.msg)
     end
 
+    # used for __mock_dispatch
+    def __mock_failed msg, actual_args, disps=__mock_disps[msg]
+      if expected = __mock_find_checked_difi(disps, actual_args)
+        Mock.__send__(:raise, # Too many times
+          Expected.new(object, expected, disps.size, disps.size+1))
+      else
+        Mock.__send__(:raise, # Wrong argument
+          Unexpected.new(object, disps, msg, actual_args))
+      end
+    end
+
     # used for __mock_dispatch_call
     def __mock_block_call context, block, actual_args, actual_block, splat
       return unless block
@@ -191,6 +195,10 @@ module Muack
       end
     end
 
+    def __mock_find_checked_difi defis, actual_args, meth=:find
+      defis.public_send(meth){ |d| __mock_check_args(d.args, actual_args) }
+    end
+
     def __mock_check_args expected_args, actual_args
       if expected_args == [WithAnyArgs]
         true

data/lib/muack/spy.rb

@@ -10,10 +10,8 @@ module Muack
 
     # used for Muack::Session#verify
     def __mock_verify
-      @stub.__mock_disps.values.flatten.each do |defi|
-        __mock_dispatch(defi.msg, defi.args) if __mock_defis.key?(defi.msg)
-      end
-      super # simulate dispatching before passing to mock to verify
+      __mock_dispatch_spy
+      super
     end
 
     # used for Muack::Session#reset, but spies never leave any track
@@ -21,5 +19,21 @@ module Muack
 
     private
     def __mock_inject_method defi; end # spies don't leave any track
+
+    # simulate dispatching before passing to mock to verify
+    def __mock_dispatch_spy
+      @stub.__mock_disps.values.flatten.each do |disp|
+        next unless __mock_defis.key?(disp.msg) # ignore undefined spies
+
+        defis = __mock_defis[disp.msg]
+        if idx = __mock_find_checked_difi(defis, disp.args, :index)
+          __mock_disps_push(defis.delete_at(idx)) # found, dispatch it
+        elsif defis.empty? # show called candidates
+          __mock_failed(disp.msg, disp.args)
+        else # show expected candidates
+          __mock_failed(disp.msg, disp.args, defis)
+        end
+      end
+    end
   end
 end

data/lib/muack/stub.rb

@@ -15,8 +15,7 @@ module Muack
 
     # used for mocked object to dispatch mocked method
     def __mock_dispatch msg, actual_args
-      if defi = __mock_defis[msg].find{ |d|
-                  __mock_check_args(d.args, actual_args) }
+      if defi = __mock_find_checked_difi(__mock_defis[msg], actual_args)
         # our spies are interested in this
         __mock_disps_push(Definition.new(msg, actual_args))
         defi

data/lib/muack/version.rb

@@ -1,4 +1,4 @@
 
 module Muack
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

data/muack.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: muack 1.3.2 ruby lib
+# stub: muack 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "muack"
-  s.version = "1.3.2"
+  s.version = "1.4.0"
 
   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 = "2015-06-11"
+  s.date = "2015-11-21"
   s.description = "Muack -- A fast, small, yet powerful mocking library.\n\nInspired by [RR][], and it's 32x times faster (750s vs 23s) than RR\nfor running [Rib][] tests.\n\n[RR]: https://github.com/rr/rr\n[Rib]: https://github.com/godfat/rib"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -45,10 +45,11 @@ Gem::Specification.new do |s|
   "test/test_modifier.rb",
   "test/test_proxy.rb",
   "test/test_satisfying.rb",
+  "test/test_spy.rb",
   "test/test_stub.rb"]
   s.homepage = "https://github.com/godfat/muack"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.8"
+  s.rubygems_version = "2.5.0"
   s.summary = "Muack -- A fast, small, yet powerful mocking library."
   s.test_files = [
   "test/test_any_instance_of.rb",
@@ -58,5 +59,6 @@ Gem::Specification.new do |s|
   "test/test_modifier.rb",
   "test/test_proxy.rb",
   "test/test_satisfying.rb",
+  "test/test_spy.rb",
   "test/test_stub.rb"]
 end

data/task/gemgem.rb

@@ -79,6 +79,11 @@ module Gemgem
   end
 
   def gem_check
+    unless git('status', '--porcelain').empty?
+      puts("\e[35mWorking copy is not clean.\e[0m")
+      exit(3)
+    end
+
     ver = spec.version.to_s
 
     if ENV['VERSION'].nil?

data/test/test_spy.rb

@@ -0,0 +1,149 @@
+
+require 'muack/test'
+
+describe Muack::Spy do
+  describe 'Muack.verify==true' do
+    after do
+      Muack.verify.should.eq true
+      Muack::EnsureReset.call
+    end
+
+    would 'inspect' do
+      spy( Obj).inspect.should.eq "Muack::API.spy(obj)"
+    end
+
+    would 'work with spy' do
+      stub(Obj).say{0}
+      Obj.say.should.eq 0
+       spy(Obj).say
+    end
+
+    would 'work with spy twice' do
+      stub(Obj).say{}
+      2.times{ Obj.say.should.eq nil }
+       spy(Obj).say.times(2)
+    end
+
+    would 'work with spy spy' do
+      stub(Obj).say{}
+      2.times{ Obj.say.should.eq nil }
+      2.times{ spy(Obj).say }
+    end
+
+    would 'work with call spy and call spy' do
+      stub(Obj).say{}
+      2.times do
+        Obj.say.should.eq nil
+        spy(Obj).say
+      end
+    end
+
+    would 'verify spy arguments' do
+      stub(Obj).say(1){|a|a}
+      Obj.say(1).should.eq 1
+       spy(Obj).say(1)
+    end
+
+    would 'properly verify spy arguments' do
+      stub(Obj).say(is_a(String)){|a|a}
+      Obj.say('Hi!').should.eq 'Hi!'
+       spy(Obj).say(is_a(String))
+    end
+
+    would 'ignore messages spies not interested' do
+      stub(Obj).saya{0}
+      stub(Obj).sayb{1}
+      Obj.saya.should.eq 0
+      Obj.sayb.should.eq 1
+       spy(Obj).saya
+    end
+
+    would 'not care about the order' do
+      stub(Obj).say(is_a(Fixnum)){|i|i} # change to &:itself in the future
+           Obj .say(1).should.eq 1
+           Obj .say(2).should.eq 2
+       spy(Obj).say(2)
+       spy(Obj).say(1)
+    end
+  end
+
+  describe 'Muack.verify==false' do
+    after do
+      Muack.reset
+      Muack::EnsureReset.call
+    end
+
+    would 'raise Expected if it is not satisfied' do
+      stub(Obj).say{}
+       spy(Obj).say
+      e = should.raise(Muack::Expected){ Muack.verify }
+      e.expected      .should.eq 'obj.say()'
+      e.expected_times.should.eq 1
+      e.actual_times  .should.eq 0
+      e.message       .should.eq "\nExpected: obj.say()\n  " \
+                                 "called 1 times\n but was 0 times."
+    end
+
+    would 'show correct times for under satisfaction' do
+      stub(Obj).say{}
+      2.times{ Obj.say }
+       spy(Obj).say.times(3)
+      e = should.raise(Muack::Expected){ Muack.verify }
+      e.expected      .should.eq 'obj.say()'
+      e.expected_times.should.eq 3
+      e.actual_times  .should.eq 2
+      e.message       .should.eq "\nExpected: obj.say()\n  " \
+                                 "called 3 times\n but was 2 times."
+    end
+
+    would 'show correct times for over satisfaction' do
+      stub(Obj).say{}
+      2.times{ Obj.say }
+      spy(Obj).say
+      e = should.raise(Muack::Expected){ Muack.verify }
+      e.expected      .should.eq 'obj.say()'
+      e.expected_times.should.eq 1
+      e.actual_times  .should.eq 2
+      e.message       .should.eq "\nExpected: obj.say()\n  " \
+                                 "called 1 times\n but was 2 times."
+    end
+
+    would 'raise Expected if arguments do not match' do
+      stub(Obj).say(is_a(Fixnum)){}
+           Obj .say(1)
+       spy(Obj).say(0)
+      e = should.raise(Muack::Unexpected){ Muack.verify }
+      e.expected.should.eq "obj.say(0)"
+      e.was     .should.eq 'obj.say(1)'
+      e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
+    end
+
+    would 'raise Expected if arguments do not match, show original args' do
+      stub(Obj).say(is_a(Fixnum)){}
+           Obj .say(0)
+           Obj .say(1)
+           Obj .say(2)
+       spy(Obj).say(within(1..1))
+       spy(Obj).say(within(0..0))
+      e = should.raise(Muack::Unexpected){ Muack.verify }
+      e.expected.should.eq "obj.say(Muack::API.within(0..0))\n" \
+                 "      or: obj.say(Muack::API.within(1..1))"
+      e.was     .should.eq 'obj.say(2)'
+      e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
+    end
+
+    would 'raise Expected if arguments do not match, show original args' do
+      stub(Obj).say(is_a(Fixnum)){}
+           Obj .say(2)
+           Obj .say(0)
+           Obj .say(1)
+       spy(Obj).say(within(1..1))
+       spy(Obj).say(within(0..0))
+      e = should.raise(Muack::Unexpected){ Muack.verify }
+      e.expected.should.eq "obj.say(Muack::API.within(1..1))\n" \
+                 "      or: obj.say(Muack::API.within(0..0))"
+      e.was     .should.eq 'obj.say(2)'
+      e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
+    end
+  end
+end

data/test/test_stub.rb

@@ -16,10 +16,6 @@ describe Muack::Stub do
       stub(Obj).inspect.should.eq "Muack::API.stub(obj)"
     end
 
-    would 'inspect' do
-      spy( Obj).inspect.should.eq "Muack::API.spy(obj)"
-    end
-
     would 'stub with regular method' do
       stub(Obj).say{ 'goo' }
       3.times{ Obj.say.should.eq 'goo' }
@@ -43,52 +39,6 @@ describe Muack::Stub do
       Obj.saya.should.eq 1
       Obj.say .should.eq 0
     end
-
-    would 'work with spy' do
-      stub(Obj).say{0}
-      Obj.say.should.eq 0
-       spy(Obj).say
-    end
-
-    would 'work with spy twice' do
-      stub(Obj).say{}
-      2.times{ Obj.say.should.eq nil }
-       spy(Obj).say.times(2)
-    end
-
-    would 'work with spy spy' do
-      stub(Obj).say{}
-      2.times{ Obj.say.should.eq nil }
-      2.times{ spy(Obj).say }
-    end
-
-    would 'work with call spy and call spy' do
-      stub(Obj).say{}
-      2.times do
-        Obj.say.should.eq nil
-        spy(Obj).say
-      end
-    end
-
-    would 'verify spy arguments' do
-      stub(Obj).say(1){|a|a}
-      Obj.say(1).should.eq 1
-       spy(Obj).say(1)
-    end
-
-    would 'properly verify spy arguments' do
-      stub(Obj).say(is_a(String)){|a|a}
-      Obj.say('Hi!').should.eq 'Hi!'
-       spy(Obj).say(is_a(String))
-    end
-
-    would 'ignore messages spies not interested' do
-      stub(Obj).saya{0}
-      stub(Obj).sayb{1}
-      Obj.saya.should.eq 0
-      Obj.sayb.should.eq 1
-       spy(Obj).saya
-    end
   end
 
   describe 'Muack.verify==false' do
@@ -113,50 +63,5 @@ describe Muack::Stub do
       e.was     .should.eq 'obj.say(false)'
       e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
     end
-
-    would 'raise Expected if the spy is not satisfied' do
-      stub(Obj).say{}
-       spy(Obj).say
-      e = should.raise(Muack::Expected){ Muack.verify }
-      e.expected      .should.eq 'obj.say()'
-      e.expected_times.should.eq 1
-      e.actual_times  .should.eq 0
-      e.message       .should.eq "\nExpected: obj.say()\n  " \
-                                 "called 1 times\n but was 0 times."
-    end
-
-    would 'raise Expected if the spy is not satisfied enough' do
-      stub(Obj).say{}
-      Obj.say
-       spy(Obj).say(0)
-      e = should.raise(Muack::Unexpected){ Muack.verify }
-      e.expected.should.eq "obj.say(0)"
-      e.was     .should.eq 'obj.say()'
-      e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
-    end
-
-    would 'show correct times for under satisfaction' do
-      stub(Obj).say{}
-      2.times{ Obj.say }
-       spy(Obj).say.times(3)
-      e = should.raise(Muack::Expected){ Muack.verify }
-      e.expected      .should.eq 'obj.say()'
-      e.expected_times.should.eq 3
-      e.actual_times  .should.eq 2
-      e.message       .should.eq "\nExpected: obj.say()\n  " \
-                                 "called 3 times\n but was 2 times."
-    end
-
-    would 'show correct times for over satisfaction' do
-      stub(Obj).say{}
-      2.times{ Obj.say }
-       spy(Obj).say
-      e = should.raise(Muack::Expected){ Muack.verify }
-      e.expected      .should.eq 'obj.say()'
-      e.expected_times.should.eq 1
-      e.actual_times  .should.eq 2
-      e.message       .should.eq "\nExpected: obj.say()\n  " \
-                                 "called 1 times\n but was 2 times."
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muack
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Muack -- A fast, small, yet powerful mocking library.
@@ -57,6 +57,7 @@ files:
 - test/test_modifier.rb
 - test/test_proxy.rb
 - test/test_satisfying.rb
+- test/test_spy.rb
 - test/test_stub.rb
 homepage: https://github.com/godfat/muack
 licenses:
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Muack -- A fast, small, yet powerful mocking library.
@@ -90,4 +91,5 @@ test_files:
 - test/test_modifier.rb
 - test/test_proxy.rb
 - test/test_satisfying.rb
+- test/test_spy.rb
 - test/test_stub.rb