Class: RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrorsMatcher

Parent Namespace

RSpec::SleepingKingStudios::Matchers::ActiveModel

Inherited Classes

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

Included Modules

RSpec::Matchers::Composable, RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrors

Defined In

lib/rspec/sleeping_king_studios/matchers/active_model/have_errors_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
  • initialize
  • matches?
  • on
  • with_message
  • with_messages

Overview

Matcher for testing ActiveModel object validations.

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 => HaveErrorsMatcher

Returns

• (HaveErrorsMatcher) — a new instance of HaveErrorsMatcher

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

#description => Object

Since

• 1.0.0

#does_not_match? actual => Boolean

Checks if the object can be validated, whether the object is valid, and checks the errors on the object against the expected errors and messages from #on and #with_message, if any.

Parameters

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

Returns

• (Boolean) — True if the object responds to :valid? and is valid or object.errors does not match the specified errors and messages (if any); otherwise false.

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 can be validated, whether the object is valid, and checks the errors on the object against the expected errors and messages from #on and #with_message, if any.

Parameters

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

Returns

• (Boolean) — True if the object responds to :valid?, is not valid, and object.errors matches the specified errors and messages (if any); otherwise false.

See Also

• RSpec::SleepingKingStudios::Matchers::BaseMatcher#matches?

Since

• 1.0.0

#on attribute => HaveErrorsMatcher

Adds an error expectation. If the actual object does not have an error on the specified attribute, #matches? will return false.

Examples

Setting an error expectation

expect(actual).to have_errors.on(:foo)

Parameters

• attribute (String, Symbol)

Returns

• (HaveErrorsMatcher) — self

Since

• 1.0.0

#with_message message => HaveErrorsMatcher

Adds a message expectation for the most recently added error attribute. If the actual object does not have an error on the that attribute with the specified message, #matches? will return false.

Examples

Setting an error and a message expectation

expect(actual).to have_errors.on(:foo).with("can't be blank")

Parameters

• message (String, Regexp) — The expected error message. If a string, matcher will check for an exact match; if a regular expression, matcher will check if the message matches the regexp.

Returns

• (HaveErrorsMatcher) — self

Raises

• (ArgumentError) — If no error attribute has been added.

See Also

• #on

Since

• 1.0.0

#with_messages => Object

Also known as: with

Adds a set of message expectations for the most recently added error attribute.

Parameters

• messages (Array<String, Regexp>)

See Also

• #with_message

Since

• 1.0.0

Back To Top

---

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