Module: Mongoid::Validatable::Macros

Extended by:
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.

Instance Method Summary collapse

Instance Method Details

#validates_associated(*args) ⇒ Object

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:

  • *args (Object...) —

    The arguments to pass to the validator.



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

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

#validates_format_of(*args) ⇒ Object

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:

  • *args (Object...) —

    The names of the field(s) to validate.



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

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

#validates_length_of(*args) ⇒ Object

Validates the length of a field.

Examples:

class Person
  include Mongoid::Document
  field :title

  validates_length_of :title, minimum: 100
end

Parameters:

  • *args (Object...) —

    The names of the field(s) to validate.



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

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

#validates_presence_of(*args) ⇒ Object

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:

  • *args (Object...) —

    The names of the field(s) to validate.



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

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

#validates_uniqueness_of(*args) ⇒ Object

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:

  • *args (Object...) —

    The arguments to pass to the validator.



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

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