Class: Kharon::Handlers::Messages

Inherits:

Object

• Object
• Kharon::Handlers::Messages

Defined in:

lib/kharon/handlers/messages.rb

Overview

Errors handler that stores each problem encountered during validation.

Author:

• Vincent Courtois <courtois.vincent@outlook.com>

Instance Method Summary

• #errors ⇒ Array

  Getter for the errors, cloning it so no error can be added from outside of the report_error method.

• #initialize ⇒ Messages constructor

  Constructor of the class, initializing the errors array.

• #report_error(error_hash) ⇒ Kharon::Handlers::Messages

  Method used to report an error by storing it in an array.

Constructor Details

#initialize ⇒ Messages

Constructor of the class, initializing the errors array.

# File 'lib/kharon/handlers/messages.rb', line 9

def initialize
  @errors = Array.new
end

Instance Method Details

#errors ⇒ Array

Getter for the errors, cloning it so no error can be added from outside of the report_error method

Returns:

• (Array) —

  the array of errors.

# File 'lib/kharon/handlers/messages.rb', line 23

def errors
  @errors.clone
end

#report_error(error_hash) ⇒ Kharon::Handlers::Messages

Method used to report an error by storing it in an array.

Parameters:

• error_hash (Hash) —

  a Hash describing the error.

Returns:

• (Kharon::Handlers::Messages) —

  the errors handler after insertion, so several calls can be chained.

# File 'lib/kharon/handlers/messages.rb', line 16

def report_error(error_hash)
  @errors.push(error_hash)
  self
end