Class: Sequel::Model::Errors

Inherits:
Hash show all
Defined in:
lib/sequel/model/errors.rb

Overview

Errors represents validation errors, a simple hash subclass with a few convenience methods.

Direct Known Subclasses

Plugins::ActiveModel::Errors

Instance Method Summary collapse

Methods inherited from Hash

#&, #case, #hstore, #pg_json, #pg_jsonb, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

#add(att, msg) ⇒ Object

Adds an error for the given attribute.

errors.add(:name, 'is not valid') if name == 'invalid'

11
12
13
# File 'lib/sequel/model/errors.rb', line 11

def add(att, msg)
  fetch(att){self[att] = []} << msg
end

#countObject

Return the total number of error messages.

errors.count # => 3

18
19
20
# File 'lib/sequel/model/errors.rb', line 18

def count
  values.inject(0){|m, v| m + v.length}
end

#empty?Boolean

Return true if there are no error messages, false otherwise.

Returns:

  • (Boolean)

23
24
25
# File 'lib/sequel/model/errors.rb', line 23

def empty?
  count == 0
end

#full_messagesObject

Returns an array of fully-formatted error messages.

errors.full_messages
# => ['name is not valid',
#     'hometown is not at least 2 letters']

If the message is a Sequel::LiteralString, it will be used literally, without the column name:

errors.add(:name, Sequel.lit("Album name is not valid"))
errors.full_messages
# => ['Album name is not valid']

38
39
40
41
42
43
44
# File 'lib/sequel/model/errors.rb', line 38

def full_messages
  inject([]) do |m, kv| 
    att, errors = *kv
    errors.each {|e| m << (e.is_a?(LiteralString) ? e : "#{Array(att).join(' and ')} #{e}")}
    m
  end
end

#on(att) ⇒ Object

Returns the array of errors for the given attribute, or nil if there are no errors for the attribute.

errors.on(:name) # => ['name is not valid']
errors.on(:id) # => nil

51
52
53
54
55
# File 'lib/sequel/model/errors.rb', line 51

def on(att)
  if v = fetch(att, nil) and !v.empty?
    v
  end
end