Class: RSpec::Mocks::NamedObjectReference

Inherits:

Object

show all

Defined in:

lib/rspec/mocks/object_reference.rb

Overview

An implementation of rspec-mocks' reference interface. Used when a string is passed to ExampleMethods#object_double, and when a string, named class or named module is passed to ExampleMethods#instance_double, or ExampleMethods#class_double. Represents a reference to the object named (via a constant lookup) by the string.

- (String) const_to_replace (also: #description)
The constant name to replace with a double.
- (Boolean) defined?
True if the named constant is defined, false otherwise.
- (NamedObjectReference) initialize(const_name) constructor
A new instance of NamedObjectReference.
- (Object^?) target
The target of the verifying double (the named object), or nil if it is not defined.
- (Object) when_loaded {|Object| ... }
Yields if the reference target is loaded, providing a generic mechanism to optionally run a bit of code only when a reference's target is loaded.

Returns a new instance of NamedObjectReference

Parameters:

111
112
113

# File 'lib/rspec/mocks/object_reference.rb', line 111
def initialize(const_name)
  @const_name = const_name
end

Returns the constant name to replace with a double.

Returns:

121
122
123

# File 'lib/rspec/mocks/object_reference.rb', line 121
def const_to_replace
  @const_name
end

Returns true if the named constant is defined, false otherwise.

Returns:

116
117
118

# File 'lib/rspec/mocks/object_reference.rb', line 116
def defined?
  !!object
end

Returns the target of the verifying double (the named object), or nil if it is not defined.

Returns:

(Object, nil) —
the target of the verifying double (the named object), or nil if it is not defined.

128
129
130

# File 'lib/rspec/mocks/object_reference.rb', line 128
def target
  object
end

Yields if the reference target is loaded, providing a generic mechanism to optionally run a bit of code only when a reference's target is loaded.

Yields:

137
138
139

# File 'lib/rspec/mocks/object_reference.rb', line 137
def when_loaded
  yield object if object
end