Class: RSpec::SleepingKingStudios::Matchers::Core::DelegateMethodMatcher

Parent Namespace

RSpec::SleepingKingStudios::Matchers::Core

Inherited Classes

RSpec::SleepingKingStudios::Matchers::BaseMatcher > Object

Included Modules

RSpec::Matchers::Composable, RSpec::Mocks::ExampleMethods

Defined In

lib/rspec/sleeping_king_studios/matchers/core/delegate_method_matcher.rb

Table Of Contents

• Overview
  • Since
• Constants
  • DEFAULT_EXPECTED_ITEMS
  • DEFAULT_EXPECTED_RETURN
• Constructor
• Instance Attributes
  • actual
  • expected
• Instance Methods
  • and_return
  • description
  • does_not_match?
  • failure_message
  • failure_message_when_negated
  • initialize
  • matches?
  • to
  • with_a_block
  • with_arguments
  • with_keywords

Overview

Matcher for testing whether an object delegates a method to the specified other object.

Since

• 2.2.0

Back To Top

Constants

DEFAULT_EXPECTED_ITEMS

= Object.new

Inherited From

RSpec::SleepingKingStudios::Matchers::Description

Since

• 2.2.0

DEFAULT_EXPECTED_RETURN

= Object.new.freeze

Since

• 2.2.0

Back To Top

Constructor

#initialize expected => DelegateMethodMatcher

Parameters

• expected (Array<String, Symbol>) — The names of the methods that should be delegated to the target.

Returns

• (DelegateMethodMatcher) — a new instance of DelegateMethodMatcher

Since

• 2.2.0

Back To Top

Instance Attributes

#actual => Object (readonly)

Inherited From

RSpec::SleepingKingStudios::Matchers::BaseMatcher

Since

• 1.0.0

#expected => Object (readonly)

Also known as: method_name

method initialize

Since

• 2.2.0

Back To Top

Instance Methods

#and_return => DelegateMethodMatcher

Specifies that the actual method, when called, will return the specified value. If more than one return value is specified, the method will be called one time for each return value, and on the Nth call must return the Nth specified return value.

from calling the method on the actual object.

Parameters

• return_values (Array<Object>) — The expected values to be returned

Returns

• (DelegateMethodMatcher) — self

Since

• 2.2.0

#description => Object

Since

• 2.2.0

#does_not_match? actual => Boolean

Inherited From

RSpec::SleepingKingStudios::Matchers::BaseMatcher

Inverse of #matches? method.

Parameters

• actual (Object) — the object to test against the matcher

Returns

• (Boolean) — false if the object matches, otherwise true

See Also

• #matches?

Since

• 1.0.0

#failure_message => Object

Message for when the object does not match, but was expected to. Make sure to always call #matches? first to set up the matcher state.

Since

• 2.2.0

#failure_message_when_negated => Object

Message for when the object matches, but was expected not to. Make sure to always call #matches? first to set up the matcher state.

Since

• 2.2.0

#matches? actual => Boolean

Tests the actual object to see if it matches the defined condition(s). Invoked by RSpec expectations.

Parameters

• actual (Object) — the object to test against the matcher

Returns

• (Boolean) — true if the object matches, otherwise false

Raises

• (ArgumentError)

Since

• 2.2.0

#to target => DelegateMethodMatcher

Specifies the target object. The expected methods should be delegated from the actual object to the target.

Parameters

• target (Object) — The target object.

Returns

• (DelegateMethodMatcher) — self

Since

• 2.2.0

#with_a_block => DelegateMethodMatcher

Also known as: and_a_block

Specifies that a block argument must be passed in to the target when calling the method on the actual object.

Returns

• (DelegateMethodMatcher) — self

Since

• 2.2.0

#with_arguments => DelegateMethodMatcher

Also known as: and_arguments

Specifies a list of arguments. The provided arguments are passed in to the method call when calling the method on the actual object, and must be passed on to the target.

Parameters

• arguments (Array<Object>) — The arguments to be passed in to the method and which must be forwarded to the target.

Returns

• (DelegateMethodMatcher) — self

Since

• 2.2.0

#with_keywords => DelegateMethodMatcher

Also known as: and_keywords

Specifies a hash of keywords and values. The provided keywords are passed in to the method call when calling the method on the actual object, and must be passed on to the target.

Parameters

• keywords (Hash) — The keywords to be passed in to the method and which must be forwarded to the target.

Returns

• (DelegateMethodMatcher) — self

Since

• 2.2.0

Back To Top

---

Back to Documentation | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Matchers | RSpec::SleepingKingStudios::Matchers::Core