flexmock 0.9.0 → 1.0.0.beta.1

data/lib/flexmock/expectation_director.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/explicit_needed.rb

@@ -0,0 +1,39 @@
+
+class FlexMock
+
+  # Expectations on mocks with a base class can only be defined on
+  # methods supported by the base class. Attempting to add an stub to
+  # a method not defined on the base class will cause the expectation
+  # to be wrapped in an ExplicitNeeded wrapper. The wrapper will throw
+  # an exception unless the explicit method is immediately called on
+  # the expectation.
+  #
+  class ExplicitNeeded
+    def initialize(expectation, method_name, base_class)
+      @expectation = expectation
+      @explicit = false
+      @method_name = method_name
+      @base_class = base_class
+    end
+
+    def explicit
+      @explicit = true
+      self
+    end
+
+    def explicit?
+      @explicit
+    end
+
+    def method_missing(sym, *args, &block)
+      if explicit?
+        @expectation.send(sym, *args, &block)
+      else
+        fail NoMethodError, "Cannot stub methods not defined by the base class\n" +
+          "   Method:     #{@method_name}\n" +
+          "   Base Class: #{@base_class}\n" +
+          "   (Use explicit to override)"
+      end
+    end
+  end
+end

data/lib/flexmock/mock_container.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -122,6 +122,7 @@ class FlexMock
       domain_obj = nil
       safe_mode = false
       model_class = nil
+      base_class = nil
       while ! args.empty?
         case args.first
         when :base, :safe
@@ -130,6 +131,10 @@ class FlexMock
         when :model
           args.shift
           model_class = args.shift
+        when :on
+          args.shift
+          base_class = args.shift
+          name ||= "#{base_class} Mock"
         when String, Symbol
           name = args.shift.to_s
         when Hash
@@ -153,6 +158,7 @@ class FlexMock
       yield(mock) if block_given?
       flexmock_remember(mock)
       ContainerHelper.add_model_methods(mock, model_class, id) if model_class
+      mock.flexmock_spies_on(base_class) if base_class
       result
     end
     alias flexstub flexmock
@@ -326,7 +332,7 @@ class FlexMock
       end
     end
 
-    METHOD_NAME_RE = /^([A-Za-z_][A-Za-z0-9_]*[=!?]?|\[\]=?||\*\*|<<|>>|<=>|[<>=]=|=~|===|[-+]@|[-+\*\/%&^|<>~`])$/
+    METHOD_NAME_RE = /^([A-Za-z_][A-Za-z0-9_]*[=!?]?|\[\]=?||\*\*|<<|>>|<=>|[<>=!]=|[=!]~|===|[-+]@|[-+\*\/%&^|<>~`!])$/
 
     # Check that all the names in the list are valid method names.
     def check_method_names(names)

data/lib/flexmock/noop.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/ordering.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/partial_mock.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -33,7 +33,8 @@ class FlexMock
 
     MOCK_METHODS = [
       :should_receive, :new_instances,
-      :flexmock_get,   :flexmock_teardown, :flexmock_verify
+      :flexmock_get,   :flexmock_teardown, :flexmock_verify,
+      :flexmock_was_called_with?,
     ]
 
     # Initialize a PartialMockProxy object.
@@ -148,6 +149,10 @@ class FlexMock
     end
     private :invoke_original
 
+    def flexmock_invoke_original(method, args)
+      invoke_original(method, args)
+    end
+
     # Verify that the mock has been properly called.  After verification,
     # detach the mocking infrastructure from the existing object.
     def flexmock_verify
@@ -171,6 +176,11 @@ class FlexMock
       @mock.flexmock_container
     end
 
+    # Forward to the mock
+    def flexmock_was_called_with?(*args)
+      @mock.flexmock_was_called_with?(*args)
+    end
+
     # Set the proxy's mock container.  This set value is ignored
     # because the proxy always uses the container of its mock.
     def flexmock_container=(container)

