Class: RSpec::Mocks::ConstantMutator

Inherits:
Object
  • Object
show all
Extended by:
RecursiveConstMethods
Defined in:
lib/rspec/mocks/mutate_const.rb

Overview

Provides a means to stub constants.

Defined Under Namespace

Classes: BaseMutator, ConstantHider, DefinedConstantReplacer, UndefinedConstantSetter

Class Method Summary (collapse)

Methods included from RecursiveConstMethods

const_defined_on?, constants_defined_on, get_const_defined_on, normalize_const_name, recursive_const_defined?, recursive_const_get

Class Method Details

+ (Object) find(name)



379
380
381
# File 'lib/rspec/mocks/mutate_const.rb', line 379

def self.find(name)
  mutators.find { |s| s.full_constant_name == name }
end

+ (Object) hide(constant_name)

Note:

It's recommended that you use hide_const in your examples. This is an alternate public API that is provided so you can hide constants in other contexts (e.g. helper classes).

Hides a constant.

Parameters:

  • constant_name (String)

    The fully qualified name of the constant. The current constant scoping at the point of call is not considered.

See Also:



189
190
191
192
193
194
# File 'lib/rspec/mocks/mutate_const.rb', line 189

def self.hide(constant_name)
  return unless recursive_const_defined?(constant_name)

  mutate(ConstantHider.new(constant_name, nil, { }))
  nil
end

+ (Object) mutate(mutator)

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.

Uses the mutator to mutate (stub or hide) a constant. Ensures that the mutator is correctly registered so it can be backed out at the end of the test.



348
349
350
351
# File 'lib/rspec/mocks/mutate_const.rb', line 348

def self.mutate(mutator)
  register_mutator(mutator)
  mutator.mutate
end

+ (Object) mutators

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.

The list of constant mutators that have been used for the current example.



370
371
372
# File 'lib/rspec/mocks/mutate_const.rb', line 370

def self.mutators
  @mutators ||= []
end

+ (Object) raise_on_invalid_const

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.

Used internally by the constant stubbing to raise a helpful error when a constant like "A::B::C" is stubbed and A::B is not a module (and thus, it's impossible to define "A::B::C" since only modules can have nested constants).



389
390
391
392
393
394
# File 'lib/rspec/mocks/mutate_const.rb', line 389

def self.raise_on_invalid_const
  lambda do |const_name, failed_name|
    raise "Cannot stub constant #{failed_name} on #{const_name} " +
          "since #{const_name} is not a module."
  end
end

+ (Object) register_mutator(mutator)

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.



375
376
377
# File 'lib/rspec/mocks/mutate_const.rb', line 375

def self.register_mutator(mutator)
  mutators << mutator
end

+ (Object) reset_all

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 all stubbed constants. This is called automatically by rspec-mocks when an example finishes.



357
358
359
360
361
362
363
364
# File 'lib/rspec/mocks/mutate_const.rb', line 357

def self.reset_all
  # We use reverse order so that if the same constant
  # was stubbed multiple times, the original value gets
  # properly restored.
  mutators.reverse.each { |s| s.rspec_reset }

  mutators.clear
end

+ (Object) stub(constant_name, value, options = {})

Note:

It's recommended that you use stub_const in your examples. This is an alternate public API that is provided so you can stub constants in other contexts (e.g. helper classes).

Stubs a constant.

Parameters:

  • constant_name (String)

    The fully qualified name of the constant. The current constant scoping at the point of call is not considered.

  • value (Object)

    The value to make the constant refer to. When the example completes, the constant will be restored to its prior state.

  • options (Hash) (defaults to: {})

    Stubbing options.

Options Hash (options):

  • :transfer_nested_constants (Boolean, Array<Symbol>)

    Determines what nested constants, if any, will be transferred from the original value of the constant to the new value of the constant. This only works if both the original and new values are modules (or classes).

Returns:

  • (Object)

    the stubbed value of the constant

See Also:



169
170
171
172
173
174
175
176
177
178
# File 'lib/rspec/mocks/mutate_const.rb', line 169

def self.stub(constant_name, value, options = {})
  mutator = if recursive_const_defined?(constant_name, &raise_on_invalid_const)
    DefinedConstantReplacer
  else
    UndefinedConstantSetter
  end

  mutate(mutator.new(constant_name, value, options[:transfer_nested_constants]))
  value
end