Class: Mongoid::Validatable::UniquenessValidator

Inherits:
ActiveModel::EachValidator
  • Object
show all
Includes:
Queryable
Defined in:
lib/mongoid/validatable/uniqueness.rb

Overview

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

Examples:

Define the uniqueness validator.


class Person
  include Mongoid::Document
  field :title

  validates_uniqueness_of :title
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Queryable

#with_query

Instance Attribute Details

#klass ⇒ Object (readonly)

Returns the value of attribute klass.



19
20
21
 
# File 'lib/mongoid/validatable/uniqueness.rb', line 19

def klass
  @klass
end

Instance Method Details

#setup(klass) ⇒ Object

Unfortunately, we have to tie Uniqueness validators to a class.

UniquenessValidator.new.setup(Person)

Examples:

Setup the validator.

Parameters:

  • klass (Class) —

    The class getting validated.

Since:

  • 1.0.0



29
30
31
 
# File 'lib/mongoid/validatable/uniqueness.rb', line 29

def setup(klass)
  @klass = klass
end

#validate_each(document, attribute, value) ⇒ Errors

Validate the document for uniqueness violations.

Examples:

Validate the document.

validate_each(person, :title, "Sir")

Parameters:

  • document (Document) —

    The document to validate.

  • attribute (Symbol) —

    The field to validate on.

  • value (Object) —

    The value of the field.

Returns:

Since:

  • 1.0.0



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/mongoid/validatable/uniqueness.rb', line 45

def validate_each(document, attribute, value)
  with_query(document) do
    attrib, val = to_validate(document, attribute, value)
    return unless validation_required?(document, attrib)
    if document.embedded?
      validate_embedded(document, attrib, val)
    else
      validate_root(document, attrib, val)
    end
  end
end