Class: BigRecord::Errors

Inherits:

Object

• Object
• BigRecord::Errors

show all

Includes:

Enumerable

Defined in:

lib/big_record/validations.rb

Overview

Constant Summary

@@default_error_messages =

{
  :inclusion => "is not included in the list",
  :exclusion => "is reserved",
  :invalid => "is invalid",
  :confirmation => "doesn't match confirmation",
  :accepted  => "must be accepted",
  :empty => "can't be empty",
  :blank => "can't be blank",
  :too_long => "is too long (maximum is %d characters)",
  :too_short => "is too short (minimum is %d characters)",
  :wrong_length => "is the wrong length (should be %d characters)",
  :taken => "has already been taken",
  :not_a_number => "is not a number"
}

Instance Method Summary

• - (Object) add(attribute, msg = @@default_error_messages[:invalid])

  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?.

• - (Object) add_on_blank(attributes, msg = @@default_error_messages[:blank])

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

• - (Object) add_on_empty(attributes, msg = @@default_error_messages[:empty])

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

• - (Object) add_to_base(msg)

  Adds an error to the base object instead of any particular attribute.

• - (Object) clear

  Removes all the errors that have been added.

• - (Object) each

  Yields each attribute and associated message per error added.

• - (Object) each_full

  Yields each full error message added.

• - (Boolean) empty?

  Returns true if no errors have been added.

• - (Object) full_messages

  Returns all the full error messages in an array.

• - (Errors) initialize(base) constructor

  :nodoc:.

• - (Boolean) invalid?(attribute)

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

• - (Object) on(attribute) (also: #[])
  • Returns nil, if no errors are associated with the specified attribute.
• - (Object) on_base

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

• - (Object) size (also: #length, #count)

  Returns the total number of errors added.

• - (Object) to_xml(options = {})

  Return an XML representation of this error object.

22
23
24

# File 'lib/big_record/validations.rb', line 22

def initialize(base) # :nodoc:
  @base, @errors = base, {}
end

57
58
59
60

# 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

72
73
74
75
76
77

# 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

63
64
65
66
67
68
69

# 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

49
50
51

# File 'lib/big_record/validations.rb', line 49

def add_to_base(msg)
  add(:base, msg)
end

135
136
137

# File 'lib/big_record/validations.rb', line 135

def clear
  @errors = {}
end

101
102
103

# File 'lib/big_record/validations.rb', line 101

def each
  @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } }
end

107
108
109

# File 'lib/big_record/validations.rb', line 107

def each_full
  full_messages.each { |msg| yield msg }
end

130
131
132

# File 'lib/big_record/validations.rb', line 130

def empty?
  @errors.empty?
end

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# 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

80
81
82

# File 'lib/big_record/validations.rb', line 80

def invalid?(attribute)
  !@errors[attribute.to_s].nil?
end

87
88
89
90
91

# 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

96
97
98

# File 'lib/big_record/validations.rb', line 96

def on_base
  on(:base)
end

141
142
143

# File 'lib/big_record/validations.rb', line 141

def size
  @errors.values.inject(0) { |error_count, attribute| error_count + attribute.size }
end

149
150
151
152
153
154
155
156
157
158

# 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