Class: Mongoid::Association::Referenced::BelongsTo

Inherits:
Object
  • Object
show all
Includes:
Buildable, Mongoid::Association::Relatable
Defined in:
lib/mongoid/association/referenced/belongs_to.rb,
lib/mongoid/association/referenced/belongs_to/eager.rb,
lib/mongoid/association/referenced/belongs_to/proxy.rb,
lib/mongoid/association/referenced/belongs_to/binding.rb,
lib/mongoid/association/referenced/belongs_to/buildable.rb

Overview

The BelongsTo type association.

Defined Under Namespace

Modules: Buildable Classes: Binding, Eager, Proxy

Constant Summary collapse

ASSOCIATION_OPTIONS =

The options available for this type of association, in addition to the common ones.

Returns:

  • (Array<Symbol>) —

    The extra valid options.

%i[
  autobuild
  autosave
  counter_cache
  dependent
  foreign_key
  index
  polymorphic
  primary_key
  touch
  optional
  required
  scope
].freeze
VALID_OPTIONS =

The complete list of valid options for this association, including the shared ones.

Returns:

  • (Array<Symbol>) —

    The valid options.

(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
FOREIGN_KEY_FIELD_TYPE =

The type of the field holding the foreign key.

Returns:

  • (Object) 
Object
FOREIGN_KEY_SUFFIX =

The default foreign key suffix.

Returns:

  • (String) —

    '_id'

'_id'

Constants included from Mongoid::Association::Relatable

Mongoid::Association::Relatable::PRIMARY_KEY_DEFAULT, Mongoid::Association::Relatable::SHARED_OPTIONS

Instance Attribute Summary

Attributes included from Mongoid::Association::Relatable

#name, #options, #owner_class, #parent_inclusions

Instance Method Summary collapse

Methods included from Buildable

#build

Methods included from Mongoid::Association::Relatable

#==, #bindable?, #counter_cache_column_name, #create_relation, #destructive?, #extension, #foreign_key_check, #foreign_key_setter, #get_callbacks, #in_to?, #initialize, #inverse, #inverse_association, #inverse_class, #inverse_class_name, #inverse_setter, #inverse_type_setter, #inverses, #key, #many?, #one?, #relation_class, #relation_class_name, #setter, #type_setter, #validate?

Methods included from Options

#as, #autobuilding?, #autosave, #cascading_callbacks?, #counter_cached?, #cyclic?, #dependent, #forced_nil_inverse?, #indexed?, #inverse_of, #order, #primary_key, #store_as, #touch_field, #touchable?, #type

Methods included from Constrainable

#convert_to_foreign_key

Instance Method Details

#embedded? ⇒ false

Is this association type embedded?

Returns:

  • (false) —

    Always false.



77
78
79
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 77

def embedded?
  false
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.



91
92
93
94
95
96
97
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 91

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

#inverse_type ⇒ String

The name of the field used to store the type of polymorphic association.

Returns:

  • (String) —

    The field used to store the type of polymorphic association.



131
132
133
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 131

def inverse_type
  (@inverse_type ||= "#{name}_type") if polymorphic?
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:



141
142
143
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 141

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.

association.path(document)

Parameters:

  • document (Document) —

    The document to calculate on.

Returns:

  • (Root) —

    The root atomic path calculator.



153
154
155
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 153

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

#polymorphic? ⇒ true | false

Is this association polymorphic?

Returns:

  • (true | false) —

    Whether this association is polymorphic.



109
110
111
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 109

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

#relation ⇒ Association::BelongsTo::Proxy

Get the association proxy class for this association type.

Returns:

  • (Association::BelongsTo::Proxy) —

    The proxy class.



102
103
104
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 102

def relation
  Proxy
end

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

The list of association complements.

Returns:



54
55
56
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 54

def relation_complements
  @relation_complements ||= [ HasMany, HasOne ].freeze
end

#resolver ⇒ nil | Mongoid::ModelResolver

Returns the object responsible for converting polymorphic type references into class objects, and vice versa. This is obtained via the :polymorphic option that was given when the association was defined.

See Mongoid::ModelResolver.resolver for how the :polymorphic option is interpreted here.

Returns:

Raises:

  • KeyError if no such resolver has been registered under the given identifier.



124
125
126
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 124

def resolver
  @resolver ||= Mongoid::ModelResolver.resolver(@options[:polymorphic])
end

#scope ⇒ Proc | Symbol | nil

Get the scope to be applied when querying the association.

Returns:

  • (Proc | Symbol | nil) —

    The association scope, if any.



160
161
162
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 160

def scope
  @options[:scope]
end

#setup! ⇒ self

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

Returns:

  • (self) 


61
62
63
64
65
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 61

def setup!
  setup_instance_methods!
  @owner_class.aliased_fields[name.to_s] = foreign_key
  self
end

#stores_foreign_key? ⇒ true

Does this association type store the foreign key?

Returns:

  • (true) —

    Always true.



70
71
72
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 70

def stores_foreign_key?
  true
end

#validation_default ⇒ false

The default for validation the association object.

Returns:

  • (false) —

    Always false.



84
85
86
 
# File 'lib/mongoid/association/referenced/belongs_to.rb', line 84

def validation_default
  false
end