@private
@private
# File lib/rspec/mocks/message_expectation.rb, line 49 def initialize(error_generator, expectation_ordering, expected_from, method_double, type=:expectation, opts={}, &implementation_block) @error_generator = error_generator @error_generator.opts = opts @expected_from = expected_from @method_double = method_double @orig_object = @method_double.object @message = @method_double.method_name @actual_received_count = 0 @expected_received_count = type == :expectation ? 1 : :any @argument_list_matcher = ArgumentListMatcher::MATCH_ALL @order_group = expectation_ordering @order_group.register(self) unless type == :stub @expectation_type = type @ordered = false @at_least = @at_most = @exactly = nil @args_to_yield = [] @failed_fast = nil @eval_context = nil @yield_receiver_to_implementation_block = false @implementation = Implementation.new self.inner_implementation_action = implementation_block end
@private
# File lib/rspec/mocks/message_expectation.rb, line 467 def actual_received_count_matters? @at_least || @at_most || @exactly end
@private
# File lib/rspec/mocks/message_expectation.rb, line 450 def additional_expected_calls return 0 if @expectation_type == :stub || !@exactly @expected_received_count - 1 end
@private
# File lib/rspec/mocks/message_expectation.rb, line 283 def advise(*args) similar_messages << args end
Tells the object to delegate to the original unmodified method when it receives the message.
@note This is only available on partial doubles.
@example
expect(counter).to receive(:increment).and_call_original original_count = counter.count counter.increment expect(counter.count).to eq(original_count + 1)
# File lib/rspec/mocks/message_expectation.rb, line 139 def and_call_original if RSpec::Mocks::TestDouble === @method_double.object @error_generator.raise_only_valid_on_a_partial_double(:and_call_original) else warn_about_stub_override if implementation.inner_action @implementation = AndCallOriginalImplementation.new(@method_double.original_method) @yield_receiver_to_implementation_block = false end end
@overload and_raise @overload and_raise(ExceptionClass) @overload and_raise(ExceptionClass, message) @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 `exception` and passing `message` if specified. If the exception class initializer requires more than one parameters, you must pass in an instance and not the class, otherwise this method will raise an ArgumentError exception.
@example
allow(car).to receive(:go).and_raise allow(car).to receive(:go).and_raise(OutOfGas) allow(car).to receive(:go).and_raise(OutOfGas, "At least 2 oz of gas needed to drive") allow(car).to receive(:go).and_raise(OutOfGas.new(2, :oz))
# File lib/rspec/mocks/message_expectation.rb, line 170 def and_raise(exception = RuntimeError, message = nil) if exception.respond_to?(:exception) exception = message ? exception.exception(message) : exception.exception end self.terminal_implementation_action = Proc.new { raise exception } nil end
@overload and_return(value) @overload and_return(first_value, second_value)
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.
@example
allow(counter).to receive(:count).and_return(1) counter.count # => 1 counter.count # => 1 allow(counter).to receive(:count).and_return(1,2,3) counter.count # => 1 counter.count # => 2 counter.count # => 3 counter.count # => 3 counter.count # => 3 # etc
# File lib/rspec/mocks/message_expectation.rb, line 103 def and_return(first_value, *values) if negative? raise "`and_return` is not supported with negative message expectations" end if block_given? raise ArgumentError, "Implementation blocks aren't supported with `and_return`" end values.unshift(first_value) @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args? || (@expected_received_count == 0 and @at_least) self.terminal_implementation_action = AndReturnImplementation.new(values) nil 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
allow(car).to receive(:go).and_throw(:out_of_gas) allow(car).to receive(:go).and_throw(:out_of_gas, :level => 0.1)
# File lib/rspec/mocks/message_expectation.rb, line 189 def and_throw(*args) self.terminal_implementation_action = Proc.new { throw(*args) } nil 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 200 def and_yield(*args, &block) yield @eval_context = Object.new if block @args_to_yield << args self.initial_implementation_action = AndYieldImplementation.new(@args_to_yield, @eval_context, @error_generator) self end
# File lib/rspec/mocks/message_expectation.rb, line 119 def and_yield_receiver_to_implementation @yield_receiver_to_implementation_block = true self end
Constrain a message expectation to be received at least a specific number of times.
@example
expect(dealer).to receive(:deal_card).at_least(9).times
# File lib/rspec/mocks/message_expectation.rb, line 364 def at_least(n, &block) set_expected_received_count :at_least, n if n == 0 raise "at_least(0) has been removed, use allow(...).to receive(:message) instead" end self.inner_implementation_action = block self end
Constrain a message expectation to be received at most a specific number of times.
@example
expect(dealer).to receive(:deal_card).at_most(10).times
# File lib/rspec/mocks/message_expectation.rb, line 382 def at_most(n, &block) self.inner_implementation_action = block set_expected_received_count :at_most, n self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 228 def called_max_times? @expected_received_count != :any && !@at_least && @expected_received_count > 0 && @actual_received_count >= @expected_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 303 def description @error_generator.describe_expectation(@message, @expected_received_count, @actual_received_count, *expected_args) end
# File lib/rspec/mocks/message_expectation.rb, line 252 def ensure_expected_ordering_received! @order_group.verify_invocation_order(self) if @ordered true end
Constrain a message expectation to be received a specific number of times.
@example
expect(dealer).to receive(:deal_card).exactly(10).times
# File lib/rspec/mocks/message_expectation.rb, line 352 def exactly(n, &block) self.inner_implementation_action = block set_expected_received_count :exactly, n self end
# File lib/rspec/mocks/message_expectation.rb, line 296 def expectation_count_type return :at_least if @at_least return :at_most if @at_most return nil end
@private
# File lib/rspec/mocks/message_expectation.rb, line 75 def expected_args @argument_list_matcher.expected_args end
@private
# File lib/rspec/mocks/message_expectation.rb, line 248 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 288 def generate_error if similar_messages.empty? @error_generator.raise_expectation_error(@message, @expected_received_count, @argument_list_matcher, @actual_received_count, expectation_count_type, *expected_args) else @error_generator.raise_similar_message_args_error(self, *@similar_messages) end end
@private
# File lib/rspec/mocks/message_expectation.rb, line 258 def ignoring_args? @expected_received_count == :any end
@private
# File lib/rspec/mocks/message_expectation.rb, line 472 def increase_actual_received_count! @actual_received_count += 1 end
@private
# File lib/rspec/mocks/message_expectation.rb, line 213 def invoke(parent_stub, *args, &block) invoke_incrementing_actual_calls_by(1, parent_stub, *args, &block) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 218 def invoke_without_incrementing_received_count(parent_stub, *args, &block) invoke_incrementing_actual_calls_by(0, parent_stub, *args, &block) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 208 def matches?(message, *args) @message == message && @argument_list_matcher.args_match?(*args) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 263 def matches_at_least_count? @at_least && @actual_received_count >= @expected_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 268 def matches_at_most_count? @at_most && @actual_received_count <= @expected_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 273 def matches_exact_count? @expected_received_count == @actual_received_count end
@private
# File lib/rspec/mocks/message_expectation.rb, line 236 def matches_name_but_not_args(message, *args) @message == message and not @argument_list_matcher.args_match?(*args) end
@private
# File lib/rspec/mocks/message_expectation.rb, line 223 def negative? @expected_received_count == 0 && !@at_least end
@private
# File lib/rspec/mocks/message_expectation.rb, line 462 def negative_expectation_for?(message) @message == message && negative? end
Expect a message not to be received at all.
@example
expect(car).to receive(:stop).never
# File lib/rspec/mocks/message_expectation.rb, line 405 def never ErrorGenerator.raise_double_negation_error("expect(obj)") if negative? @expected_received_count = 0 self end
Expect a message to be received exactly one time.
@example
expect(car).to receive(:go).once
# File lib/rspec/mocks/message_expectation.rb, line 416 def once(&block) self.inner_implementation_action = block set_expected_received_count :exactly, 1 self end
Expect messages to be received in a specific order.
@example
expect(api).to receive(:prepare).ordered expect(api).to receive(:run).ordered expect(api).to receive(:finish).ordered
# File lib/rspec/mocks/message_expectation.rb, line 440 def ordered(&block) self.inner_implementation_action = block additional_expected_calls.times do @order_group.register(self) end @ordered = true self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 457 def ordered? @ordered end
# File lib/rspec/mocks/message_expectation.rb, line 307 def raise_out_of_order_error @error_generator.raise_out_of_order_error @message end
@private
# File lib/rspec/mocks/message_expectation.rb, line 278 def similar_messages @similar_messages ||= [] end
Syntactic sugar for `exactly`, `at_least` and `at_most`
@example
expect(dealer).to receive(:deal_card).exactly(10).times expect(dealer).to receive(:deal_card).at_least(10).times expect(dealer).to receive(:deal_card).at_most(10).times
# File lib/rspec/mocks/message_expectation.rb, line 395 def times(&block) self.inner_implementation_action = block self end
Expect a message to be received exactly two times.
@example
expect(car).to receive(:go).twice
# File lib/rspec/mocks/message_expectation.rb, line 427 def twice(&block) self.inner_implementation_action = block set_expected_received_count :exactly, 2 self end
@private
# File lib/rspec/mocks/message_expectation.rb, line 241 def verify_messages_received InsertOntoBacktrace.line(@expected_from) do generate_error unless expected_messages_received? || failed_fast? end 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
allow(cart).to receive(:add) { :failure } allow(cart).to receive(:add).with(Book.new(:isbn => 1934356379)) { :success } cart.add(Book.new(:isbn => 1234567890)) # => :failure cart.add(Book.new(:isbn => 1934356379)) # => :success expect(cart).to 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 335 def with(*args, &block) if args.empty? raise ArgumentError, "`with` must have at least one argument. Use `no_args` matcher to set the expectation of receiving no arguments." end self.inner_implementation_action = block @argument_list_matcher = ArgumentListMatcher.new(*args) self end
Generated with the Darkfish Rdoc Generator 2.