Parent

Files

Mocha::Expectation

Methods on expectations returned from Mock#expects, Mock#stubs, Object#expects and Object#stubs.

Public Instance Methods

at_least(minimum_number_of_times) → expectation click to toggle source

Modifies expectation so that the expected method must be called at least a minimum_number_of_times.

  object = mock()
  object.expects(:expected_method).at_least(2)
  3.times { object.expected_method }
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).at_least(2)
  object.expected_method
  # => verify fails
     # File lib/mocha/expectation.rb, line 123
123:     def at_least(minimum_number_of_times)
124:       @cardinality = Cardinality.at_least(minimum_number_of_times)
125:       self
126:     end
at_least_once() → expectation click to toggle source

Modifies expectation so that the expected method must be called at least once.

  object = mock()
  object.expects(:expected_method).at_least_once
  object.expected_method
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).at_least_once
  # => verify fails
     # File lib/mocha/expectation.rb, line 139
139:     def at_least_once
140:       at_least(1)
141:       self
142:     end
at_most(maximum_number_of_times) → expectation click to toggle source

Modifies expectation so that the expected method must be called at most a maximum_number_of_times.

  object = mock()
  object.expects(:expected_method).at_most(2)
  2.times { object.expected_method }
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).at_most(2)
  3.times { object.expected_method }
  # => verify fails
     # File lib/mocha/expectation.rb, line 156
156:     def at_most(maximum_number_of_times)
157:       @cardinality = Cardinality.at_most(maximum_number_of_times)
158:       self
159:     end
at_most_once() → expectation click to toggle source

Modifies expectation so that the expected method must be called at most once.

  object = mock()
  object.expects(:expected_method).at_most_once
  object.expected_method
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).at_most_once
  2.times { object.expected_method }
  # => verify fails
     # File lib/mocha/expectation.rb, line 173
173:     def at_most_once()
174:       at_most(1)
175:       self
176:     end
in_sequence(*sequences) → expectation click to toggle source

Constrains this expectation so that it must be invoked at the current point in the sequence.

To expect a sequence of invocations, write the expectations in order and add the in_sequence(sequence) clause to each one.

Expectations in a sequence can have any invocation count.

If an expectation in a sequence is stubbed, rather than expected, it can be skipped in the sequence.

See also API#sequence.

  breakfast = sequence('breakfast')

  egg = mock('egg')
  egg.expects(:crack).in_sequence(breakfast)
  egg.expects(:fry).in_sequence(breakfast)
  egg.expects(:eat).in_sequence(breakfast)
     # File lib/mocha/expectation.rb, line 377
377:     def in_sequence(*sequences)
378:       sequences.each { |sequence| add_in_sequence_ordering_constraint(sequence) }
379:       self
380:     end
multiple_yields(*parameter_groups) → expectation click to toggle source

Modifies expectation so that when the expected method is called, it yields multiple times per invocation with the specified parameter_groups.

  object = mock()
  object.expects(:expected_method).multiple_yields(['result_1', 'result_2'], ['result_3'])
  yielded_values = []
  object.expected_method { |*values| yielded_values << values }
  yielded_values # => [['result_1', 'result_2'], ['result_3]]

May be called multiple times on the same expectation for consecutive invocations. Also see Expectation#then.

  object = mock()
  object.stubs(:expected_method).multiple_yields([1, 2], [3]).then.multiple_yields([4], [5, 6])
  yielded_values_from_first_invocation = []
  yielded_values_from_second_invocation = []
  object.expected_method { |*values| yielded_values_from_first_invocation << values } # first invocation
  object.expected_method { |*values| yielded_values_from_second_invocation << values } # second invocation
  yielded_values_from_first_invocation # => [[1, 2], [3]]
  yielded_values_from_second_invocation # => [[4], [5, 6]]
     # File lib/mocha/expectation.rb, line 247
247:     def multiple_yields(*parameter_groups)
248:       @yield_parameters.multiple_add(*parameter_groups)
249:       self
250:     end
never() → expectation click to toggle source

Modifies expectation so that the expected method must never be called.

  object = mock()
  object.expects(:expected_method).never
  object.expected_method
  # => verify fails

  object = mock()
  object.expects(:expected_method).never
  object.expected_method
  # => verify succeeds
     # File lib/mocha/expectation.rb, line 106
