Module: Mongoid::Association::Macros::ClassMethods

Defined in:
lib/mongoid/association/macros.rb

Overview

Class methods for associations.

Instance Method Summary collapse

Instance Method Details

#belongs_to(name, options = {}, &block) ⇒ Object

Adds a referenced association from the child Document to a Document in another database or collection.

Examples:

Define the association.


class Game
  include Mongoid::Document
  belongs_to :person
end

class Person
  include Mongoid::Document
  has_one :game
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



148
149
150
 
# File 'lib/mongoid/association/macros.rb', line 148

def belongs_to(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#embedded_in(name, options = {}, &block) ⇒ Object

Adds the association back to the parent document. This macro is necessary to set the references from the child back to the parent document. If a child does not define this association calling persistence methods on the child object will cause a save to fail.

Examples:

Define the association.


class Person
  include Mongoid::Document
  embeds_many :addresses
end

class Address
  include Mongoid::Document
  embedded_in :person
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



80
81
82
 
# File 'lib/mongoid/association/macros.rb', line 80

def embedded_in(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#embeds_many(name, options = {}, &block) ⇒ Object

Adds the association from a parent document to its children. The name of the association needs to be a pluralized form of the child class name.

Examples:

Define the association.


class Person
  include Mongoid::Document
  embeds_many :addresses
end

class Address
  include Mongoid::Document
  embedded_in :person
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



103
104
105
 
# File 'lib/mongoid/association/macros.rb', line 103

def embeds_many(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#embeds_one(name, options = {}, &block) ⇒ Object

Adds the association from a parent document to its child. The name of the association needs to be a singular form of the child class name.

Examples:

Define the association.


class Person
  include Mongoid::Document
  embeds_one :name
end

class Name
  include Mongoid::Document
  embedded_in :person
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



126
127
128
 
# File 'lib/mongoid/association/macros.rb', line 126

def embeds_one(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#has_and_belongs_to_many(name, options = {}, &block) ⇒ Object

Adds a referenced many-to-many association between many of this Document and many of another Document.

Examples:

Define the association.


class Person
  include Mongoid::Document
  has_and_belongs_to_many :preferences
end

class Preference
  include Mongoid::Document
  has_and_belongs_to_many :people
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



194
195
196
 
# File 'lib/mongoid/association/macros.rb', line 194

def has_and_belongs_to_many(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#has_many(name, options = {}, &block) ⇒ Object

Adds a referenced association from a parent Document to many Documents in another database or collection.

Examples:

Define the association.


class Person
  include Mongoid::Document
  has_many :posts
end

class Game
  include Mongoid::Document
  belongs_to :person
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



172
173
174
 
# File 'lib/mongoid/association/macros.rb', line 172

def has_many(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end

#has_one(name, options = {}, &block) ⇒ Object

Adds a referenced association from the child Document to a Document in another database or collection.

Examples:

Define the association.


class Game
  include Mongoid::Document
  belongs_to :person
end

class Person
  include Mongoid::Document
  has_one :game
end

Parameters:

  • name (Symbol) —

    The name of the association.

  • options (Hash) (defaults to: {}) —

    The association options.

  • &block —

    Optional block for defining extensions.



216
217
218
 
# File 'lib/mongoid/association/macros.rb', line 216

def has_one(name, options = {}, &block)
  define_association!(__method__, name, options, &block)
end