class BigRecord::Errors

Active Record validation is reported to and from this object, which is used by BigRecord::Base#save to determine whether the object in a valid state to be saved. See usage example in Validations.

Public Instance Methods

[](attribute)
Alias for: on
add(attribute, msg = @@default_error_messages[:invalid]) click to toggle source

Adds an error message (msg) to the attribute, which will be returned on a call to on(attribute) for the same attribute and ensure that this error object returns false when asked if empty?. More than one error can be added to the same attribute in which case an array will be returned on a call to on(attribute). If no msg is supplied, “invalid” is assumed.

# File lib/big_record/validations.rb, line 57
def add(attribute, msg = @@default_error_messages[:invalid])
  @errors[attribute.to_s] = [] if @errors[attribute.to_s].nil?
  @errors[attribute.to_s] << msg
end
add_on_blank(attributes, msg = @@default_error_messages[:blank]) click to toggle source

Will add an error message to each of the attributes in attributes that is blank (using Object#blank?).

# File lib/big_record/validations.rb, line 72
def add_on_blank(attributes, msg = @@default_error_messages[:blank])
  for attr in [attributes].flatten
    value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s]
    add(attr, msg) if value.blank?
  end
end
add_on_empty(attributes, msg = @@default_error_messages[:empty]) click to toggle source

Will add an error message to each of the attributes in attributes that is empty.

# File lib/big_record/validations.rb, line 63
def add_on_empty(attributes, msg = @@default_error_messages[:empty])
  for attr in [attributes].flatten
    value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s]
    is_empty = value.respond_to?("empty?") ? value.empty? : false
    add(attr, msg) unless !value.nil? && !is_empty
  end
end
add_to_base(msg) click to toggle source

Adds an error to the base object instead of any particular attribute. This is used to report errors that don't tie to any specific attribute, but rather to the object as a whole. These error messages don't get prepended with any field name when iterating with #each_full, so they should be complete sentences.

# File lib/big_record/validations.rb, line 49
def add_to_base(msg)
  add(:base, msg)
end
clear() click to toggle source

Removes all the errors that have been added.

# File lib/big_record/validations.rb, line 135
def clear
  @errors = {}
end
count()
Alias for: size
each() { |attr, msg| ... } click to toggle source

Yields each attribute and associated message per error added.

# File lib/big_record/validations.rb, line 101
def each
  @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } }
end
each_full() { |msg| ... } click to toggle source

Yields each full error message added. So Person.errors.add(“first_name”, “can't be empty”) will be returned through iteration as “First name can't be empty”.

# File lib/big_record/validations.rb, line 107
def each_full
  full_messages.each { |msg| yield msg }
end
empty?() click to toggle source

Returns true if no errors have been added.

# File lib/big_record/validations.rb, line 130
def empty?
  @errors.empty?
end
full_messages() click to toggle source

Returns all the full error messages in an array.

# File lib/big_record/validations.rb, line 112
def full_messages
  full_messages = []

  @errors.each_key do |attr|
    @errors[attr].each do |msg|
      next if msg.nil?

      if attr == "base"
        full_messages << msg
      else
        full_messages << @base.human_attribute_name(attr) + " " + msg
      end
    end
  end
  full_messages
end
invalid?(attribute) click to toggle source

Returns true if the specified attribute has errors associated with it.

# File lib/big_record/validations.rb, line 80
def invalid?(attribute)
  !@errors[attribute.to_s].nil?
end
length()
Alias for: size
on(attribute) click to toggle source
  • Returns nil, if no errors are associated with the specified attribute.

  • Returns the error message, if one error is associated with the specified attribute.

  • Returns an array of error messages, if more than one error is associated with the specified attribute.

# File lib/big_record/validations.rb, line 87
def on(attribute)
  errors = @errors[attribute.to_s]
  return nil if errors.nil?
  errors.size == 1 ? errors.first : errors
end
Also aliased as: []
on_base() click to toggle source

Returns errors assigned to base object through #add_to_base according to the normal rules of on(attribute).

# File lib/big_record/validations.rb, line 96
def on_base
  on(:base)
end
size() click to toggle source

Returns the total number of errors added. Two errors added to the same attribute will be counted as such with this as well.

# File lib/big_record/validations.rb, line 141
def size
  @errors.values.inject(0) { |error_count, attribute| error_count + attribute.size }
end
Also aliased as: count, length
to_xml(options={}) click to toggle source

Return an XML representation of this error object.

# File lib/big_record/validations.rb, line 149
def to_xml(options={})
  options[:root] ||= "errors"
  options[:indent] ||= 2
  options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])

  options[:builder].instruct! unless options.delete(:skip_instruct)
  options[:builder].errors do |e|
    full_messages.each { |msg| e.error(msg) }
  end
end