flexmock 1.0.2 → 1.0.3

data/lib/flexmock/core.rb

@@ -197,9 +197,14 @@ class FlexMock
   # See Expectation for a list of declarators that can be used.
   #
   def should_receive(*args)
+    location = caller.first
+    flexmock_define_expectation(location, *args)
+  end
+
+  def flexmock_define_expectation(location, *args)
     @last_expectation = ContainerHelper.parse_should_args(self, args) do |sym|
       @expectations[sym] ||= ExpectationDirector.new(sym)
-      result = Expectation.new(self, sym)
+      result = Expectation.new(self, sym, location)
       @expectations[sym] << result
       override_existing_method(sym) if flexmock_respond_to?(sym)
       result = ExplicitNeeded.new(result, sym, @base_class) if

data/lib/flexmock/default_framework_adapter.rb

@@ -15,6 +15,7 @@ class FlexMock
   class DefaultFrameworkAdapter
     def assert_block(msg, &block)
       unless yield
+        msg = msg.call if msg.is_a?(Proc)
         fail assertion_failed_error, msg
       end
     end

data/lib/flexmock/expectation.rb

@@ -32,9 +32,10 @@ class FlexMock
     attr_accessor :mock
 
     # Create an expectation for a method named +sym+.
-    def initialize(mock, sym)
+    def initialize(mock, sym, location)
       @mock = mock
       @sym = sym
+      @location = location
       @expected_args = nil
       @count_validators = []
       @count_validator_class = ExactCountValidator
@@ -392,6 +393,13 @@ class FlexMock
       expectations.defaultify_expectation(self) if expectations
     end
 
+    def flexmock_location_filter
+      yield
+    rescue Exception => ex
+      ex.backtrace.insert(0, @location)
+      raise ex
+    end
+
   end
 
   ##########################################################################
@@ -434,7 +442,7 @@ class FlexMock
     # Start a new method expectation.  The following constraints will be
     # applied to the new expectation.
     def should_receive(*args, &block)
-      @expectations.first.mock.should_receive(*args, &block)
+      @expectations.first.mock.flexmock_define_expectation(caller.first, *args, &block)
     end
 
     # Return a string representations

data/lib/flexmock/expectation_director.rb

@@ -37,8 +37,8 @@ class FlexMock
     # criteria.
     def call(*args)
       exp = find_expectation(*args)
-      FlexMock.check("no matching handler found for " +
-        FlexMock.format_args(@sym, args)) { ! exp.nil? }
+      FlexMock.check(
+        "no matching handler found for " + FlexMock.format_args(@sym, args)) { ! exp.nil? }
       exp.verify_call(*args)
     end
 

data/lib/flexmock/mock_container.rb

@@ -117,6 +117,7 @@ class FlexMock
     #   the mock object.
     #
     def flexmock(*args)
+      location = caller.first
       name = nil
       quick_defs = {}
       domain_obj = nil
@@ -160,10 +161,10 @@ class FlexMock
         result = mock
       end
       mock.flexmock_based_on(base_class) if base_class
-      mock.should_receive(quick_defs)
+      mock.flexmock_define_expectation(location, quick_defs)
       yield(mock) if block_given?
       flexmock_remember(mock)
-      ContainerHelper.add_model_methods(mock, model_class, id) if model_class
+      ContainerHelper.add_model_methods(mock, model_class, id, location) if model_class
       result
     end
     alias flexstub flexmock
@@ -230,29 +231,29 @@ class FlexMock
 
     # Automatically add mocks for some common methods in ActiveRecord
     # models.
-    def add_model_methods(mock, model_class, id)
+    def add_model_methods(mock, model_class, id, location)
       container = mock.flexmock_container
 
       mock_errors = container.flexmock("errors")
-      mock_errors.should_receive(:count).and_return(0).by_default
-      mock_errors.should_receive(:full_messages).and_return([]).by_default
+      mock_errors.flexmock_define_expectation(location, :count).and_return(0).by_default
+      mock_errors.flexmock_define_expectation(location, :full_messages).and_return([]).by_default
 
