rspec-mocks 2.7.0.rc1 → 2.7.0

data/README.md

@@ -3,21 +3,6 @@
 rspec-mocks provides a test-double framework for rspec including support
 for method stubs, fakes, and message expectations.
 
-[![build status](http://travis-ci.org/rspec/rspec-mocks.png)](http://travis-ci.org/rspec/rspec-mocks)
-
-## Documentation
-
-The [Cucumber features](http://relishapp.com/rspec/rspec-mocks) are the
-most comprehensive and up-to-date docs for end-users.
-
-The [RDoc](http://rubydoc.info/gems/rspec-mocks/2.3.0/frames) provides additional
-information for contributors and/or extenders.
-
-All of the documentation is open source and a work in progress. If you find it
-lacking or confusing, you can help improve it by submitting requests and
-patches to the [rspec-mocks issue
-tracker](https://github.com/rspec/rspec-mocks/issues).
-
 ## Install
 
     gem install rspec       # for rspec-core, rspec-expectations, rspec-mocks
@@ -48,10 +33,6 @@ tracker](https://github.com/rspec/rspec-mocks/issues).
       end
     end
 
-## Contribute
-
-See [http://github.com/rspec/rspec-dev](http://github.com/rspec/rspec-dev)
-
 ## Also see
 
 * [http://github.com/rspec/rspec](http://github.com/rspec/rspec)

data/lib/rspec/mocks.rb

@@ -17,7 +17,7 @@ module RSpec
   #
   #   book = double("book")
   #   double.stub(:title) { "The RSpec Book" }
-  #   double.title => "The RSpec Book"
+  #   double.title # => "The RSpec Book"
   #
   # When we declare a stub, we say we are "stubbing" a method.
   #
@@ -37,9 +37,9 @@ module RSpec
   # == Mock Objects and Test Stubs
   #
   # The names Mock Object and Test Stub suggest specialized Test Doubles.  i.e.
-  # Test Stub evokes Test Double that only supports method stubs, and a Mock
-  # Object evokes a Test Double that only supports message expectations, or
-  # sometimes supports message expectations in addition to method stubs.
+  # a Test Stub is a Test Double that only supports method stubs, and a Mock
+  # Object is a Test Double that supports message expectations and method
+  # stubs.
   #
   # There is a lot of overlapping nomenclature here, and there are many
   # variations of these patterns (fakes, spies, etc). Keep in mind that most of
@@ -60,7 +60,7 @@ module RSpec
   #
   # In this case we're instrumenting Person to return the person object we've
   # defined whenever it receives the +find+ message. We can do this with any
-  # object in a system because RSpec adds the +stub+ and +should_receive+
+  # object in a system because rspec-mocks adds the +stub+ and +should_receive+
   # methods to every object. When we use either, RSpec replaces the method
   # we're stubbing or mocking with it's own test-double-like method. At the
   # end of the example, RSpec verifies any message expectations, and then
@@ -73,15 +73,14 @@ module RSpec
   #
   # == Argument Matchers
   #
-  # Arguments that are passed to #with are compared with actual arguments received
-  # using == by default. In cases in which you want to specify things about the arguments
-  # rather than the arguments themselves, you can use any of RSpec's Expression Matchers.
-  # They don't all make syntactic sense (they were primarily designed for use with
-  # RSpec::Expectations), but you are free to create your own custom RSpec::Matchers.
+  # Arguments that are passed to +with+ are compared with actual arguments
+  # received using ==. In cases in which you want to specify things about the
+  # arguments rather than the arguments themselves, you can use any of the
+  # matchers that ship with rspec-expectations. They don't all make syntactic
+  # sense (they were primarily designed for use with RSpec::Expectations), but
+  # you are free to create your own custom RSpec::Matchers.
   #
-  # RSpec::Mocks does provide one additional Matcher method named #ducktype.
-  #
-  # In addition, RSpec::Mocks adds some keyword Symbols that you can use to
+  # rspec-mocks also adds some keyword Symbols that you can use to
   # specify certain kinds of arguments:
   #
   #   double.should_receive(:msg).with(no_args())

data/lib/rspec/mocks/any_instance/recorder.rb

@@ -36,6 +36,10 @@ module RSpec
           end
         end
 
+        def stub!(*)
+          raise "stub! is not supported on any_instance. Use stub instead."
+        end
+
         def stub_chain(method_name_or_string_chain, *args, &block)
           if period_separated_method_chain?(method_name_or_string_chain)
             first_method_name = method_name_or_string_chain.split('.').first.to_sym
@@ -89,7 +93,7 @@ module RSpec
         end
         
         def restore_method!(method_name)
-          if @klass.method_defined?(build_alias_method_name(method_name))
+          if public_protected_or_private_method_defined?(build_alias_method_name(method_name))
             restore_original_method!(method_name)
           else
             remove_dummy_method!(method_name)
@@ -118,12 +122,14 @@ module RSpec
         def backup_method!(method_name)
           alias_method_name = build_alias_method_name(method_name)
           @klass.class_eval do
-            if method_defined?(method_name)
-              alias_method alias_method_name, method_name
-            end
-          end
+            alias_method alias_method_name, method_name
+          end if public_protected_or_private_method_defined?(method_name)
         end
-
+        
+        def public_protected_or_private_method_defined?(method_name)
+          @klass.method_defined?(method_name) || @klass.private_method_defined?(method_name)
+        end
+        
         def stop_observing!(method_name)
           restore_method!(method_name)
           @observed_methods.delete(method_name)

data/lib/rspec/mocks/argument_matchers.rb

@@ -138,48 +138,41 @@ module RSpec
         end
       end
 
-      # :call-seq:
-      #   object.should_receive(:message).with(any_args())
-      #
       # Passes if object receives :message with any args at all. This is
       # really a more explicit variation of object.should_receive(:message)
+      #
+      # == Examples
+      #   object.should_receive(:message).with(any_args())
       def any_args
         AnyArgsMatcher.new
       end
       
-      # :call-seq:
-      #   object.should_receive(:message).with(anything())
-      #
       # Passes as long as there is an argument.
+      #
+      # == Examples
+      #   object.should_receive(:message).with(anything())
       def anything
         AnyArgMatcher.new(nil)
       end
       
-      # :call-seq:
-      #   object.should_receive(:message).with(no_args)
-      #
       # Passes if no arguments are passed along with the message
+      #
+      # == Examples
+      #   object.should_receive(:message).with(no_args)
       def no_args
         NoArgsMatcher.new
       end
       
-      # :call-seq:
-      #   object.should_receive(:message).with(duck_type(:hello))
-      #   object.should_receive(:message).with(duck_type(:hello, :goodbye))
-      #
       # Passes if the argument responds to the specified messages.
       #
       # == Examples
-      #
-      #   array = []
-      #   display = double('display')
-      #   display.should_receive(:present_names).with(duck_type(:length, :each))
-      #   => passes
+      #   object.should_receive(:message).with(duck_type(:hello))
+      #   object.should_receive(:message).with(duck_type(:hello, :goodbye))
       def duck_type(*args)
         DuckTypeMatcher.new(*args)
       end
 
-      # :call-seq:
+      # == Examples
       #   object.should_receive(:message).with(boolean())
       #
       # Passes if the argument is boolean.
@@ -187,22 +180,23 @@ module RSpec
         BooleanMatcher.new(nil)
       end
       
-      # :call-seq:
+      # Passes if the argument is a hash that includes the specified key(s) or key/value
+      # pairs. If the hash includes other keys, it will still pass.
+      #
+      # == Examples
       #   object.should_receive(:message).with(hash_including(:key => val))
       #   object.should_receive(:message).with(hash_including(:key))
       #   object.should_receive(:message).with(hash_including(:key, :key2 => val2))
-      # Passes if the argument is a hash that includes the specified key(s) or key/value
-      # pairs. If the hash includes other keys, it will still pass.
       def hash_including(*args)
         HashIncludingMatcher.new(anythingize_lonely_keys(*args))
       end
       
-      # :call-seq:
+      # Passes if the argument is a hash that doesn't include the specified key(s) or key/value
+      #
+      # == Examples
       #   object.should_receive(:message).with(hash_not_including(:key => val))
       #   object.should_receive(:message).with(hash_not_including(:key))
       #   object.should_receive(:message).with(hash_not_including(:key, :key2 => :val2))
-      #
-      # Passes if the argument is a hash that doesn't include the specified key(s) or key/value
       def hash_not_including(*args)
         HashNotIncludingMatcher.new(anythingize_lonely_keys(*args))
       end

data/lib/rspec/mocks/message_expectation.rb

@@ -63,10 +63,8 @@ module RSpec
         @return_block = block_given? ? return_block : lambda { value }
       end
       
-      # :call-seq:
-      #   and_raise()
-      #   and_raise(Exception) #any exception class
-      #   and_raise(exception) #any exception object
+      # Tells the mock or stub to raise an exception when the message
+      # is received.
       #
       # == Warning
       #
@@ -74,6 +72,11 @@ module RSpec
       # raise an instance of it, creating it with +new+. If the exception
       # class initializer requires any parameters, you must pass in an
       # instance and not the class.
+      #
+      # == Examples
+      #   and_raise()
+      #   and_raise(Exception) #any exception class
+      #   and_raise(exception) #any exception object
       def and_raise(exception=Exception)
         @exception_to_raise = exception
       end

data/lib/rspec/mocks/methods.rb

@@ -24,15 +24,13 @@ module RSpec
       alias_method :stub!, :stub
       alias_method :unstub!, :unstub
       
-      # :call-seq:
-      #   double.stub_chain("foo.bar") { :baz }
-      #   double.stub_chain(:foo, :bar) { :baz }
-      #
       # Stubs a chain of methods. Especially useful with fluent and/or
       # composable interfaces.
       #
       # == Examples
       #
+      #   double.stub_chain("foo.bar") { :baz }
+      #   double.stub_chain(:foo, :bar) { :baz }
       #   Article.stub_chain("recent.published") { [Article.new] }
       def stub_chain(*chain, &blk)
         chain, blk = format_chain(*chain, &blk)
@@ -50,15 +48,15 @@ module RSpec
         end
       end
       
-      def received_message?(sym, *args, &block) #:nodoc:
+      def received_message?(sym, *args, &block)
         __mock_proxy.received_message?(sym.to_sym, *args, &block)
       end
       
-      def rspec_verify #:nodoc:
+      def rspec_verify
         __mock_proxy.verify
       end
 
-      def rspec_reset #:nodoc:
+      def rspec_reset
         __mock_proxy.reset
       end
       

data/lib/rspec/mocks/proxy.rb

@@ -45,11 +45,11 @@ module RSpec
         @object
       end
 
-      def already_proxied_respond_to # :nodoc:
+      def already_proxied_respond_to
         @already_proxied_respond_to = true
       end
 
-      def already_proxied_respond_to? # :nodoc:
+      def already_proxied_respond_to?
         @already_proxied_respond_to
       end
 
@@ -69,7 +69,7 @@ module RSpec
         method_double[method_name].remove_stub
       end
       
-      def verify #:nodoc:
+      def verify
         method_doubles.each {|d| d.verify}
       ensure
         reset

data/lib/rspec/mocks/version.rb

@@ -1,7 +1,7 @@
-module RSpec # :nodoc:
-  module Mocks # :nodoc:
-    module Version # :nodoc:
-      STRING = '2.7.0.rc1'
+module RSpec
+  module Mocks
+    module Version
+      STRING = '2.7.0'
     end
   end
 end

data/spec/rspec/mocks/any_instance_spec.rb

@@ -1,4 +1,3 @@
-
 require 'spec_helper'
 
 module RSpec
@@ -11,6 +10,8 @@ module RSpec
           def existing_method; :existing_method_return_value; end
           def existing_method_with_arguments(arg_one, arg_two = nil); :existing_method_with_arguments_return_value; end
           def another_existing_method; end
+          private
+          def private_method; :private_method_return_value; end
         end
       end
       let(:existing_method_return_value){ :existing_method_return_value }
@@ -195,7 +196,7 @@ module RSpec
             klass.new.foo.should eq(klass.new.foo)
           end
         end
-
+        
         context "core ruby objects" do
           it "works uniformly across *everything*" do
             Object.any_instance.stub(:foo).and_return(1)
@@ -235,6 +236,14 @@ module RSpec
           end
         end
       end
+
+      context "with #stub!" do
+        it "raises with a message instructing the user to use stub instead" do
+          expect do
+            klass.any_instance.stub!(:foo)
+          end.to raise_error(/Use stub instead/)
+        end
+      end
       
       context "unstub implementation" do
         it "replaces the stubbed method with the original method" do
@@ -635,39 +644,80 @@ module RSpec
           end
 
           context "with stubbing" do
-            before(:each) do
-              klass.any_instance.stub(:existing_method).and_return(1)
-              klass.method_defined?(:__existing_method_without_any_instance__).should be_true
-            end
+            context "public methods" do
+              before(:each) do
+                klass.any_instance.stub(:existing_method).and_return(1)
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_true
+              end
 
-            it "restores the class to its original state after each example when no instance is created" do
-              space.verify_all
+              it "restores the class to its original state after each example when no instance is created" do
+                space.verify_all
 
-              klass.method_defined?(:__existing_method_without_any_instance__).should be_false
-              klass.new.existing_method.should eq(existing_method_return_value)
-            end
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_false
+                klass.new.existing_method.should eq(existing_method_return_value)
+              end
 
-            it "restores the class to its original state after each example when one instance is created" do
-              klass.new.existing_method
+              it "restores the class to its original state after each example when one instance is created" do
+                klass.new.existing_method
 
-              space.verify_all
+                space.verify_all
 
-              klass.method_defined?(:__existing_method_without_any_instance__).should be_false
-              klass.new.existing_method.should eq(existing_method_return_value)
-            end
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_false
+                klass.new.existing_method.should eq(existing_method_return_value)
+              end
 
-            it "restores the class to its original state after each example when more than one instance is created" do
-              klass.new.existing_method
-              klass.new.existing_method
+              it "restores the class to its original state after each example when more than one instance is created" do
+                klass.new.existing_method
+                klass.new.existing_method
 
-              space.verify_all
+                space.verify_all
 
-              klass.method_defined?(:__existing_method_without_any_instance__).should be_false
-              klass.new.existing_method.should eq(existing_method_return_value)
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_false
+                klass.new.existing_method.should eq(existing_method_return_value)
+              end
+            end
+            
+            context "private methods" do
+              before :each do
+                klass.any_instance.stub(:private_method).and_return(:something)
+                space.verify_all
+              end
+              
+              it "cleans up the backed up method" do
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_false
+              end
+              
+              it "restores a stubbed private method after the spec is run" do
+                klass.private_method_defined?(:private_method).should be_true
+              end
+              
+              it "ensures that the restored method behaves as it originally did" do
+                klass.new.send(:private_method).should eq(:private_method_return_value)
+              end
             end
           end
 
           context "with expectations" do
+            context "private methods" do
+              before :each do
+                klass.any_instance.should_receive(:private_method).and_return(:something)
+                klass.new.private_method
+                space.verify_all
+              end
+
+              it "cleans up the backed up method" do
+                klass.method_defined?(:__existing_method_without_any_instance__).should be_false
+              end
+
+              it "restores a stubbed private method after the spec is run" do
+                klass.private_method_defined?(:private_method).should be_true
+              end
+
+              it "ensures that the restored method behaves as it originally did" do
+                klass.new.send(:private_method).should eq(:private_method_return_value)
+              end
+            end
+            
             context "ensures that the subsequent specs do not see expectations set in previous specs" do
               context "when the instance created after the expectation is set" do
                 it "first spec" do

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-mocks
 version: !ruby/object:Gem::Version 
-  hash: 15424039
-  prerelease: 6
+  hash: 19
+  prerelease: 
   segments: 
   - 2
   - 7
   - 0
-  - rc
-  - 1
-  version: 2.7.0.rc1
+  version: 2.7.0
 platform: ruby
 authors: 
 - David Chelimsky
@@ -18,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-09 00:00:00 Z
+date: 2011-10-16 00:00:00 Z
 dependencies: []
 
 description: RSpec's 'test double' framework, with support for stubbing and mocking
@@ -147,21 +145,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: rspec
-rubygems_version: 1.8.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: rspec-mocks-2.7.0.rc1
+summary: rspec-mocks-2.7.0
 test_files: 
 - features/README.markdown
 - features/Scope.md