Class: Mocha::Expectation
- Inherits:
-
Object
- Object
- Mocha::Expectation
- Defined in:
- lib/mocha/expectation.rb
Overview
Methods on expectations returned from Mock#expects, Mock#stubs, ObjectMethods#expects and ObjectMethods#stubs.
Instance Method Summary collapse
-
#at_least(minimum_number_of_times) ⇒ Expectation
Modifies expectation so that the expected method must be called at least a
minimum_number_of_times
. -
#at_least_once ⇒ Expectation
Modifies expectation so that the expected method must be called at least once.
-
#at_most(maximum_number_of_times) ⇒ Expectation
Modifies expectation so that the expected method must be called at most a
maximum_number_of_times
. -
#at_most_once ⇒ Expectation
Modifies expectation so that the expected method must be called at most once.
-
#in_sequence(sequence, *sequences) ⇒ Expectation
Constrains the expectation so that it must be invoked at the current point in the
sequence
. -
#multiple_yields(*parameter_groups) ⇒ Expectation
Modifies expectation so that when the expected method is called, it yields multiple times per invocation with the specified
parameter_groups
. -
#never ⇒ Expectation
Modifies expectation so that the expected method must never be called.
-
#once ⇒ Expectation
Modifies expectation so that the expected method must be called exactly once.
-
#raises(exception = RuntimeError, message = nil) ⇒ Expectation
Modifies expectation so that when the expected method is called, it raises the specified
exception
with the specifiedmessage
i.e. -
#returns(*values) ⇒ Expectation
Modifies expectation so that when the expected method is called, it returns the specified
value
. -
#then(state = nil) ⇒ Expectation
The same expectation, thereby allowing invocations of other Expectation methods to be chained.
-
#throws(tag, object = nil) ⇒ Expectation
Modifies expectation so that when the expected method is called, it throws the specified
tag
with the specific return valueobject
i.e. -
#times(range) ⇒ Expectation
Modifies expectation so that the number of calls to the expected method must be within a specific
range
. -
#twice ⇒ Expectation
Modifies expectation so that the expected method must be called exactly twice.
-
#when(state_predicate) ⇒ Expectation
Constrains the expectation to occur only when the
state_machine
is in the state specified bystate_predicate
. -
#with(*expected_parameters) {|actual_parameters| ... } ⇒ Expectation
Modifies expectation so that the expected method must be called with
expected_parameters
. -
#with_block_given ⇒ Expectation
Modifies expectation so that the expected method must be called with a block.
-
#with_no_block_given ⇒ Expectation
Modifies expectation so that the expected method must be called without a block.
-
#yields(*parameters) ⇒ Expectation
Modifies expectation so that when the expected method is called, it yields to the block with the specified
parameters
.
Instance Method Details
#at_least(minimum_number_of_times) ⇒ Expectation
Modifies expectation so that the expected method must be called at least a minimum_number_of_times
.
132 133 134 135 |
# File 'lib/mocha/expectation.rb', line 132 def at_least(minimum_number_of_times) @cardinality.at_least(minimum_number_of_times) self end |
#at_least_once ⇒ Expectation
Modifies expectation so that the expected method must be called at least once.
150 151 152 |
# File 'lib/mocha/expectation.rb', line 150 def at_least_once at_least(1) end |
#at_most(maximum_number_of_times) ⇒ Expectation
Modifies expectation so that the expected method must be called at most a maximum_number_of_times
.
168 169 170 171 |
# File 'lib/mocha/expectation.rb', line 168 def at_most(maximum_number_of_times) @cardinality.at_most(maximum_number_of_times) self end |
#at_most_once ⇒ Expectation
Modifies expectation so that the expected method must be called at most once.
186 187 188 |
# File 'lib/mocha/expectation.rb', line 186 def at_most_once at_most(1) end |
#in_sequence(sequence, *sequences) ⇒ Expectation
Constrains the 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
.
An expected method can appear in multiple sequences.
539 540 541 542 |
# File 'lib/mocha/expectation.rb', line 539 def in_sequence(sequence, *sequences) sequences.unshift(sequence).each { |seq| add_in_sequence_ordering_constraint(seq) } self end |
#multiple_yields(*parameter_groups) ⇒ Expectation
Modifies expectation so that when the expected method is called, it yields multiple times per invocation with the specified parameter_groups
.
If no block is provided, the method will still attempt to yield resulting in a LocalJumpError
. Note that this is what would happen if a “real” (non-mock) method implementation tried to yield to a non-existent block.
326 327 328 329 |
# File 'lib/mocha/expectation.rb', line 326 def multiple_yields(*parameter_groups) @yield_parameters.add(*parameter_groups) self end |
#never ⇒ Expectation
Modifies expectation so that the expected method must never be called.
112 113 114 115 |
# File 'lib/mocha/expectation.rb', line 112 def never @cardinality.exactly(0) self end |
#once ⇒ Expectation
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.
95 96 97 98 |
# File 'lib/mocha/expectation.rb', line 95 def once @cardinality.exactly(1) self end |
#raises ⇒ Expectation #raises(exception) ⇒ Expectation #raises(exception, message) ⇒ Expectation
Modifies expectation so that when the expected method is called, it raises the specified exception
with the specified message
i.e. calls Kernel#raise(exception, message).
413 414 415 416 |
# File 'lib/mocha/expectation.rb', line 413 def raises(exception = RuntimeError, = nil) @return_values += ReturnValues.new(ExceptionRaiser.new(exception, )) self end |
#returns(value) ⇒ Expectation #returns(*values) ⇒ Expectation
Modifies expectation so that when the expected method is called, it returns the specified value
.
373 374 375 376 |
# File 'lib/mocha/expectation.rb', line 373 def returns(*values) @return_values += ReturnValues.build(*values) self end |
#then ⇒ Expectation #then(state) ⇒ Expectation
Returns the same expectation, thereby allowing invocations of other Mocha::Expectation methods to be chained.
487 488 489 490 |
# File 'lib/mocha/expectation.rb', line 487 def then(state = nil) add_side_effect(ChangeStateSideEffect.new(state)) if state self end |
#throw(tag) ⇒ Expectation #throw(tag, object) ⇒ Expectation
Modifies expectation so that when the expected method is called, it throws the specified tag
with the specific return value object
i.e. calls Kernel#throw(tag, object).
452 453 454 455 |
# File 'lib/mocha/expectation.rb', line 452 def throws(tag, object = nil) @return_values += ReturnValues.new(Thrower.new(tag, object)) self end |
#times(range) ⇒ Expectation
Modifies expectation so that the number of calls to the expected method must be within a specific range
.
44 45 46 47 |
# File 'lib/mocha/expectation.rb', line 44 def times(range) @cardinality.times(range) self end |
#twice ⇒ Expectation
Modifies expectation so that the expected method must be called exactly twice.
70 71 72 73 |
# File 'lib/mocha/expectation.rb', line 70 def twice @cardinality.exactly(2) self end |
#when(state_predicate) ⇒ Expectation
Constrains the expectation to occur only when the state_machine
is in the state specified by state_predicate
.
511 512 513 514 |
# File 'lib/mocha/expectation.rb', line 511 def when(state_predicate) add_ordering_constraint(InStateOrderingConstraint.new(state_predicate)) self end |
#with(*expected_parameters) {|actual_parameters| ... } ⇒ Expectation
Modifies expectation so that the expected method must be called with expected_parameters
.
May be used with parameter matchers in ParameterMatchers.
221 222 223 224 |
# File 'lib/mocha/expectation.rb', line 221 def with(*expected_parameters, &matching_block) @parameters_matcher = ParametersMatcher.new(expected_parameters, &matching_block) self end |
#with_block_given ⇒ Expectation
Modifies expectation so that the expected method must be called with a block.
240 241 242 243 |
# File 'lib/mocha/expectation.rb', line 240 def with_block_given @block_matcher = BlockMatchers::BlockGiven.new self end |
#with_no_block_given ⇒ Expectation
Modifies expectation so that the expected method must be called without a block.
259 260 261 262 |
# File 'lib/mocha/expectation.rb', line 259 def with_no_block_given @block_matcher = BlockMatchers::NoBlockGiven.new self end |
#yields(*parameters) ⇒ Expectation
Modifies expectation so that when the expected method is called, it yields to the block with the specified parameters
.
If no parameters
are specified, it yields to the block without any parameters.
If no block is provided, the method will still attempt to yield resulting in a LocalJumpError
. Note that this is what would happen if a “real” (non-mock) method implementation tried to yield to a non-existent block.
May be called multiple times on the same expectation for consecutive invocations.
298 299 300 |
# File 'lib/mocha/expectation.rb', line 298 def yields(*parameters) multiple_yields(parameters) end |