2010-03-27 14:50:11 -04:00
|
|
|
require 'active_support/core_ext/array/wrap'
|
2010-02-18 10:28:48 -05:00
|
|
|
require "active_support/core_ext/module/anonymous"
|
2010-03-28 08:15:02 -04:00
|
|
|
require 'active_support/core_ext/object/blank'
|
2010-02-18 10:28:48 -05:00
|
|
|
|
2009-10-20 20:20:01 -04:00
|
|
|
module ActiveModel #:nodoc:
|
2010-06-14 05:26:51 -04:00
|
|
|
|
|
|
|
# == Active Model Validator
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
|
|
|
# A simple base class that can be used along with
|
2010-09-16 09:10:36 -04:00
|
|
|
# ActiveModel::Validations::ClassMethods.validates_with
|
2009-08-09 03:29:34 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# class Person
|
|
|
|
# include ActiveModel::Validations
|
2009-08-09 03:29:34 -04:00
|
|
|
# validates_with MyValidator
|
|
|
|
# end
|
|
|
|
#
|
2009-10-20 20:20:01 -04:00
|
|
|
# class MyValidator < ActiveModel::Validator
|
2010-01-07 12:44:35 -05:00
|
|
|
# def validate(record)
|
2009-08-09 03:29:34 -04:00
|
|
|
# if some_complex_logic
|
|
|
|
# record.errors[:base] = "This record is invalid"
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# private
|
|
|
|
# def some_complex_logic
|
|
|
|
# # ...
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# Any class that inherits from ActiveModel::Validator must implement a method
|
|
|
|
# called <tt>validate</tt> which accepts a <tt>record</tt>.
|
2009-08-09 03:29:34 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# class Person
|
|
|
|
# include ActiveModel::Validations
|
2009-08-09 03:29:34 -04:00
|
|
|
# validates_with MyValidator
|
|
|
|
# end
|
|
|
|
#
|
2009-10-20 20:20:01 -04:00
|
|
|
# class MyValidator < ActiveModel::Validator
|
2010-01-31 18:08:20 -05:00
|
|
|
# def validate(record)
|
2009-08-09 03:29:34 -04:00
|
|
|
# record # => The person instance being validated
|
|
|
|
# options # => Any non-standard options passed to validates_with
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
2010-09-16 09:10:36 -04:00
|
|
|
# To cause a validation error, you must add to the <tt>record</tt>'s errors directly
|
2009-08-09 03:29:34 -04:00
|
|
|
# from within the validators message
|
|
|
|
#
|
2009-10-20 20:20:01 -04:00
|
|
|
# class MyValidator < ActiveModel::Validator
|
2010-01-07 12:44:35 -05:00
|
|
|
# def validate(record)
|
2009-08-09 03:29:34 -04:00
|
|
|
# record.errors[:base] << "This is some custom error message"
|
|
|
|
# record.errors[:first_name] << "This is some complex validation"
|
|
|
|
# # etc...
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# To add behavior to the initialize method, use the following signature:
|
|
|
|
#
|
2009-10-20 20:20:01 -04:00
|
|
|
# class MyValidator < ActiveModel::Validator
|
2009-08-09 03:29:34 -04:00
|
|
|
# def initialize(record, options)
|
|
|
|
# super
|
|
|
|
# @my_custom_field = options[:field_name] || :first_name
|
|
|
|
# end
|
|
|
|
# end
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# The easiest way to add custom validators for validating individual attributes
|
2011-03-07 13:26:16 -05:00
|
|
|
# is with the convenient <tt>ActiveModel::EachValidator</tt>. For example:
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# class TitleValidator < ActiveModel::EachValidator
|
|
|
|
# def validate_each(record, attribute, value)
|
|
|
|
# record.errors[attribute] << 'must be Mr. Mrs. or Dr.' unless ['Mr.', 'Mrs.', 'Dr.'].include?(value)
|
|
|
|
# end
|
|
|
|
# end
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# This can now be used in combination with the +validates+ method
|
2011-03-07 13:26:16 -05:00
|
|
|
# (see <tt>ActiveModel::Validations::ClassMethods.validates</tt> for more on this)
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# class Person
|
|
|
|
# include ActiveModel::Validations
|
|
|
|
# attr_accessor :title
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2011-03-07 13:26:16 -05:00
|
|
|
# validates :title, :presence => true
|
2010-01-07 12:44:35 -05:00
|
|
|
# end
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# Validator may also define a +setup+ instance method which will get called
|
2011-03-07 13:26:16 -05:00
|
|
|
# with the class that using that validator as its argument. This can be
|
|
|
|
# useful when there are prerequisites such as an +attr_accessor+ being present
|
2010-01-07 12:44:35 -05:00
|
|
|
# for example:
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-01-07 12:44:35 -05:00
|
|
|
# class MyValidator < ActiveModel::Validator
|
|
|
|
# def setup(klass)
|
|
|
|
# klass.send :attr_accessor, :custom_attribute
|
|
|
|
# end
|
|
|
|
# end
|
2010-05-11 09:36:09 -04:00
|
|
|
#
|
|
|
|
# This setup method is only called when used with validation macros or the
|
|
|
|
# class level <tt>validates_with</tt> method.
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2009-08-09 03:29:34 -04:00
|
|
|
class Validator
|
2009-12-22 17:12:21 -05:00
|
|
|
attr_reader :options
|
2009-08-09 03:29:34 -04:00
|
|
|
|
2011-03-06 16:34:01 -05:00
|
|
|
# Returns the kind of the validator. Examples:
|
2010-02-18 10:28:48 -05:00
|
|
|
#
|
2010-07-29 20:30:04 -04:00
|
|
|
# PresenceValidator.kind # => :presence
|
|
|
|
# UniquenessValidator.kind # => :uniqueness
|
2010-02-18 10:28:48 -05:00
|
|
|
#
|
|
|
|
def self.kind
|
|
|
|
@kind ||= name.split('::').last.underscore.sub(/_validator$/, '').to_sym unless anonymous?
|
|
|
|
end
|
|
|
|
|
2010-06-11 06:15:34 -04:00
|
|
|
# Accepts options that will be made available through the +options+ reader.
|
2009-12-22 17:12:21 -05:00
|
|
|
def initialize(options)
|
2010-08-03 09:34:31 -04:00
|
|
|
@options = options.freeze
|
2009-08-09 03:29:34 -04:00
|
|
|
end
|
|
|
|
|
2010-02-18 10:28:48 -05:00
|
|
|
# Return the kind for this validator.
|
|
|
|
def kind
|
|
|
|
self.class.kind
|
|
|
|
end
|
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
# Override this method in subclasses with validation logic, adding errors
|
|
|
|
# to the records +errors+ array where necessary.
|
2009-12-22 17:12:21 -05:00
|
|
|
def validate(record)
|
2011-02-09 08:32:40 -05:00
|
|
|
raise NotImplementedError, "Subclasses must implement a validate(record) method."
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-03-07 13:26:16 -05:00
|
|
|
# +EachValidator+ is a validator which iterates through the attributes given
|
|
|
|
# in the options hash invoking the <tt>validate_each</tt> method passing in the
|
2009-12-22 19:37:19 -05:00
|
|
|
# record, attribute and value.
|
|
|
|
#
|
2011-03-07 13:26:16 -05:00
|
|
|
# All Active Model validations are built on top of this validator.
|
2009-12-22 18:36:51 -05:00
|
|
|
class EachValidator < Validator
|
|
|
|
attr_reader :attributes
|
2010-08-14 01:13:00 -04:00
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
# Returns a new validator instance. All options will be available via the
|
|
|
|
# +options+ reader, however the <tt>:attributes</tt> option will be removed
|
|
|
|
# and instead be made available through the +attributes+ reader.
|
2009-12-22 18:36:51 -05:00
|
|
|
def initialize(options)
|
2010-03-27 14:50:11 -04:00
|
|
|
@attributes = Array.wrap(options.delete(:attributes))
|
2010-01-03 10:58:33 -05:00
|
|
|
raise ":attributes cannot be blank" if @attributes.empty?
|
2009-12-22 18:36:51 -05:00
|
|
|
super
|
2009-12-22 19:08:27 -05:00
|
|
|
check_validity!
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
# Performs validation on the supplied record. By default this will call
|
|
|
|
# +validates_each+ to determine validity therefore subclasses should
|
|
|
|
# override +validates_each+ with validation logic.
|
2009-12-22 18:36:51 -05:00
|
|
|
def validate(record)
|
|
|
|
attributes.each do |attribute|
|
2010-01-07 12:44:35 -05:00
|
|
|
value = record.read_attribute_for_validation(attribute)
|
2009-12-22 18:36:51 -05:00
|
|
|
next if (value.nil? && options[:allow_nil]) || (value.blank? && options[:allow_blank])
|
|
|
|
validate_each(record, attribute, value)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2010-06-11 06:15:34 -04:00
|
|
|
# Override this method in subclasses with the validation logic, adding
|
2010-01-07 12:44:35 -05:00
|
|
|
# errors to the records +errors+ array where necessary.
|
2009-12-22 19:37:19 -05:00
|
|
|
def validate_each(record, attribute, value)
|
2011-02-09 08:32:40 -05:00
|
|
|
raise NotImplementedError, "Subclasses must implement a validate_each(record, attribute, value) method"
|
2009-08-09 03:29:34 -04:00
|
|
|
end
|
2009-12-22 19:08:27 -05:00
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
# Hook method that gets called by the initializer allowing verification
|
|
|
|
# that the arguments supplied are valid. You could for example raise an
|
2011-03-07 13:26:16 -05:00
|
|
|
# +ArgumentError+ when invalid options are supplied.
|
2009-12-22 19:08:27 -05:00
|
|
|
def check_validity!
|
|
|
|
end
|
2009-08-09 03:29:34 -04:00
|
|
|
end
|
2009-12-22 19:37:19 -05:00
|
|
|
|
2011-03-07 13:26:16 -05:00
|
|
|
# +BlockValidator+ is a special +EachValidator+ which receives a block on initialization
|
|
|
|
# and call this block for each attribute being validated. +validates_each+ uses this validator.
|
2009-12-22 19:37:19 -05:00
|
|
|
class BlockValidator < EachValidator
|
|
|
|
def initialize(options, &block)
|
|
|
|
@block = block
|
|
|
|
super
|
|
|
|
end
|
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
private
|
|
|
|
|
2009-12-22 19:37:19 -05:00
|
|
|
def validate_each(record, attribute, value)
|
|
|
|
@block.call(record, attribute, value)
|
|
|
|
end
|
|
|
|
end
|
2009-08-09 03:29:34 -04:00
|
|
|
end
|