Class: RSpec::SleepingKingStudios::Matchers::BaseMatcher

Inherits:

Object

• Object
• RSpec::SleepingKingStudios::Matchers::BaseMatcher

Includes:

Description

Defined in:

lib/rspec/sleeping_king_studios/matchers/base_matcher.rb

Overview

Minimal implementation of the RSpec matcher interface.

Since:

• 1.0.0

Direct Known Subclasses

ActiveModel::HaveErrorsMatcher, Core::AliasMethodMatcher, Core::BeBooleanMatcher, Core::ConstructMatcher, Core::DelegateMethodMatcher, Core::HaveConstantMatcher, Core::HavePredicateMatcher, Core::HavePropertyMatcher, Core::HaveReaderMatcher, Core::HaveWriterMatcher

Constant Summary

Constants included from Description

Description::DEFAULT_EXPECTED_ITEMS

Instance Attribute Summary

• #actual ⇒ Object readonly

Instance Method Summary

• #does_not_match?(actual) ⇒ Boolean

  Inverse of #matches? method.

• #failure_message ⇒ Object

  Message for when the object does not match, but was expected to.

• #failure_message_when_negated ⇒ Object

  Message for when the object matches, but was expected not to.

• #matches?(actual) ⇒ Boolean

  Tests the actual object to see if it matches the defined condition(s).

Methods included from Description

#description

Instance Attribute Details

#actual ⇒ Object (readonly)

Since:

• 1.0.0

# File 'lib/rspec/sleeping_king_studios/matchers/base_matcher.rb', line 15

def actual
  @actual
end

Instance Method Details

#does_not_match?(actual) ⇒ Boolean

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

# File 'lib/rspec/sleeping_king_studios/matchers/base_matcher.rb', line 24

def does_not_match? actual
  !matches?(actual)
end

#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:

• 1.0.0

# File 'lib/rspec/sleeping_king_studios/matchers/base_matcher.rb', line 42

def failure_message
  "expected #{@actual.inspect} to #{description}"
end

#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:

• 1.0.0

# File 'lib/rspec/sleeping_king_studios/matchers/base_matcher.rb', line 48

def failure_message_when_negated
  "expected #{@actual.inspect} not to #{description}"
end

#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

Since:

• 1.0.0

# File 'lib/rspec/sleeping_king_studios/matchers/base_matcher.rb', line 34

def matches? actual
  @actual = actual

  true
end