123456789_123456789_123456789_123456789_123456789_

Module: ActiveRecord::Validations

Overview

Active Record includes the majority of its validations from ::ActiveModel::Validations.

In Active Record, all validations are performed on save by default. Validations accept the :on argument to define the context where the validations are active. Active Record will pass either the context of :create or :update depending on whether the model is a new_record?.

::ActiveModel::Validations - Attributes & Methods

Class Method Summary

::ActiveModel::Callbacks - self

extended

::ActiveModel::Naming - self

param_key

Returns string to use for params names.
plural

Returns the plural class name of a record or class.
route_key

Returns string to use while generating route names.
singular

Returns the singular class name of a record or class.
singular_route_key

Returns string to use while generating route names.
uncountable?

Identifies whether the class name of a record or class is uncountable.
extended, model_name_from_record_or_class

::ActiveSupport::Concern - Extended

class_methods

Define class methods from given block.
included

Evaluate given block in context of base class, so that you can write class macros here.
prepended

Evaluate given block in context of base class, so that you can write class macros here.
append_features, prepend_features

Instance Method Summary

::ActiveModel::Validations::HelperMethods - self

#validates_absence_of

Validates that the specified attributes are blank (as defined by Object#present?).
#validates_acceptance_of

Encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement).
#validates_comparison_of

Validates the value of a specified attribute fulfills all defined comparisons with another value, proc, or attribute.
#validates_confirmation_of

Encapsulates the pattern of wanting to validate a password or email address field with a confirmation.
#validates_exclusion_of

Validates that the value of the specified attribute is not in a particular enumerable object.
#validates_format_of

Validates whether the value of the specified attribute is of the correct form, going by the regular expression provided.
#validates_inclusion_of

Validates whether the value of the specified attribute is available in a particular enumerable object.
#validates_length_of

Validates that the specified attributes match the length restrictions supplied.
#validates_numericality_of

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_presence_of

Validates that the specified attributes are not blank (as defined by Object#blank?).
#validates_size_of

Alias for ActiveModel::Validations::HelperMethods#validates_length_of.
#_merge_attributes

::ActiveModel::Validations - Included

#errors

Returns the Errors object that holds all information about attribute error messages.
#invalid?

Performs the opposite of #valid?.
#read_attribute_for_validation

Hook method defining how an attribute value should be retrieved.
#valid?

Runs all the specified validations and returns true if no errors were added otherwise false.
#validate

Alias for ActiveModel::Validations#valid?.
#validate!

Runs all the validations within the specified context.
#validates_with

Passes the record off to the class or classes specified and allows them to add errors based on more complex conditions.
#init_internals, #raise_validation_error, #run_validations!,
#initialize_dup

Clean the Errors object if instance is duped.

Class Attribute Details

._validators (rw)

[ GitHub ] 

  


# File 'activemodel/lib/active_model/validations.rb', line 71



class_attribute :_validators, instance_writer: false, default: Hash.new { |h, k| h[k] = [] }


  








  

    ._validators?  ⇒ Boolean  (rw)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/validations.rb', line 71



class_attribute :_validators, instance_writer: false, default: Hash.new { |h, k| h[k] = [] }


  







Instance Attribute Details



  

    #_validators   (readonly)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/validations.rb', line 71



class_attribute :_validators, instance_writer: false, default: Hash.new { |h, k| h[k] = [] }


  








  

    #_validators?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/validations.rb', line 71



class_attribute :_validators, instance_writer: false, default: Hash.new { |h, k| h[k] = [] }


  








  

    #validation_context   (rw)
  



  

    

Returns the context when running validations.



This is useful when running validations except a certain context (opposite to the on option).



class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates :name, presence: true, if: -> { validation_context != :custom }
end

person = Person.new
person.valid?          #=> false
person.valid?(:new)    #=> false
person.valid?(:custom) #=> true


  



  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/validations.rb', line 49



rdoc_method :method: validation_context


  







Instance Method Details



  

    #default_validation_context   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 79



def default_validation_context
  new_record? ? :create : :update
end


  








  

    #perform_validations(options = {})   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 87



def perform_validations(options = {})
  options[:validate] == false || valid?(options[:context])
end


  








  

    #raise_validation_error   (private)
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 83



def raise_validation_error
  raise(RecordInvalid.new(self))
end


  








  

    #save(**options)  
  



  

    

The validation process on save can be skipped by passing validate: false. The validation context can be changed by passing context: context. The regular {ActiveRecord::Base#save} method is replaced with this when the validations module is mixed in, which it is by default.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 48



def save(**options)
  perform_validations(options) ? super : false
end


  








  

    #save!(**options)  
  



  

    

Attempts to save the record just like {ActiveRecord::Base#save} but will raise an RecordInvalid exception instead of returning false if the record is not valid.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 54



def save!(**options)
  perform_validations(options) ? super : raise_validation_error
end


  








  

    #valid?(context = nil)  ⇒ Boolean 
    Also known as: #validate
  



  

    

Runs all the validations within the specified context. Returns true if no errors are found, false otherwise.



Aliased as #validate.



If the argument is false (default is nil), the context is set to :create if new_record? is true, and to :update if it is not. If the argument is an array of contexts, post.valid?([:create, :update]), the validations are run within multiple contexts.



Validations with no :on option will run no matter the context. Validations with some :on option will only run in the specified context.


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 70



def valid?(context = nil)
  context ||= default_validation_context
  output = super(context)
  errors.empty? && output
end


  








  

    #validate(context = nil)  
  



  

    

Alias for #valid?.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/validations.rb', line 76



alias_method :validate, :valid?