Class: RSpec::Mocks::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/mocks/configuration.rb

Overview

Provides configuration options for rspec-mocks.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Configuration) initialize

Returns a new instance of Configuration

5
6
7
8
9
10
 
# File 'lib/rspec/mocks/configuration.rb', line 5
def initialize
  @yield_receiver_to_any_instance_implementation_blocks = true
  @verify_doubled_constant_names = false
  @transfer_nested_constants = false
  @verify_partial_doubles = false
end

Instance Attribute Details

- (Object) color=(value) (writeonly)

Indicates whether or not diffs should be colored. Delegates to rspec-core's color option if rspec-core is loaded; otherwise you can set it here.

151
152
153
 
# File 'lib/rspec/mocks/configuration.rb', line 151
def color=(value)
  @color = value
end

- (Object) transfer_nested_constants=(value) (writeonly)

Sets the default for the transfer_nested_constants option when stubbing constants.

130
131
132
 
# File 'lib/rspec/mocks/configuration.rb', line 130
def transfer_nested_constants=(value)
  @transfer_nested_constants = value
end

- (Object) verify_doubled_constant_names=(value) (writeonly)

When this is set to true, an error will be raised when instance_double or class_double is given the name of an undefined constant. You probably only want to set this when running your entire test suite, with all production code loaded. Setting this for an isolated unit test will prevent you from being able to isolate it!

105
106
107
 
# File 'lib/rspec/mocks/configuration.rb', line 105
def verify_doubled_constant_names=(value)
  @verify_doubled_constant_names = value
end

- (Object) yield_receiver_to_any_instance_implementation_blocks=(value) (writeonly)

Sets whether or not RSpec will yield the receiving instance of a message to blocks that are used for any_instance stub implementations. When set, the first yielded argument will be the receiving instance. Defaults to true.

Examples:


RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.yield_receiver_to_any_instance_implementation_blocks = false
  end
end
28
29
30
 
# File 'lib/rspec/mocks/configuration.rb', line 28
def yield_receiver_to_any_instance_implementation_blocks=(value)
  @yield_receiver_to_any_instance_implementation_blocks = value
end

Instance Method Details

- (Object) add_stub_and_should_receive_to(*modules)

Adds stub and should_receive to the given modules or classes. This is usually only necessary if you application uses some proxy classes that "strip themselves down" to a bare minimum set of methods and remove stub and should_receive in the process.

Examples:


RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.add_stub_and_should_receive_to Delegator
  end
end
45
46
47
48
49
 
# File 'lib/rspec/mocks/configuration.rb', line 45
def add_stub_and_should_receive_to(*modules)
  modules.each do |mod|
    Syntax.enable_should(mod)
  end
end

- (Boolean) color?

Indicates whether or not diffs should be colored. Delegates to rspec-core's color option if rspec-core is loaded; otherwise you can set it here.

Returns:

  • (Boolean) 
156
157
158
 
# File 'lib/rspec/mocks/configuration.rb', line 156
def color?
  ::RSpec.configuration.color_enabled?
end

- (Object) patch_marshal_to_support_partial_doubles=(val)

Monkey-patch Marshal.dump to enable dumping of mocked or stubbed objects. By default this will not work since RSpec mocks works by adding singleton methods that cannot be serialized. This patch removes these singleton methods before serialization. Setting to falsey removes the patch.

This method is idempotent.

168
169
170
171
172
173
174
 
# File 'lib/rspec/mocks/configuration.rb', line 168
def patch_marshal_to_support_partial_doubles=(val)
  if val
    RSpec::Mocks::MarshalExtension.patch!
  else
    RSpec::Mocks::MarshalExtension.unpatch!
  end
end

- (Object) reset_syntaxes_to_default

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Resets the configured syntax to the default.

178
179
180
181
 
# File 'lib/rspec/mocks/configuration.rb', line 178
def reset_syntaxes_to_default
  self.syntax = [:should, :expect]
  RSpec::Mocks::Syntax.warn_about_should!
end

- (Object) syntax

Returns an array with a list of syntaxes that are enabled.

Examples:


unless RSpec::Mocks.configuration.syntax.include?(:expect)
  raise "this RSpec extension gem requires the rspec-mocks `:expect` syntax"
end
89
90
91
92
93
94
 
# File 'lib/rspec/mocks/configuration.rb', line 89
def syntax
  syntaxes = []
  syntaxes << :should  if Syntax.should_enabled?
  syntaxes << :expect if Syntax.expect_enabled?
  syntaxes
end

- (Object) syntax=(*values)

Provides the ability to set either expect, should or both syntaxes. RSpec uses expect syntax by default. This is needed if you want to explicitly enable should syntax and/or explicitly disable expect syntax.

end

Examples:


RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.syntax = [:expect, :should]
  end
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rspec/mocks/configuration.rb', line 65
def syntax=(*values)
  syntaxes = values.flatten
  if syntaxes.include?(:expect)
    Syntax.enable_expect
  else
    Syntax.disable_expect
  end
  if syntaxes.include?(:should)
    Syntax.enable_should
  else
    Syntax.disable_should
  end
end

- (Boolean) transfer_nested_constants?

Returns:

  • (Boolean) 
124
125
126
 
# File 'lib/rspec/mocks/configuration.rb', line 124
def transfer_nested_constants?
  !!@transfer_nested_constants
end

- (Boolean) verify_doubled_constant_names?

Returns:

  • (Boolean) 
96
97
98
 
# File 'lib/rspec/mocks/configuration.rb', line 96
def verify_doubled_constant_names?
  !!@verify_doubled_constant_names
end

- (Object) verify_partial_doubles=(val)

When set to true, partial mocks will be verified the same as object doubles. Any stubs will have their arguments checked against the original method, and methods that do not exist cannot be stubbed.

135
136
137
 
# File 'lib/rspec/mocks/configuration.rb', line 135
def verify_partial_doubles=(val)
  @verify_partial_doubles = !!val
end

- (Boolean) verify_partial_doubles?

Returns:

  • (Boolean) 
139
140
141
 
# File 'lib/rspec/mocks/configuration.rb', line 139
def verify_partial_doubles?
  @verify_partial_doubles
end

- (Object) verifying_double_declaration_callbacks

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns an array of blocks to call when verifying doubles

120
121
122
 
# File 'lib/rspec/mocks/configuration.rb', line 120
def verifying_double_declaration_callbacks
  @verifying_double_declaration_callbacks ||= []
end

- (Object) when_declaring_verifying_double(&block)

Provides a way to perform customisations when verifying doubles.

Examples:


RSpec::Mocks.configuration.when_declaring_verifying_double do |ref|
  ref.some_method!
end
114
115
116
 
# File 'lib/rspec/mocks/configuration.rb', line 114
def when_declaring_verifying_double(&block)
  verifying_double_declaration_callbacks << block
end

- (Boolean) yield_receiver_to_any_instance_implementation_blocks?

Returns:

  • (Boolean) 
12
13
14
 
# File 'lib/rspec/mocks/configuration.rb', line 12
def yield_receiver_to_any_instance_implementation_blocks?
  @yield_receiver_to_any_instance_implementation_blocks
end