Class: RSpec::SleepingKingStudios::Configuration::Examples

Parent Namespace

RSpec::SleepingKingStudios::Configuration

Defined In

lib/rspec/sleeping_king_studios/configuration.rb

Table Of Contents

• Overview
• Constants
  • MISSING_FAILURE_MESSAGE_HANDLERS
  • STRING_FAILURE_MESSAGE_MATCH_OPTIONS
• Instance Methods
  • handle_missing_failure_message_with
  • handle_missing_failure_message_with=
  • match_string_failure_message_as
  • match_string_failure_message_as=

Overview

Configuration options for RSpec::SleepingKingStudios::Examples.

Back To Top

Constants

MISSING_FAILURE_MESSAGE_HANDLERS

= %i[ignore pending exception].freeze

Permitted options for :handle_missing_failure_message_with.

STRING_FAILURE_MESSAGE_MATCH_OPTIONS

= %i[exact substring].freeze

Options for matching failure messages to strings.

Back To Top

Instance Methods

#handle_missing_failure_message_with => Symbol

Gets the handler for missing failure messages when using the matcher examples, and sets to :pending if unset.

Returns

• (Symbol) — The current missing message handler.

#handle_missing_failure_message_with=(value) => Object

Sets the handler for missing failure messages when using the matcher examples.

Parameters

• value (Symbol) — The desired handler. Must be :ignore, :pending, or :exception.

Raises

• () — ArgumentError If the handler is not one of the recognized values.

#match_string_failure_message_as => Symbol

Gets the option for matching failure messages to strings, and sets to :substring if unset.

Returns

• (Symbol) — The current failure message string matching option.

#match_string_failure_message_as=(value) => Object

Sets the option for matching failure messages to strings.

Parameters

• value (Symbol) — The desired option. Must be :exact, :substring, or :partial (alias of :substring).

Raises

• () — ArgumentError If the handler is not one of the recognized values.

Back To Top

---

Back to Documentation | Versions | 2.8.1 | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Configuration