rspec-mocks 2.0.0.beta.4 → 2.0.0.beta.5

data/.autotest

@@ -1,6 +1,7 @@
 Autotest.add_hook :initialize do |at|
-  at.add_mapping(%r%^lib/.*\.rb$%) {
-    at.files_matching %r%^spec/.*\_spec.rb$%
+  at.clear_mappings
+  at.add_mapping(%r%\.rb$%) {
+    at.files_matching %r%^spec/.*_spec\.rb$%
   }
 end
 

data/VERSION

@@ -1 +1 @@
-2.0.0.beta.4
+2.0.0.beta.5

data/features/mocks/block_local_expectations.feature

@@ -1,9 +1,5 @@
 Feature: block local expectations
 
-  In order to set message expectations on ...
-  As an RSpec user
-  I want to configure the evaluation context
-
   Background:
     Given a file named "account.rb" with:
       """
@@ -22,13 +18,8 @@ Feature: block local expectations
       """
       require 'account'
 
-      Rspec.configure do |config|
-        config.mock_framework = :rspec
-      end
-
       describe "account DSL" do
         it "it succeeds when the block local receives the given call" do
-          account = Account.new
           Account.should_receive(:create).and_yield do |account|
             account.should_receive(:opening_balance).with(100, :USD)
           end
@@ -47,13 +38,8 @@ Feature: block local expectations
       """
       require 'account'
 
-      Rspec.configure do |config|
-        config.mock_framework = :rspec
-      end
-
       describe "account DSL" do
         it "fails when the block local does not receive the expected call" do
-          account = Account.new
           Account.should_receive(:create).and_yield do |account|
             account.should_receive(:opening_balance).with(100, :USD)
           end

data/features/mocks/mix_stubs_and_mocks.feature

@@ -14,7 +14,7 @@ Feature: Spec and test together
 
       describe "a stub in before" do
         before(:each) do
-          @messenger = mock('messenger').as_null_object
+          @messenger = double('messenger').as_null_object
         end
 
         it "a" do
@@ -25,4 +25,4 @@ Feature: Spec and test together
       end
       """
     When I run "rspec stub_and_mocks_spec.rb -fs"
-    Then I should see "'messenger' expected :foo with"
+    Then I should see "received :foo with unexpected arguments"

data/features/mocks/warn_when_expectation_is_set_on_nil.feature

@@ -0,0 +1,50 @@
+Feature: warn when expectation is set on nil
+
+  Scenario: nil instance variable
+    Given a file named "example_spec.rb" with:
+      """
+      Rspec.configure {|c| c.mock_with :rspec}
+      describe "something" do
+        it "does something" do
+          @i_do_not_exist.should_receive(:foo)
+          @i_do_not_exist.foo
+        end
+      end
+      """
+    When I run "rspec example_spec.rb"
+    Then I should see "An expectation of :foo was set on nil"
+
+  Scenario: allow
+    Given a file named "example_spec.rb" with:
+      """
+      Rspec.configure {|c| c.mock_with :rspec}
+      describe "something" do
+        it "does something" do
+          allow_message_expectations_on_nil
+          nil.should_receive(:foo)
+          nil.foo
+        end
+      end
+      """
+    When I run "rspec example_spec.rb"
+    Then I should not see "An expectation"
+
+  Scenario: allow in one example, but not on another
+    Given a file named "example_spec.rb" with:
+      """
+      Rspec.configure {|c| c.mock_with :rspec}
+      describe "something" do
+        it "does something (foo)" do
+          allow_message_expectations_on_nil
+          nil.should_receive(:foo)
+          nil.foo
+        end
+        it "does something (bar)" do
+          nil.should_receive(:bar)
+          nil.bar
+        end
+      end
+      """
+    When I run "rspec example_spec.rb"
+    Then I should see "An expectation of :bar"
+    And  I should not see "An expectation of :foo"

data/lib/rspec/mocks.rb

@@ -68,13 +68,13 @@ module Rspec
   #
   # You can create a mock in any specification (or setup) using:
   #
-  #   mock(name, options={})
+  #   double(name, options={})
   #
   # The optional +options+ argument is a +Hash+. Currently the only supported
   # option is +:null_object+. Setting this to true instructs the mock to ignore
   # any messages it hasn’t been told to expect – and quietly return itself. For example:
   #
-  #   mock("person", :null_object => true)
+  #   double("person", :null_object => true)
   #
   # == Creating a Stub
   #
@@ -93,7 +93,7 @@ module Rspec
   # mock expectations to existing classes and objects:
   #
   #   Factory.should_receive(:find).with(id).and_return(value)
-  #   obj.stub!(:to_i).and_return(3)
+  #   obj.stub(:to_i).and_return(3)
   #   etc ...
   #
   # == Expecting Messages
@@ -168,12 +168,12 @@ module Rspec
   # not support any qualifiers about the message received (i.e. you can't specify arguments
   # or receive counts):
   #
-  #   my_mock.stub!(:sym).and_return(value)
-  #   my_mock.stub!(:sym).and_return(value1, value2, value3)
-  #   my_mock.stub!(:sym).and_raise(error)
-  #   my_mock.stub!(:sym).and_throw(:sym)
-  #   my_mock.stub!(:sym).and_yield(values,to,yield)
-  #   my_mock.stub!(:sym).and_yield(values,to,yield).and_yield(some,other,values,this,time)
+  #   my_mock.stub(:sym).and_return(value)
+  #   my_mock.stub(:sym).and_return(value1, value2, value3)
+  #   my_mock.stub(:sym).and_raise(error)
+  #   my_mock.stub(:sym).and_throw(:sym)
+  #   my_mock.stub(:sym).and_yield(values,to,yield)
+  #   my_mock.stub(:sym).and_yield(values,to,yield).and_yield(some,other,values,this,time)
   #
   # == Arbitrary Handling
   #

data/lib/rspec/mocks/argument_matchers.rb

@@ -172,7 +172,7 @@ module Rspec
       # == Examples
       #
       #   array = []
-      #   display = mock('display')
+      #   display = double('display')
       #   display.should_receive(:present_names).with(duck_type(:length, :each))
       #   => passes
       def duck_type(*args)

data/lib/rspec/mocks/error_generator.rb

@@ -3,7 +3,8 @@ module Rspec
     class ErrorGenerator
       attr_writer :opts
       
-      def initialize(target, name)
+      def initialize(target, name, options={})
+        @declared_as = options[:__declared_as] || 'Mock'
         @target = target
         @name = name
       end
@@ -18,12 +19,18 @@ module Rspec
       
       def raise_unexpected_message_args_error(expectation, *args)
         expected_args = format_args(*expectation.expected_args)
-        actual_args = args.empty? ? "(no args)" : format_args(*args)
-        __raise "#{intro} expected #{expectation.sym.inspect} with #{expected_args} but received it with #{actual_args}"
+        actual_args = format_args(*args)
+        __raise "#{intro} received #{expectation.sym.inspect} with unexpected arguments\n  expected: #{expected_args}\n       got: #{actual_args}"
+      end
+      
+      def raise_similar_message_args_error(expectation, *args)
+        expected_args = format_args(*expectation.expected_args)
+        actual_args = args.collect {|a| format_args(*a)}.join(", ")
+        __raise "#{intro} received #{expectation.sym.inspect} with unexpected arguments\n  expected: #{expected_args}\n       got: #{actual_args}"
       end
       
       def raise_expectation_error(sym, expected_received_count, actual_received_count, *args)
-        __raise "#{intro} expected :#{sym}#{arg_message(*args)} #{count_message(expected_received_count)}, but received it #{count_message(actual_received_count)}"
+        __raise "(#{intro}).#{sym}#{format_args(*args)}\n    expected: #{count_message(expected_received_count)}\n    received: #{count_message(actual_received_count)}"
       end
       
       def raise_out_of_order_error(sym)
@@ -45,7 +52,17 @@ module Rspec
     private
 
       def intro
-        @name ? "Mock '#{@name}'" : @target.class == Class ? "<#{@target.inspect} (class)>" : (@target.nil? ? "nil" : @target)
+        if @name
+          "#{@declared_as} #{@name.inspect}"
+        elsif Mock === @target
+          @declared_as
+        elsif Class === @target
+          "<#{@target.inspect} (class)>"
+        elsif @target
+          @target
+        else
+          "nil"
+        end
       end
       
       def __raise(message)
@@ -71,11 +88,10 @@ module Rspec
       end
 
       def pretty_print(count)
-        return "once" if count == 1
-        return "twice" if count == 2
-        return "#{count} times"
+        "#{count} time#{count == 1 ? '' : 's'}"
       end
 
     end
   end
 end
+

data/lib/rspec/mocks/framework.rb

@@ -2,6 +2,7 @@
 # supports wrapping rspec's mocking functionality without invading every
 # object in the system.
 
+require 'rspec/mocks/method_double'
 require 'rspec/mocks/methods'
 require 'rspec/mocks/argument_matchers'
 require 'rspec/mocks/spec_methods'

data/lib/rspec/mocks/message_expectation.rb

@@ -244,7 +244,7 @@ module Rspec
         if similar_messages.empty?
           @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *@args_expectation.args)
         else
