Class: Mongoid::Association::Referenced::HasOne

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

Overview

The has_one 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/referenced/has_one.rb', line 22
```
[
    :as,
    :autobuild,
    :autosave,
    :dependent,
    :foreign_key,
    :primary_key,
    :scope,
].freeze
```
FOREIGN_KEY_SUFFIX =

The default foreign key suffix.
Returns:
- (String) —
  
  ‘_id’
# File 'lib/mongoid/association/referenced/has_one.rb', line 41
```
'_id'.freeze
```
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/referenced/has_one.rb', line 36
```
(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
```

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

PRIMARY_KEY_DEFAULT, SHARED_OPTIONS

Instance Attribute Summary

#embedded? ⇒ false 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::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

#bindable?(doc) ⇒ true | false

Whether trying to bind an object using this association should raise an error.
#foreign_key ⇒ String

Get the foreign key field for saving the association reference.
#nested_builder(attributes, options) ⇒ Association::Nested::Many

The nested builder object.
#path(document) ⇒ Root

Get the path calculator for the supplied document.
#relation ⇒ Association::HasOne::Proxy

Get the association proxy class for this association type.
#relation_complements ⇒ Array<Mongoid::Association::Relatable>

The list of association complements.
#scope ⇒ Proc | Symbol | nil

Get the scope to be applied when querying the association.
#setup! ⇒ self

Setup the instance methods, fields, etc.
#type ⇒ String | nil

The type of this association if it’s polymorphic.
#validation_default ⇒ true

The default for validation the association object.
#default_foreign_key_field private
#default_primary_key private
#determine_inverses(other) private
#polymorphic_inverses(other) private
#setup_instance_methods! ⇒ self private

Setup the instance methods on the class having this association type.

`Buildable` - Included

#build	This method either takes an _id or an object and queries for the inverse side using the id or sets the object after clearing the associated object.
#clear_associated, #execute_query, #query?, #query_criteria, #with_polymorphic_criterion

`::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 Mongoid::Association::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 Mongoid::Association::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 Mongoid::Association::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? ⇒ `false` (readonly)

Is this association type embedded?

Returns:

(false) —

Always false.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 70


def embedded?; false; end

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

Is this association polymorphic?

Returns:

(true | false) —

Whether this association is polymorphic.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 97


def polymorphic?
  @polymorphic ||= !!as
end

#stores_foreign_key? ⇒ `false` (readonly)

Does this association type store the foreign key?

Returns:

(false) —

Always false.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 123


def stores_foreign_key?; false; end

Instance Method Details

#bindable?(doc) ⇒ `true` | `false`

Whether trying to bind an object using this association should raise an error.

Parameters:

doc (Document) —

The document to be bound.

Returns:

(true | false) —

Whether the document can be bound.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 116


def bindable?(doc)
  forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
end

#default_foreign_key_field (private)

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 162


def default_foreign_key_field
  @default_foreign_key_field ||= "#{inverse}#{FOREIGN_KEY_SUFFIX}"
end

#default_primary_key (private)

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 182


def default_primary_key
  PRIMARY_KEY_DEFAULT
end

#determine_inverses(other) (private)

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 170


def determine_inverses(other)
  matches = (other || relation_class).relations.values.select do |rel|
    relation_complements.include?(rel.class) &&
        rel.relation_class_name == 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

#foreign_key ⇒ String

Get the foreign key field for saving the association reference.

Returns:

(String) —

The foreign key field for saving the association reference.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 62


def foreign_key
  @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                     default_foreign_key_field
end

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

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::Many) —

The Nested Builder object.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 90


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

#path(document) ⇒ `Root`

Get the path calculator for the supplied document.

Examples:

Get the path calculator.

Proxy.path(document)

Parameters:

document (Document) —

The document to calculate on.

Returns:

(Root) —

The root atomic path calculator.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 133


def path(document)
  Mongoid::Atomic::Paths::Root.new(document)
end

#polymorphic_inverses(other) (private)

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 166


def polymorphic_inverses(other)
  [ as ]
end

#relation ⇒ `Association::HasOne::Proxy`

Get the association proxy class for this association type.

Returns:

(Association::HasOne::Proxy) —

The proxy class.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 80


def relation
  Proxy
end

#relation_complements ⇒ Array<Mongoid::Association::Relatable>

The list of association complements.

Returns:

(Array<Mongoid::Association::Relatable>) —

The association complements.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 46


def relation_complements
  @relation_complements ||= [ Referenced::BelongsTo ].freeze
end

#scope ⇒ `Proc` | Symbol | `nil`

Get the scope to be applied when querying the association.

Returns:

(Proc | Symbol | nil) —

The association scope, if any.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 140


def scope
  @options[:scope]
end

#setup! ⇒ `self`

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

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 53


def setup!
  setup_instance_methods!
  self
end

#setup_instance_methods! ⇒ `self` (private)

Setup the instance methods on the class having this association type.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 149


def setup_instance_methods!
  define_getter!
  define_setter!
  define_existence_check!
  define_builder!
  define_creator!
  define_autosaver!
  polymorph!
  define_dependency!
  @owner_class.validates_associated(name) if validate?
  self
end

#type ⇒ String | `nil`

Note:

Only relevant for polymorphic associations.

The type of this association if it’s polymorphic.

Returns:

(String | nil) —

The type field.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 106


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

#validation_default ⇒ `true`

The default for validation the association object.

Returns:

(true) —

Always true.

[ GitHub ]

# File 'lib/mongoid/association/referenced/has_one.rb', line 75


def validation_default; true; end

Class: Mongoid::Association::Referenced::HasOne

Overview

Constant Summary

::Mongoid::Association::Relatable - Included

Instance Attribute Summary

::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? ⇒ false (readonly)

#polymorphic? ⇒ true | false (readonly)

#stores_foreign_key? ⇒ false (readonly)

Instance Method Details

#bindable?(doc) ⇒ true | false

#default_foreign_key_field (private)

#default_primary_key (private)

#determine_inverses(other) (private)

#foreign_key ⇒ String

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

#path(document) ⇒ Root

#polymorphic_inverses(other) (private)

#relation ⇒ Association::HasOne::Proxy

#relation_complements ⇒ Array<Mongoid::Association::Relatable>

#scope ⇒ Proc | Symbol | nil

#setup! ⇒ self

#setup_instance_methods! ⇒ self (private)

#type ⇒ String | nil

#validation_default ⇒ true

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

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

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

`Buildable` - Included

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

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

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

#embedded? ⇒ `false` (readonly)

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

#stores_foreign_key? ⇒ `false` (readonly)

#bindable?(doc) ⇒ `true` | `false`

#path(document) ⇒ `Root`

#relation ⇒ `Association::HasOne::Proxy`

#scope ⇒ `Proc` | Symbol | `nil`

#setup! ⇒ `self`

#setup_instance_methods! ⇒ `self` (private)

#type ⇒ String | `nil`

#validation_default ⇒ `true`