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

Parent Namespace

RSpec::SleepingKingStudios::Matchers

Included Modules

RSpec::SleepingKingStudios::Matchers::Description

Defined In

lib/rspec/sleeping_king_studios/matchers/base_matcher.rb

Table Of Contents

• Overview
  • Since
• Direct Subclasses
• Constants
  • DEFAULT_EXPECTED_ITEMS
• Instance Attributes
  • actual
• Instance Methods
  • description
  • does_not_match?
  • failure_message
  • failure_message_when_negated
  • matches?

Overview

Minimal implementation of the RSpec matcher interface.

Since

• 1.0.0

Back To Top

Direct Subclasses

RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrorsMatcher, RSpec::SleepingKingStudios::Matchers::Core::BeAUuidMatcher, RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher, RSpec::SleepingKingStudios::Matchers::Core::ConstructMatcher, RSpec::SleepingKingStudios::Matchers::Core::DeepMatcher, RSpec::SleepingKingStudios::Matchers::Core::DelegateMethodMatcher, RSpec::SleepingKingStudios::Matchers::Core::HaveAliasedMethodMatcher, RSpec::SleepingKingStudios::Matchers::Core::HaveChangedMatcher, RSpec::SleepingKingStudios::Matchers::Core::HaveConstantMatcher, RSpec::SleepingKingStudios::Matchers::Core::HavePredicateMatcher, RSpec::SleepingKingStudios::Matchers::Core::HavePropertyMatcher, RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher, RSpec::SleepingKingStudios::Matchers::Core::HaveWriterMatcher

Back To Top

Constants

DEFAULT_EXPECTED_ITEMS

= Object.new

Inherited From

RSpec::SleepingKingStudios::Matchers::Description

Since

• 2.2.0

Back To Top

Instance Attributes

#actual => Object (readonly)

Since

• 1.0.0

Back To Top

Instance Methods

#description => String

Inherited From

RSpec::SleepingKingStudios::Matchers::Description

A short string that describes the purpose of the matcher.

Returns

• (String) — the matcher description

Since

• 2.2.0

#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

#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

#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

#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

Back To Top

---

Back to Documentation | Versions | 2.8 | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Matchers