data/lib/flexmock/rails.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/recorder.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/rspec.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -9,6 +9,8 @@
 # above copyright notice is included.
 #+++
 
+
+
 require 'flexmock/base'
 
 class FlexMock
@@ -36,3 +38,5 @@ class FlexMock
 
   @framework_adapter = RSpecFrameworkAdapter.new
 end
+
+require 'flexmock/rspec_spy_matcher'

data/lib/flexmock/rspec_spy_matcher.rb

@@ -0,0 +1,74 @@
+require 'flexmock/spy_describers'
+
+class FlexMock
+  module RSpecMatchers
+
+    class HaveReceived
+      include SpyDescribers
+
+      def initialize(method_name)
+        @method_name = method_name
+        @args = nil
+        @block = nil
+        @times = nil
+        @needs_block = nil
+      end
+
+      def matches?(spy)
+        @spy = spy
+        @options = {}
+        @options[:times] = @times if @times
+        @options[:with_block] = @needs_block unless @needs_block.nil?
+        @spy.flexmock_was_called_with?(@method_name, @args, @options)
+      end
+
+      def failure_message_for_should
+        describe_spy_expectation(@spy, @method_name, @args, @options)
+      end
+
+      def failure_message_for_should_not
+        describe_spy_negative_expectation(@spy, @method_name, @args, @options)
+      end
+
+      def with(*args)
+        @args = args
+        self
+      end
+
+      def with_a_block
+        @needs_block = true
+        self
+      end
+
+      def without_a_block
+        @needs_block = false
+        self
+      end
+
+      def times(n)
+        @times = n
+        self
+      end
+
+      def never
+        times(0)
+      end
+
+      def once
+        times(1)
+      end
+
+      def twice
+        times(2)
+      end
+    end
+
+    def have_received(method_name)
+      HaveReceived.new(method_name)
+    end
+  end
+end
+
+RSpec::configure do |config|
+  config.include(FlexMock::RSpecMatchers)
+end

data/lib/flexmock/spy_describers.rb

@@ -0,0 +1,60 @@
+class FlexMock
+
+    module SpyDescribers
+      def describe_spy_expectation(spy, sym, args, options={})
+        describe(spy, sym, args, options)
+      end
+
+      def describe_spy_negative_expectation(spy, sym, args, options={})
+        describe(spy, sym, args, options, " NOT")
+      end
+
+      private
+
+      def describe(spy, sym, args, options, not_clause="")
+        result = "expected "
+        result << call_description(sym, args)
+        result << " to#{not_clause} be called on "
+        result << spy.inspect
+        result << times_description(options[:times])
+        result << block_description(options[:with_block])
+        result << "."
+        result
+      end
+
+      def times_description(times)
+        case times
+        when 0
+          " never"
+        when 1
+          " once"
+        when 2
+          " twice"
+        when nil
+          ""
+        else
+          " #{times} times"
+        end
+      end
+
+      def block_description(needs_block)
+        case needs_block
+        when true
+          " with a block"
+        when false
+          " without a block"
+        else
+          ""
+        end
+      end
+
+      def call_description(sym, args)
+        if args
+          "#{sym}(#{args.map { |o| o.inspect }.join(', ')})"
+        else
+          "#{sym}(...)"
+        end
+      end
+    end
+
+end

data/lib/flexmock/test_unit.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/test_unit_assert_spy_called.rb

@@ -0,0 +1,34 @@
+require 'flexmock/spy_describers'
+
+class FlexMock
+  module TestUnitAssertions
+    include FlexMock::SpyDescribers
+
+    def assert_spy_called(spy, method_name, *args)
+      _assert_spy_called(false, spy, method_name, *args)
+    end
+
+    def assert_spy_not_called(spy, method_name, *args)
+      _assert_spy_called(true, spy, method_name, *args)
+    end
+
+    private
+
+    def _assert_spy_called(negative, spy, method_name, *args)
+      options = {}
+      if method_name.is_a?(Hash)
+        options = method_name
+        method_name = args.shift
+      end
+      args = nil if args == [:_]
+      bool = spy.flexmock_was_called_with?(method_name, args, options)
+      if negative
+        bool = !bool
+        message = describe_spy_negative_expectation(spy, method_name, args, options)
+      else
+        message = describe_spy_expectation(spy, method_name, args, options)
+      end
+      assert bool, message
+    end
+  end
+end

