mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
2bb0abbec0
The documentation on `:on` for validations was inconsistent, and most only referenced the `:create` and `:update` contexts. I fixed those to be consistent with the documentation on `AM::Validations.validates`, which seemed to have the best docs. [ci skip]
153 lines
5.1 KiB
Ruby
153 lines
5.1 KiB
Ruby
module ActiveModel
|
|
module Validations
|
|
module HelperMethods
|
|
private
|
|
def _merge_attributes(attr_names)
|
|
options = attr_names.extract_options!.symbolize_keys
|
|
attr_names.flatten!
|
|
options[:attributes] = attr_names
|
|
options
|
|
end
|
|
end
|
|
|
|
class WithValidator < EachValidator # :nodoc:
|
|
def validate_each(record, attr, val)
|
|
method_name = options[:with]
|
|
|
|
if record.method(method_name).arity == 0
|
|
record.send method_name
|
|
else
|
|
record.send method_name, attr
|
|
end
|
|
end
|
|
end
|
|
|
|
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
|
|
# include ActiveModel::Validations
|
|
# validates_with MyValidator
|
|
# end
|
|
#
|
|
# class MyValidator < ActiveModel::Validator
|
|
# def validate(record)
|
|
# if some_complex_logic
|
|
# record.errors.add :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
|
|
# include ActiveModel::Validations
|
|
# validates_with MyValidator, MyOtherValidator, on: :create
|
|
# end
|
|
#
|
|
# Configuration options:
|
|
# * <tt>:on</tt> - Specifies the contexts where this validation is active.
|
|
# Runs in all validation contexts by default (nil). You can pass a symbol
|
|
# or an array of symbols. (e.g. <tt>on: :create</tt> or
|
|
# <tt>on: :custom_validation_context</tt> or
|
|
# <tt>on: [:create, :custom_validation_context]</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.
|
|
# * <tt>:strict</tt> - Specifies whether validation should be strict.
|
|
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
|
#
|
|
# If you pass any additional configuration options, they will be passed
|
|
# to the class and available as +options+:
|
|
#
|
|
# class Person
|
|
# include ActiveModel::Validations
|
|
# validates_with MyValidator, my_custom_key: 'my custom value'
|
|
# end
|
|
#
|
|
# class MyValidator < ActiveModel::Validator
|
|
# def validate(record)
|
|
# options[:my_custom_key] # => "my custom value"
|
|
# end
|
|
# end
|
|
def validates_with(*args, &block)
|
|
options = args.extract_options!
|
|
options[:class] = self
|
|
|
|
args.each do |klass|
|
|
validator = klass.new(options, &block)
|
|
|
|
if validator.respond_to?(:attributes) && !validator.attributes.empty?
|
|
validator.attributes.each do |attribute|
|
|
_validators[attribute.to_sym] << validator
|
|
end
|
|
else
|
|
_validators[nil] << validator
|
|
end
|
|
|
|
validate(validator, options)
|
|
end
|
|
end
|
|
end
|
|
|
|
# Passes the record off to the class or classes specified and allows them
|
|
# to add errors based on more complex conditions.
|
|
#
|
|
# class Person
|
|
# include ActiveModel::Validations
|
|
#
|
|
# validate :instance_validations
|
|
#
|
|
# def instance_validations
|
|
# validates_with MyValidator
|
|
# end
|
|
# end
|
|
#
|
|
# Please consult the class method documentation for more information on
|
|
# creating your own validator.
|
|
#
|
|
# You may also pass it multiple classes, like so:
|
|
#
|
|
# class Person
|
|
# include ActiveModel::Validations
|
|
#
|
|
# validate :instance_validations, on: :create
|
|
#
|
|
# def instance_validations
|
|
# validates_with MyValidator, MyOtherValidator
|
|
# end
|
|
# end
|
|
#
|
|
# Standard configuration options (<tt>:on</tt>, <tt>:if</tt> and
|
|
# <tt>:unless</tt>), which are available on the class version of
|
|
# +validates_with+, should instead be placed on the +validates+ method
|
|
# as these are applied and tested in the callback.
|
|
#
|
|
# If you pass any additional configuration options, they will be passed
|
|
# to the class and available as +options+, please refer to the
|
|
# class version of this method for more information.
|
|
def validates_with(*args, &block)
|
|
options = args.extract_options!
|
|
options[:class] = self.class
|
|
|
|
args.each do |klass|
|
|
validator = klass.new(options, &block)
|
|
validator.validate(self)
|
|
end
|
|
end
|
|
end
|
|
end
|