Module: Mongoid::Validatable::Macros

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::Mongoid::Document`, `::Mongoid::GlobalDiscriminatorKeyAssignment::InvalidFieldHost`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ActiveSupport::Concern
Defined in:	lib/mongoid/validatable/macros.rb

Overview

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

#validates_associated(*args)

Validates whether or not an association is valid or not.
#validates_format_of(*args)

Validates the format of a field.
#validates_length_of(*args)

Validates the length of a field.
#validates_presence_of(*args)

Validates whether or not a field is present - meaning nil or empty.
#validates_uniqueness_of(*args)

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

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

Examples:

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

  validates_associated :name, :addresses
end

Parameters:

[ GitHub ]

# File 'lib/mongoid/validatable/macros.rb', line 27


def validates_associated(*args)
  validates_with(AssociatedValidator, _merge_attributes(args))
end

Validates the format of a field.

Examples:

class Person
  include Mongoid::Document
  field :title

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

Parameters:

[ GitHub ]

# File 'lib/mongoid/validatable/macros.rb', line 59


def validates_format_of(*args)
  validates_with(FormatValidator, _merge_attributes(args))
end

Validates the length of a field.

Examples:

class Person
  include Mongoid::Document
  field :title

  validates_length_of :title, minimum: 100
end

Parameters:

[ GitHub ]

# File 'lib/mongoid/validatable/macros.rb', line 74


def validates_length_of(*args)
  validates_with(LengthValidator, _merge_attributes(args))
end

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

Examples:

class Person
  include Mongoid::Document
  field :title

  validates_presence_of :title
end

Parameters:

[ GitHub ]

# File 'lib/mongoid/validatable/macros.rb', line 89


def validates_presence_of(*args)
  validates_with(PresenceValidator, _merge_attributes(args))
end

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

Examples:

class Person
  include Mongoid::Document
  field :title

  validates_uniqueness_of :title
end

Parameters:

[ GitHub ]

# File 'lib/mongoid/validatable/macros.rb', line 44


def validates_uniqueness_of(*args)
  validates_with(UniquenessValidator, _merge_attributes(args))
end