106:     def never
107:       @cardinality = Cardinality.exactly(0)
108:       self
109:     end
once() → expectation click to toggle source

Modifies expectation so that the expected method must be called exactly once. Note that this is the default behaviour for an expectation, but you may wish to use it for clarity/emphasis.

  object = mock()
  object.expects(:expected_method).once
  object.expected_method
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).once
  object.expected_method
  object.expected_method
  # => verify fails

  object = mock()
  object.expects(:expected_method).once
  # => verify fails
    # File lib/mocha/expectation.rb, line 89
89:     def once
90:       @cardinality = Cardinality.exactly(1)
91:       self
92:     end
raises(exception = RuntimeError, message = nil) → expectation click to toggle source

Modifies expectation so that when the expected method is called, it raises the specified exception with the specified message.

  object = mock()
  object.expects(:expected_method).raises(Exception, 'message')
  object.expected_method # => raises exception of class Exception and with message 'message'

May be called multiple times on the same expectation. Also see Expectation#then.

  object = mock()
  object.stubs(:expected_method).raises(Exception1).then.raises(Exception2)
  object.expected_method # => raises exception of class Exception1
  object.expected_method # => raises exception of class Exception2

May be called in conjunction with Expectation#returns on the same expectation.

  object = mock()
  object.stubs(:expected_method).raises(Exception).then.returns(2, 3)
  object.expected_method # => raises exception of class Exception1
  object.expected_method # => 2
  object.expected_method # => 3
     # File lib/mocha/expectation.rb, line 305
305:     def raises(exception = RuntimeError, message = nil)
306:       @return_values += ReturnValues.new(ExceptionRaiser.new(exception, message))
307:       self
308:     end
returns(value) → expectation returns(*values) → expectation click to toggle source

Modifies expectation so that when the expected method is called, it returns the specified value.

  object = mock()
  object.stubs(:stubbed_method).returns('result')
  object.stubbed_method # => 'result'
  object.stubbed_method # => 'result'

If multiple values are given, these are returned in turn on consecutive calls to the method.

  object = mock()
  object.stubs(:stubbed_method).returns(1, 2)
  object.stubbed_method # => 1
  object.stubbed_method # => 2

May be called multiple times on the same expectation. Also see Expectation#then.

  object = mock()
  object.stubs(:expected_method).returns(1, 2).then.returns(3)
  object.expected_method # => 1
  object.expected_method # => 2
  object.expected_method # => 3

May be called in conjunction with Expectation#raises on the same expectation.

  object = mock()
  object.stubs(:expected_method).returns(1, 2).then.raises(Exception)
  object.expected_method # => 1
  object.expected_method # => 2
  object.expected_method # => raises exception of class Exception1

Note that in Ruby a method returning multiple values is exactly equivalent to a method returning an Array of those values.

  object = mock()
  object.stubs(:expected_method).returns([1, 2])
  x, y = object.expected_method
  x # => 1
  y # => 2
     # File lib/mocha/expectation.rb, line 283
283:     def returns(*values)
284:       @return_values += ReturnValues.build(*values)
285:       self
286:     end
is(state)) → expectation click to toggle source

then() is used as syntactic sugar to improve readability. It has no effect on state of the expectation.

  object = mock()
  object.stubs(:expected_method).returns(1, 2).then.raises(Exception).then.returns(4)
  object.expected_method # => 1
  object.expected_method # => 2
  object.expected_method # => raises exception of class Exception
  object.expected_method # => 4

then(state_machine.is(state)) is used to change the state_machine to the specified state when the invocation occurs.

See also API#states, StateMachine and Expectation#when.

  power = states('power').starts_as('off')

  radio = mock('radio')
  radio.expects(:switch_on).then(power.is('on'))
  radio.expects(:select_channel).with('BBC Radio 4').when(power.is('on'))
  radio.expects(:adjust_volume).with(+5).when(power.is('on'))
  radio.expects(:select_channel).with('BBC World Service').when(power.is('on'))
  radio.expects(:adjust_volume).with(-5).when(power.is('on'))
  radio.expects(:switch_off).then(power.is('off'))
     # File lib/mocha/expectation.rb, line 333
