Class: RSpec::SleepingKingStudios::Matchers::Core::HaveConstantMatcher

Parent Namespace

RSpec::SleepingKingStudios::Matchers::Core

Inherited Classes

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

Included Modules

RSpec::Matchers::Composable

Defined In

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

Table Of Contents

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

Overview

Matcher for testing whether an object has a specific constant. Includes functionality for testing the value of the constant and whether the constant is immutable.

Since

• 2.2.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 => HaveConstantMatcher

Parameters

• expected (String, Symbol) — The name of the constant to check for on the actual object.

Returns

• (HaveConstantMatcher) — a new instance of HaveConstantMatcher

Since

• 2.2.0

Back To Top

Instance Attributes

#actual => Object (readonly)

Inherited From

RSpec::SleepingKingStudios::Matchers::BaseMatcher

Since

• 1.0.0

Back To Top

Instance Methods

#description => Object

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

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

#immutable => HaveConstantMatcher

Also known as: frozen

Sets a mutability expectation. The matcher will determine whether the value of the constant is mutable. Values of nil, false, true are always immutable, as are Numeric and Symbol primitives. Array values must be frozen and all array items must be immutable. Hash values must be frozen and all hash keys and values must be immutable.

Returns

• (HaveConstantMatcher) — self

Since

• 2.2.0

#immutable? => Boolean

Also known as: frozen?

Returns

• (Boolean) — True if a mutability expectation is set, otherwise false.

Since

• 2.2.0

#matches? actual => Boolean

Checks if the object has a constant :expected. Additionally, if a value expectation is set, compares the value of #expected to the specified value and checks the mutability of the constant.

Parameters

• actual (Object) — The object to check.

Returns

• (Boolean) — true If the object has a constant :expected and matches the value and mutability expectations (if any); otherwise false.

Since

• 2.2.0

#with value => HaveConstantMatcher

Also known as: with_value

Sets a value expectation. The matcher will compare the value of the constant with the specified value.

Parameters

• value (Object) — The value to compare.

Returns

• (HaveConstantMatcher) — self

Since

• 2.2.0

Back To Top

---

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