Exception: Sinclair::Exception::InvalidOptions Private

Inherits:

Sinclair::Exception

• Object
• StandardError
• Sinclair::Exception
• Sinclair::Exception::InvalidOptions

Defined in:

lib/sinclair/exception.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Exception raised when invalid options are given

Examples:

Usage

exception = Sinclair::Exception::InvalidOptions.new(%i[invalid options])
exception.message
# return 'Invalid keys on options initialization (invalid options)'

Author:

• Darthjee

Instance Method Summary

• #initialize(invalid_keys = []) ⇒ InvalidOptions constructor private

  A new instance of InvalidOptions.

• #message ⇒ String private

  Exception string showing invalid keys.

Constructor Details

#initialize(invalid_keys = []) ⇒ InvalidOptions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of InvalidOptions.

Parameters:

• invalid_keys (Array<Symbol>) (defaults to: []) —

  list of invalid keys

# File 'lib/sinclair/exception.rb', line 20

def initialize(invalid_keys = [])
  @invalid_keys = invalid_keys
end

Instance Method Details

#message ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Exception string showing invalid keys

Examples:

Usage

exception = Sinclair::Exception::InvalidOptions.new(%i[invalid options])
exception.message
# return 'Invalid keys on options initialization (invalid options)'

Returns:

• (String)

# File 'lib/sinclair/exception.rb', line 29

def message
  keys = invalid_keys.join(' ')
  "Invalid keys on options initialization (#{keys})"
end