rspec 1.3.0 → 2.0.0

data/lib/spec/mocks/proxy.rb

@@ -1,266 +0,0 @@
-module Spec
-  module Mocks
-    class Proxy
-      DEFAULT_OPTIONS = {
-        :null_object => false,
-      }
-      
-      @@warn_about_expectations_on_nil = true
-      
-      def self.allow_message_expectations_on_nil
-        @@warn_about_expectations_on_nil = false
-        
-        # ensure nil.rspec_verify is called even if an expectation is not set in the example
-        # otherwise the allowance would effect subsequent examples
-        $rspec_mocks.add(nil) unless $rspec_mocks.nil?
-      end
-
-      def initialize(target, name=nil, options={})
-        @target = target
-        @name = name
-        @error_generator = ErrorGenerator.new target, name, options
-        @expectation_ordering = OrderGroup.new @error_generator
-        @expectations = []
-        @messages_received = []
-        @stubs = []
-        @proxied_methods = []
-        @options = options ? DEFAULT_OPTIONS.dup.merge(options) : DEFAULT_OPTIONS
-        @already_proxied_respond_to = false
-      end
-
-      def null_object?
-        @options[:null_object]
-      end
-      
-      def as_null_object
-        @options[:null_object] = true
-        @target
-      end
-
-      def add_message_expectation(expected_from, sym, opts={}, &block)        
-        __add sym
-        warn_if_nil_class sym
-        @expectations << build_expectation(expected_from, sym, opts, &block)
-        @expectations.last
-      end
-
-      def build_expectation(expected_from, sym, opts, &block)
-        if stub = find_matching_method_stub(sym) 
-          stub.build_child(expected_from, block_given?? block : nil, 1, opts)
-        else
-          MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil, 1, opts)
-        end
-      end
-
-      def add_negative_message_expectation(expected_from, sym, &block)
-        __add sym
-        warn_if_nil_class sym
-        @expectations << NegativeMessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil)
-        @expectations.last
-      end
-
-      def add_stub(expected_from, sym, opts={}, &implementation)
-        __add sym
-        @stubs.unshift MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, nil, :any, opts, &implementation)
-        @stubs.first
-      end
-
-      def remove_stub(message)
-        message = message.to_sym
-        if stub_to_remove = @stubs.detect { |s| s.matches_name?(message) }
-          reset_proxied_method(message)
-          @stubs.delete(stub_to_remove)
-        else
-          raise MockExpectationError, "The method `#{message}` was not stubbed or was already unstubbed"
-        end
-      end
-      
-      def verify #:nodoc:
-        verify_expectations
-      ensure
-        reset
-      end
-
-      def reset
-        clear_expectations
-        clear_stubs
-        reset_proxied_methods
-        clear_proxied_methods
-        reset_nil_expectations_warning
-      end
-
-      def received_message?(sym, *args, &block)
-        @messages_received.any? {|array| array == [sym, args, block]}
-      end
-
-      def has_negative_expectation?(sym)
-        @expectations.any? {|expectation| expectation.negative_expectation_for?(sym)}
-      end
-      
-      def record_message_received(sym, args, block)
-        @messages_received << [sym, args, block]
-      end
-
-      def message_received(sym, *args, &block)
-        expectation = find_matching_expectation(sym, *args)
-        stub = find_matching_method_stub(sym, *args)
-
-        if ok_to_invoke_stub?(stub, expectation)
-          record_stub(stub, sym, args, &block)
-        elsif expectation
-          invoke_expectation(expectation, *args, &block)
-        elsif expectation = find_almost_matching_expectation(sym, *args)
-          record_almost_matching_expectation(expectation, sym, *args, &block)
-        else
-          @target.__send__ :method_missing, sym, *args, &block
-        end
-      end
-
-      def record_stub(stub, sym, args, &block)
-        almost_matching_expectation(sym, *args) do |e|
-          e.advise(args, block)
-        end
-        stub.invoke(*args, &block)
-      end
-
-      def invoke_expectation(expectation, *args, &block)
-        expectation.invoke(*args, &block)
-      end
-
-      def record_almost_matching_expectation(expectation, sym, *args, &block)
-        expectation.advise(args, block)
-        unless (null_object? or has_negative_expectation?(sym))
-          raise_unexpected_message_args_error(expectation, *args)
-        end
-      end
-
-      def ok_to_invoke_stub?(stub, expectation)
-        stub && (!expectation || expectation.called_max_times?)
-      end
-
-      def raise_unexpected_message_args_error(expectation, *args)
-        @error_generator.raise_unexpected_message_args_error expectation, *args
-      end
-
-      def raise_unexpected_message_error(sym, *args)
-        @error_generator.raise_unexpected_message_error sym, *args
-      end
-      
-      def find_matching_method_stub(sym, *args)
-        @stubs.find {|stub| stub.matches(sym, args)}
-      end
-      
-    private
-
-      def __add(sym)
-        $rspec_mocks.add(@target) unless $rspec_mocks.nil?
-        define_expected_method(sym)
-      end
-      
-      def warn_if_nil_class(sym)
-        if proxy_for_nil_class? & @@warn_about_expectations_on_nil          
-          Kernel.warn("An expectation of :#{sym} was set on nil. Called from #{caller[2]}. Use allow_message_expectations_on_nil to disable warnings.")
-        end
-      end
-      
-      def define_expected_method(sym)
-        unless @proxied_methods.include?(sym)
-          visibility_string = "#{visibility(sym)} :#{sym}"
-          if target_responds_to?(sym)
-            munged_sym = munge(sym)
-            target_metaclass.instance_eval do
-              alias_method munged_sym, sym if method_defined?(sym)
-            end
-            @proxied_methods << sym
-          end
-          target_metaclass.class_eval(<<-EOF, __FILE__, __LINE__)
-            def #{sym}(*args, &block)
-              __mock_proxy.message_received :#{sym}, *args, &block
-            end
-            #{visibility_string}
-          EOF
-        end
-      end
-
-      def target_responds_to?(sym)
-        return @target.__send__(munge(:respond_to?),sym) if @already_proxied_respond_to
-        return @already_proxied_respond_to = true if sym == :respond_to?
-        return @target.respond_to?(sym, true)
-      end
-
-      def visibility(sym)
-        if Mock === @target
-          'public'
-        elsif target_metaclass.private_method_defined?(sym)
-          'private'
-        elsif target_metaclass.protected_method_defined?(sym)
-          'protected'
-        else
-          'public'
-        end
-      end
-
-      def munge(sym)
-        "proxied_by_rspec__#{sym}"
-      end
-
-      def clear_expectations
-        @expectations.clear
-      end
-
-      def clear_stubs
-        @stubs.clear
-      end
-
-      def clear_proxied_methods
-        @proxied_methods.clear
-      end
-
-      def target_metaclass
-        class << @target; self; end
-      end
-
-      def verify_expectations
-        @expectations.map {|e| e.verify_messages_received}
-      end
-
-      def reset_proxied_methods
-        @proxied_methods.map {|sym| reset_proxied_method(sym)}
-      end
-
-      def reset_proxied_method(sym)
-        munged_sym = munge(sym)
-        target_metaclass.instance_eval do
-          remove_method sym
-          if method_defined?(munged_sym)
-            alias_method sym, munged_sym
-            remove_method munged_sym
-          end
-        end
-      end
-      
-      def proxy_for_nil_class?
-        @target.nil?
-      end
-      
-      def reset_nil_expectations_warning
-        @@warn_about_expectations_on_nil = true if proxy_for_nil_class?
-      end
-
-      def find_matching_expectation(sym, *args)
-        @expectations.find {|expectation| expectation.matches(sym, args) && !expectation.called_max_times?} || 
-        @expectations.find {|expectation| expectation.matches(sym, args)}
-      end
-
-      def almost_matching_expectation(sym, *args, &block)
-        if e = find_almost_matching_expectation(sym, *args)
-          yield e
-        end
-      end
-
-      def find_almost_matching_expectation(sym, *args)
-        @expectations.find {|expectation| expectation.matches_name_but_not_args(sym, args)}
-      end
-    end
-  end
-end

