lib/spec/mocks/methods.rb



module Spec
  module Mocks
    module Methods
      def should_receive(sym, opts={}, &block)
        __mock_proxy.add_message_expectation(opts[:expected_from] || caller(1)[0], sym.to_sym, opts, &block)
      end

      def should_not_receive(sym, &block)
        __mock_proxy.add_negative_message_expectation(caller(1)[0], sym.to_sym, &block)
      end
      
      def stub!(sym_or_hash, opts={}, &block)
        if Hash === sym_or_hash
          sym_or_hash.each {|method, value| stub!(method).and_return value }
        else
          __mock_proxy.add_stub(caller(1)[0], sym_or_hash.to_sym, opts, &block)
        end
      end
      
      alias_method :stub, :stub!

      def unstub!(message)
        __mock_proxy.remove_stub(message)
      end

      alias_method :unstub, :unstub!

      # :call-seq:
      #   object.stub_chain(:first, :second, :third).and_return(:this)
      #
      # Supports stubbing a chain of methods. Each argument represents
      # a method name to stub, and each one returns a proxy object that
      # can accept more stubs, until the last, which returns whatever
      # is passed to +and_return_.
      #
      # == Examples
      #   
      #   # with this in an example ...
      #   article = double('article')
      #   Article.stub_chain(:authored_by, :published, :recent).and_return([article])
      #   # then this will return an Array with the article double in it:
      #   Article.authored_by(params[:author_id]).published.recent
      def stub_chain(*methods)
        if methods.length > 1
          if matching_stub = __mock_proxy.find_matching_method_stub(methods[0])
            methods.shift
            matching_stub.invoke_return_block.stub_chain(*methods)
          else
            next_in_chain = Object.new
            stub!(methods.shift) {next_in_chain}
            next_in_chain.stub_chain(*methods)
          end
        else
          stub!(methods.shift)
        end
      end
      
      # Record and otherwise ignore all messages that aren't specified,
      # with +stub+, +stub!+, or +should_receive+.
      # 
      # == Returns
      #   self
      def as_null_object
        __mock_proxy.as_null_object
      end
      
      def null_object?
        __mock_proxy.null_object?
      end
      
      def received_message?(sym, *args, &block) #:nodoc:
        __mock_proxy.received_message?(sym.to_sym, *args, &block)
      end
      
      def rspec_verify #:nodoc:
        __mock_proxy.verify
      end

      def rspec_reset #:nodoc:
        __mock_proxy.reset
      end

    private

      def __mock_proxy
        if Mock === self
          @mock_proxy ||= Proxy.new(self, @name, @options)
        else
          @mock_proxy ||= Proxy.new(self)
        end
      end
    end
  end
end