Class: RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher

Parent Namespace

RSpec::SleepingKingStudios::Matchers::Core

Inherited Classes

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

Included Modules

RSpec::Matchers::Composable, RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty

Defined In

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

Table Of Contents

• Overview
  • Since
• Constants
  • DEFAULT_EXPECTED_ITEMS
• Constructor
• Instance Attributes
  • actual
• Instance Methods
  • allow_private?
  • description
  • does_not_match?
  • failure_message
  • failure_message_when_negated
  • initialize
  • matches?
  • with

Overview

Matcher for testing whether an object has a specific property reader, e.g. responds to :property.

Since

• 1.0.0

Back To Top

Constants

DEFAULT_EXPECTED_ITEMS

= Object.new

Inherited From

RSpec::SleepingKingStudios::Matchers::Description

Since

• 2.2.0

Back To Top

Constructor

#initialize expected, allow_private: false => HaveReaderMatcher

Parameters

• expected (String, Symbol) — The property to check for on the actual object.
• allow_private (Boolean) — If true, then the matcher will match a protected or private reader method. Defaults to false.

Returns

• (HaveReaderMatcher) — a new instance of HaveReaderMatcher

Since

• 1.0.0

Back To Top

Instance Attributes

#actual => Object (readonly)

Inherited From

RSpec::SleepingKingStudios::Matchers::BaseMatcher

Since

• 1.0.0

Back To Top

Instance Methods

#allow_private? => Boolean

Returns

• (Boolean) — True if the matcher matches private reader methods, otherwise false.

Since

• 1.0.0

#description => Object

Since

• 1.0.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

Checks if the object responds to #expected. Additionally, if a value expectation is set, compares the value of #expected to the specified value.

Parameters

• actual (Object) — The object to check.

Returns

• (Boolean) — true If the object responds to #expected and matches the value expectation (if any); otherwise false.

Since

• 1.0.0

#with value => HaveReaderMatcher

Also known as: with_value

Sets a value expectation. The matcher will compare the value from #property with the specified value.

Parameters

• value (Object) — The value to compare.

Returns

• (HaveReaderMatcher) — self

Since

• 1.0.0

Back To Top

---

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