From 007c3d8bcb695c3a712b85eb882c95a940c8875e Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Wed, 16 May 2012 00:03:03 -0500 Subject: better example format in validates_exclusion_of docs --- activemodel/lib/active_model/validations/exclusion.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'activemodel/lib/active_model') diff --git a/activemodel/lib/active_model/validations/exclusion.rb b/activemodel/lib/active_model/validations/exclusion.rb index 5fedb1978b..310e07f897 100644 --- a/activemodel/lib/active_model/validations/exclusion.rb +++ b/activemodel/lib/active_model/validations/exclusion.rb @@ -1,7 +1,6 @@ require "active_model/validations/clusivity" module ActiveModel - # == Active Model Exclusion Validator module Validations class ExclusionValidator < EachValidator @@ -21,7 +20,8 @@ module ActiveModel # 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" + # 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: -- cgit v1.2.3 From 95e14d1523ae075a39ce6c6efe68b13db43a16d8 Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Wed, 16 May 2012 01:23:46 -0500 Subject: better format and fixes to validators docs --- .../lib/active_model/validations/acceptance.rb | 5 +- .../lib/active_model/validations/confirmation.rb | 5 +- .../lib/active_model/validations/exclusion.rb | 44 +++++++++++------- activemodel/lib/active_model/validations/format.rb | 53 +++++++++++++--------- .../lib/active_model/validations/inclusion.rb | 27 ++++++----- activemodel/lib/active_model/validations/length.rb | 44 +++++++++++------- .../lib/active_model/validations/numericality.rb | 51 +++++++++++++-------- .../lib/active_model/validations/presence.rb | 29 ++++++------ 8 files changed, 154 insertions(+), 104 deletions(-) (limited to 'activemodel/lib/active_model') diff --git a/activemodel/lib/active_model/validations/acceptance.rb b/activemodel/lib/active_model/validations/acceptance.rb index e628c6f306..7ce7700079 100644 --- a/activemodel/lib/active_model/validations/acceptance.rb +++ b/activemodel/lib/active_model/validations/acceptance.rb @@ -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. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_acceptance_of(*attr_names) validates_with AcceptanceValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/confirmation.rb b/activemodel/lib/active_model/validations/confirmation.rb index 69ab74734d..c591dba609 100644 --- a/activemodel/lib/active_model/validations/confirmation.rb +++ b/activemodel/lib/active_model/validations/confirmation.rb @@ -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 # :unless => Proc.new { |user| user.signup_step <= 2 }). The # method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_confirmation_of(*attr_names) validates_with ConfirmationValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/exclusion.rb b/activemodel/lib/active_model/validations/exclusion.rb index 310e07f897..4a6a45ecf3 100644 --- a/activemodel/lib/active_model/validations/exclusion.rb +++ b/activemodel/lib/active_model/validations/exclusion.rb @@ -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: - # * :in - 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 Range#cover? - # (backported in Active Support for 1.8), otherwise with include?. - # * :message - Specifies a custom error message (default is: "is reserved"). - # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). - # * :allow_blank - If set to true, skips this validation if the attribute is blank (default is +false+). + # * :in - 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 + # Range#cover? (backported in Active Support for 1.8), otherwise + # with include?. + # * :message - Specifies a custom error message (default is: "is + # reserved"). + # * :allow_nil - If set to true, skips this validation if the attribute + # is +nil+ (default is +false+). + # * :allow_blank - If set to true, skips this validation if the + # attribute is blank(default is +false+). # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The + # * :if - Specifies a method, proc or string to call to determine if + # the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The # method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_exclusion_of(*attr_names) validates_with ExclusionValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/format.rb b/activemodel/lib/active_model/validations/format.rb index d3faa8c6a6..dae6a01829 100644 --- a/activemodel/lib/active_model/validations/format.rb +++ b/activemodel/lib/active_model/validations/format.rb @@ -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 \A and \Z to match the start and end of the string, ^ and $ match the start/end of a line. + # Note: use \A and \Z to match the start and end of the + # string, ^ and $ match the start/end of a line. # - # You must pass either :with or :without 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 :with or :without 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: # * :message - A custom error message (default is: "is invalid"). - # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). - # * :allow_blank - If set to true, skips this validation if the attribute is blank (default is +false+). - # * :with - 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. - # * :without - 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. + # * :allow_nil - If set to true, skips this validation if the attribute + # is +nil+ (default is +false+). + # * :allow_blank - If set to true, skips this validation if the + # attribute is blank (default is +false+). + # * :with - 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. + # * :without - 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. # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The + # * :if - Specifies a method, proc or string to call to determine + # if the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The # method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_format_of(*attr_names) validates_with FormatValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/inclusion.rb b/activemodel/lib/active_model/validations/inclusion.rb index 15ae7b1959..be1e6160f1 100644 --- a/activemodel/lib/active_model/validations/inclusion.rb +++ b/activemodel/lib/active_model/validations/inclusion.rb @@ -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 Range#cover? # (backported in Active Support for 1.8), otherwise with include?. - # * :message - Specifies a custom error message (default is: "is not included in the list"). - # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). - # * :allow_blank - If set to true, skips this validation if the attribute is blank (default is +false+). + # * :message - Specifies a custom error message (default is: "is not + # included in the list"). + # * :allow_nil - If set to true, skips this validation if the attribute + # is +nil+ (default is +false+). + # * :allow_blank - If set to true, skips this validation if the + # attribute is blank (default is +false+). # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The + # * :if - Specifies a method, proc or string to call to determine if + # the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The # method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_inclusion_of(*attr_names) validates_with InclusionValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/length.rb b/activemodel/lib/active_model/validations/length.rb index 037f8c2db8..4a9a6ea7a5 100644 --- a/activemodel/lib/active_model/validations/length.rb +++ b/activemodel/lib/active_model/validations/length.rb @@ -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: # * :minimum - The minimum size of the attribute. # * :maximum - The maximum size of the attribute. # * :is - The exact size of the attribute. - # * :within - A range specifying the minimum and maximum size of the attribute. + # * :within - A range specifying the minimum and maximum size of the + # attribute. # * :in - A synonym(or alias) for :within. # * :allow_nil - Attribute may be +nil+; skip validation. # * :allow_blank - Attribute may be blank; skip validation. - # * :too_long - The error message if the attribute goes over the maximum (default is: "is too long (maximum is %{count} characters)"). - # * :too_short - The error message if the attribute goes under the minimum (default is: "is too short (min is %{count} characters)"). - # * :wrong_length - The error message if using the :is method and the attribute is the wrong size (default is: "is the wrong length (should be %{count} characters)"). - # * :message - The error message to use for a :minimum, :maximum, or :is violation. An alias of the appropriate too_long/too_short/wrong_length message. + # * :too_long - The error message if the attribute goes over the + # maximum (default is: "is too long (maximum is %{count} characters)"). + # * :too_short - The error message if the attribute goes under the + # minimum (default is: "is too short (min is %{count} characters)"). + # * :wrong_length - The error message if using the :is method + # and the attribute is the wrong size (default is: "is the wrong length + # (should be %{count} characters)"). + # * :message - The error message to use for a :minimum, + # :maximum, or :is violation. An alias of the appropriate + # too_long/too_short/wrong_length message. # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :tokenizer - Specifies how to split up the attribute string. (e.g. :tokenizer => lambda {|str| str.scan(/\w+/)} to - # count words as in above example.) - # Defaults to lambda{ |value| value.split(//) } which counts individual characters. + # * :if - Specifies a method, proc or string to call to determine if + # the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The method, + # proc or string should return or evaluate to a true or false value. + # * :tokenizer - Specifies how to split up the attribute string. + # (e.g. :tokenizer => lambda {|str| str.scan(/\w+/)} to count words + # as in above example). Defaults to lambda{ |value| value.split(//) } + # which counts individual characters. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! for more information. def validates_length_of(*attr_names) validates_with LengthValidator, _merge_attributes(attr_names) end diff --git a/activemodel/lib/active_model/validations/numericality.rb b/activemodel/lib/active_model/validations/numericality.rb index bb9f9679fc..78c25f70f2 100644 --- a/activemodel/lib/active_model/validations/numericality.rb +++ b/activemodel/lib/active_model/validations/numericality.rb @@ -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 only_integer is false) or applying it to the regular expression - # /\A[\+\-]?\d+\Z/ (if only_integer 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 only_integer is false) + # or applying it to the regular expression /\A[\+\-]?\d+\Z/ (if + # only_integer is set to true). # # class Person < ActiveRecord::Base # validates_numericality_of :value, :on => :create @@ -92,37 +92,50 @@ module ActiveModel # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :only_integer - Specifies whether the value has to be an integer, e.g. an integral value (default is +false+). - # * :allow_nil - Skip validation if attribute is +nil+ (default is +false+). Notice that for fixnum and float columns empty strings are converted to +nil+. - # * :greater_than - Specifies the value must be greater than the supplied value. - # * :greater_than_or_equal_to - Specifies the value must be greater than or equal the supplied value. + # * :only_integer - Specifies whether the value has to be an integer, + # e.g. an integral value (default is +false+). + # * :allow_nil - Skip validation if attribute is +nil+ (default is + # +false+). Notice that for fixnum and float columns empty strings are + # converted to +nil+. + # * :greater_than - Specifies the value must be greater than the + # supplied value. + # * :greater_than_or_equal_to - Specifies the value must be greater + # than or equal the supplied value. # * :equal_to - Specifies the value must be equal to the supplied value. - # * :less_than - Specifies the value must be less than the supplied value. - # * :less_than_or_equal_to - Specifies the value must be less than or equal the supplied value. - # * :other_than - Specifies the value must be other than the supplied value. + # * :less_than - Specifies the value must be less than the supplied + # value. + # * :less_than_or_equal_to - Specifies the value must be less than or + # equal the supplied value. + # * :other_than - Specifies the value must be other than the supplied + # value. # * :odd - Specifies the value must be an odd number. # * :even - Specifies the value must be an even number. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The - # method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). The + # * :if - Specifies a method, proc or string to call to determine if + # the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The # method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information + # See ActiveModel::Validation#validates! 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: # * :greater_than # * :greater_than_or_equal_to # * :equal_to # * :less_than # * :less_than_or_equal_to # + # 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 diff --git a/activemodel/lib/active_model/validations/presence.rb b/activemodel/lib/active_model/validations/presence.rb index 9a643a6f5c..e606f74757 100644 --- a/activemodel/lib/active_model/validations/presence.rb +++ b/activemodel/lib/active_model/validations/presence.rb @@ -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 validates_inclusion_of :field_name, :in => [true, false]. + # If you want to validate the presence of a boolean field (where the real values + # are true and false), you will want to use + # validates_inclusion_of :field_name, :in => [true, false]. # - # This is due to the way Object#blank? handles boolean values: false.blank? # => true. + # This is due to the way Object#blank? handles boolean values: + # false.blank? # => true. # # Configuration options: # * :message - A custom error message (default is: "can't be blank"). # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. - # * :if - Specifies a method, proc or string to call to determine if the validation should - # occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). - # The method, proc or string should return or evaluate to a true or false value. - # * :unless - Specifies a method, proc or string to call to determine if the validation should - # not occur (e.g. :unless => :skip_validation, or :unless => Proc.new { |user| user.signup_step <= 2 }). - # The method, proc or string should return or evaluate to a true or false value. + # * :if - Specifies a method, proc or string to call to determine if + # the validation should occur (e.g. :if => :allow_validation, or + # :if => Proc.new { |user| user.signup_step > 2 }). The method, proc + # or string should return or evaluate to a true or false value. + # * :unless - Specifies a method, proc or string to call to determine + # if the validation should not occur (e.g. :unless => :skip_validation, + # or :unless => Proc.new { |user| user.signup_step <= 2 }). The method, + # proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information - # + # See ActiveModel::Validation#validates! for more information. def validates_presence_of(*attr_names) validates_with PresenceValidator, _merge_attributes(attr_names) end -- cgit v1.2.3 From a9e66c62e987e163cb80cd1dd71c1a2d4c7ce2b7 Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Wed, 16 May 2012 08:56:31 -0500 Subject: fixing validates_with docs --- activemodel/lib/active_model/validations/with.rb | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'activemodel/lib/active_model') diff --git a/activemodel/lib/active_model/validations/with.rb b/activemodel/lib/active_model/validations/with.rb index 991c5f7b82..66cc9daa2c 100644 --- a/activemodel/lib/active_model/validations/with.rb +++ b/activemodel/lib/active_model/validations/with.rb @@ -62,8 +62,8 @@ module ActiveModel # :unless => Proc.new { |user| user.signup_step <= 2 }). # The method, proc or string should return or evaluate to a true or false value. # * :strict - Specifies whether validation should be strict. - # See ActiveModel::Validation#validates! for more information - + # See ActiveModel::Validation#validates! for more information. + # # If you pass any additional configuration options, they will be passed # to the class and available as options: # @@ -77,7 +77,6 @@ module ActiveModel # options[:my_custom_key] # => "my custom value" # end # end - # def validates_with(*args, &block) options = args.extract_options! args.each do |klass| @@ -128,12 +127,11 @@ module ActiveModel # Standard configuration options (:on, :if and :unless), 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 + # 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 - # + # class version of this method for more information. def validates_with(*args, &block) options = args.extract_options! args.each do |klass| -- cgit v1.2.3 From 3004bc24706ed62ea7e4e752adc287dc92d168f5 Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Wed, 16 May 2012 10:01:43 -0500 Subject: fixing removed empty lines and examples --- activemodel/lib/active_model/validations/acceptance.rb | 1 + activemodel/lib/active_model/validations/confirmation.rb | 1 + activemodel/lib/active_model/validations/exclusion.rb | 10 ++++------ activemodel/lib/active_model/validations/format.rb | 1 + activemodel/lib/active_model/validations/inclusion.rb | 1 + activemodel/lib/active_model/validations/length.rb | 1 + activemodel/lib/active_model/validations/numericality.rb | 1 + activemodel/lib/active_model/validations/presence.rb | 1 + 8 files changed, 11 insertions(+), 6 deletions(-) (limited to 'activemodel/lib/active_model') diff --git a/activemodel/lib/active_model/validations/acceptance.rb b/activemodel/lib/active_model/validations/acceptance.rb index 7ce7700079..38abd0c1fa 100644 --- a/activemodel/lib/active_model/validations/acceptance.rb +++ b/activemodel/lib/active_model/validations/acceptance.rb @@ -1,4 +1,5 @@ module ActiveModel + # == Active Model Acceptance Validator module Validations class AcceptanceValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/confirmation.rb b/activemodel/lib/active_model/validations/confirmation.rb index c591dba609..ede34d15bc 100644 --- a/activemodel/lib/active_model/validations/confirmation.rb +++ b/activemodel/lib/active_model/validations/confirmation.rb @@ -1,4 +1,5 @@ module ActiveModel + # == Active Model Confirmation Validator module Validations class ConfirmationValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/exclusion.rb b/activemodel/lib/active_model/validations/exclusion.rb index 4a6a45ecf3..4f09679541 100644 --- a/activemodel/lib/active_model/validations/exclusion.rb +++ b/activemodel/lib/active_model/validations/exclusion.rb @@ -1,6 +1,7 @@ require "active_model/validations/clusivity" module ActiveModel + # == Active Model Exclusion Validator module Validations class ExclusionValidator < EachValidator @@ -18,12 +19,9 @@ module ActiveModel # 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 diff --git a/activemodel/lib/active_model/validations/format.rb b/activemodel/lib/active_model/validations/format.rb index dae6a01829..dd87e312f9 100644 --- a/activemodel/lib/active_model/validations/format.rb +++ b/activemodel/lib/active_model/validations/format.rb @@ -1,4 +1,5 @@ module ActiveModel + # == Active Model Format Validator module Validations class FormatValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/inclusion.rb b/activemodel/lib/active_model/validations/inclusion.rb index be1e6160f1..ffdbed0fc1 100644 --- a/activemodel/lib/active_model/validations/inclusion.rb +++ b/activemodel/lib/active_model/validations/inclusion.rb @@ -1,6 +1,7 @@ require "active_model/validations/clusivity" module ActiveModel + # == Active Model Inclusion Validator module Validations class InclusionValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/length.rb b/activemodel/lib/active_model/validations/length.rb index 4a9a6ea7a5..64b4fe2d74 100644 --- a/activemodel/lib/active_model/validations/length.rb +++ b/activemodel/lib/active_model/validations/length.rb @@ -1,4 +1,5 @@ module ActiveModel + # == Active Model Length Validator module Validations class LengthValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/numericality.rb b/activemodel/lib/active_model/validations/numericality.rb index 78c25f70f2..40b5b92b84 100644 --- a/activemodel/lib/active_model/validations/numericality.rb +++ b/activemodel/lib/active_model/validations/numericality.rb @@ -1,4 +1,5 @@ module ActiveModel + # == Active Model Numericality Validator module Validations class NumericalityValidator < EachValidator diff --git a/activemodel/lib/active_model/validations/presence.rb b/activemodel/lib/active_model/validations/presence.rb index e606f74757..018ef1e733 100644 --- a/activemodel/lib/active_model/validations/presence.rb +++ b/activemodel/lib/active_model/validations/presence.rb @@ -1,6 +1,7 @@ require 'active_support/core_ext/object/blank' module ActiveModel + # == Active Model Presence Validator module Validations class PresenceValidator < EachValidator -- cgit v1.2.3