mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
better format and fixes to validators docs
This commit is contained in:
parent
d8e84738ea
commit
95e14d1523
8 changed files with 154 additions and 104 deletions
|
@ -1,5 +1,4 @@
|
|||
module ActiveModel
|
||||
|
||||
# == Active Model Acceptance Validator
|
||||
module Validations
|
||||
class AcceptanceValidator < EachValidator
|
||||
|
@ -23,7 +22,7 @@ module ActiveModel
|
|||
|
||||
module HelperMethods
|
||||
# Encapsulates the pattern of wanting to validate the acceptance of a
|
||||
# terms of service check box (or similar agreement). Example:
|
||||
# terms of service check box (or similar agreement).
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_acceptance_of :terms_of_service
|
||||
|
@ -59,7 +58,7 @@ module ActiveModel
|
|||
# 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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_acceptance_of(*attr_names)
|
||||
validates_with AcceptanceValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
module ActiveModel
|
||||
|
||||
# == Active Model Confirmation Validator
|
||||
module Validations
|
||||
class ConfirmationValidator < EachValidator
|
||||
|
@ -19,7 +18,7 @@ module ActiveModel
|
|||
|
||||
module HelperMethods
|
||||
# Encapsulates the pattern of wanting to validate a password or email
|
||||
# address field with a confirmation. For example:
|
||||
# address field with a confirmation.
|
||||
#
|
||||
# Model:
|
||||
# class Person < ActiveRecord::Base
|
||||
|
@ -60,7 +59,7 @@ module ActiveModel
|
|||
# <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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_confirmation_of(*attr_names)
|
||||
validates_with ConfirmationValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -14,35 +14,45 @@ module ActiveModel
|
|||
end
|
||||
|
||||
module HelperMethods
|
||||
# Validates that the value of the specified attribute is not in a particular enumerable object.
|
||||
# Validates that the value of the specified attribute is not in a
|
||||
# particular enumerable object.
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_exclusion_of :username, :in => %w( admin superuser ), :message => "You don't belong here"
|
||||
# validates_exclusion_of :age, :in => 30..60, :message => "This site is only for under 30 and over 60"
|
||||
# validates_exclusion_of :format, :in => %w( mov avi ), :message => "extension %{value} is not allowed"
|
||||
# validates_exclusion_of :username, :in => %w( admin superuser ),
|
||||
# :message => "You don't belong here"
|
||||
# validates_exclusion_of :age, :in => 30..60,
|
||||
# :message => "This site is only for under 30 and over 60"
|
||||
# validates_exclusion_of :format, :in => %w( mov avi ),
|
||||
# :message => "extension %{value} is not allowed"
|
||||
# validates_exclusion_of :password, :in => lambda { |p| [p.username, p.first_name] },
|
||||
# :message => "should not be the same as your username or first name"
|
||||
# end
|
||||
#
|
||||
# Configuration options:
|
||||
# * <tt>:in</tt> - An enumerable object of items that the value shouldn't be part of.
|
||||
# This can be supplied as a proc or lambda which returns an enumerable. If the enumerable
|
||||
# is a range the test is performed with <tt>Range#cover?</tt>
|
||||
# (backported in Active Support for 1.8), otherwise with <tt>include?</tt>.
|
||||
# * <tt>:message</tt> - Specifies a custom error message (default is: "is reserved").
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the attribute is blank (default is +false+).
|
||||
# * <tt>:in</tt> - An enumerable object of items that the value shouldn't be
|
||||
# part of. This can be supplied as a proc or lambda which returns an
|
||||
# enumerable. If the enumerable is a range the test is performed with
|
||||
# <tt>Range#cover?</tt> (backported in Active Support for 1.8), otherwise
|
||||
# with <tt>include?</tt>.
|
||||
# * <tt>:message</tt> - Specifies a custom error message (default is: "is
|
||||
# reserved").
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute
|
||||
# is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the
|
||||
# attribute is blank(default is +false+).
|
||||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <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
|
||||
# * <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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_exclusion_of(*attr_names)
|
||||
validates_with ExclusionValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
module ActiveModel
|
||||
|
||||
# == Active Model Format Validator
|
||||
module Validations
|
||||
class FormatValidator < EachValidator
|
||||
|
@ -42,50 +41,62 @@ module ActiveModel
|
|||
end
|
||||
|
||||
module HelperMethods
|
||||
# Validates whether the value of the specified attribute is of the correct form, going by the regular expression provided.
|
||||
# You can require that the attribute matches the regular expression:
|
||||
# Validates whether the value of the specified attribute is of the correct
|
||||
# form, going by the regular expression provided.You can require that the
|
||||
# attribute matches the regular expression:
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :create
|
||||
# end
|
||||
#
|
||||
# Alternatively, you can require that the specified attribute does _not_ match the regular expression:
|
||||
# Alternatively, you can require that the specified attribute does _not_
|
||||
# match the regular expression:
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_format_of :email, :without => /NOSPAM/
|
||||
# end
|
||||
#
|
||||
# You can also provide a proc or lambda which will determine the regular expression that will be used to validate the attribute
|
||||
# You can also provide a proc or lambda which will determine the regular
|
||||
# expression that will be used to validate the attribute.
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# # Admin can have number as a first letter in their screen name
|
||||
# validates_format_of :screen_name, :with => lambda{ |person| person.admin? ? /\A[a-z0-9][a-z0-9_\-]*\Z/i : /\A[a-z][a-z0-9_\-]*\Z/i }
|
||||
# validates_format_of :screen_name,
|
||||
# :with => lambda{ |person| person.admin? ? /\A[a-z0-9][a-z0-9_\-]*\Z/i : /\A[a-z][a-z0-9_\-]*\Z/i }
|
||||
# end
|
||||
#
|
||||
# Note: use <tt>\A</tt> and <tt>\Z</tt> to match the start and end of the string, <tt>^</tt> and <tt>$</tt> match the start/end of a line.
|
||||
# Note: use <tt>\A</tt> and <tt>\Z</tt> to match the start and end of the
|
||||
# string, <tt>^</tt> and <tt>$</tt> match the start/end of a line.
|
||||
#
|
||||
# You must pass either <tt>:with</tt> or <tt>:without</tt> as an option. In addition, both must be a regular expression
|
||||
# or a proc or lambda, or else an exception will be raised.
|
||||
# You must pass either <tt>:with</tt> or <tt>:without</tt> as an option.
|
||||
# In addition, both must be a regular expression or a proc or lambda, or
|
||||
# else an exception will be raised.
|
||||
#
|
||||
# Configuration options:
|
||||
# * <tt>:message</tt> - A custom error message (default is: "is invalid").
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the attribute is blank (default is +false+).
|
||||
# * <tt>:with</tt> - Regular expression that if the attribute matches will result in a successful validation.
|
||||
# This can be provided as a proc or lambda returning regular expression which will be called at runtime.
|
||||
# * <tt>:without</tt> - Regular expression that if the attribute does not match will result in a successful validation.
|
||||
# This can be provided as a proc or lambda returning regular expression which will be called at runtime.
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute
|
||||
# is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the
|
||||
# attribute is blank (default is +false+).
|
||||
# * <tt>:with</tt> - Regular expression that if the attribute matches will
|
||||
# result in a successful validation. This can be provided as a proc or lambda
|
||||
# returning regular expression which will be called at runtime.
|
||||
# * <tt>:without</tt> - Regular expression that if the attribute does not match
|
||||
# will result in a successful validation. This can be provided as a proc or
|
||||
# lambda returning regular expression which will be called at runtime.
|
||||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <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
|
||||
# * <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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_format_of(*attr_names)
|
||||
validates_with FormatValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
require "active_model/validations/clusivity"
|
||||
|
||||
module ActiveModel
|
||||
|
||||
# == Active Model Inclusion Validator
|
||||
module Validations
|
||||
class InclusionValidator < EachValidator
|
||||
|
@ -15,7 +14,8 @@ module ActiveModel
|
|||
end
|
||||
|
||||
module HelperMethods
|
||||
# Validates whether the value of the specified attribute is available in a particular enumerable object.
|
||||
# Validates whether the value of the specified attribute is available in a
|
||||
# particular enumerable object.
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_inclusion_of :gender, :in => %w( m f )
|
||||
|
@ -29,20 +29,25 @@ module ActiveModel
|
|||
# supplied as a proc or lambda which returns an enumerable. If the enumerable
|
||||
# is a range the test is performed with <tt>Range#cover?</tt>
|
||||
# (backported in Active Support for 1.8), otherwise with <tt>include?</tt>.
|
||||
# * <tt>:message</tt> - Specifies a custom error message (default is: "is not included in the list").
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the attribute is blank (default is +false+).
|
||||
# * <tt>:message</tt> - Specifies a custom error message (default is: "is not
|
||||
# included in the list").
|
||||
# * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute
|
||||
# is +nil+ (default is +false+).
|
||||
# * <tt>:allow_blank</tt> - If set to true, skips this validation if the
|
||||
# attribute is blank (default is +false+).
|
||||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <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
|
||||
# * <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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_inclusion_of(*attr_names)
|
||||
validates_with InclusionValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
module ActiveModel
|
||||
|
||||
# == Active Model Length Validator
|
||||
module Validations
|
||||
class LengthValidator < EachValidator
|
||||
|
@ -72,35 +71,46 @@ module ActiveModel
|
|||
# validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name"
|
||||
# validates_length_of :zip_code, :minimum => 5, :too_short => "please enter at least 5 characters"
|
||||
# validates_length_of :smurf_leader, :is => 4, :message => "papa is spelled with 4 characters... don't play me."
|
||||
# validates_length_of :essay, :minimum => 100, :too_short => "Your essay must be at least 100 words.", :tokenizer => lambda { |str| str.scan(/\w+/) }
|
||||
# validates_length_of :essay, :minimum => 100, :too_short => "Your essay must be at least 100 words.",
|
||||
# :tokenizer => lambda { |str| str.scan(/\w+/) }
|
||||
# end
|
||||
#
|
||||
# Configuration options:
|
||||
# * <tt>:minimum</tt> - The minimum size of the attribute.
|
||||
# * <tt>:maximum</tt> - The maximum size of the attribute.
|
||||
# * <tt>:is</tt> - The exact size of the attribute.
|
||||
# * <tt>:within</tt> - A range specifying the minimum and maximum size of the attribute.
|
||||
# * <tt>:within</tt> - A range specifying the minimum and maximum size of the
|
||||
# attribute.
|
||||
# * <tt>:in</tt> - A synonym(or alias) for <tt>:within</tt>.
|
||||
# * <tt>:allow_nil</tt> - Attribute may be +nil+; skip validation.
|
||||
# * <tt>:allow_blank</tt> - Attribute may be blank; skip validation.
|
||||
# * <tt>:too_long</tt> - The error message if the attribute goes over the maximum (default is: "is too long (maximum is %{count} characters)").
|
||||
# * <tt>:too_short</tt> - The error message if the attribute goes under the minimum (default is: "is too short (min is %{count} characters)").
|
||||
# * <tt>:wrong_length</tt> - The error message if using the <tt>:is</tt> method and the attribute is the wrong size (default is: "is the wrong length (should be %{count} characters)").
|
||||
# * <tt>:message</tt> - The error message to use for a <tt>:minimum</tt>, <tt>:maximum</tt>, or <tt>:is</tt> violation. An alias of the appropriate <tt>too_long</tt>/<tt>too_short</tt>/<tt>wrong_length</tt> message.
|
||||
# * <tt>:too_long</tt> - The error message if the attribute goes over the
|
||||
# maximum (default is: "is too long (maximum is %{count} characters)").
|
||||
# * <tt>:too_short</tt> - The error message if the attribute goes under the
|
||||
# minimum (default is: "is too short (min is %{count} characters)").
|
||||
# * <tt>:wrong_length</tt> - The error message if using the <tt>:is</tt> method
|
||||
# and the attribute is the wrong size (default is: "is the wrong length
|
||||
# (should be %{count} characters)").
|
||||
# * <tt>:message</tt> - The error message to use for a <tt>:minimum</tt>,
|
||||
# <tt>:maximum</tt>, or <tt>:is</tt> violation. An alias of the appropriate
|
||||
# <tt>too_long</tt>/<tt>too_short</tt>/<tt>wrong_length</tt> message.
|
||||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <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.
|
||||
# * <tt>:tokenizer</tt> - Specifies how to split up the attribute string. (e.g. <tt>:tokenizer => lambda {|str| str.scan(/\w+/)}</tt> to
|
||||
# count words as in above example.)
|
||||
# Defaults to <tt>lambda{ |value| value.split(//) }</tt> which counts individual characters.
|
||||
# * <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>:tokenizer</tt> - Specifies how to split up the attribute string.
|
||||
# (e.g. <tt>:tokenizer => lambda {|str| str.scan(/\w+/)}</tt> to count words
|
||||
# as in above example). Defaults to <tt>lambda{ |value| value.split(//) }</tt>
|
||||
# which counts individual characters.
|
||||
# * <tt>:strict</tt> - Specifies whether validation should be strict.
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_length_of(*attr_names)
|
||||
validates_with LengthValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
module ActiveModel
|
||||
|
||||
# == Active Model Numericality Validator
|
||||
module Validations
|
||||
class NumericalityValidator < EachValidator
|
||||
|
@ -79,9 +78,10 @@ module ActiveModel
|
|||
end
|
||||
|
||||
module HelperMethods
|
||||
# Validates whether the value of the specified attribute is numeric by trying to convert it to
|
||||
# a float with Kernel.Float (if <tt>only_integer</tt> is false) or applying it to the regular expression
|
||||
# <tt>/\A[\+\-]?\d+\Z/</tt> (if <tt>only_integer</tt> is set to true).
|
||||
# Validates whether the value of the specified attribute is numeric by trying
|
||||
# to convert it to a float with Kernel.Float (if <tt>only_integer</tt> is false)
|
||||
# or applying it to the regular expression <tt>/\A[\+\-]?\d+\Z/</tt> (if
|
||||
# <tt>only_integer</tt> is set to true).
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_numericality_of :value, :on => :create
|
||||
|
@ -92,37 +92,50 @@ module ActiveModel
|
|||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <tt>:update</tt>.
|
||||
# * <tt>:only_integer</tt> - Specifies whether the value has to be an integer, e.g. an integral value (default is +false+).
|
||||
# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default is +false+). Notice that for fixnum and float columns empty strings are converted to +nil+.
|
||||
# * <tt>:greater_than</tt> - Specifies the value must be greater than the supplied value.
|
||||
# * <tt>:greater_than_or_equal_to</tt> - Specifies the value must be greater than or equal the supplied value.
|
||||
# * <tt>:only_integer</tt> - Specifies whether the value has to be an integer,
|
||||
# e.g. an integral value (default is +false+).
|
||||
# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default is
|
||||
# +false+). Notice that for fixnum and float columns empty strings are
|
||||
# converted to +nil+.
|
||||
# * <tt>:greater_than</tt> - Specifies the value must be greater than the
|
||||
# supplied value.
|
||||
# * <tt>:greater_than_or_equal_to</tt> - Specifies the value must be greater
|
||||
# than or equal the supplied value.
|
||||
# * <tt>:equal_to</tt> - Specifies the value must be equal to the supplied value.
|
||||
# * <tt>:less_than</tt> - Specifies the value must be less than the supplied value.
|
||||
# * <tt>:less_than_or_equal_to</tt> - Specifies the value must be less than or equal the supplied value.
|
||||
# * <tt>:other_than</tt> - Specifies the value must be other than the supplied value.
|
||||
# * <tt>:less_than</tt> - Specifies the value must be less than the supplied
|
||||
# value.
|
||||
# * <tt>:less_than_or_equal_to</tt> - Specifies the value must be less than or
|
||||
# equal the supplied value.
|
||||
# * <tt>:other_than</tt> - Specifies the value must be other than the supplied
|
||||
# value.
|
||||
# * <tt>:odd</tt> - Specifies the value must be an odd number.
|
||||
# * <tt>:even</tt> - Specifies the value must be an even number.
|
||||
# * <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
|
||||
# * <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
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
#
|
||||
# The following checks can also be supplied with a proc or a symbol which
|
||||
# corresponds to a method:
|
||||
#
|
||||
# The following checks can also be supplied with a proc or a symbol which corresponds to a method:
|
||||
# * <tt>:greater_than</tt>
|
||||
# * <tt>:greater_than_or_equal_to</tt>
|
||||
# * <tt>:equal_to</tt>
|
||||
# * <tt>:less_than</tt>
|
||||
# * <tt>:less_than_or_equal_to</tt>
|
||||
#
|
||||
# For example:
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_numericality_of :width, :less_than => Proc.new { |person| person.height }
|
||||
# validates_numericality_of :width, :greater_than => :minimum_weight
|
||||
# end
|
||||
#
|
||||
def validates_numericality_of(*attr_names)
|
||||
validates_with NumericalityValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
require 'active_support/core_ext/object/blank'
|
||||
|
||||
module ActiveModel
|
||||
|
||||
# == Active Model Presence Validator
|
||||
module Validations
|
||||
class PresenceValidator < EachValidator
|
||||
|
@ -11,7 +10,8 @@ module ActiveModel
|
|||
end
|
||||
|
||||
module HelperMethods
|
||||
# Validates that the specified attributes are not blank (as defined by Object#blank?). Happens by default on save. Example:
|
||||
# Validates that the specified attributes are not blank (as defined by
|
||||
# Object#blank?). Happens by default on save.
|
||||
#
|
||||
# class Person < ActiveRecord::Base
|
||||
# validates_presence_of :first_name
|
||||
|
@ -19,25 +19,28 @@ module ActiveModel
|
|||
#
|
||||
# The first_name attribute must be in the object and it cannot be blank.
|
||||
#
|
||||
# If you want to validate the presence of a boolean field (where the real values are true and false),
|
||||
# you will want to use <tt>validates_inclusion_of :field_name, :in => [true, false]</tt>.
|
||||
# If you want to validate the presence of a boolean field (where the real values
|
||||
# are true and false), you will want to use
|
||||
# <tt>validates_inclusion_of :field_name, :in => [true, false]</tt>.
|
||||
#
|
||||
# This is due to the way Object#blank? handles boolean values: <tt>false.blank? # => true</tt>.
|
||||
# This is due to the way Object#blank? handles boolean values:
|
||||
# <tt>false.blank? # => true</tt>.
|
||||
#
|
||||
# Configuration options:
|
||||
# * <tt>:message</tt> - A custom error message (default is: "can't be blank").
|
||||
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
||||
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
||||
# and <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.
|
||||
# * <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
|
||||
#
|
||||
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
||||
def validates_presence_of(*attr_names)
|
||||
validates_with PresenceValidator, _merge_attributes(attr_names)
|
||||
end
|
||||
|
|
Loading…
Reference in a new issue