-          @error_generator.raise_unexpected_message_args_error(self, *@similar_messages)
+          @error_generator.raise_similar_message_args_error(self, *@similar_messages)
         end
       end
 

data/lib/rspec/mocks/method_double.rb

@@ -0,0 +1,156 @@
+module Rspec
+  module Mocks
+    class MethodDouble < Hash
+      attr_reader :method_name
+
+      def initialize(object, method_name, proxy)
+        @method_name = method_name
+        @object = object
+        @proxy = proxy
+        @stashed = false
+        store(:expectations, [])
+        store(:stubs, [])
+      end
+
+      def expectations
+        self[:expectations]
+      end
+
+      def stubs
+        self[:stubs]
+      end
+
+      def visibility
+        if Mock === @object
+          'public'
+        elsif object_singleton_class.private_method_defined?(@method_name)
+          'private'
+        elsif object_singleton_class.protected_method_defined?(@method_name)
+          'protected'
+        else
+          'public'
+        end
+      end
+
+      def object_singleton_class
+        class << @object; self; end
+      end
+
+      def obfuscate(method_name)
+        "obfuscated_by_rspec_mocks__#{method_name}"
+      end
+
+      def stashed_method_name
+        obfuscate(method_name)
+      end
+
+      def object_responds_to?(method_name)
+        if @proxy.already_proxied_respond_to?
+          @object.__send__(obfuscate(:respond_to?), method_name)
+        elsif method_name == :respond_to?
+          @proxy.already_proxied_respond_to
+        else
+          @object.respond_to?(method_name, true)
+        end
+      end
+
+      def configure_method
+        $rspec_mocks.add(@object) if $rspec_mocks
+        warn_if_nil_class
+        stash_original_method
+        define_proxy_method
+      end
+
+      def stash_original_method
+        if object_responds_to?(@method_name)
+          stashed = stashed_method_name
+          orig = @method_name
+          object_singleton_class.class_eval do
+            alias_method(stashed, orig) if method_defined?(orig)
+          end
+          @stashed = true
+        end
+      end
+
+      def define_proxy_method
+        method_name = @method_name
+        visibility_for_method = "#{visibility} :#{method_name}"
+        object_singleton_class.class_eval(<<-EOF, __FILE__, __LINE__)
+          def #{method_name}(*args, &block)
+            __mock_proxy.message_received :#{method_name}, *args, &block
+          end
+          #{visibility_for_method}
+        EOF
+      end
+
+      def restore_original_method
+        if @stashed
+          method_name = @method_name
+          stashed_method_name = self.stashed_method_name
+          object_singleton_class.instance_eval do
+            remove_method method_name
+            if method_defined?(stashed_method_name)
+              alias_method method_name, stashed_method_name
+              remove_method stashed_method_name
+            end
+          end
+          @stashed = false
+        end
+      end
+
+      def verify
+        expectations.each {|e| e.verify_messages_received}
+      end
+
+      def reset
+        reset_nil_expectations_warning
+        restore_original_method
+        clear
+      end
+
+      def clear
+        expectations.clear
+        stubs.clear
+      end
+
+      def add_expectation(error_generator, expectation_ordering, expected_from, opts, &block)
+        configure_method
+        expectation = if existing_stub = stubs.first
+          existing_stub.build_child(expected_from, block, 1, opts)
+        else
+          MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, block, 1, opts)
+        end
+        expectations << expectation
+        expectation
+      end
+
+      def add_negative_expectation(error_generator, expectation_ordering, expected_from, &implementation)
+        configure_method
+        expectation = NegativeMessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, implementation)
+        expectations << expectation
+        expectation
+      end
+
+      def add_stub(error_generator, expectation_ordering, expected_from, opts={}, &implementation)
+        configure_method
+        stub = MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, nil, :any, opts, &implementation)
+        stubs << stub
+        stub
+      end
+
+      def proxy_for_nil_class?
+        @object.nil?
+      end
+
+      def warn_if_nil_class
+        if proxy_for_nil_class? & Rspec::Mocks::Proxy.warn_about_expectations_on_nil
+          Kernel.warn("An expectation of :#{@method_name} was set on nil. Called from #{caller[4]}. Use allow_message_expectations_on_nil to disable warnings.")
+        end
+      end
+
+      def reset_nil_expectations_warning
+        Rspec::Mocks::Proxy.warn_about_expectations_on_nil = true if proxy_for_nil_class?
+      end
+    end
+  end
+end

