Module: RSpec::Mocks::ExampleMethods
- Includes:
- ArgumentMatchers
- Defined in:
- lib/rspec/mocks/example_methods.rb
Overview
Contains methods intended to be used from within code examples. Mix this in to your test context (such as a test framework base class) to use rspec-mocks with your test framework. If you're using rspec-core, it'll take care of doing this for you.
Defined Under Namespace
Modules: ExpectHost
Instance Method Summary collapse
-
#allow ⇒ Object
Used to wrap an object in preparation for stubbing a method on it.
-
#allow_any_instance_of ⇒ Object
Used to wrap a class in preparation for stubbing a method on instances of it.
-
#allow_message_expectations_on_nil ⇒ Object
deprecated
Deprecated.
Use Configuration#allow_message_expectations_on_nil instead.
-
#class_double(doubled_class, *args) ⇒ Object
Constructs a test double against a specific class.
-
#class_spy(*args) ⇒ Object
Constructs a test double that is optimized for use with
have_received
against a specific class. -
#double(*args) ⇒ Double
Constructs an instance of :Mocks::Double configured with an optional name, used for reporting in failure messages, and an optional hash of message/return-value pairs.
-
#expect ⇒ Object
Used to wrap an object in preparation for setting a mock expectation on it.
-
#expect_any_instance_of ⇒ Object
Used to wrap a class in preparation for setting a mock expectation on instances of it.
-
#have_received(method_name, &block) ⇒ Object
Verifies that the given object received the expected message during the course of the test.
-
#hide_const(constant_name) ⇒ Object
Hides the named constant with the given value.
-
#instance_double(doubled_class, *args) ⇒ Object
Constructs a test double against a specific class.
-
#instance_spy(*args) ⇒ Object
Constructs a test double that is optimized for use with
have_received
against a specific class. -
#object_double(object_or_name, *args) ⇒ Object
Constructs a test double against a specific object.
-
#object_spy(*args) ⇒ Object
Constructs a test double that is optimized for use with
have_received
against a specific object. -
#receive ⇒ Object
Used to specify a message that you expect or allow an object to receive.
-
#receive_message_chain ⇒ Object
stubs/mocks a chain of messages on an object or test double.
-
#receive_messages ⇒ Object
Shorthand syntax used to setup message(s), and their return value(s), that you expect or allow an object to receive.
-
#spy(*args) ⇒ Double
Constructs a test double that is optimized for use with
have_received
. -
#stub_const(constant_name, value, options = {}) ⇒ Object
Stubs the named constant with the given value.
-
#without_partial_double_verification ⇒ Object
Turns off the verifying of partial doubles for the duration of the block, this is useful in situations where methods are defined at run time and you wish to define stubs for them but not turn off partial doubles for the entire run suite.
Methods included from ArgumentMatchers
#any_args, #anything, #array_including, #boolean, #duck_type, #hash_excluding, #hash_including, #instance_of, #kind_of, #no_args
Instance Method Details
#allow ⇒ Object
If you disable the :expect
syntax this method will be undefined.
Used to wrap an object in preparation for stubbing a method on it.
|
# File 'lib/rspec/mocks/example_methods.rb', line 309
|
#allow_any_instance_of ⇒ Object
This is only available when you have enabled the expect
syntax.
Used to wrap a class in preparation for stubbing a method on instances of it.
|
# File 'lib/rspec/mocks/example_methods.rb', line 327
|
#allow_message_expectations_on_nil ⇒ Object
Use Configuration#allow_message_expectations_on_nil instead.
Disables warning messages about expectations being set on nil.
By default warning messages are issued when expectations are set on nil. This is to prevent false-positives and to catch potential bugs early on.
201 202 203 |
# File 'lib/rspec/mocks/example_methods.rb', line 201 def RSpec::Mocks.space.proxy_for(nil).warn_about_expectations = false end |
#class_double(doubled_class) ⇒ Object #class_double(doubled_class, name) ⇒ Object #class_double(doubled_class, stubs) ⇒ Object #class_double(doubled_class, name, stubs) ⇒ Object
Constructs a test double against a specific class. If the given class name has been loaded, only class methods defined on the class are allowed to be stubbed. In all other ways it behaves like a double.
79 80 81 82 |
# File 'lib/rspec/mocks/example_methods.rb', line 79 def class_double(doubled_class, *args) ref = ObjectReference.for(doubled_class) ExampleMethods.(ClassVerifyingDouble, ref, *args) end |
#class_spy(doubled_class) ⇒ Object #class_spy(doubled_class, name) ⇒ Object #class_spy(doubled_class, stubs) ⇒ Object #class_spy(doubled_class, name, stubs) ⇒ Object
Constructs a test double that is optimized for use with have_received
against a specific class. If the given class name has been loaded, only class methods defined on the class are allowed to be stubbed. With a normal double one has to stub methods in order to be able to spy them. An class_spy automatically spies on all class methods to which the class responds.
191 192 193 |
# File 'lib/rspec/mocks/example_methods.rb', line 191 def class_spy(*args) class_double(*args).as_null_object end |
#double ⇒ Double #double(name) ⇒ Double #double(stubs) ⇒ Double #double(name, stubs) ⇒ Double
Constructs an instance of :Mocks::Double configured with an optional name, used for reporting in failure messages, and an optional hash of message/return-value pairs.
34 35 36 |
# File 'lib/rspec/mocks/example_methods.rb', line 34 def double(*args) ExampleMethods.declare_double(Double, *args) end |
#expect ⇒ Object
This method is usually provided by rspec-expectations. However, if you use rspec-mocks without rspec-expectations, there's a definition of it that is made available here. If you disable the :expect
syntax this method will be undefined.
Used to wrap an object in preparation for setting a mock expectation on it.
|
# File 'lib/rspec/mocks/example_methods.rb', line 297
|
#expect_any_instance_of ⇒ Object
If you disable the :expect
syntax this method will be undefined.
Used to wrap a class in preparation for setting a mock expectation on instances of it.
|
# File 'lib/rspec/mocks/example_methods.rb', line 318
|
#have_received(method_name, &block) ⇒ Object
have_received(...).with(...)
is unable to work properly when passed arguments are mutated after the spy records the received message.
Verifies that the given object received the expected message during the course of the test. On a spy objects or as null object doubles this works for any method, on other objects the method must have been stubbed beforehand in order for messages to be verified.
Stubbing and verifying messages received in this way implements the Test Spy pattern.
281 282 283 |
# File 'lib/rspec/mocks/example_methods.rb', line 281 def have_received(method_name, &block) Matchers::HaveReceived.new(method_name, &block) end |
#hide_const(constant_name) ⇒ Object
Hides the named constant with the given value. The constant will be undefined for the duration of the test.
Like method stubs, the constant will be restored to its original value when the example completes.
256 257 258 |
# File 'lib/rspec/mocks/example_methods.rb', line 256 def hide_const(constant_name) ConstantMutator.hide(constant_name) end |
#instance_double(doubled_class) ⇒ Object #instance_double(doubled_class, name) ⇒ Object #instance_double(doubled_class, stubs) ⇒ Object #instance_double(doubled_class, name, stubs) ⇒ Object
Constructs a test double against a specific class. If the given class name has been loaded, only instance methods defined on the class are allowed to be stubbed. In all other ways it behaves like a double.
56 57 58 59 |
# File 'lib/rspec/mocks/example_methods.rb', line 56 def instance_double(doubled_class, *args) ref = ObjectReference.for(doubled_class) ExampleMethods.(InstanceVerifyingDouble, ref, *args) end |
#instance_spy(doubled_class) ⇒ Object #instance_spy(doubled_class, name) ⇒ Object #instance_spy(doubled_class, stubs) ⇒ Object #instance_spy(doubled_class, name, stubs) ⇒ Object
Constructs a test double that is optimized for use with have_received
against a specific class. If the given class name has been loaded, only instance methods defined on the class are allowed to be stubbed. With a normal double one has to stub methods in order to be able to spy them. An instance_spy automatically spies on all instance methods to which the class responds.
144 145 146 |
# File 'lib/rspec/mocks/example_methods.rb', line 144 def instance_spy(*args) instance_double(*args).as_null_object end |
#object_double(object_or_name) ⇒ Object #object_double(object_or_name, name) ⇒ Object #object_double(object_or_name, stubs) ⇒ Object #object_double(object_or_name, name, stubs) ⇒ Object
Constructs a test double against a specific object. Only the methods the object responds to are allowed to be stubbed. If a String argument is provided, it is assumed to reference a constant object which is used for verification. In all other ways it behaves like a double.
102 103 104 105 |
# File 'lib/rspec/mocks/example_methods.rb', line 102 def object_double(object_or_name, *args) ref = ObjectReference.for(object_or_name, :allow_direct_object_refs) ExampleMethods.(ObjectVerifyingDouble, ref, *args) end |
#object_spy(object_or_name) ⇒ Object #object_spy(object_or_name, name) ⇒ Object #object_spy(object_or_name, stubs) ⇒ Object #object_spy(object_or_name, name, stubs) ⇒ Object
Constructs a test double that is optimized for use with have_received
against a specific object. Only instance methods defined on the object are allowed to be stubbed. With a normal double one has to stub methods in order to be able to spy them. An object_spy automatically spies on all methods to which the object responds.
167 168 169 |
# File 'lib/rspec/mocks/example_methods.rb', line 167 def object_spy(*args) object_double(*args).as_null_object end |
#receive ⇒ Object
If you disable the :expect
syntax this method will be undefined.
Used to specify a message that you expect or allow an object to receive. The object returned by receive
supports the same fluent interface that should_receive
and stub
have always supported, allowing you to constrain the arguments or number of times, and configure how the object should respond to the message.
|
# File 'lib/rspec/mocks/example_methods.rb', line 336
|
#receive_message_chain(method1, method2) ⇒ Object #receive_message_chain("method1.method2") ⇒ Object #receive_message_chain(method1, method_to_value_hash) ⇒ Object
If you disable the :expect
syntax this method will be undefined.
stubs/mocks a chain of messages on an object or test double.
Warning:
Chains can be arbitrarily long, which makes it quite painless to violate the Law of Demeter in violent ways, so you should consider any use of receive_message_chain
a code smell. Even though not all code smells indicate real problems (think fluent interfaces), receive_message_chain
still results in brittle examples. For example, if you write allow(foo).to receive_message_chain(:bar, :baz => 37)
in a spec and then the implementation calls foo.baz.bar
, the stub will not work.
|
# File 'lib/rspec/mocks/example_methods.rb', line 361
|
#receive_messages ⇒ Object
If you disable the :expect
syntax this method will be undefined.
Shorthand syntax used to setup message(s), and their return value(s), that you expect or allow an object to receive. The method takes a hash of messages and their respective return values. Unlike with receive
, you cannot apply further customizations using a block or the fluent interface.
|
# File 'lib/rspec/mocks/example_methods.rb', line 348
|
#spy ⇒ Double #spy(name) ⇒ Double #spy(stubs) ⇒ Double #spy(name, stubs) ⇒ Double
Constructs a test double that is optimized for use with have_received
. With a normal double one has to stub methods in order to be able to spy them. A spy automatically spies on all methods.
120 121 122 |
# File 'lib/rspec/mocks/example_methods.rb', line 120 def spy(*args) double(*args).as_null_object end |
#stub_const(constant_name, value, options = {}) ⇒ Object
Stubs the named constant with the given value. Like method stubs, the constant will be restored to its original value (or lack of one, if it was undefined) when the example completes.
241 242 243 |
# File 'lib/rspec/mocks/example_methods.rb', line 241 def stub_const(constant_name, value, ={}) ConstantMutator.stub(constant_name, value, ) end |
#without_partial_double_verification ⇒ Object
Turns off the verifying of partial doubles for the duration of the block, this is useful in situations where methods are defined at run time and you wish to define stubs for them but not turn off partial doubles for the entire run suite. (e.g. view specs in rspec-rails).
289 290 291 292 293 294 295 |
# File 'lib/rspec/mocks/example_methods.rb', line 289 def without_partial_double_verification original_state = Mocks.configuration.temporarily_suppress_partial_double_verification Mocks.configuration.temporarily_suppress_partial_double_verification = true yield ensure Mocks.configuration.temporarily_suppress_partial_double_verification = original_state end |