| 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 253
253: def condition_block?(condition)
254: condition.respond_to?("call") && (condition.arity == 1 || condition.arity == -1)
255: 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 716
716: def create!(attributes = nil)
717: if attributes.is_a?(Array)
718: attributes.collect { |attr| create!(attr) }
719: else
720: attributes ||= {}
721: attributes.reverse_merge!(scope(:create)) if scoped?(:create)
722:
723: object = new(attributes)
724: object.save!
725: object
726: end
727: 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 259
259: def evaluate_condition(condition, record)
260: case condition
261: when Symbol: record.send(condition)
262: when String: eval(condition, binding)
263: else
264: if condition_block?(condition)
265: condition.call(record)
266: else
267: raise(
268: ActiveRecordError,
269: "Validations need to be either a symbol, string (to be eval'ed), proc/method, or " +
270: "class implementing a static validation method"
271: )
272: end
273: end
274: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 238
238: def validate(*methods, &block)
239: methods << block if block_given?
240: write_inheritable_set(:validate, methods)
241: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 243
243: def validate_on_create(*methods, &block)
244: methods << block if block_given?
245: write_inheritable_set(:validate_on_create, methods)
246: end
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 248
248: def validate_on_update(*methods, &block)
249: methods << block if block_given?
250: write_inheritable_set(:validate_on_update, methods)
251: 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 666
666: def validates_associated(*attr_names)
667: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save }
668: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
669:
670: validates_each(attr_names, configuration) do |record, attr_name, value|
671: record.errors.add(attr_name, configuration[:message]) unless
672: (value.is_a?(Array) ? value : [value]).all? { |r| r.nil? or r.valid? }
673: end
674: 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 329
329: def validates_confirmation_of(*attr_names)
330: configuration = { :message => ActiveRecord::Errors.default_error_messages[:confirmation], :on => :save }
331: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
332:
333: attr_accessor *(attr_names.map { |n| "#{n}_confirmation" })
334:
335: validates_each(attr_names, configuration) do |record, attr_name, value|
336: confirm = record.send("#{attr_name}_confirmation")
337: record.errors.add(attr_name, configuration[:message]) unless value.nil? || value == confirm
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 290
290: def validates_each(*attrs)
291: options = attrs.last.is_a?(Hash) ? attrs.pop.symbolize_keys : {}
292: attrs = attrs.flatten
293:
294: # Declare the validation.
295: send(validation_method(options[:on] || :save)) do |record|
296: # Don't validate when there is an :if condition and that condition is false
297: unless options[:if] && !evaluate_condition(options[:if], record)
298: attrs.each do |attr|
299: value = record.send(attr)
300: next if value.nil? && options[:allow_nil]
301: yield record, attr, value
302: end
303: end
304: end
305: 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 626
626: def validates_exclusion_of(*attr_names)
627: configuration = { :message => ActiveRecord::Errors.default_error_messages[:exclusion], :on => :save }
628: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
629:
630: enum = configuration[:in] || configuration[:within]
631:
632: 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?")
633:
634: validates_each(attr_names, configuration) do |record, attr_name, value|
635: record.errors.add(attr_name, configuration[:message]) if enum.include?(value)
636: end
637: 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 574
574: def validates_format_of(*attr_names)
575: configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save, :with => nil }
576: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
577:
578: raise(ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash") unless configuration[:with].is_a?(Regexp)
579:
580: validates_each(attr_names, configuration) do |record, attr_name, value|
581: record.errors.add(attr_name, configuration[:message]) unless value.to_s =~ configuration[:with]
582: end
583: 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 599
599: def validates_inclusion_of(*attr_names)
600: configuration = { :message => ActiveRecord::Errors.default_error_messages[:inclusion], :on => :save }
601: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
602:
603: enum = configuration[:in] || configuration[:within]
604:
605: 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?")
606:
607: validates_each(attr_names, configuration) do |record, attr_name, value|
608: record.errors.add(attr_name, configuration[:message]) unless enum.include?(value)
609: end
610: 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 442
442: def validates_length_of(*attrs)
443: # Merge given options with defaults.
444: options = {
445: :too_long => ActiveRecord::Errors.default_error_messages[:too_long],
446: :too_short => ActiveRecord::Errors.default_error_messages[:too_short],
447: :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length]
448: }.merge(DEFAULT_VALIDATION_OPTIONS)
449: options.update(attrs.pop.symbolize_keys) if attrs.last.is_a?(Hash)
450:
451: # Ensure that one and only one range option is specified.
452: range_options = ALL_RANGE_OPTIONS & options.keys
453: case range_options.size
454: when 0
455: raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
456: when 1
457: # Valid number of options; do nothing.
458: else
459: raise ArgumentError, 'Too many range options specified. Choose only one.'
460: end
461:
462: # Get range option and value.
463: option = range_options.first
464: option_value = options[range_options.first]
465:
466: case option
467: when :within, :in
468: raise ArgumentError, ":#{option} must be a Range" unless option_value.is_a?(Range)
469:
470: too_short = options[:too_short] % option_value.begin
471: too_long = options[:too_long] % option_value.end
472:
473: validates_each(attrs, options) do |record, attr, value|
474: if value.nil? or value.split(//).size < option_value.begin
475: record.errors.add(attr, too_short)
476: elsif value.split(//).size > option_value.end
477: record.errors.add(attr, too_long)
478: end
479: end
480: when :is, :minimum, :maximum
481: raise ArgumentError, ":#{option} must be a nonnegative Integer" unless option_value.is_a?(Integer) and option_value >= 0
482:
483: # Declare different validations per option.
484: validity_checks = { :is => "==", :minimum => ">=", :maximum => "<=" }
485: message_options = { :is => :wrong_length, :minimum => :too_short, :maximum => :too_long }
486:
487: message = (options[:message] || options[message_options[option]]) % option_value
488:
489: validates_each(attrs, options) do |record, attr, value|
490: if value.kind_of?(String)
491: record.errors.add(attr, message) unless !value.nil? and value.split(//).size.method(validity_checks[option])[option_value]
492: else
493: record.errors.add(attr, message) unless !value.nil? and value.size.method(validity_checks[option])[option_value]
494: end
495: end
496: end
497: 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 692
692: def validates_numericality_of(*attr_names)
693: configuration = { :message => ActiveRecord::Errors.default_error_messages[:not_a_number], :on => :save,
694: :only_integer => false, :allow_nil => false }
695: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
696:
697: if configuration[:only_integer]
698: validates_each(attr_names,configuration) do |record, attr_name,value|
699: record.errors.add(attr_name, configuration[:message]) unless record.send("#{attr_name}_before_type_cast").to_s =~ /^[+-]?\d+$/
700: end
701: else
702: validates_each(attr_names,configuration) do |record, attr_name,value|
703: next if configuration[:allow_nil] and record.send("#{attr_name}_before_type_cast").nil?
704: begin
705: Kernel.Float(record.send("#{attr_name}_before_type_cast").to_s)
706: rescue ArgumentError, TypeError
707: record.errors.add(attr_name, configuration[:message])
708: end
709: end
710: end
711: 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.
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
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.
Validate the presence of the foreign key, not the instance variable itself. Do this:
validate_presence_of :invoice_id
Not this:
validate_presence_of :invoice
If you validate the presence of the associated object, you will get failures on saves when both the parent object and the child object are new.
# File vendor/rails/activerecord/lib/active_record/validations.rb, line 400
400: def validates_presence_of(*attr_names)
401: configuration = { :message => ActiveRecord::Errors.default_error_messages[:blank], :on => :save }
402: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
403:
404: # can't use validates_each here, because it cannot cope with nonexistent attributes,
405: # while errors.add_on_empty can
406: attr_names.each do |attr_name|
407: send(validation_method(configuration[:on])) do |record|
408: unless configuration[:if] and not evaluate_condition(configuration[:if], record)
409: record.errors.add_on_blank(attr_name,configuration[:message])
410: end
411: end
412: end
413: 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 527
527: def validates_uniqueness_of(*attr_names)
528: configuration = { :message => ActiveRecord::Errors.default_error_messages[:taken], :case_sensitive => true }
529: configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
530:
531: validates_each(attr_names,configuration) do |record, attr_name, value|
532: if value.nil? || (configuration[:case_sensitive] || !columns_hash[attr_name.to_s].text?)
533: condition_sql = "#{record.class.table_name}.#{attr_name} #{attribute_condition(value)}"
534: condition_params = [value]
535: else
536: condition_sql = "UPPER(#{record.class.table_name}.#{attr_name}) #{attribute_condition(value)}"
537: condition_params = [value.upcase]
538: end
539: if scope = configuration[:scope]
540: Array(scope).map do |scope_item|
541: scope_value = record.send(scope_item)
542: condition_sql << " AND #{record.class.table_name}.#{scope_item} #{attribute_condition(scope_value)}"
543: condition_params << scope_value
544: end
545: end
546: unless record.new_record?
547: condition_sql << " AND #{record.class.table_name}.#{record.class.primary_key} <> ?"
548: condition_params << record.send(:id)
549: end
550: if record.class.find(:first, :conditions => [condition_sql, *condition_params])
551: record.errors.add(attr_name, configuration[:message])
552: end
553: end
554: end