Module: Mongoid::Document::ClassMethods

Defined in:
lib/mongoid/document.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#===(other) ⇒ true, false

Performs class equality checking.

Examples:

Compare the classes.

document === other

Parameters:

Returns:

  • (true, false) —

    True if the classes are equal, false if not.

Since:

  • 2.0.0.rc.4



278
279
280
 
# File 'lib/mongoid/document.rb', line 278

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

#_types ⇒ Array<Class>

Returns all types to query for when using this class as the base.

Examples:

Get the types.

document._types

Returns:

  • (Array<Class>) —

    All subclasses of the current document.



307
308
309
 
# File 'lib/mongoid/document.rb', line 307

def _types
  @_type ||= [descendants + [self]].flatten.uniq.map { |t| t.to_s }
end

#i18n_scope ⇒ Symbol

Set the i18n scope to overwrite ActiveModel.

Returns:



314
315
316
 
# File 'lib/mongoid/document.rb', line 314

def i18n_scope
  :mongoid
end

#instantiate(attrs = nil) ⇒ Document

Instantiate a new object, only when loaded from the database or when the attributes have already been typecast.

Examples:

Create the document.

Person.instantiate(:title => "Sir", :age => 30)

Parameters:

  • attrs (Hash) (defaults to: nil) —

    The hash of attributes to instantiate with.

Returns:



291
292
293
294
295
296
297
298
299
 
# File 'lib/mongoid/document.rb', line 291

def instantiate(attrs = nil)
  attributes = attrs || {}
  allocate.tap do |doc|
    doc.instance_variable_set(:@attributes, attributes)
    doc.apply_defaults
    IdentityMap.set(doc) unless _loading_revision?
    doc.run_callbacks(:initialize) { doc }
  end
end

#logger ⇒ Logger

Returns the logger

Examples:

Get the logger.

Person.logger

Returns:

  • (Logger) —

    The configured logger or a default Logger instance.

Since:

  • 2.2.0



326
327
328
 
# File 'lib/mongoid/document.rb', line 326

def logger
  Mongoid.logger
end