-      mock.should_receive(:id).and_return(id).by_default
-      mock.should_receive(:to_params).and_return(id.to_s).by_default
-      mock.should_receive(:new_record?).and_return(false).by_default
-      mock.should_receive(:class).and_return(model_class).by_default
-      mock.should_receive(:errors).and_return(mock_errors).by_default
+      mock.flexmock_define_expectation(location, :id).and_return(id).by_default
+      mock.flexmock_define_expectation(location, :to_params).and_return(id.to_s).by_default
+      mock.flexmock_define_expectation(location, :new_record?).and_return(false).by_default
+      mock.flexmock_define_expectation(location, :class).and_return(model_class).by_default
+      mock.flexmock_define_expectation(location, :errors).and_return(mock_errors).by_default
 
       # HACK: Ruby 1.9 needs the following lambda so that model_class
       # is correctly bound below.
       lambda { }
-      mock.should_receive(:is_a?).with(any).and_return { |other|
+      mock.flexmock_define_expectation(location, :is_a?).with(any).and_return { |other|
         other == model_class
       }.by_default
-      mock.should_receive(:instance_of?).with(any).and_return { |other|
+      mock.flexmock_define_expectation(location, :instance_of?).with(any).and_return { |other|
         other == model_class
       }.by_default
-      mock.should_receive(:kind_of?).with(any).and_return { |other|
+      mock.flexmock_define_expectation(location, :kind_of?).with(any).and_return { |other|
         model_class.ancestors.include?(other)
       }.by_default
     end

data/lib/flexmock/partial_mock.rb

@@ -33,6 +33,7 @@ class FlexMock
 
     MOCK_METHODS = [
       :should_receive, :new_instances,
+      :should_receive_with_location,
       :flexmock_get,   :flexmock_teardown, :flexmock_verify,
       :flexmock_received?, :flexmock_calls,
     ]
@@ -79,11 +80,16 @@ class FlexMock
     #
     # See Expectation for a list of declarators that can be used.
     def should_receive(*args)
+      location = caller.first
+      flexmock_define_expectation(location, *args)
+    end
+
+    def flexmock_define_expectation(location, *args)
       ContainerHelper.parse_should_args(@mock, args) do |sym|
         unless @methods_proxied.include?(sym)
           hide_existing_method(sym)
         end
-        ex = @mock.should_receive(sym)
+        ex = @mock.flexmock_define_expectation(location, sym)
         ex.mock = self
         ex
       end
@@ -123,14 +129,17 @@ class FlexMock
     #
     def new_instances(*allocators, &block)
       fail ArgumentError, "new_instances requires a Class to stub" unless Class === @obj
+      location = caller.first
       allocators = [:new] if allocators.empty?
       result = ExpectationRecorder.new
       allocators.each do |allocate_method|
         check_allocate_method(allocate_method)
-        # HACK: Without the following lambda, Ruby 1.9 will not bind
-        # the allocate_method parameter correctly.
+        # HACK: Without the following lambda, Some versions of Ruby 1.9
+        #       would not bind the allocate_method parameter
+        #       correctly. I don't think it is necessary for recent
+        #       versions.
         lambda { }
-        self.should_receive(allocate_method).and_return { |*args|
+        self.flexmock_define_expectation(location, allocate_method).and_return { |*args|
           new_obj = invoke_original(allocate_method, args)
           mock = flexmock_container.flexmock(new_obj)
           block.call(mock) if block_given?

data/lib/flexmock/recorder.rb

@@ -57,7 +57,8 @@ class FlexMock
     # Record an expectation for receiving the method +sym+ with the
     # given arguments.
     def method_missing(sym, *args, &block)
-      expectation = @mock.should_receive(sym).and_return(&block)
+      location = caller.first
+      expectation = @mock.flexmock_define_expectation(location, sym).and_return(&block)
       if strict?
         args = args.collect { |arg| eq(arg) }
         expectation.with(*args).ordered.once

data/lib/flexmock/rspec.rb

@@ -22,6 +22,7 @@ class FlexMock
 
   class RSpecFrameworkAdapter
     def assert_block(msg, &block)
+      msg = msg.call if msg.is_a?(Proc)
       SpecModule::Expectations.fail_with(msg) unless yield
     end
 

data/lib/flexmock/spy_describers.rb

@@ -19,9 +19,19 @@ class FlexMock
         result << times_description(options[:times])
         result << block_description(options[:with_block])
         result << ".\n"
-        result << "The following messages have been received:\n"
-        spy.flexmock_calls.each do |call_sym, call_args|
-          result << "    " << call_description(call_sym, call_args) << "\n"
+        result << describe_calls(spy)
+        result
+      end
+
+      def describe_calls(spy)
+        result = ''
+        if spy.flexmock_calls.empty?
+          result << "No messages have been received\n"
+        else
+          result << "The following messages have been received:\n"
+          spy.flexmock_calls.each do |call_sym, call_args|
+            result << "    " << call_description(call_sym, call_args) << "\n"
+          end
         end
         result
       end

data/lib/flexmock/test_unit_integration.rb

@@ -46,6 +46,17 @@ class FlexMock
   #
   class TestUnitFrameworkAdapter
     include Test::Unit::Assertions
+
+    def assert_block(msg, &block)
+      unless yield
+        msg = msg.call if msg.is_a?(Proc)
+        super(msg) { false }
+      end
+    rescue assertion_failed_error => ex
+      ex.message.sub!(/Expected block to return true value./,'')
+      raise ex
+    end
+
     def assertion_failed_error
       defined?(Test::Unit::AssertionFailedError) ? Test::Unit::AssertionFailedError : MiniTest::Assertion
     end

data/lib/flexmock/validators.rb

@@ -10,6 +10,7 @@
 #+++
 
 require 'flexmock/noop'
+require 'flexmock/spy_describers'
 
 class FlexMock
 
@@ -17,6 +18,8 @@ class FlexMock
   # Base class for all the count validators.
   #
   class CountValidator
+    include FlexMock::SpyDescribers
+
     def initialize(expectation, limit)
       @exp = expectation
       @limit = limit
@@ -28,6 +31,10 @@ class FlexMock
     def eligible?(n)
       n < @limit
     end
+
+    def calls(n)
+      n == 1 ? "call" : "calls"
+    end
   end
 
   ####################################################################
@@ -37,8 +44,16 @@ class FlexMock
     # Validate that the method expectation was called exactly +n+
     # times.
     def validate(n)
-      FlexMock.framework_adapter.assert_equal @limit, n,
-        "method '#{@exp}' called incorrect number of times"
+      @exp.flexmock_location_filter do
+        FlexMock.framework_adapter.assert_block(
+          lambda {
+            "Method '#{@exp}' called incorrect number of times\n" +
+            "#{@limit} #{calls(@limit)} expected\n" +
+            "#{n} matching #{calls(n)} found\n" +
+            describe_calls(@exp.mock)
+          }
+          ) { @limit == n }
+      end
     end
   end
 
@@ -49,9 +64,15 @@ class FlexMock
     # Validate the method expectation was called no more than +n+
     # times.
     def validate(n)
-      FlexMock.framework_adapter.assert_block(
-        "Method '#{@exp}' should be called at least #{@limit} times,\n" +
-        "only called #{n} times") { n >= @limit }
+      @exp.flexmock_location_filter do
+        FlexMock.framework_adapter.assert_block(
+          lambda {
+            "Method '#{@exp}' called incorrect number of times\n" +
+            "At least #{@limit} #{calls(@limit)} expected\n" +
+            "#{n} matching #{calls(n)} found\n" +
+            describe_calls(@exp.mock)
+          }) { n >= @limit }
+      end
     end
 
     # If the expectation has been called +n+ times, is it still
@@ -69,9 +90,15 @@ class FlexMock
   class AtMostCountValidator < CountValidator
     # Validate the method expectation was called at least +n+ times.
     def validate(n)
-      FlexMock.framework_adapter.assert_block(
-        "Method '#{@exp}' should be called at most #{@limit} times,\n" +
-        "only called #{n} times") { n <= @limit }
+      @exp.flexmock_location_filter do
+        FlexMock.framework_adapter.assert_block(
+          lambda {
+            "Method '#{@exp}' called incorrect number of times\n" +
+            "At most #{@limit} #{calls(@limit)} expected\n" +
+            "#{n} matching #{calls(n)} found\n" +
+            describe_calls(@exp.mock)
+          }) { n <= @limit }
+      end
     end
   end
 end

data/lib/flexmock/version.rb

@@ -3,7 +3,7 @@ class FlexMock
     NUMBERS = [
       MAJOR = 1,
       MINOR = 0,
-      BUILD = 2,
+      BUILD = 3,
     ]
   end
 

data/test/assert_spy_called_test.rb

@@ -76,6 +76,23 @@ class AssertSpyCalledTest < Test::Unit::TestCase
     end
   end
 
+  def test_assert_error_lists_calls_actually_made
+    spy.foo
+    spy.bar(1)
+    ex = assert_fails(/The following messages have been received/) do
+      assert_spy_called spy, :baz
+    end
+    assert_match(/  foo\(\)/, ex.message)
+    assert_match(/  bar\(1\)/, ex.message)
+    assert_no_match(/  baz\(\)/, ex.message)
+  end
+
+  def test_assert_errors_say_no_calls_made
+    ex = assert_fails(/No messages have been received/) do
+      assert_spy_called spy, :baz
+    end
+  end
+
   private
 
   def assert_fails(message_pattern)

data/test/base_class_test.rb

@@ -21,10 +21,20 @@ class BaseClassTest < Test::Unit::TestCase
     @mock ||= flexmock(:on, FooBar)
   end
 
-  def test_auto_mocks_class
+  def test_base_class_auto_mocks_class
     assert_equal FooBar, mock.class
   end
 
+  def test_base_class_auto_mocks_base_class_methods
+    assert_equal FlexMock.undefined, mock.foo
+  end
+
+  def test_base_class_does_not_mock_non_base_class_methods
+    assert_raise(NoMethodError) do
+      mock.fuzz
+    end
+  end
+
   def test_can_stub_existing_methods
     mock.should_receive(:foo => :bar)
     assert_equal :bar, mock.foo

data/test/demeter_mocking_test.rb

@@ -65,7 +65,7 @@ class TestDemeterMocking < Test::Unit::TestCase
   def test_conflicting_mock_declarations_in_reverse_order_does_not_raise_error
     # Not all conflicting definitions can be detected.
     m = flexmock("A")
-    assert_failure() do
+    assert_failure do
       m.should_receive("child.other").and_return(:other)
       m.should_receive("child").and_return(:xyzzy)
       assert_equal :xyzzy, m.child.other

data/test/new_instances_test.rb

@@ -96,7 +96,7 @@ class TestNewInstances < Test::Unit::TestCase
 
     Dog.new
     ex = assert_raise(assertion_failed_error) { flexmock_teardown }
-    assert_match(/method 'bark\(.*\)' called incorrect number of times/, ex.message)
+    assert_match(/method 'bark\(.*\)' called incorrect number of times/i, ex.message)
   end
 
   def test_new_instances_reports_error_on_non_classes

data/test/record_mode_test.rb

@@ -71,7 +71,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_recording_mode_should_validate_args_with_equals
-    assert_failure do
+    assert_mock_failure(:deep => true, :line => __LINE__+5) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |r|
           r.f(1)
@@ -82,7 +82,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_recording_mode_should_allow_arg_contraint_validation
-    assert_failure do
+    assert_mock_failure(:deep => true, :line => __LINE__+5) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |r|
           r.f(1)
@@ -93,7 +93,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_recording_mode_should_handle_multiplicity_contraints
-    assert_failure do
+    assert_mock_failure(:line => __LINE__+3) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |r|
           r.f { :result }.once
@@ -105,7 +105,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_strict_record_mode_requires_exact_argument_matches
-    assert_failure do
+    assert_mock_failure(:deep => true, :line => __LINE__+6) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |rec|
           rec.should_be_strict
@@ -117,7 +117,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_strict_record_mode_requires_exact_ordering
-    assert_failure do
+    assert_mock_failure(:deep => true, :line => __LINE__+8) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |rec|
           rec.should_be_strict
@@ -131,7 +131,7 @@ class TestRecordMode < Test::Unit::TestCase
   end
 
   def test_strict_record_mode_requires_once
-    assert_failure do
+    assert_mock_failure(:deep => true, :line => __LINE__+4) do
       FlexMock.use("mock") do |mock|
         mock.should_expect do |rec|
           rec.should_be_strict