# File lib/mongoid/association/embedded/embeds_one.rb, line 96 def primary_key; end
class Mongoid::Association::Embedded::EmbedsOne
The EmbedsOne type association.
@since 7.0
Constants
- ASSOCIATION_OPTIONS
The options available for this type of association, in addition to the common ones.
@return [ Array<Symbol> ] The extra valid options.
@since 7.0
- VALID_OPTIONS
The complete list of valid options for this association, including the shared ones.
@return [ Array<Symbol> ] The valid options.
@since 7.0
Public Instance Methods
Is this association type embedded?
@return [ true ] Always true.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 73 def embedded?; true; end
The key that is used to get the attributes for the associated object.
@return [ String ] The name of the field used to store the relation.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 64 def key store_as.to_s end
The nested builder object.
@param [ Hash ] attributes The attributes to use to build the association object. @param [ Hash ] options The options for the association.
@return [ Association::Nested::One ] The Nested Builder object.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 135 def nested_builder(attributes, options) Nested::One.new(self, attributes, options) end
Is this association polymorphic?
@return [ true, false ] Whether this association is polymorphic.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 112 def polymorphic? @polymorphic ||= !!@options[:as] end
The primary key
@return [ nil ] Not relevant for this relation
Get the relation proxy class for this association type.
@return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 103 def relation Proxy end
Setup the instance methods, fields, etc. on the association owning class.
@return [ self ]
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 43 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
The field key used to store the association object.
@return [ String ] The field name.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 55 def store_as @store_as ||= (@options[:store_as].try(:to_s) || name.to_s) end
Does this association type store the foreign key?
@return [ false ] Always false.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 91 def stores_foreign_key?; false; end
The field used to store the type of the related object.
@note Only relevant if the association is polymorphic.
@return [ String, nil ] The field for storing the associated object's type.
@since 7.0
# File lib/mongoid/association/embedded/embeds_one.rb, line 123 def type @type ||= "#{as}_type" if polymorphic? end
Get the default validation setting for the relation. Determines if by default a validates associated will occur.
@example Get the validation default.
Proxy.validation_default
@return [ true, false ] The validation default.
@since 2.1.9
# File lib/mongoid/association/embedded/embeds_one.rb, line 84 def validation_default; true; end
Private Instance Methods
# File lib/mongoid/association/embedded/embeds_one.rb, line 159 def determine_inverses(other) matches = 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
# File lib/mongoid/association/embedded/embeds_one.rb, line 155 def polymorphic_inverses(other = nil) [ as ] end
# File lib/mongoid/association/embedded/embeds_one.rb, line 151 def relation_complements @relation_complements ||= [ Embedded::EmbeddedIn ].freeze end
# File lib/mongoid/association/embedded/embeds_one.rb, line 141 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