module Mongoid::Validatable::Macros

Mixin module included in Mongoid::Document which adds various validation macro methods, such as validates_presence_of and validates_uniqueness_of.

Public Instance Methods

validates_associated(*args) click to toggle source

Validates whether or not an association is valid or not. Will correctly handle has one and has many associations.

@example

class Person
  include Mongoid::Document
  embeds_one :name
  embeds_many :addresses

  validates_associated :name, :addresses
end

@param [ Object… ] *args The arguments to pass to the validator.

# File lib/mongoid/validatable/macros.rb, line 27
def validates_associated(*args)
  validates_with(AssociatedValidator, _merge_attributes(args))
end
validates_format_of(*args) click to toggle source

Validates the format of a field.

@example

class Person
  include Mongoid::Document
  field :title

  validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
end

@param [ Object… ] *args The names of the field(s) to validate.

# File lib/mongoid/validatable/macros.rb, line 59
def validates_format_of(*args)
  validates_with(FormatValidator, _merge_attributes(args))
end
validates_length_of(*args) click to toggle source

Validates the length of a field.

@example

class Person
  include Mongoid::Document
  field :title

  validates_length_of :title, minimum: 100
end

@param [ Object… ] *args The names of the field(s) to validate.

# File lib/mongoid/validatable/macros.rb, line 74
def validates_length_of(*args)
  validates_with(LengthValidator, _merge_attributes(args))
end
validates_presence_of(*args) click to toggle source

Validates whether or not a field is present - meaning nil or empty.

@example

class Person
  include Mongoid::Document
  field :title

  validates_presence_of :title
end

@param [ Object… ] *args The names of the field(s) to validate.

# File lib/mongoid/validatable/macros.rb, line 89
def validates_presence_of(*args)
  validates_with(PresenceValidator, _merge_attributes(args))
end
validates_uniqueness_of(*args) click to toggle source

Validates whether or not a field is unique against the documents in the database.

@example

class Person
  include Mongoid::Document
  field :title

  validates_uniqueness_of :title
end

@param [ Object… ] *args The arguments to pass to the validator.

# File lib/mongoid/validatable/macros.rb, line 44
def validates_uniqueness_of(*args)
  validates_with(UniquenessValidator, _merge_attributes(args))
end