data/lib/spec/mocks/space.rb

@@ -1,28 +0,0 @@
-module Spec
-  module Mocks
-    class Space
-      def add(obj)
-        mocks << obj unless mocks.detect {|m| m.equal? obj}
-      end
-
-      def verify_all
-        mocks.each do |mock|
-          mock.rspec_verify
-        end
-      end
-      
-      def reset_all
-        mocks.each do |mock|
-          mock.rspec_reset
-        end
-        mocks.clear
-      end
-      
-    private
-    
-      def mocks
-        @mocks ||= []
-      end
-    end
-  end
-end

data/lib/spec/mocks.rb

@@ -1,200 +0,0 @@
-require 'spec/mocks/framework'
-require 'spec/mocks/extensions/object'
-
-module Spec
-  # == Mocks and Stubs
-  #
-  # RSpec will create Mock Objects and Stubs for you at runtime, or attach stub/mock behaviour
-  # to any of your real objects (Partial Mock/Stub). Because the underlying implementation
-  # for mocks and stubs is the same, you can intermingle mock and stub
-  # behaviour in either dynamically generated mocks or your pre-existing classes.
-  # There is a semantic difference in how they are created, however,
-  # which can help clarify the role it is playing within a given spec.
-  #
-  # == Mock Objects
-  # 
-  # Mocks are objects that allow you to set and verify expectations that they will
-  # receive specific messages during run time. They are very useful for specifying how the subject of
-  # the spec interacts with its collaborators. This approach is widely known as "interaction
-  # testing".
-  # 
-  # Mocks are also very powerful as a design tool. As you are
-  # driving the implementation of a given class, Mocks provide an anonymous
-  # collaborator that can change in behaviour as quickly as you can write an expectation in your
-  # spec. This flexibility allows you to design the interface of a collaborator that often
-  # does not yet exist. As the shape of the class being specified becomes more clear, so do the
-  # requirements for its collaborators - often leading to the discovery of new types that are
-  # needed in your system.
-  # 
-  # Read Endo-Testing[http://www.mockobjects.com/files/endotesting.pdf] for a much
-  # more in depth description of this process.
-  # 
-  # == Stubs
-  # 
-  # Stubs are objects that allow you to set "stub" responses to
-  # messages. As Martin Fowler points out on his site,
-  # mocks_arent_stubs[http://www.martinfowler.com/articles/mocksArentStubs.html].
-  # Paraphrasing Fowler's paraphrasing
-  # of Gerard Meszaros: Stubs provide canned responses to messages they might receive in a test, while
-  # mocks allow you to specify and, subsquently, verify that certain messages should be received during
-  # the execution of a test.
-  # 
-  # == Partial Mocks/Stubs
-  # 
-  # RSpec also supports partial mocking/stubbing, allowing you to add stub/mock behaviour
-  # to instances of your existing classes. This is generally
-  # something to be avoided, because changes to the class can have ripple effects on
-  # seemingly unrelated specs. When specs fail due to these ripple effects, the fact
-  # that some methods are being mocked can make it difficult to understand why a
-  # failure is occurring.
-  # 
-  # That said, partials do allow you to expect and
-  # verify interactions with class methods such as +#find+ and +#create+
-  # on Ruby on Rails model classes.
-  # 
-  # == Further Reading
-  # 
-  # There are many different viewpoints about the meaning of mocks and stubs. If you are interested
-  # in learning more, here is some recommended reading:
-  # 
-  # * Mock Objects: http://www.mockobjects.com/
-  # * Endo-Testing: http://www.mockobjects.com/files/endotesting.pdf
-  # * Mock Roles, Not Objects: http://www.mockobjects.com/files/mockrolesnotobjects.pdf
-  # * Test Double Patterns: http://xunitpatterns.com/Test%20Double%20Patterns.html
-  # * Mocks aren't stubs: http://www.martinfowler.com/articles/mocksArentStubs.html
-  #
-  # == Creating a Mock
-  #
-  # You can create a mock in any specification (or setup) using:
-  #
-  #   mock(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)
-  #
-  # == Creating a Stub
-  #
-  # You can create a stub in any specification (or setup) using:
-  #
-  #   stub(name, stub_methods_and_values_hash)
-  #
-  # For example, if you wanted to create an object that always returns
-  # "More?!?!?!" to "please_sir_may_i_have_some_more" you would do this:
-  #
-  #   stub("Mr Sykes", :please_sir_may_i_have_some_more => "More?!?!?!")
-  #
-  # == Creating a Partial Mock
-  #
-  # You don't really "create" a partial mock, you simply add method stubs and/or
-  # mock expectations to existing classes and objects:
-  #
-  #   Factory.should_receive(:find).with(id).and_return(value)
-  #   obj.stub!(:to_i).and_return(3)
-  #   etc ...
-  #
-  # == Expecting Messages
-  #
-  #   my_mock.should_receive(:sym)
-  #   my_mock.should_not_receive(:sym)
-  #   
-  # == Expecting Arguments
-  #
-  #   my_mock.should_receive(:sym).with(*args)
-  #   my_mock.should_not_receive(:sym).with(*args)
-  #
-  # == 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
-  # Spec::Expectations), but you are free to create your own custom Spec::Matchers.
-  #
-  # Spec::Mocks does provide one additional Matcher method named #ducktype.
-  #
-  # In addition, Spec::Mocks adds some keyword Symbols that you can use to
-  # specify certain kinds of arguments:
-  #
-  #   my_mock.should_receive(:sym).with(no_args())
-  #   my_mock.should_receive(:sym).with(any_args())
-  #   my_mock.should_receive(:sym).with(1, kind_of(Numeric), "b") #2nd argument can any kind of Numeric
-  #   my_mock.should_receive(:sym).with(1, boolean(), "b") #2nd argument can true or false
-  #   my_mock.should_receive(:sym).with(1, /abc/, "b") #2nd argument can be any String matching the submitted Regexp
-  #   my_mock.should_receive(:sym).with(1, anything(), "b") #2nd argument can be anything at all
-  #   my_mock.should_receive(:sym).with(1, ducktype(:abs, :div), "b")
-  #                            #2nd argument can be object that responds to #abs and #div
-  #                                                                       
-  # == Receive Counts
-  #
-  #   my_mock.should_receive(:sym).once
-  #   my_mock.should_receive(:sym).twice
-  #   my_mock.should_receive(:sym).exactly(n).times
-  #   my_mock.should_receive(:sym).at_least(:once)
-  #   my_mock.should_receive(:sym).at_least(:twice)
-  #   my_mock.should_receive(:sym).at_least(n).times
-  #   my_mock.should_receive(:sym).at_most(:once)
-  #   my_mock.should_receive(:sym).at_most(:twice)
-  #   my_mock.should_receive(:sym).at_most(n).times
-  #   my_mock.should_receive(:sym).any_number_of_times
-  #
-  # == Ordering
-  #
-  #   my_mock.should_receive(:sym).ordered
-  #   my_mock.should_receive(:other_sym).ordered
-  #     #This will fail if the messages are received out of order
-  #
-  # == Setting Reponses
-  #
-  # Whether you are setting a mock expectation or a simple stub, you can tell the
-  # object precisely how to respond:
-  #
-  #   my_mock.should_receive(:sym).and_return(value)
-  #   my_mock.should_receive(:sym).exactly(3).times.and_return(value1, value2, value3)
-  #     # returns value1 the first time, value2 the second, etc
-  #   my_mock.should_receive(:sym).and_return { ... } #returns value returned by the block
-  #   my_mock.should_receive(:sym).and_raise(error)
-  #     #error can be an instantiated object or a class
-  #     #if it is a class, it must be instantiable with no args
-  #   my_mock.should_receive(:sym).and_throw(:sym)
-  #   my_mock.should_receive(:sym).and_yield(values,to,yield)
-  #   my_mock.should_receive(:sym).and_yield(values,to,yield).and_yield(some,other,values,this,time)
-  #     # for methods that yield to a block multiple times
-  #
-  # Any of these responses can be applied to a stub as well, but stubs do
-  # 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)
-  #
-  # == Arbitrary Handling
-  #
-  # Once in a while you'll find that the available expectations don't solve the
-  # particular problem you are trying to solve. Imagine that you expect the message
-  # to come with an Array argument that has a specific length, but you don't care
-  # what is in it. You could do this:
-  #
-  #   my_mock.should_receive(:sym) do |arg|
-  #     arg.should be_an_istance_of(Array)
-  #     arg.length.should == 7
-  #   end
-  #
-  # Note that this would fail if the number of arguments received was different from
-  # the number of block arguments (in this case 1).
-  #
-  # == Combining Expectation Details
-  #
-  # Combining the message name with specific arguments, receive counts and responses
-  # you can get quite a bit of detail in your expectations:
-  #
-  #   my_mock.should_receive(:<<).with("illegal value").once.and_raise(ArgumentError)
-  module Mocks
-  end
-end