Exception: Israeli::InvalidFormatError

Inherits:

Error

• Object
• StandardError
• Error
• Israeli::InvalidFormatError

Defined in:

lib/israeli/errors.rb

Overview

Raised when input format is invalid for the requested validation type.

Examples:

Israeli.valid_id!("123456789")
# => Israeli::InvalidFormatError: Invalid Israeli ID

Direct Known Subclasses

InvalidBankAccountError, InvalidIdError, InvalidPhoneError, InvalidPostalCodeError

Instance Attribute Summary

• #reason ⇒ Object readonly

  Returns the value of attribute reason.

Instance Method Summary

• #initialize(message = nil, reason: nil) ⇒ InvalidFormatError constructor

  A new instance of InvalidFormatError.

Constructor Details

#initialize(message = nil, reason: nil) ⇒ InvalidFormatError

Returns a new instance of InvalidFormatError.

Parameters:

• message (String) (defaults to: nil) —

  Human-readable error message

• reason (Symbol, nil) (defaults to: nil) —

  Machine-readable reason code

# File 'lib/israeli/errors.rb', line 26

def initialize(message = nil, reason: nil)
  @reason = reason
  super(message)
end

Instance Attribute Details

#reason ⇒ Object (readonly)

Returns the value of attribute reason.

# File 'lib/israeli/errors.rb', line 22

def reason
  @reason
end