Module RSpec::Mocks::ExampleMethods
In: lib/rspec/mocks/example_methods.rb

Methods

Included Modules

RSpec::Mocks::ArgumentMatchers

Public Instance methods

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.

@overload double() @overload double(name) @overload double(stubs) @overload double(name, stubs) @param name [String/Symbol] (optional) used in

  clarify intent

@param stubs (Hash) (optional) hash of method/return-value pairs @return (Mock)

Constructs an instance of [RSpec::Mocks::Mock](RSpec::Mocks::Mock) configured with an optional name, used for reporting in failure messages, and an optional hash of method/return-value pairs.

@example

  book = double("book", :title => "The RSpec Book")
  book.title #=> "The RSpec Book"

  card = double("card", :suit => "Spades", :rank => "A")
  card.suit  #=> "Spades"
  card.rank  #=> "A"

@see mock @see stub

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.

@param constant_name [String] The fully qualified name of the constant.

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

@example

  hide_const("MyClass") # => MyClass is now an undefined constant

Effectively an alias for [double](double-instance_method).

Effectively an alias for [double](double-instance_method).

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.

@param constant_name [String] The fully qualified name of the constant. The current

  constant scoping at the point of call is not considered.

@param value [Object] The value to make the constant refer to. When the

  example completes, the constant will be restored to its prior state.

@param options [Hash] Stubbing options. @option 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).

@return [Object] the stubbed value of the constant

@example

  stub_const("MyClass", Class.new) # => Replaces (or defines) MyClass with a new class object.
  stub_const("SomeModel::PER_PAGE", 5) # => Sets SomeModel::PER_PAGE to 5.

  class CardDeck
    SUITS = [:Spades, :Diamonds, :Clubs, :Hearts]
    NUM_CARDS = 52
  end

  stub_const("CardDeck", Class.new)
  CardDeck::SUITS # => uninitialized constant error
  CardDeck::NUM_CARDS # => uninitialized constant error

  stub_const("CardDeck", Class.new, :transfer_nested_constants => true)
  CardDeck::SUITS # => our suits array
  CardDeck::NUM_CARDS # => 52

  stub_const("CardDeck", Class.new, :transfer_nested_constants => [:SUITS])
  CardDeck::SUITS # => our suits array
  CardDeck::NUM_CARDS # => uninitialized constant error

[Validate]