Module: Mongoid::Relations::Macros::ClassMethods

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

Instance Method Summary collapse

Instance Method Details

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


138
139
140
141
142
143
144
# File 'lib/mongoid/relations/macros.rb', line 138

def belongs_to(name, options = {}, &block)
  meta = reference_one_to_one(name, options, Referenced::In, &block)
  aliased_fields[name.to_s] = meta.foreign_key
  touchable(meta)
  add_counter_cache_callbacks(meta) if meta.counter_cached?
  meta
end

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

Adds the relation 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 relation calling persistence methods on the child object will cause a save to fail.

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


53
54
55
56
57
58
59
60
61
# File 'lib/mongoid/relations/macros.rb', line 53

def embedded_in(name, options = {}, &block)
  meta = characterize(name, Embedded::In, options, &block)
  self.embedded = true
  relate(name, meta)
  builder(name, meta).creator(name, meta)
  touchable(meta)
  add_counter_cache_callbacks(meta) if meta.counter_cached?
  meta
end

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


82
83
84
85
86
87
88
89
# File 'lib/mongoid/relations/macros.rb', line 82

def embeds_many(name, options = {}, &block)
  meta = characterize(name, Embedded::Many, options, &block)
  self.cyclic = true if options[:cyclic]
  relate(name, meta)
  embed(name, meta)
  validates_relation(meta)
  meta
end

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


110
111
112
113
114
115
116
117
118
# File 'lib/mongoid/relations/macros.rb', line 110

def embeds_one(name, options = {}, &block)
  meta = characterize(name, Embedded::One, options, &block)
  self.cyclic = true if options[:cyclic]
  relate(name, meta)
  embed(name, meta)
  builder(name, meta).creator(name, meta)
  validates_relation(meta)
  meta
end

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.

Since:

  • 2.0.0.rc.1


194
195
196
197
198
199
200
201
202
# File 'lib/mongoid/relations/macros.rb', line 194

def has_and_belongs_to_many(name, options = {}, &block)
  meta = characterize(name, Referenced::ManyToMany, options, &block)
  relate(name, meta)
  reference(meta, Array)
  autosave(meta)
  validates_relation(meta)
  synced(meta)
  meta
end

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


164
165
166
167
168
169
170
171
172
# File 'lib/mongoid/relations/macros.rb', line 164

def has_many(name, options = {}, &block)
  meta = characterize(name, Referenced::Many, options, &block)
  relate(name, meta)
  ids_getter(name, meta).ids_setter(name, meta)
  reference(meta)
  autosave(meta)
  validates_relation(meta)
  meta
end

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

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

Examples:

Define the relation.


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 relation.

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

    The relation options.

  • block (Proc)

    Optional block for defining extensions.


222
223
224
# File 'lib/mongoid/relations/macros.rb', line 222

def has_one(name, options = {}, &block)
  reference_one_to_one(name, options, Referenced::One, &block)
end