1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activemodel/lib/active_model/validations/with.rb
2009-12-23 01:38:15 +01:00

59 lines
2.2 KiB
Ruby

module ActiveModel
module Validations
module ClassMethods
# Passes the record off to the class or classes specified and allows them to add errors based on more complex conditions.
#
# class Person < ActiveRecord::Base
# validates_with MyValidator
# end
#
# class MyValidator < ActiveRecord::Validator
# def validate
# if some_complex_logic
# record.errors[:base] << "This record is invalid"
# end
# end
#
# private
# def some_complex_logic
# # ...
# end
# end
#
# You may also pass it multiple classes, like so:
#
# class Person < ActiveRecord::Base
# validates_with MyValidator, MyOtherValidator, :on => :create
# end
#
# Configuration options:
# * <tt>on</tt> - Specifies when this validation is active (<tt>:create</tt> or <tt>:update</tt>
# * <tt>if</tt> - Specifies a method, proc or string to call to determine if the validation should
# occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).
# The method, proc or string should return or evaluate to a true or false value.
# * <tt>unless</tt> - Specifies a method, proc or string to call to determine if the validation should
# not occur (e.g. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>).
# The method, proc or string should return or evaluate to a true or false value.
#
# If you pass any additional configuration options, they will be passed to the class and available as <tt>options</tt>:
#
# class Person < ActiveRecord::Base
# validates_with MyValidator, :my_custom_key => "my custom value"
# end
#
# class MyValidator < ActiveRecord::Validator
# def validate
# options[:my_custom_key] # => "my custom value"
# end
# end
#
def validates_with(*args, &block)
options = args.extract_options!
args.each { |klass| validate(klass.new(options, &block), options) }
end
end
end
end