muack 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46ee22af9472ac4c12baeb58afee2b979d6b80d0
-  data.tar.gz: f155f3f23684f6fdceb3a6e5bc922cebbd151d0b
+  metadata.gz: fa29c09257f78580be72e3872fc7d3ef05650e02
+  data.tar.gz: 222e4d730c838c6f76d701c0505b41f7b3476d1e
 SHA512:
-  metadata.gz: d27fc18f9ef192c19167432c73ca93191af1f747bfe59731eb8621709925da4ae3f33549ad9b493e0627f4d061581cd7fc1b6d818af6f4c93cd09bcd9bf60267
-  data.tar.gz: 161f8b4a87addc0d0841fcfe6e3a6ad71becb17ff0b2f2e535e0c7e856051225e71f363950c81bae9ee78f9de8a4baa38150312b4ac15ceb23aa60c231bcbff8
+  metadata.gz: 3e539ea17a87076e48f85d980ad7e2c58afb91c8c627af09f05266a2811ecf2d22efb7adbc49f117c240ffca3c34a5e95229457ab2d82a7e8174a132aa17798e
+  data.tar.gz: 3b2de41a40ab1134c0952ec763423a0a07b0967ce180b076e129ecde0063ddc05853e278cf6b5fb2d0bb36ecb7ac6d612f3471bd3abefa0ff69a8b79fe0660e4

data/.travis.yml

@@ -2,8 +2,8 @@ before_install: 'git submodule update --init'
 script: 'ruby -r bundler/setup -S rake test'
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby
+  - 1.9
+  - 2.0
+  - 2.1
   - rbx-2
   - jruby

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## Muack 1.1.2 -- 2014-11-07
+
+* Introduced `Muack::API.coat`.
+  See [README.md](README.md#coats) for explanation.
+
+* `Muack::Session` is no longer a hash. Hope no one is trying to store
+   anything into it so this change would break nothing.
+
+* `Muack::Failure` is no longer an Exception, but a StandardError.
+
 ## Muack 1.1.1 -- 2014-05-21
 
 It's no longer necessary to make spy the last call. Below now works:

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'bacon'
+gem 'pork'
 
 platform :rbx do
   gem 'rubysl-singleton' # used in rake

data/README.md

@@ -33,27 +33,27 @@ Muack is much simpler and thus much faster and much more consistent.
 
 ## SYNOPSIS:
 
-Here's a quick example using [Bacon][].
+Here's a quick example using [Pork][].
 
 ``` ruby
-require 'bacon'
+require 'pork/auto'
 require 'muack'
 
-Bacon::Context.__send__(:include, Muack::API)
+include Muack::API
 
 describe 'Hello' do
   before{ Muack.reset  }
   after { Muack.verify }
 
-  should 'say world!' do
+  would 'say world!' do
     str = 'Hello'
     mock(str).say('!'){ |arg| "World#{arg}" }
-    str.say('!').should.equal 'World!'
+    str.say('!').should.eq 'World!'
   end
 end
 ```
 
-[Bacon]: https://github.com/chneukirchen/bacon
+[Pork]: https://github.com/godfat/pork
 
 ### Overview
 
@@ -71,14 +71,15 @@ Let's explain them one by one.
 
 ### Mocks
 
-There are also 3 different kinds of mocks in Muack, which are:
+There are also 4 different kinds of mocks in Muack, which are:
 
 * Mocks
 * Stubs
 * Spies
+* Coats
 
-You could think of _mocks_ are sort of _stubs_ combined with _spies_. Here's
-the inequation:
+You could think of _mocks_ are sort of _stubs_ combined with _spies_.
+Here's the inequation: (we'll talk about _coats_ later)
 
     mock >= stub + spy
 