data/lib/rspec/mocks/methods.rb

@@ -9,7 +9,7 @@ module Rspec
         __mock_proxy.add_negative_message_expectation(caller(1)[0], sym.to_sym, &block)
       end
       
-      def stub!(sym_or_hash, opts={}, &block)
+      def stub(sym_or_hash, opts={}, &block)
         if Hash === sym_or_hash
           sym_or_hash.each {|method, value| stub!(method).and_return value }
         else
@@ -17,7 +17,7 @@ module Rspec
         end
       end
       
-      alias_method :stub, :stub!
+      alias_method :stub!, :stub
 
       def stub_chain(*methods)
         if methods.length > 1

data/lib/rspec/mocks/mock.rb

@@ -7,14 +7,14 @@ module Rspec
       # only) == Options:
       # * <tt>:null_object</tt> - if true, the mock object acts as a forgiving
       #   null object allowing any message to be sent to it.
-      def initialize(name='mock', stubs_and_options={})
+      def initialize(name=nil, stubs_and_options={})
         if name.is_a?(Hash) && stubs_and_options.empty?
           stubs_and_options = name
-          build_name_from_options stubs_and_options
+          @name = nil
         else
           @name = name
         end
-        @options = parse_options(stubs_and_options)
+        @options = extract_options(stubs_and_options)
         assign_stubs(stubs_and_options)
       end
 
@@ -46,8 +46,19 @@ module Rspec
         end
       end
 
-      def parse_options(options)
-        options.has_key?(:null_object) ? {:null_object => options.delete(:null_object)} : {}
+      def extract_options(stubs_and_options)
+        options = {}
+        extract_option(stubs_and_options, options, :null_object)
+        extract_option(stubs_and_options, options, :__declared_as, 'Mock')
+        options
+      end
+      
+      def extract_option(source, target, key, default=nil)
+        if source[key]
+          target[key] = source.delete(key)
+        elsif default
+          target[key] = default
+        end
       end
 
       def assign_stubs(stubs)
@@ -55,11 +66,7 @@ module Rspec
           stub!(message).and_return(response)
         end
       end
-
-      def build_name_from_options(options)
-        vals = options.inject([]) {|coll, pair| coll << "#{pair.first}: #{pair.last.inspect}"}
-        @name = '{' + vals.join(', ') + '}'
-      end
     end
   end
 end
+