Class: Mongoid::Association::Embedded::EmbedsOne

Relationships & Source Files
Namespace Children
Modules: `Buildable`
Classes: `Binding`, `Proxy`
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `Buildable`, `::Mongoid::Threaded::Lifecycle`, `::Mongoid::Association::Relatable`, `::Mongoid::Association::Options`, `::Mongoid::Association::Constrainable`
Inherits:	Object
Defined in:	lib/mongoid/association/embedded/embeds_one.rb, lib/mongoid/association/embedded/embeds_one/binding.rb, lib/mongoid/association/embedded/embeds_one/buildable.rb, lib/mongoid/association/embedded/embeds_one/proxy.rb

Overview

The EmbedsOne type association.

Constant Summary

ASSOCIATION_OPTIONS =

The options available for this type of association, in addition to the common ones.
Returns:
- (Array<Symbol>) —
  
  The extra valid options.
# File 'lib/mongoid/association/embedded/embeds_one.rb', line 21
```
[
    :autobuild,
    :as,
    :cascade_callbacks,
    :cyclic,
    :store_as
]
```
VALID_OPTIONS =

The complete list of valid options for this association, including the shared ones.
Returns:
- (Array<Symbol>) —
  
  The valid options.
# File 'lib/mongoid/association/embedded/embeds_one.rb', line 33
```
(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
```

`::Mongoid::Association::Relatable` - Included

PRIMARY_KEY_DEFAULT, SHARED_OPTIONS

Instance Attribute Summary

#embedded? ⇒ true readonly

Is this association type embedded?
#polymorphic? ⇒ true | false readonly

Is this association polymorphic?
#stores_foreign_key? ⇒ false readonly

Does this association type store the foreign key?

`::Mongoid::Threaded::Lifecycle` - Included

#_assigning	Begin the assignment of attributes.
#_assigning?	Is the current thread in assigning mode?
#_binding	Execute a block in binding mode.
#_binding?	Is the current thread in binding mode?
#_building	Execute a block in building mode.
#_building?	Is the current thread in building mode?
#_creating?	Is the current thread in creating mode?
#_loading	Execute a block in loading mode.
#_loading?	Is the current thread in loading mode?

`::Mongoid::Association::Relatable` - Included

#destructive?	Whether the dependent method is destructive.
#in_to?	Is this association an embedded_in or belongs_to association?
#many?	Is this association an embeds_many or has_many association?
#name	The name of the association.
#one?	Is this association an embeds_one or has_one association?
#options	The options on this association.
#parent_inclusions	The associations above this one in the inclusion tree.
#parent_inclusions=	The associations above this one in the inclusion tree.
#validate?	Whether the associated object(s) should be validated.

`::Mongoid::Association::Options` - Included

#autobuilding?	Whether the association is autobuilding.
#autosave	`::Mongoid::Association::Options` to save any loaded members and destroy members that are marked for destruction when the parent object is saved.
#autosave?	Alias for Options#autosave.
#cascading_callbacks?	Whether the association has callbacks cascaded down from the parent.
#counter_cached?	Whether the association is counter-cached.
#cyclic?	Is the association cyclic.
#forced_nil_inverse?	Whether the association has forced nil inverse (So no foreign keys are saved).
#indexed?	Whether to index the primary or foreign key field.
#polymorphic?	Whether this association is polymorphic.
#touchable?	Whether the association object should be automatically touched when its inverse object is updated.

Instance Method Summary

#key ⇒ String

The key that is used to get the attributes for the associated object.
#nested_builder(attributes, options) ⇒ Association::Nested::One

The nested builder object.
#primary_key ⇒ nil

The primary key.
#relation ⇒ Association::Embedded::EmbedsMany::Proxy

Get the association proxy class for this association type.
#setup! ⇒ self

Setup the instance methods, fields, etc.
#store_as ⇒ String

The field key used to store the association object.
#type ⇒ String | nil

The field used to store the type of the related object.
#validation_default ⇒ true | false

Get the default validation setting for the association.
#determine_inverses(other) private
#polymorphic_inverses(other = nil) private
#relation_complements private
#setup_instance_methods! private

