Module: ActiveModel::Validations

Extended by:
ActiveSupport::Concern
Included in:
Model, ActiveRecord::Validations
Defined in:
activemodel/lib/active_model/validations.rb,
activemodel/lib/active_model/validations/with.rb,
activemodel/lib/active_model/validations/format.rb,
activemodel/lib/active_model/validations/length.rb,
activemodel/lib/active_model/validations/absence.rb,
activemodel/lib/active_model/validations/presence.rb,
activemodel/lib/active_model/validations/callbacks.rb,
activemodel/lib/active_model/validations/clusivity.rb,
activemodel/lib/active_model/validations/exclusion.rb,
activemodel/lib/active_model/validations/inclusion.rb,
activemodel/lib/active_model/validations/validates.rb,
activemodel/lib/active_model/validations/acceptance.rb,
activemodel/lib/active_model/validations/confirmation.rb,
activemodel/lib/active_model/validations/numericality.rb

Overview

Active Model Length Validator

Defined Under Namespace

Modules: Callbacks, ClassMethods, Clusivity, HelperMethods Classes: AbsenceValidator, AcceptanceValidator, ConfirmationValidator, ExclusionValidator, FormatValidator, InclusionValidator, LengthValidator, NumericalityValidator, PresenceValidator, WithValidator

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Instance Method Details

#errorsObject

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

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates_presence_of :name
end

person = Person.new
person.valid? # => false
person.errors # => #<ActiveModel::Errors:0x007fe603816640 @messages={name:["can't be blank"]}>

300
301
302
# File 'activemodel/lib/active_model/validations.rb', line 300

def errors
  @errors ||= Errors.new(self)
end

#initialize_dup(other) ⇒ Object

Clean the Errors object if instance is duped.


282
283
284
285
# File 'activemodel/lib/active_model/validations.rb', line 282

def initialize_dup(other) #:nodoc:
  @errors = nil
  super
end

#invalid?(context = nil) ⇒ Boolean

Performs the opposite of valid?. Returns true if errors were added, false otherwise.

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates_presence_of :name
end

person = Person.new
person.name = ''
person.invalid? # => true
person.name = 'david'
person.invalid? # => false

Context can optionally be supplied to define which callbacks to test against (the context is defined on the validations using :on).

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates_presence_of :name, on: :new
end

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

Returns:

  • (Boolean)

374
375
376
# File 'activemodel/lib/active_model/validations.rb', line 374

def invalid?(context = nil)
  !valid?(context)
end

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

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

Aliased as validate.

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates_presence_of :name
end

person = Person.new
person.name = ''
person.valid? # => false
person.name = 'david'
person.valid? # => true

Context can optionally be supplied to define which callbacks to test against (the context is defined on the validations using :on).

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates_presence_of :name, on: :new
end

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

Returns:

  • (Boolean)

335
336
337
338
339
340
341
# File 'activemodel/lib/active_model/validations.rb', line 335

def valid?(context = nil)
  current_context, self.validation_context = validation_context, context
  errors.clear
  run_validations!
ensure
  self.validation_context = current_context
end

#validates_with(*args, &block) ⇒ Object

Passes the record off to the class or classes specified and allows them to add errors based on more complex conditions.

class Person
  include ActiveModel::Validations

  validate :instance_validations

  def instance_validations
    validates_with MyValidator
  end
end

Please consult the class method documentation for more information on creating your own validator.

You may also pass it multiple classes, like so:

class Person
  include ActiveModel::Validations

  validate :instance_validations, on: :create

  def instance_validations
    validates_with MyValidator, MyOtherValidator
  end
end

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.

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.


143
144
145
146
147
148
149
150
151
# File 'activemodel/lib/active_model/validations/with.rb', line 143

def validates_with(*args, &block)
  options = args.extract_options!
  options[:class] = self.class

  args.each do |klass|
    validator = klass.new(options, &block)
    validator.validate(self)
  end
end