Module | ActiveRecord::Validations::ClassMethods |
In: |
vendor/rails/activerecord/lib/active_record/validations.rb
|
All of the following validations are defined in the class scope of the model that you’re interested in validating. They offer a more declarative way of specifying when the model is valid and when it is not. It is recommended to use these over the low-level calls to validate and validate_on_create when possible.
DEFAULT_VALIDATION_OPTIONS | = | { :on => :save, :allow_nil => false, :message => nil |
ALL_RANGE_OPTIONS | = | [ :is, :within, :in, :minimum, :maximum ].freeze |
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 233 233: def condition_block?(condition) 234: condition.respond_to?("call") && (condition.arity == 1 || condition.arity == -1) 235: end
Determine from the given condition (whether a block, procedure, method or string) whether or not to validate the record. See validates_each.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 239 239: def evaluate_condition(condition, record) 240: case condition 241: when Symbol: record.send(condition) 242: when String: eval(condition, binding) 243: else 244: if condition_block?(condition) 245: condition.call(record) 246: else 247: raise( 248: ActiveRecordError, 249: "Validations need to be either a symbol, string (to be eval'ed), proc/method, or " + 250: "class implementing a static validation method" 251: ) 252: end 253: end 254: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 218 218: def validate(*methods, &block) 219: methods << block if block_given? 220: write_inheritable_set(:validate, methods) 221: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 223 223: def validate_on_create(*methods, &block) 224: methods << block if block_given? 225: write_inheritable_set(:validate_on_create, methods) 226: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 228 228: def validate_on_update(*methods, &block) 229: methods << block if block_given? 230: write_inheritable_set(:validate_on_update, methods) 231: end
Encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example:
class Person < ActiveRecord::Base validates_acceptance_of :terms_of_service validates_acceptance_of :eula, :message => "must be abided" end
The terms_of_service attribute is entirely virtual. No database column is needed. This check is performed only if terms_of_service is not nil and by default on save.
Configuration options:
makes it easy to relate to an HTML checkbox.
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 338 338: def validates_acceptance_of(*attr_names) 339: configuration = { :message => ActiveRecord::Errors.default_error_messages[:accepted], :on => :save, :allow_nil => true, :accept => "1" } 340: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 341: 342: attr_accessor *attr_names 343: 344: validates_each(attr_names,configuration) do |record, attr_name, value| 345: record.errors.add(attr_name, configuration[:message]) unless value == configuration[:accept] 346: end 347: end
Validates whether the associated object or objects are all themselves valid. Works with any kind of association.
class Book < ActiveRecord::Base has_many :pages belongs_to :library validates_associated :pages, :library end
Warning: If, after the above definition, you then wrote:
class Page < ActiveRecord::Base belongs_to :book validates_associated :book end
…this would specify a circular dependency and cause infinite recursion.
NOTE: This validation will not fail if the association hasn’t been assigned. If you want to ensure that the association is both present and guaranteed to be valid, you also need to use validates_presence_of.
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 585 585: def validates_associated(*attr_names) 586: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save } 587: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 588: 589: validates_each(attr_names, configuration) do |record, attr_name, value| 590: record.errors.add(attr_name, configuration[:message]) unless 591: (value.is_a?(Array) ? value : [value]).inject(true) { |memo, r| (r.nil? or r.valid?) and memo } 592: end 593: end
Encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example:
Model: class Person < ActiveRecord::Base validates_confirmation_of :user_name, :password validates_confirmation_of :email_address, :message => "should match confirmation" end View: <%= password_field "person", "password" %> <%= password_field "person", "password_confirmation" %>
The person has to already have a password attribute (a column in the people table), but the password_confirmation is virtual. It exists only as an in-memory variable for validating the password. This check is performed only if password_confirmation is not nil and by default on save.
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 309 309: def validates_confirmation_of(*attr_names) 310: configuration = { :message => ActiveRecord::Errors.default_error_messages[:confirmation], :on => :save } 311: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 312: 313: attr_accessor *(attr_names.map { |n| "#{n}_confirmation" }) 314: 315: validates_each(attr_names, configuration) do |record, attr_name, value| 316: record.errors.add(attr_name, configuration[:message]) unless record.send("#{attr_name}_confirmation").nil? or value == record.send("#{attr_name}_confirmation") 317: end 318: end
Validates each attribute against a block.
class Person < ActiveRecord::Base validates_each :first_name, :last_name do |record, attr| record.errors.add attr, 'starts with z.' if attr[0] == ?z end end
Options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 270 270: def validates_each(*attrs) 271: options = attrs.last.is_a?(Hash) ? attrs.pop.symbolize_keys : {} 272: attrs = attrs.flatten 273: 274: # Declare the validation. 275: send(validation_method(options[:on] || :save)) do |record| 276: # Don't validate when there is an :if condition and that condition is false 277: unless options[:if] && !evaluate_condition(options[:if], record) 278: attrs.each do |attr| 279: value = record.send(attr) 280: next if value.nil? && options[:allow_nil] 281: yield record, attr, value 282: end 283: end 284: end 285: end
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" end
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 545 545: def validates_exclusion_of(*attr_names) 546: configuration = { :message => ActiveRecord::Errors.default_error_messages[:exclusion], :on => :save } 547: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 548: 549: enum = configuration[:in] || configuration[:within] 550: 551: raise(ArgumentError, "An object with the method include? is required must be supplied as the :in option of the configuration hash") unless enum.respond_to?("include?") 552: 553: validates_each(attr_names, configuration) do |record, attr_name, value| 554: record.errors.add(attr_name, configuration[:message]) if enum.include?(value) 555: end 556: end
Validates whether the value of the specified attribute is of the correct form by matching it against the regular expression provided.
class Person < ActiveRecord::Base validates_format_of :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/, :on => :create end
A regular expression must be provided or else an exception will be raised.
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 493 493: def validates_format_of(*attr_names) 494: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save, :with => nil } 495: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 496: 497: raise(ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash") unless configuration[:with].is_a?(Regexp) 498: 499: validates_each(attr_names, configuration) do |record, attr_name, value| 500: record.errors.add(attr_name, configuration[:message]) unless value.to_s =~ configuration[:with] 501: end 502: end
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 ), :message=>"woah! what are you then!??!!" validates_inclusion_of :age, :in=>0..99 end
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 518 518: def validates_inclusion_of(*attr_names) 519: configuration = { :message => ActiveRecord::Errors.default_error_messages[:inclusion], :on => :save } 520: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 521: 522: enum = configuration[:in] || configuration[:within] 523: 524: raise(ArgumentError, "An object with the method include? is required must be supplied as the :in option of the configuration hash") unless enum.respond_to?("include?") 525: 526: validates_each(attr_names, configuration) do |record, attr_name, value| 527: record.errors.add(attr_name, configuration[:message]) unless enum.include?(value) 528: end 529: end
Validates that the specified attribute matches the length restrictions supplied. Only one option can be used at a time:
class Person < ActiveRecord::Base validates_length_of :first_name, :maximum=>30 validates_length_of :last_name, :maximum=>30, :message=>"less than %d if you don't mind" validates_length_of :fax, :in => 7..32, :allow_nil => true validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name" validates_length_of :fav_bra_size, :minimum=>1, :too_short=>"please enter at least %d character" validates_length_of :smurf_leader, :is=>4, :message=>"papa is spelled with %d characters... don't play me." end
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 399 399: def validates_length_of(*attrs) 400: # Merge given options with defaults. 401: options = {:too_long => ActiveRecord::Errors.default_error_messages[:too_long], 402: :too_short => ActiveRecord::Errors.default_error_messages[:too_short], 403: :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length]}.merge(DEFAULT_VALIDATION_OPTIONS) 404: options.update(attrs.pop.symbolize_keys) if attrs.last.is_a?(Hash) 405: 406: # Ensure that one and only one range option is specified. 407: range_options = ALL_RANGE_OPTIONS & options.keys 408: case range_options.size 409: when 0 410: raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.' 411: when 1 412: # Valid number of options; do nothing. 413: else 414: raise ArgumentError, 'Too many range options specified. Choose only one.' 415: end 416: 417: # Get range option and value. 418: option = range_options.first 419: option_value = options[range_options.first] 420: 421: # Declare different validations per option. 422: validity_checks = { :is => "==", :minimum => ">=", :maximum => "<=" } 423: message_options = { :is => :wrong_length, :minimum => :too_short, :maximum => :too_long } 424: 425: case option 426: when :within, :in 427: raise ArgumentError, ':within must be a Range' unless option_value.is_a?(Range) # ' 428: (options_without_range = options.dup).delete(option) 429: (options_with_minimum = options_without_range.dup).store(:minimum, option_value.begin) 430: validates_length_of attrs, options_with_minimum 431: (options_with_maximum = options_without_range.dup).store(:maximum, option_value.end) 432: validates_length_of attrs, options_with_maximum 433: when :is, :minimum, :maximum 434: raise ArgumentError, ":#{option} must be a nonnegative Integer" unless option_value.is_a?(Integer) and option_value >= 0 # ' 435: message = options[:message] || options[message_options[option]] 436: message = (message % option_value) rescue message 437: validates_each(attrs, options) do |record, attr, value| 438: record.errors.add(attr, message) if value.nil? or !value.size.method(validity_checks[option])[option_value] 439: end 440: end 441: end
Validates whether the value of the specified attribute is numeric by trying to convert it to a float with Kernel.Float (if integer is false) or applying it to the regular expression /^[+\-]?\d+$/ (if integer is set to true).
class Person < ActiveRecord::Base validates_numericality_of :value, :on => :create end
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 611 611: def validates_numericality_of(*attr_names) 612: configuration = { :message => ActiveRecord::Errors.default_error_messages[:not_a_number], :on => :save, 613: :only_integer => false, :allow_nil => false } 614: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 615: 616: if configuration[:only_integer] 617: validates_each(attr_names,configuration) do |record, attr_name,value| 618: record.errors.add(attr_name, configuration[:message]) unless record.send("#{attr_name}_before_type_cast").to_s =~ /^[+-]?\d+$/ 619: end 620: else 621: validates_each(attr_names,configuration) do |record, attr_name,value| 622: next if configuration[:allow_nil] and record.send("#{attr_name}_before_type_cast").nil? 623: begin 624: Kernel.Float(record.send("#{attr_name}_before_type_cast").to_s) 625: rescue ArgumentError, TypeError 626: record.errors.add(attr_name, configuration[:message]) 627: end 628: end 629: end 630: end
Validates that the specified attributes are not blank (as defined by Object#blank?). Happens by default on save.
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 357 357: def validates_presence_of(*attr_names) 358: configuration = { :message => ActiveRecord::Errors.default_error_messages[:blank], :on => :save } 359: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 360: 361: # can't use validates_each here, because it cannot cope with non-existant attributes, 362: # while errors.add_on_empty can 363: attr_names.each do |attr_name| 364: send(validation_method(configuration[:on])) do |record| 365: unless configuration[:if] and not evaluate_condition(configuration[:if], record) 366: record.errors.add_on_blank(attr_name,configuration[:message]) 367: end 368: end 369: end 370: end
Validates whether the value of the specified attributes are unique across the system. Useful for making sure that only one user can be named "davidhh".
class Person < ActiveRecord::Base validates_uniqueness_of :user_name, :scope => "account_id" end
When the record is created, a check is performed to make sure that no record exist in the database with the given value for the specified attribute (that maps to a column). When the record is updated, the same check is made but disregarding the record itself.
Configuration options:
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.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 462 462: def validates_uniqueness_of(*attr_names) 463: configuration = { :message => ActiveRecord::Errors.default_error_messages[:taken] } 464: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) 465: 466: if scope = configuration[:scope] 467: validates_each(attr_names,configuration) do |record, attr_name, value| 468: record.errors.add(attr_name, configuration[:message]) if record.class.find(:first, :conditions => (record.new_record? ? ["#{attr_name} = ? AND #{scope} = ?", record.send(attr_name), record.send(scope)] : ["#{attr_name} = ? AND #{record.class.primary_key} <> ? AND #{scope} = ?", record.send(attr_name), record.send(:id), record.send(scope)])) 469: end 470: else 471: validates_each(attr_names,configuration) do |record, attr_name, value| 472: record.errors.add(attr_name, configuration[:message]) if record.class.find(:first, :conditions => (record.new_record? ? ["#{attr_name} = ?", record.send(attr_name)] : ["#{attr_name} = ? AND #{record.class.primary_key} <> ?", record.send(attr_name), record.send(:id) ] )) 473: end 474: end 475: end