class Minitest::Mock

A simple and clean mock object framework.

All mock objects are an instance of Mock

Public Class Methods

(?untyped? delegator) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 12
def initialize: (?untyped? delegator) -> void

Public Instance Methods

__call

(untyped name, untyped data) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 52
def __call: (untyped name, untyped data) -> untyped

__respond_to?

(untyped sym, ?bool include_private) → (true | untyped)

Alias for: respond_to?

expect

(untyped name, untyped retval, ?untyped args, **untyped kwargs) ?{ (?) → untyped } → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 51
def expect: (untyped name, untyped retval, ?untyped args, **untyped kwargs) ?{ (?) -> untyped } -> self

Expect that method name is called, optionally with args (and kwargs or a blk), and returns retval.

@mock.expect(:meaning_of_life, 42)
@mock.meaning_of_life # => 42

@mock.expect(:do_something_with, true, [some_obj, true])
@mock.do_something_with(some_obj, true) # => true

@mock.expect(:do_something_else, true) do |a1, a2|
  a1 == "buggs" && a2 == :bunny
end

args is compared to the expected args using case equality (ie, the ‘===’ operator), allowing for less specific expectations.

@mock.expect(:uses_any_string, true, [String])
@mock.uses_any_string("foo") # => true
@mock.verify  # => true

@mock.expect(:uses_one_string, true, ["foo"])
@mock.uses_one_string("bar") # => raises MockExpectationError

If a method will be called multiple times, specify a new expect for each one. They will be used in the order you define them.

@mock.expect(:ordinal_increment, 'first')
@mock.expect(:ordinal_increment, 'second')

@mock.ordinal_increment # => 'first'
@mock.ordinal_increment # => 'second'
@mock.ordinal_increment # => raises MockExpectationError "No more expects available for :ordinal_increment"

method_missing

(untyped sym, *untyped args, **untyped kwargs) { (?) → untyped } → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 62
def method_missing: (untyped sym, *untyped args, **untyped kwargs) { (?) -> untyped } -> untyped

respond_to?

(untyped sym, ?bool include_private) → (true | untyped)

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 63
def respond_to?: (untyped sym, ?bool include_private) -> (true | untyped)

Also aliased as: __respond_to?

verify

() → true

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/minitest/0/minitest/mock.rbs, line 61
def verify: () -> true

Verify that all methods were called as expected. Raises MockExpectationError if the mock object was not called as expected.