| 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 254
254: def condition_block?(condition)
255: condition.respond_to?("call") && (condition.arity == 1 || condition.arity == -1)
256: end
Creates an object just like Base.create but calls save! instead of save so an exception is raised if the record is invalid.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 692
692: def create!(attributes = nil)
693: if attributes.is_a?(Array)
694: attributes.collect { |attr| create!(attr) }
695: else
696: attributes.reverse_merge!(scope(:create)) if scoped?(:create)
697:
698: object = new(attributes)
699: object.save!
700: object
701: end
702: 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 260
260: def evaluate_condition(condition, record)
261: case condition
262: when Symbol: record.send(condition)
263: when String: eval(condition, binding)
264: else
265: if condition_block?(condition)
266: condition.call(record)
267: else
268: raise(
269: ActiveRecordError,
270: "Validations need to be either a symbol, string (to be eval'ed), proc/method, or " +
271: "class implementing a static validation method"
272: )
273: end
274: end
275: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 239
239: def validate(*methods, &block)
240: methods << block if block_given?
241: write_inheritable_set(:validate, methods)
242: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 244
244: def validate_on_create(*methods, &block)
245: methods << block if block_given?
246: write_inheritable_set(:validate_on_create, methods)
247: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 249
249: def validate_on_update(*methods, &block)
250: methods << block if block_given?
251: write_inheritable_set(:validate_on_update, methods)
252: 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 359
359: def validates_acceptance_of(*attr_names)
360: configuration = { :message => ActiveRecord::Errors.default_error_messages[:accepted], :on => :save, :allow_nil => true, :accept => "1" }
361: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
362:
363: attr_accessor *attr_names
364:
365: validates_each(attr_names,configuration) do |record, attr_name, value|
366: record.errors.add(attr_name, configuration[:message]) unless value == configuration[:accept]
367: end
368: end
Validates whether the associated object or objects are all valid themselves. 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 642
642: def validates_associated(*attr_names)
643: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save }
644: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
645:
646: validates_each(attr_names, configuration) do |record, attr_name, value|
647: record.errors.add(attr_name, configuration[:message]) unless
648: (value.is_a?(Array) ? value : [value]).all? { |r| r.nil? or r.valid? }
649: end
650: 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 330
330: def validates_confirmation_of(*attr_names)
331: configuration = { :message => ActiveRecord::Errors.default_error_messages[:confirmation], :on => :save }
332: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
333:
334: attr_accessor *(attr_names.map { |n| "#{n}_confirmation" })
335:
336: validates_each(attr_names, configuration) do |record, attr_name, value|
337: record.errors.add(attr_name, configuration[:message]) unless record.send("#{attr_name}_confirmation").nil? or value == record.send("#{attr_name}_confirmation")
338: end
339: end
Validates each attribute against a block.
class Person < ActiveRecord::Base
validates_each :first_name, :last_name do |record, attr, value|
record.errors.add attr, 'starts with z.' if value[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 291
291: def validates_each(*attrs)
292: options = attrs.last.is_a?(Hash) ? attrs.pop.symbolize_keys : {}
293: attrs = attrs.flatten
294:
295: # Declare the validation.
296: send(validation_method(options[:on] || :save)) do |record|
297: # Don't validate when there is an :if condition and that condition is false
298: unless options[:if] && !evaluate_condition(options[:if], record)
299: attrs.each do |attr|
300: value = record.send(attr)
301: next if value.nil? && options[:allow_nil]
302: yield record, attr, value
303: end
304: end
305: end
306: 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 602
602: def validates_exclusion_of(*attr_names)
603: configuration = { :message => ActiveRecord::Errors.default_error_messages[:exclusion], :on => :save }
604: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
605:
606: enum = configuration[:in] || configuration[:within]
607:
608: 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?")
609:
610: validates_each(attr_names, configuration) do |record, attr_name, value|
611: record.errors.add(attr_name, configuration[:message]) if enum.include?(value)
612: end
613: 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,})$/i, :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 550
550: def validates_format_of(*attr_names)
551: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save, :with => nil }
552: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
553:
554: raise(ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash") unless configuration[:with].is_a?(Regexp)
555:
556: validates_each(attr_names, configuration) do |record, attr_name, value|
557: record.errors.add(attr_name, configuration[:message]) unless value.to_s =~ configuration[:with]
558: end
559: 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 575
575: def validates_inclusion_of(*attr_names)
576: configuration = { :message => ActiveRecord::Errors.default_error_messages[:inclusion], :on => :save }
577: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
578:
579: enum = configuration[:in] || configuration[:within]
580:
581: 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?")
582:
583: validates_each(attr_names, configuration) do |record, attr_name, value|
584: record.errors.add(attr_name, configuration[:message]) unless enum.include?(value)
585: end
586: 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 426
426: def validates_length_of(*attrs)
427: # Merge given options with defaults.
428: options = {
429: :too_long => ActiveRecord::Errors.default_error_messages[:too_long],
430: :too_short => ActiveRecord::Errors.default_error_messages[:too_short],
431: :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length]
432: }.merge(DEFAULT_VALIDATION_OPTIONS)
433: options.update(attrs.pop.symbolize_keys) if attrs.last.is_a?(Hash)
434:
435: # Ensure that one and only one range option is specified.
436: range_options = ALL_RANGE_OPTIONS & options.keys
437: case range_options.size
438: when 0
439: raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
440: when 1
441: # Valid number of options; do nothing.
442: else
443: raise ArgumentError, 'Too many range options specified. Choose only one.'
444: end
445:
446: # Get range option and value.
447: option = range_options.first
448: option_value = options[range_options.first]
449:
450: case option
451: when :within, :in
452: raise ArgumentError, ":#{option} must be a Range" unless option_value.is_a?(Range)
453:
454: too_short = options[:too_short] % option_value.begin
455: too_long = options[:too_long] % option_value.end
456:
457: validates_each(attrs, options) do |record, attr, value|
458: if value.nil? or value.split(//).size < option_value.begin
459: record.errors.add(attr, too_short)
460: elsif value.split(//).size > option_value.end
461: record.errors.add(attr, too_long)
462: end
463: end
464: when :is, :minimum, :maximum
465: raise ArgumentError, ":#{option} must be a nonnegative Integer" unless option_value.is_a?(Integer) and option_value >= 0
466:
467: # Declare different validations per option.
468: validity_checks = { :is => "==", :minimum => ">=", :maximum => "<=" }
469: message_options = { :is => :wrong_length, :minimum => :too_short, :maximum => :too_long }
470:
471: message = (options[:message] || options[message_options[option]]) % option_value
472:
473: validates_each(attrs, options) do |record, attr, value|
474: if value.kind_of?(String)
475: record.errors.add(attr, message) unless !value.nil? and value.split(//).size.method(validity_checks[option])[option_value]
476: else
477: record.errors.add(attr, message) unless !value.nil? and value.size.method(validity_checks[option])[option_value]
478: end
479: end
480: end
481: 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 668
668: def validates_numericality_of(*attr_names)
669: configuration = { :message => ActiveRecord::Errors.default_error_messages[:not_a_number], :on => :save,
670: :only_integer => false, :allow_nil => false }
671: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
672:
673: if configuration[:only_integer]
674: validates_each(attr_names,configuration) do |record, attr_name,value|
675: record.errors.add(attr_name, configuration[:message]) unless record.send("#{attr_name}_before_type_cast").to_s =~ /^[+-]?\d+$/
676: end
677: else
678: validates_each(attr_names,configuration) do |record, attr_name,value|
679: next if configuration[:allow_nil] and record.send("#{attr_name}_before_type_cast").nil?
680: begin
681: Kernel.Float(record.send("#{attr_name}_before_type_cast").to_s)
682: rescue ArgumentError, TypeError
683: record.errors.add(attr_name, configuration[:message])
684: end
685: end
686: end
687: end
Validates that the specified attributes are not blank (as defined by Object#blank?). Happens by default on save. Example:
class Person < ActiveRecord::Base
validates_presence_of :first_name
end
The first_name attribute must be in the object and it cannot be blank.
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 384
384: def validates_presence_of(*attr_names)
385: configuration = { :message => ActiveRecord::Errors.default_error_messages[:blank], :on => :save }
386: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
387:
388: # can't use validates_each here, because it cannot cope with nonexistent attributes,
389: # while errors.add_on_empty can
390: attr_names.each do |attr_name|
391: send(validation_method(configuration[:on])) do |record|
392: unless configuration[:if] and not evaluate_condition(configuration[:if], record)
393: record.errors.add_on_blank(attr_name,configuration[:message])
394: end
395: end
396: end
397: 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
It can also validate whether the value of the specified attributes are unique based on multiple scope parameters. For example, making sure that a teacher can only be on the schedule once per semester for a particular class.
class TeacherSchedule < ActiveRecord::Base
validates_uniqueness_of :teacher_id, :scope => [:semester_id, :class_id]
end
When the record is created, a check is performed to make sure that no record exists 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 510
510: def validates_uniqueness_of(*attr_names)
511: configuration = { :message => ActiveRecord::Errors.default_error_messages[:taken] }
512: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
513:
514: validates_each(attr_names,configuration) do |record, attr_name, value|
515: condition_sql = "#{record.class.table_name}.#{attr_name} #{attribute_condition(value)}"
516: condition_params = [value]
517: if scope = configuration[:scope]
518: Array(scope).map do |scope_item|
519: scope_value = record.send(scope_item)
520: condition_sql << " AND #{record.class.table_name}.#{scope_item} #{attribute_condition(scope_value)}"
521: condition_params << scope_value
522: end
523: end
524: unless record.new_record?
525: condition_sql << " AND #{record.class.table_name}.#{record.class.primary_key} <> ?"
526: condition_params << record.send(:id)
527: end
528: if record.class.find(:first, :conditions => [condition_sql, *condition_params])
529: record.errors.add(attr_name, configuration[:message])
530: end
531: end
532: end