Object
@private
# File lib/rspec/mocks/message_expectation.rb, line 13 def initialize(error_generator, expectation_ordering, expected_from, message, expected_received_count=1, opts={}, &implementation) @error_generator = error_generator @error_generator.opts = opts @expected_from = expected_from @message = message @actual_received_count = 0 @expected_received_count = expected_received_count @argument_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new) @consecutive = false @exception_to_raise = nil @args_to_throw = [] @order_group = expectation_ordering @at_least = @at_most = @exactly = nil @args_to_yield = [] @failed_fast = nil @args_to_yield_were_cloned = false @eval_context = nil @implementation = implementation end
@private
# File lib/rspec/mocks/message_expectation.rb, line 399 def actual_received_count_matters? @at_least || @at_most || @exactly end
@private
# File lib/rspec/mocks/message_expectation.rb, line 244 def advise(*args) similar_messages << args end
@overload and_raise @overload and_raise(ExceptionClass) @overload and_raise(exception_instance)
Tells the object to raise an exception when the message is received.
@note
When you pass an exception class, the MessageExpectation will 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.
@example
car.stub(:go).and_raise car.stub(:go).and_raise(OutOfGas) car.stub(:go).and_raise(OutOfGas.new(2, :oz))
# File lib/rspec/mocks/message_expectation.rb, line 113 def and_raise(exception=Exception) @exception_to_raise = exception end
@overload and_return(value) @overload and_return(first_value, second_value) @overload and_return(&block)
Tells the object to return a value when it receives the message. Given more than one value, the first value is returned the first time the message is received, the second value is returned the next time, etc, etc.
If the message is received more times than there are values, the last value is received for every subsequent call.
The block format is still supported, but is unofficially deprecated in favor of just passing a block to the stub method.
@example
counter.stub(:count).and_return(1) counter.count # => 1 counter.count # => 1 counter.stub(:count).and_return(1,2,3) counter.count # => 1 counter.count # => 2 counter.count # => 3 counter.count # => 3 counter.count # => 3 # etc # Supported, but ... counter.stub(:count).and_return { 1 } counter.count # => 1 # ... this is prefered counter.stub(:count) { 1 } counter.count # => 1
# File lib/rspec/mocks/message_expectation.rb, line 89 def and_return(*values, &implementation) @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 and @at_least) @consecutive = true if values.size > 1 @implementation = implementation || build_implementation(values) end
@overload and_throw(symbol) @overload and_throw(symbol, object)
Tells the object to throw a symbol (with the object if that form is used) when the message is received.
@example
car.stub(:go).and_throw(:out_of_gas) car.stub(:go).and_throw(:out_of_gas, :level => 0.1)
# File lib/rspec/mocks/message_expectation.rb, line 127 def and_throw(symbol, object = nil) @args_to_throw = [symbol, object].compact end
Tells the object to yield one or more args to a block when the message is received.
@example
stream.stub(:open).and_yield(StringIO.new)
# File lib/rspec/mocks/message_expectation.rb, line 137 def and_yield(*args, &block) if @args_to_yield_were_cloned @args_to_yield.clear @args_to_yield_were_cloned = false end yield @eval_context = Object.new.extend(RSpec::Mocks::InstanceExec) if block @args_to_yield << args self end
Allows an expected message to be received any number of times.
# File lib/rspec/mocks/message_expectation.rb, line 341 def any_number_of_times(&block) @implementation = block if block @expected_received_count = :any self end
Constrain a message expectation to be received at least a specific number of times.
@example
dealer.should_recieve(:deal_card).at_least(9).times
# File lib/rspec/mocks/message_expectation.rb, line 309 def at_least(n, &block) @implementation = block if block set_expected_received_count :at_least, n self end
Constrain a message expectation to be received at most a specific number of times.
@example
dealer.should_recieve(:deal_card).at_most(10).times
# File lib/rspec/mocks/message_expectation.rb, line 321 def at_most(n, &block) @implementation = block if block set_expected_received_count :at_most, n self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 34 def build_child(expected_from, expected_received_count, opts={}, &implementation) child = clone child.expected_from = expected_from child.implementation = implementation if implementation child.expected_received_count = expected_received_count child.clear_actual_received_count! new_gen = error_generator.clone new_gen.opts = opts child.error_generator = new_gen child.clone_args_to_yield(*@args_to_yield) child.argument_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new) child end
@private
# File lib/rspec/mocks/message_expectation.rb, line 196 def called_max_times? @expected_received_count != :any && @expected_received_count > 0 && @actual_received_count >= @expected_received_count end
Constrain a message expectation to be received a specific number of times.
@example
dealer.should_recieve(:deal_card).exactly(10).times
# File lib/rspec/mocks/message_expectation.rb, line 297 def exactly(n, &block) @implementation = block if block set_expected_received_count :exactly, n self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 49 def expected_args @argument_expectation.args end
@private
# File lib/rspec/mocks/message_expectation.rb, line 214 def expected_messages_received? ignoring_args? || matches_exact_count? || matches_at_least_count? || matches_at_most_count? end
@private
# File lib/rspec/mocks/message_expectation.rb, line 249 def generate_error if similar_messages.empty? @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *@argument_expectation.args) else @error_generator.raise_similar_message_args_error(self, *@similar_messages) end end
@private
# File lib/rspec/mocks/message_expectation.rb, line 219 def ignoring_args? @expected_received_count == :any end
@private
# File lib/rspec/mocks/message_expectation.rb, line 404 def increase_actual_received_count! @actual_received_count += 1 end
@private
# File lib/rspec/mocks/message_expectation.rb, line 155 def invoke(*args, &block) if (@expected_received_count == 0 && !@at_least) || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count)) @actual_received_count += 1 @failed_fast = true @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *args) end @order_group.handle_order_constraint self begin raise_exception unless @exception_to_raise.nil? Kernel::throw(*@args_to_throw) unless @args_to_throw.empty? default_return_val = call_with_yield(&block) if !@args_to_yield.empty? || @eval_context if @consecutive call_implementation_consecutive(*args, &block) elsif @implementation call_implementation(*args, &block) else default_return_val end ensure @actual_received_count += 1 end end
@private
# File lib/rspec/mocks/message_expectation.rb, line 150 def matches?(message, *args) @message == message && @argument_expectation.args_match?(*args) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 224 def matches_at_least_count? @at_least && @actual_received_count >= @expected_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 229 def matches_at_most_count? @at_most && @actual_received_count <= @expected_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 234 def matches_exact_count? @expected_received_count == @actual_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 201 def matches_name_but_not_args(message, *args) @message == message and not @argument_expectation.args_match?(*args) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 394 def negative_expectation_for?(message) return false end
Expect a message not to be received at all.
@example
car.should_receive(:stop).never
# File lib/rspec/mocks/message_expectation.rb, line 352 def never @expected_received_count = 0 self end
Expect a message to be received exactly one time.
@example
car.should_receive(:go).once
# File lib/rspec/mocks/message_expectation.rb, line 362 def once(&block) @implementation = block if block set_expected_received_count :exactly, 1 self end
Expect messages to be received in a specific order.
@example
api.should_receive(:prepare).ordered api.should_receive(:run).ordered api.should_receive(:finish).ordered
# File lib/rspec/mocks/message_expectation.rb, line 386 def ordered(&block) @implementation = block if block @order_group.register(self) @ordered = true self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 183 def raise_exception if !@exception_to_raise.respond_to?(:instance_method) || @exception_to_raise.instance_method(:initialize).arity <= 0 raise(@exception_to_raise) else raise ArgumentError.new('and_raise' can only accept an Exception class if an instance can be constructed with no arguments.#{@exception_to_raise.to_s}'s initialize method requires #{@exception_to_raise.instance_method(:initialize).arity} arguments, so you have to supply an instance instead.) end end
# File lib/rspec/mocks/message_expectation.rb, line 257 def raise_out_of_order_error @error_generator.raise_out_of_order_error @message end
@private
# File lib/rspec/mocks/message_expectation.rb, line 239 def similar_messages @similar_messages ||= [] end
Syntactic sugar for `exactly`, `at_least` and `at_most`
@example
dealer.should_recieve(:deal_card).exactly(10).times dealer.should_recieve(:deal_card).at_least(10).times dealer.should_recieve(:deal_card).at_most(10).times
# File lib/rspec/mocks/message_expectation.rb, line 334 def times(&block) @implementation = block if block self end
Expect a message to be received exactly two times.
@example
car.should_receive(:go).twice
# File lib/rspec/mocks/message_expectation.rb, line 373 def twice(&block) @implementation = block if block set_expected_received_count :exactly, 2 self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 206 def verify_messages_received generate_error unless expected_messages_received? || failed_fast? rescue RSpec::Mocks::MockExpectationError => error error.backtrace.insert(0, @expected_from) Kernel::raise error end
Constrains a stub or message expectation to invocations with specific arguments.
With a stub, if the message might be received with other args as well, you should stub a default value first, and then stub or mock the same message using `with` to constrain to specific arguments.
A message expectation will fail if the message is received with different arguments.
@example
cart.stub(:add) { :failure } cart.stub(:add).with(Book.new(:isbn => 1934356379)) { :success } cart.add(Book.new(:isbn => 1234567890)) # => :failure cart.add(Book.new(:isbn => 1934356379)) # => :success cart.should_receive(:add).with(Book.new(:isbn => 1934356379)) { :success } cart.add(Book.new(:isbn => 1234567890)) # => failed expectation cart.add(Book.new(:isbn => 1934356379)) # => passes
# File lib/rspec/mocks/message_expectation.rb, line 285 def with(*args, &block) @implementation = block if block_given? unless args.empty? @argument_expectation = ArgumentExpectation.new(*args, &block) self end
# File lib/rspec/mocks/message_expectation.rb, line 427 def call_implementation(*args, &block) @implementation.arity == 0 ? @implementation.call(&block) : @implementation.call(*args, &block) end
# File lib/rspec/mocks/message_expectation.rb, line 422 def call_implementation_consecutive(*args, &block) @value ||= call_implementation(*args, &block) @value[[@actual_received_count, @value.size-1].min] end
# File lib/rspec/mocks/message_expectation.rb, line 410 def call_with_yield(&block) @error_generator.raise_missing_block_error @args_to_yield unless block value = nil @args_to_yield.each do |args| if block.arity > -1 && args.length != block.arity @error_generator.raise_wrong_arity_error args, block.arity end value = @eval_context ? @eval_context.instance_exec(*args, &block) : block.call(*args) end value end
# File lib/rspec/mocks/message_expectation.rb, line 451 def clear_actual_received_count! @actual_received_count = 0 end
# File lib/rspec/mocks/message_expectation.rb, line 431 def clone_args_to_yield(*args) @args_to_yield = args.clone @args_to_yield_were_cloned = true end
# File lib/rspec/mocks/message_expectation.rb, line 436 def failed_fast? @failed_fast end
# File lib/rspec/mocks/message_expectation.rb, line 440 def set_expected_received_count(relativity, n) @at_least = (relativity == :at_least) @at_most = (relativity == :at_most) @exactly = (relativity == :exactly) @expected_received_count = case n when Numeric then n when :once then 1 when :twice then 2 end end
Generated with the Darkfish Rdoc Generator 2.