data/lib/flexmock/test_unit_integration.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -11,6 +11,7 @@
 
 require 'test/unit'
 require 'flexmock/base'
+require 'flexmock/test_unit_assert_spy_called'
 
 class FlexMock
 
@@ -29,6 +30,7 @@ class FlexMock
   module TestCase
     include ArgumentTypes
     include MockContainer
+    include TestUnitAssertions
 
     # Teardown the test case, verifying any mocks that might have been
     # defined in this test case.

data/lib/flexmock/undefined.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/validators.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/version.rb

@@ -1,9 +1,11 @@
 class FlexMock
   module Version
     NUMBERS = [
-      MAJOR = 0,
-      MINOR = 9,
+      MAJOR = 1,
+      MINOR = 0,
       BUILD = 0,
+      BETA = 'beta',
+      REV  = 1,
     ]
   end
 

data/test/assert_spy_called_test.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'test/test_setup'
+require 'flexmock/test_unit_assert_spy_called'
+
+class AssertSpyCalledTest < Test::Unit::TestCase
+  include FlexMock::TestCase
+
+  class FooBar
+    def foo
+    end
+    def bar
+    end
+  end
+
+  def setup
+    super
+    @spy = flexmock(:on, FooBar)
+  end
+
+  def spy
+    @spy
+  end
+
+  def test_assert_detects_basic_call
+    spy.foo
+    assert_spy_called spy, :foo
+  end
+
+  def test_assert_detects_basic_call_with_args
+    spy.foo(1,2)
+    assert_spy_called spy, :foo, 1, 2
+  end
+
+  def test_assert_rejects_incorrect_args
+    spy.foo(1,2)
+    messages = assert_fails(/^expected foo\(1, 3\) to be called on <FlexMock:AssertSpyCalledTest::FooBar Mock>/i) do
+      assert_spy_called spy, :foo, 1, 3
+    end
+  end
+
+  def test_assert_detects_multiple_calls
+    spy.foo
+    spy.foo
+    spy.foo
+    assert_spy_called spy, {times: 3}, :foo
+  end
+
+  def test_assert_rejects_incorrect_type
+    spy.foo
+    spy.foo
+    assert_fails(/^expected foo\(\) to be called on <FlexMock:AssertSpyCalledTest::FooBar Mock> 3 times/i) do
+      assert_spy_called spy, {times: 3}, :foo
+    end
+  end
+
+  def test_assert_detects_blocks
+    spy.foo { }
+    spy.bar
+    assert_spy_called spy, :foo, Proc
+    assert_spy_called spy, :bar
+  end
+
+  def test_assert_detects_any_args
+    spy.foo
+    spy.foo(1)
+    spy.foo("HI")
+    spy.foo("Hello", "World", 10, options: true)
+    assert_spy_called spy, {times: 4}, :foo, :_
+  end
+
+  def test_assert_rejects_bad_count_on_any_args
+    spy.foo
+    assert_fails(/^expected foo\(\.\.\.\) to be called on <FlexMock:AssertSpyCalledTest::FooBar Mock> twice/i) do
+      assert_spy_called spy, {times: 2}, :foo, :_
+    end
+  end
+
+  private
+
+  def assert_fails(message_pattern)
+     ex = assert_raises(FlexMock.framework_adapter.assertion_failed_error) do
+      yield
+    end
+    assert_match(message_pattern, ex.message)
+    ex
+  end
+
+end