Module: Mongoid::Document::ClassMethods

Defined in:
build/mongoid-7.3/lib/mongoid/document.rb

Instance Method Summary collapse

Instance Method Details

#===(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:

  • 2.0.0.rc.4



306
307
308
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 306

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

#_mongoid_clear_types ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Clear the @_type cache. This is generally called when changing the discriminator key/value on a class.

Examples:

Get the types.

document._mongoid_clear_types


354
355
356
357
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 354

def _mongoid_clear_types
  @_type = nil
  superclass._mongoid_clear_types if hereditary?
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.

Since:

  • 1.0.0



343
344
345
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 343

def _types
  @_type ||= (descendants + [ self ]).uniq.map(&:discriminator_value)
end

#i18n_scope ⇒ Symbol

Set the i18n scope to overwrite ActiveModel.

Returns:

  • (Symbol) —

    :mongoid

Since:

  • 2.0.0



364
365
366
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 364

def i18n_scope
  :mongoid
end

#instantiate(attrs = nil, selected_fields = nil) {|doc| ... } ⇒ 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.

  • selected_fields (Integer) (defaults to: nil) —

    The selected fields from the criteria.

Yields:

  • (doc)

Returns:

Since:

  • 1.0.0



323
324
325
326
327
328
329
330
331
332
333
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 323

def instantiate(attrs = nil, selected_fields = nil)
  attributes = attrs || {}
  doc = allocate
  doc.__selected_fields = selected_fields
  doc.instance_variable_set(:@attributes, attributes)
  doc.apply_defaults
  yield(doc) if block_given?
  doc.run_callbacks(:find) unless doc._find_callbacks.empty?
  doc.run_callbacks(:initialize) unless doc._initialize_callbacks.empty?
  doc
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



376
377
378
 
# File 'build/mongoid-7.3/lib/mongoid/document.rb', line 376

def logger
  Mongoid.logger
end