@@ -183,6 +184,39 @@ p name.to_s          # 'str'
 p Muack.verify       # true
 ```
 
+### Coats
+
+Now we could talk about coats. It's a kind of mocks but it would wear out
+instead of raising an exception when it's called more than expected times.
+This is useful when we want to restore the original behaviour of a
+particular method at some point. The problem is that we can't simply
+call the original method because it's already mocked! We could workaround
+this by using `Muack.verify` or `Muack.reset` at some point, or let _coats_
+handle that.
+
+Here's an example with _coats_:
+
+``` ruby
+coat(Time).now{ Time.at(0) }.times(2)
+
+p Time.now.to_i == 0 # true
+p Time.now.to_i == 0 # true
+p Time.now.to_i  > 0 # true
+p Muack.verify       # true
+```
+
+Without _coats_ we might end up with:
+
+``` ruby
+mock(Time).now{ Time.at(0) }
+mock(Time).now{ Muack.verify(Time); Time.at(0) }
+
+p Time.now.to_i == 0 # true
+p Time.now.to_i == 0 # true
+p Time.now.to_i  > 0 # true
+p Muack.verify       # true
+```
+
 #### Anonymous mode
 
 Sometimes we just want to stub something without a concrete object in mind.

data/lib/muack.rb

@@ -31,6 +31,11 @@ module Muack
       if block_given? then yield(ret) else ret end
     end
 
+    def coat obj=Object.new
+      ret = Muack.session.coat(obj)
+      if block_given? then yield(ret) else ret end
+    end
+
     def spy obj
       ret = Muack.session.spy(obj)
       if block_given? then yield(ret) else ret end

data/lib/muack/any_instance_of.rb

@@ -4,5 +4,9 @@ module Muack
     def inspect
       "Muack::API.any_instance_of(#{singleton_class})"
     end
+
+    # dummies for Muack::Session
+    def __mock_verify; true; end
+    def __mock_reset ;     ; end
   end
 end

data/lib/muack/coat.rb

@@ -0,0 +1,16 @@
+
+require 'muack/mock'
+
+module Muack
+  class Coat < Mock
+    # used for mocked object to dispatch mocked method
+    def __mock_dispatch msg, actual_args
+      defi = super
+      if __mock_defis[defi.msg].empty?
+        __mock_reset_method(defi)
+        __mock_injected.delete(defi.msg)
+      end
+      defi
+    end
+  end
+end

data/lib/muack/failure.rb

@@ -1,6 +1,6 @@
 
 module Muack
-  class Failure < Exception
+  class Failure < StandardError
     attr_reader :expected
     def build_expected obj, expected_defis
       @expected = expected_defis.uniq{ |d| [d.msg, d.args] }.map{ |defi|

data/lib/muack/mock.rb

@@ -112,17 +112,7 @@ module Muack
 
     # used for Muack::Session#reset
     def __mock_reset
-      __mock_injected.each_value do |defi|
-        object.singleton_class.module_eval do
-          remove_method(defi.msg)
-          # restore original method
-          if instance_methods(false).include?(defi.original_method) ||
-             private_instance_methods(false).include?(defi.original_method)
-            alias_method(defi.msg, defi.original_method)
-            remove_method(defi.original_method)
-          end
-        end
-      end
+      __mock_injected.each_value{ |defi| __mock_reset_method(defi) }
     end
 
     protected # get warnings for private attributes
@@ -136,6 +126,18 @@ module Muack
       __mock_inject_mock_method(target, defi, privilege)
     end
 
+    def __mock_reset_method defi
+      object.singleton_class.module_eval do
+        remove_method(defi.msg)
+        # restore original method
+        if instance_methods(false).include?(defi.original_method) ||
+           private_instance_methods(false).include?(defi.original_method)
+          alias_method(defi.msg, defi.original_method)
+          remove_method(defi.original_method)
+        end
+      end
+    end
+
     def self.store_original_method klass, defi
       privilege = if klass.instance_methods(false).include?(defi.msg)
         :public # TODO: forget about protected methods?

data/lib/muack/session.rb

@@ -1,24 +1,29 @@
 
 require 'muack/mock'
 require 'muack/stub'
+require 'muack/coat'
 require 'muack/spy'
 require 'muack/any_instance_of'
 
 module Muack
-  class Session < Hash
-    def mock obj; self["mk #{obj.__id__}"] ||= Mock.new(obj)      ; end
-    def stub obj; self["sb #{obj.__id__}"] ||= Stub.new(obj)      ; end
-    def spy  obj; self["sy #{obj.__id__}"] ||= Spy .new(stub(obj)); end
+  class Session
+    attr_reader :data
+    def initialize; @data = {}; end
+
+    def mock obj; data["mk #{obj.__id__}"] ||= Mock.new(obj)      ; end
+    def stub obj; data["sb #{obj.__id__}"] ||= Stub.new(obj)      ; end
+    def coat obj; data["co #{obj.__id__}"] ||= Coat.new(obj)      ; end
+    def spy  obj; data["sy #{obj.__id__}"] ||= Spy .new(stub(obj)); end
 
     def any_instance_of kls
-      (@others ||= {})["ai #{kls.__id__}"] ||= AnyInstanceOf.new(kls)
+      data["ai #{kls.__id__}"] ||= AnyInstanceOf.new(kls)
     end
 
     def verify obj=nil
       if obj
         with(obj, :[]).all?(&:__mock_verify)
       else
-        each_value.all?(&:__mock_verify)
+        data.each_value.all?(&:__mock_verify)
       end
     end
 
@@ -26,15 +31,16 @@ module Muack
       if obj
         with(obj, :delete).each(&:__mock_reset)
       else
-        instance_variable_defined?(:@others) && @others.clear
-        reverse_each{ |_, m| m.__mock_reset }
-        clear
+        data.reverse_each{ |_, m| m.__mock_reset } # reverse_each_value?
+        data.clear
       end
     end
 
     private
     def with obj, meth
-      %w[mk sb sy].map{ |k| __send__(meth, "#{k} #{obj.__id__}") }.compact
+      %w[mk sb co sy ai].map{ |k|
+        data.__send__(meth, "#{k} #{obj.__id__}")
+      }.compact
     end
   end
 end

data/lib/muack/test.rb

@@ -1,9 +1,8 @@
 
-require 'bacon'
+require 'pork/auto'
 require 'muack'
 
-Bacon.summary_on_exit
-Bacon::Context.__send__(:include, Muack::API)
+Pork::Executor.__send__(:include, Muack::API)
 
 Obj = Object.new
 Str = 'Moo'
@@ -22,12 +21,6 @@ Muack::EnsureReset = lambda{
   [Obj, Str].each do |o|
     o.methods.select{ |m|
       m.to_s.start_with?('__muack_mock') || m.to_s.start_with?('say')
-    }.should.empty
+    }.should.empty?
   end
 }
-
-module Kernel
-  def eq? rhs
-    self == rhs
-  end
-end

data/lib/muack/version.rb

@@ -1,4 +1,4 @@
 
 module Muack
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/muack.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: muack 1.1.1 ruby lib
+# stub: muack 1.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "muack"
-  s.version = "1.1.1"
+  s.version = "1.1.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-05-21"
+  s.date = "2014-11-07"
   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 = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   "lib/muack.rb",
   "lib/muack/any_instance_of.rb",
   "lib/muack/block.rb",
+  "lib/muack/coat.rb",
   "lib/muack/definition.rb",
   "lib/muack/error.rb",
   "lib/muack/failure.rb",
@@ -38,6 +39,7 @@ Gem::Specification.new do |s|
   "task/README.md",
   "task/gemgem.rb",
   "test/test_any_instance_of.rb",
+  "test/test_coat.rb",
   "test/test_from_readme.rb",
   "test/test_mock.rb",
   "test/test_modifier.rb",
@@ -46,10 +48,11 @@ Gem::Specification.new do |s|
   "test/test_stub.rb"]
   s.homepage = "https://github.com/godfat/muack"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.2"
   s.summary = "Muack -- A fast, small, yet powerful mocking library."
   s.test_files = [
   "test/test_any_instance_of.rb",
+  "test/test_coat.rb",
   "test/test_from_readme.rb",
   "test/test_mock.rb",
   "test/test_modifier.rb",

data/task/gemgem.rb

@@ -34,7 +34,7 @@ module Gemgem
       s.executables = bin_files
     end
     spec_create.call(spec)
-    spec.homepage = "https://github.com/godfat/#{spec.name}"
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
     self.spec = spec
   end
 
@@ -227,10 +227,6 @@ end # of gem namespace
 desc 'Run tests'
 task :test do
   next if Gemgem.test_files.empty?
-
-  require 'bacon'
-  Bacon.extend(Bacon::TestUnitOutput)
-  Bacon.summary_on_exit
   Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
 end
 

data/test/test_any_instance_of.rb

@@ -4,7 +4,7 @@ require 'muack/test'
 describe Muack::AnyInstanceOf do
   klass = Class.new{ def f; 0; end; private; def g; 1; end }
 
-  should 'mock any_instance_of' do
+  would 'mock any_instance_of' do
     any_instance_of(klass){ |inst| mock(inst).say{ true } }
     obj = klass.new
     obj.say              .should.eq true
@@ -13,7 +13,7 @@ describe Muack::AnyInstanceOf do
     obj.respond_to?(:say).should.eq false
   end
 
-  should 'mock any_instance_of with instance_exec' do
+  would 'mock any_instance_of with instance_exec' do
     any_instance_of(klass){ |inst|
       mock(inst).say.returns(:instance_exec => true){ f } }
     obj = klass.new
@@ -22,7 +22,7 @@ describe Muack::AnyInstanceOf do
     obj.respond_to?(:say).should.eq false
   end
 
-  should 'proxy any_instance_of' do
+  would 'proxy any_instance_of' do
     any_instance_of(klass){ |inst| mock(inst).f }
     obj = klass.new
     obj.f       .should.eq 0
@@ -30,7 +30,7 @@ describe Muack::AnyInstanceOf do
     obj.f       .should.eq 0
   end
 
-  should 'proxy any_instance_of for private methods' do
+  would 'proxy any_instance_of for private methods' do
     any_instance_of(klass){ |inst| mock(inst).g.peek_return{|i|i+1} }
     obj = klass.new
     obj.__send__(:g).should.eq 2
@@ -38,7 +38,7 @@ describe Muack::AnyInstanceOf do
     obj.__send__(:g).should.eq 1
   end
 
-  should 'proxy any_instance_of with peek_return' do
+  would 'proxy any_instance_of with peek_return' do
     any_instance_of(klass){ |inst| mock(inst).f.peek_return{|i|i+1} }
     obj = klass.new
     obj.f       .should.eq 1
@@ -46,7 +46,7 @@ describe Muack::AnyInstanceOf do
     obj.f       .should.eq 0
   end
 
-  should 'proxy with multiple any_instance_of call' do
+  would 'proxy with multiple any_instance_of call' do
     any_instance_of(klass){ |inst| mock(inst).f.peek_return{ |i| i+1 } }
     any_instance_of(klass){ |inst| mock(inst).f.peek_return{ |i| i+2 } }
     obj = klass.new
@@ -56,7 +56,7 @@ describe Muack::AnyInstanceOf do
     obj.f.should.eq 0
   end
 
-  should 'mock with multiple any_instance_of call' do
+  would 'mock with multiple any_instance_of call' do
     any_instance_of(klass){ |inst| mock(inst).f(is_a(Fixnum)){ |i| i+1 } }
     any_instance_of(klass){ |inst| mock(inst).f(is_a(Fixnum)){ |i| i+2 } }
     obj = klass.new
@@ -66,14 +66,14 @@ describe Muack::AnyInstanceOf do
     obj.f.should.eq 0
   end
 
-  should 'share the same counts for different instances' do
+  would 'share the same counts for different instances' do
     times = 2
     any_instance_of(klass){ |inst| mock(inst).f{0}.times(times) }
     times.times{ klass.new.f.should.eq 0 }
     Muack.verify.should.eq true
   end
 
-  should 'stub proxy with any_instance_of and spy' do
+  would 'stub proxy with any_instance_of and spy' do
     any_instance_of(klass){ |inst| stub(inst).f.peek_return{ |i| i+3 } }
     obj = klass.new
     obj.f.should.eq 3
@@ -83,35 +83,33 @@ describe Muack::AnyInstanceOf do
     obj.f.should.eq 0
   end
 
-  should 'stub with any_instance_of and spy under satisfied' do
+  would 'stub with any_instance_of and spy under satisfied' do
     any_instance_of(klass){ |inst| stub(inst).f{ 5 } }
     obj = klass.new
     obj.f.should.eq 5
     spy(any_instance_of(klass)).f.times(2)
-    begin
-      Muack.verify
-    rescue Muack::Expected => e
-      expected = /Muack::API\.any_instance_of\(.+?\)\.f\(\)/
-      e.expected      .should =~ expected
-      e.expected_times.should.eq 2
-      e.actual_times  .should.eq 1
-    end
+
+    e = should.raise(Muack::Expected){ Muack.verify }
+    expected = /Muack::API\.any_instance_of\(.+?\)\.f\(\)/
+    e.expected      .should =~ expected
+    e.expected_times.should.eq 2
+    e.actual_times  .should.eq 1
+
     obj.f.should.eq 0
   end
 
-  should 'stub with any_instance_of and spy over satisfied' do
+  would 'stub with any_instance_of and spy over satisfied' do
     any_instance_of(klass){ |inst| stub(inst).f{ 2 } }
     obj = klass.new
     2.times{ obj.f.should.eq 2 }
     spy(any_instance_of(klass)).f
-    begin
-      Muack.verify
-    rescue Muack::Expected => e
-      expected = /Muack::API\.any_instance_of\(.+?\)\.f\(\)/
-      e.expected      .should =~ expected
-      e.expected_times.should.eq 1
-      e.actual_times  .should.eq 2
-    end
+
+    e = should.raise(Muack::Expected){ Muack.verify }
+    expected = /Muack::API\.any_instance_of\(.+?\)\.f\(\)/
+    e.expected      .should =~ expected
+    e.expected_times.should.eq 1
+    e.actual_times  .should.eq 2
+
     obj.f.should.eq 0
   end
 end