Module: Mongoid::Equality

Included in:
Composable
Defined in:
lib/mongoid/equality.rb

Overview

This module contains the behaviour of Mongoid's clone/dup of documents.

Instance Method Summary collapse

Instance Method Details

#<=>(other) ⇒ Integer

Default comparison is via the string version of the id.

Examples:

Compare two documents.

person <=> other_person

Parameters:

  • other (Document)

    The document to compare with.

Returns:

  • (Integer)

    -1, 0, 1.

Since:

  • 1.0.0


17
18
19
# File 'lib/mongoid/equality.rb', line 17

def <=>(other)
  attributes["_id"].to_s <=> other.attributes["_id"].to_s
end

#==(other) ⇒ true, false

Performs equality checking on the document ids. For more robust equality checking please override this method.

Examples:

Compare for equality.

document == other

Parameters:

  • other (Document, Object)

    The other object to compare with.

Returns:

  • (true, false)

    True if the ids are equal, false if not.

Since:

  • 1.0.0


32
33
34
35
# File 'lib/mongoid/equality.rb', line 32

def ==(other)
  self.class == other.class &&
      attributes["_id"] == other.attributes["_id"]
end

#===(other) ⇒ true, false

Performs class equality checking.

Examples:

Compare the classes.

document === other

Parameters:

  • other (Document, Object)

    The other object to compare with.

Returns:

  • (true, false)

    True if the classes are equal, false if not.

Since:

  • 1.0.0


47
48
49
# File 'lib/mongoid/equality.rb', line 47

def ===(other)
  other.class == Class ? self.class === other : self == other
end

#eql?(other) ⇒ true, false

Delegates to ==. Used when needing checks in hashes.

Examples:

Perform equality checking.

document.eql?(other)

Parameters:

  • other (Document, Object)

    The object to check against.

Returns:

  • (true, false)

    True if equal, false if not.

Since:

  • 1.0.0


61
62
63
# File 'lib/mongoid/equality.rb', line 61

def eql?(other)
  self == (other)
end