333:     def then(*parameters)
334:       if parameters.length == 1
335:         state = parameters.first
336:         add_side_effect(ChangeStateSideEffect.new(state))
337:       end
338:       self
339:     end
times(range) → expectation click to toggle source

Modifies expectation so that the number of calls to the expected method must be within a specific range.

range can be specified as an exact integer or as a range of integers

  object = mock()
  object.expects(:expected_method).times(3)
  3.times { object.expected_method }
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).times(3)
  2.times { object.expected_method }
  # => verify fails

  object = mock()
  object.expects(:expected_method).times(2..4)
  3.times { object.expected_method }
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).times(2..4)
  object.expected_method
  # => verify fails
    # File lib/mocha/expectation.rb, line 41
41:     def times(range)
42:       @cardinality = Cardinality.times(range)
43:       self
44:     end
twice() → expectation click to toggle source

Modifies expectation so that the expected method must be called exactly twice.

  object = mock()
  object.expects(:expected_method).twice
  object.expected_method
  object.expected_method
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).twice
  object.expected_method
  object.expected_method
  object.expected_method
  # => verify fails

  object = mock()
  object.expects(:expected_method).twice
  object.expected_method
  # => verify fails
    # File lib/mocha/expectation.rb, line 66
66:     def twice
67:       @cardinality = Cardinality.exactly(2)
68:       self
69:     end
is(state)) → exception click to toggle source

Constrains the expectation to occur only when the state_machine is in the named state.

See also API#states, StateMachine#starts_as and Expectation#then.

  power = states('power').starts_as('off')

  radio = mock('radio')
  radio.expects(:switch_on).then(power.is('on'))
  radio.expects(:select_channel).with('BBC Radio 4').when(power.is('on'))
  radio.expects(:adjust_volume).with(+5).when(power.is('on'))
  radio.expects(:select_channel).with('BBC World Service').when(power.is('on'))
  radio.expects(:adjust_volume).with(-5).when(power.is('on'))
  radio.expects(:switch_off).then(power.is('off'))
     # File lib/mocha/expectation.rb, line 355
355:     def when(state_predicate)
356:       add_ordering_constraint(InStateOrderingConstraint.new(state_predicate))
357:       self
358:     end
with(*expected_parameters, &matching_block) → expectation click to toggle source

Modifies expectation so that the expected method must be called with expected_parameters.

  object = mock()
  object.expects(:expected_method).with(:param1, :param2)
  object.expected_method(:param1, :param2)
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).with(:param1, :param2)
  object.expected_method(:param3)
  # => verify fails

May be used with parameter matchers in Mocha::ParameterMatchers.

If a matching_block is given, the block is called with the parameters passed to the expected method. The expectation is matched if the block evaluates to true.

  object = mock()
  object.expects(:expected_method).with() { |value| value % 4 == 0 }
  object.expected_method(16)
  # => verify succeeds

  object = mock()
  object.expects(:expected_method).with() { |value| value % 4 == 0 }
  object.expected_method(17)
  # => verify fails
     # File lib/mocha/expectation.rb, line 203
203:     def with(*expected_parameters, &matching_block)
204:       @parameters_matcher = ParametersMatcher.new(expected_parameters, &matching_block)
205:       self
206:     end
yields(*parameters) → expectation click to toggle source

Modifies expectation so that when the expected method is called, it yields with the specified parameters.

  object = mock()
  object.expects(:expected_method).yields('result')
  yielded_value = nil
  object.expected_method { |value| yielded_value = value }
  yielded_value # => 'result'

May be called multiple times on the same expectation for consecutive invocations. Also see Expectation#then.

  object = mock()
  object.stubs(:expected_method).yields(1).then.yields(2)
  yielded_values_from_first_invocation = []
  yielded_values_from_second_invocation = []
  object.expected_method { |value| yielded_values_from_first_invocation << value } # first invocation
  object.expected_method { |value| yielded_values_from_second_invocation << value } # second invocation
  yielded_values_from_first_invocation # => [1]
  yielded_values_from_second_invocation # => [2]
     # File lib/mocha/expectation.rb, line 225
225:     def yields(*parameters)
226:       @yield_parameters.add(*parameters)
227:       self
228:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.