`Buildable` - Included

#build	Builds the document out of the attributes using the provided association metadata on the association.
#clear_associated

`::Mongoid::Association::Relatable` - Included

#==	Compare this association to another.
#bindable?	Whether trying to bind an object using this association should raise an error.
#class_name	Alias for Relatable#relation_class_name.
#counter_cache_column_name	Get the counter cache column name.
#create_relation	Create an association proxy object using the owner and target.
#extension	Get the extension.
#foreign_key_check	Get the name of the method to check if the foreign key has changed.
#foreign_key_setter	The name of the foreign key setter method.
#get_callbacks	Get the callbacks for a given type.
#initialize	Initialize the `::Mongoid::Association`.
#inverse	Get the inverse name.
#inverse_association	Get the inverse’s association metadata.
#inverse_class	The class of the object owning this association.
#inverse_class_name	The class name of the object owning this association.
#inverse_klass	Alias for Relatable#inverse_class.
#inverse_setter	The name of the inverse setter method.
#inverse_type	Get the inverse type.
#inverse_type_setter	Gets the setter for the field that sets the type of document on a polymorphic association.
#inverses	Get the inverse names.
#key	The foreign key field if this association stores a foreign key.
#klass	Alias for Relatable#relation_class.
#path	The atomic path for this association.
#relation_class	The class of the association object(s).
#relation_class_name	The class name, possibly unqualified or prefixed, of the association object(s).
#setter	The name of the setter on this object for assigning an associated object.
#type_setter	Get the type setter.
#create_extension!, #default_inverse, #define_autosaver!, #define_builder!, #define_counter_cache_callbacks!, #define_creator!, #define_dependency!, #define_existence_check!, #define_getter!, #define_ids_getter!, #define_ids_setter!, #define_setter!, #define_touchable!,
#inverse_association_classes	Gets the model classes with inverse associations of this model.
#namespace_hierarchy	Returns an array of classes/modules forming the namespace hierarchy where symbols referenced in the provided class/module would be looked up by Ruby.
#polymorph!,
#resolve_name	Resolves the given class/module name in the context of the specified module, as Ruby would when a constant is referenced in the source.
#setup_index!, #validate!

`::Mongoid::Association::Options` - Included

#as	Returns the name of the parent to a polymorphic child.
#dependent	Specify what happens to the associated object when the owner is destroyed.
#inverse_of	The name the owning object uses to refer to this association.
#order	The custom sorting options on the association.
#primary_key	`::Mongoid` assumes that the field used to hold the primary key of the association is id.
#store_as	The store_as option.
#touch_field	The field for saving the associated object’s type.
#type	The field for saving the associated object’s type.

`::Mongoid::Association::Constrainable` - Included

#convert_to_foreign_key	Convert the supplied object to the appropriate type to set as the foreign key for an association.
#convert_polymorphic

Instance Attribute Details

#embedded? ⇒ `true` (readonly)

Is this association type embedded?

Returns:

(true) —

Always true.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 62


def embedded?; true; end

#polymorphic? ⇒ `true` | `false` (readonly)

Is this association polymorphic?

Returns:

(true | false) —

Whether this association is polymorphic.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 93


def polymorphic?
  @polymorphic ||= !!@options[:as]
end

#stores_foreign_key? ⇒ `false` (readonly)

Does this association type store the foreign key?

Returns:

(false) —

Always false.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 76


def stores_foreign_key?; false; end

Instance Method Details

#determine_inverses(other) (private)

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 136


def determine_inverses(other)
  matches = relation_class.relations.values.select do |rel|
    relation_complements.include?(rel.class) &&
      # https://jira.mongodb.org/browse/MONGOID-4882
      rel.relation_class_name.sub(/\A::/, '') == inverse_class_name

  end
  if matches.size > 1
    raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
  end
  matches.collect { |m| m.name } unless matches.blank?
end

#key ⇒ String

The key that is used to get the attributes for the associated object.

Returns:

(String) —

The name of the field used to store the association.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 55


def key
  store_as.to_s
end

#nested_builder(attributes, options) ⇒ Association::Nested::One

