Class: RSpec::Mocks::Configuration

Inherits:

Object

• Object
• RSpec::Mocks::Configuration

show all

Defined in:

lib/rspec/mocks/configuration.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) allow_message_expectations_on_nil

  Sets whether RSpec will warn, ignore, or fail a test when expectations are set on nil.

• - (Object) color writeonly

  Indicates whether or not diffs should be colored.

• - (Object) transfer_nested_constants writeonly

  Sets the default for the transfer_nested_constants option when stubbing constants.

• - (Object) verify_doubled_constant_names 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.

• - (Object) yield_receiver_to_any_instance_implementation_blocks writeonly

  Sets whether or not RSpec will yield the receiving instance of a message to blocks that are used for any_instance stub implementations.

Instance Method Summary (collapse)

• - (Object) add_stub_and_should_receive_to(*modules)

  Adds stub and should_receive to the given modules or classes.

• - (Object) before_verifying_doubles(&block) (also: #when_declaring_verifying_double)

  Provides a way to perform customisations when verifying doubles.

• - (Boolean) color?

  Indicates whether or not diffs should be colored.

• - (Configuration) initialize constructor

  A new instance of Configuration.

• - (Object) patch_marshal_to_support_partial_doubles=(val)

  Monkey-patch Marshal.dump to enable dumping of mocked or stubbed objects.

• - (Object) reset_syntaxes_to_default private

  Resets the configured syntax to the default.

• - (Object) syntax

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

• - (Object) syntax=(*values)

  Provides the ability to set either expect, should or both syntaxes.

• - (Boolean) transfer_nested_constants?
• - (Boolean) verify_doubled_constant_names?
• - (Object) verify_partial_doubles=(val)

  When set to true, partial mocks will be verified the same as object doubles.

• - (Boolean) verify_partial_doubles?
• - (Object) verifying_double_callbacks private

  Returns an array of blocks to call when verifying doubles.

• - (Boolean) yield_receiver_to_any_instance_implementation_blocks?

5
6
7
8
9
10
11

# File 'lib/rspec/mocks/configuration.rb', line 5
def initialize
  @allow_message_expectations_on_nil = nil
  @yield_receiver_to_any_instance_implementation_blocks = true
  @verify_doubled_constant_names = false
  @transfer_nested_constants = false
  @verify_partial_doubles = false
end

RSpec.configure do |config|
  config.mock_with :rspec do |mocks|
    mocks.allow_message_expectations_on_nil = false
  end
end

27
28
29

# File 'lib/rspec/mocks/configuration.rb', line 27
def allow_message_expectations_on_nil
  @allow_message_expectations_on_nil
end

164
165
166

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

143
144
145

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

118
119
120

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

RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.yield_receiver_to_any_instance_implementation_blocks = false
  end
end

44
45
46

# File 'lib/rspec/mocks/configuration.rb', line 44
def yield_receiver_to_any_instance_implementation_blocks=(value)
  @yield_receiver_to_any_instance_implementation_blocks = value
end

RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.add_stub_and_should_receive_to Delegator
  end
end

60
61
62
63
64

# File 'lib/rspec/mocks/configuration.rb', line 60
def add_stub_and_should_receive_to(*modules)
  modules.each do |mod|
    Syntax.enable_should(mod)
  end
end

RSpec::Mocks.configuration.before_verifying_doubles do |ref|
  ref.some_method!
end

126
127
128

# File 'lib/rspec/mocks/configuration.rb', line 126
def before_verifying_doubles(&block)
  verifying_double_callbacks << block
end

169
170
171

# File 'lib/rspec/mocks/configuration.rb', line 169
def color?
  ::RSpec.configuration.color_enabled?
end

181
182
183
184
185
186
187

# File 'lib/rspec/mocks/configuration.rb', line 181
def patch_marshal_to_support_partial_doubles=(val)
  if val
    RSpec::Mocks::MarshalExtension.patch!
  else
    RSpec::Mocks::MarshalExtension.unpatch!
  end
end

191
192
193
194

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

unless RSpec::Mocks.configuration.syntax.include?(:expect)
  raise "this RSpec extension gem requires the rspec-mocks `:expect` syntax"
end

102
103
104
105
106
107

# File 'lib/rspec/mocks/configuration.rb', line 102
def syntax
  syntaxes = []
  syntaxes << :should  if Syntax.should_enabled?
  syntaxes << :expect if Syntax.expect_enabled?
  syntaxes
end

RSpec.configure do |rspec|
  rspec.mock_with :rspec do |mocks|
    mocks.syntax = [:expect, :should]
  end

79
80
81
82
83
84
85
86
87
88
89
90
91
92

# File 'lib/rspec/mocks/configuration.rb', line 79
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

137
138
139

# File 'lib/rspec/mocks/configuration.rb', line 137
def transfer_nested_constants?
  !!@transfer_nested_constants
end

109
110
111

# File 'lib/rspec/mocks/configuration.rb', line 109
def verify_doubled_constant_names?
  !!@verify_doubled_constant_names
end

148
149
150

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

152
153
154

# File 'lib/rspec/mocks/configuration.rb', line 152
def verify_partial_doubles?
  @verify_partial_doubles
end

133
134
135

# File 'lib/rspec/mocks/configuration.rb', line 133
def verifying_double_callbacks
  @verifying_double_callbacks ||= []
end

29
30
31

# File 'lib/rspec/mocks/configuration.rb', line 29
def yield_receiver_to_any_instance_implementation_blocks?
  @yield_receiver_to_any_instance_implementation_blocks
end