The nested builder object.

Parameters:

attributes (Hash) —

The attributes to use to build the association object.
options (Hash) —

The options for the association.

Returns:

(Association::Nested::One) —

The Nested Builder object.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 112


def nested_builder(attributes, options)
  Nested::One.new(self, attributes, options)
end

#polymorphic_inverses(other = nil) (private)

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 132


def polymorphic_inverses(other = nil)
  [ as ]
end

#primary_key ⇒ `nil`

The primary key

Returns:

(nil) —

Not relevant for this association

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 81


def primary_key; end

#relation ⇒ Association::Embedded::EmbedsMany::Proxy

Get the association proxy class for this association type.

Returns:

(Association::Embedded::EmbedsMany::Proxy) —

The proxy class.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 86


def relation
  Proxy
end

#relation_complements (private)

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 128


def relation_complements
  @relation_complements ||= [ Embedded::EmbeddedIn ].freeze
end

#setup! ⇒ `self`

Setup the instance methods, fields, etc. on the association owning class.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 38


def setup!
  setup_instance_methods!
  @owner_class.embedded_relations = @owner_class.embedded_relations.merge(name => self)
  @owner_class.aliased_fields[name.to_s] = store_as if store_as
  self
end

#setup_instance_methods! (private)

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 118


def setup_instance_methods!
  define_getter!
  define_setter!
  define_existence_check!
  define_builder!
  define_creator!
  @owner_class.cyclic = true if cyclic?
  @owner_class.validates_associated(name) if validate?
end

#store_as ⇒ String

The field key used to store the association object.

Returns:

(String) —

The field name.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 48


def store_as
  @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
end

#type ⇒ String | `nil`

Note:

Only relevant if the association is polymorphic.

The field used to store the type of the related object.

Returns:

(String | nil) —

The field for storing the associated object’s type.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 102


def type
  @type ||= "#{as}_type" if polymorphic?
end

#validation_default ⇒ `true` | `false`

Get the default validation setting for the association. Determines if by default a validates associated will occur.

Examples:

Get the validation default.

Proxy.validation_default

Returns:

(true | false) —

The validation default.

[ GitHub ]

# File 'lib/mongoid/association/embedded/embeds_one.rb', line 71


def validation_default; true; end

Class: Mongoid::Association::Embedded::EmbedsOne

Overview

Constant Summary

::Mongoid::Association::Relatable - Included

Instance Attribute Summary

::Mongoid::Threaded::Lifecycle - Included

::Mongoid::Association::Relatable - Included

::Mongoid::Association::Options - Included

Instance Method Summary

Buildable - Included

::Mongoid::Association::Relatable - Included

::Mongoid::Association::Options - Included

::Mongoid::Association::Constrainable - Included

Instance Attribute Details

#embedded? ⇒ true (readonly)

#polymorphic? ⇒ true | false (readonly)

#stores_foreign_key? ⇒ false (readonly)

Instance Method Details

#determine_inverses(other) (private)

#key ⇒ String

#nested_builder(attributes, options) ⇒ Association::Nested::One

#polymorphic_inverses(other = nil) (private)

#primary_key ⇒ nil

#relation ⇒ Association::Embedded::EmbedsMany::Proxy

#relation_complements (private)

#setup! ⇒ self

#setup_instance_methods! (private)

#store_as ⇒ String

#type ⇒ String | nil

#validation_default ⇒ true | false

`::Mongoid::Association::Relatable` - Included

`::Mongoid::Threaded::Lifecycle` - Included

`::Mongoid::Association::Relatable` - Included

`::Mongoid::Association::Options` - Included

`Buildable` - Included

`::Mongoid::Association::Relatable` - Included

`::Mongoid::Association::Options` - Included

`::Mongoid::Association::Constrainable` - Included

#embedded? ⇒ `true` (readonly)

#polymorphic? ⇒ `true` | `false` (readonly)

#stores_foreign_key? ⇒ `false` (readonly)

#primary_key ⇒ `nil`

#setup! ⇒ `self`

#type ⇒ String | `nil`

#validation_default ⇒ `true` | `false`