class Mongoid::Association::Referenced::HasOne
The has_one 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
- FOREIGN_KEY_SUFFIX
The default foreign key suffix.
@return [ String ] ‘_id’
@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
Whether trying to bind an object using this association should raise an error.
@param [ Document
] doc The document to be bound.
@return [ true, false ] Whether the document can be bound.
# File lib/mongoid/association/referenced/has_one.rb, line 141 def bindable?(doc) forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key)) end
Is this association type embedded?
@return [ false ] Always false.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 85 def embedded?; false; end
Get the foreign key field for saving the association reference.
@return [ String ] The foreign key field for saving the
association reference.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 75 def foreign_key @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s : default_foreign_key_field 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::Many
] The Nested
Builder object.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 111 def nested_builder(attributes, options) Nested::One.new(self, attributes, options) end
Get the path calculator for the supplied document.
@example Get the path calculator.
Proxy.path(document)
@param [ Document
] document The document to calculate on.
@return [ Root ] The root atomic path calculator.
@since 2.1.0
# File lib/mongoid/association/referenced/has_one.rb, line 157 def path(document) Mongoid::Atomic::Paths::Root.new(document) end
Is this association polymorphic?
@return [ true, false ] Whether this association is polymorphic.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 120 def polymorphic? @polymorphic ||= !!as end
Get the association proxy class for this association type.
@return [ Association::HasOne::Proxy ] The proxy class.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 99 def relation Proxy end
The list of association complements.
@return [ Array<Association> ] The association complements.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 55 def relation_complements @relation_complements ||= [ Referenced::BelongsTo ].freeze end
Setup the instance methods, fields, etc. on the association owning class.
@return [ self ]
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 64 def setup! setup_instance_methods! self end
# File lib/mongoid/association/referenced/has_one.rb, line 145 def stores_foreign_key?; false; end
The type of this association if it’s polymorphic.
@note Only relevant for polymorphic associations.
@return [ String, nil ] The type field.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 131 def type @type ||= "#{as}_type" if polymorphic? end
The default for validation the association object.
@return [ true ] Always true.
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 92 def validation_default; true; end
Private Instance Methods
# File lib/mongoid/association/referenced/has_one.rb, line 181 def default_foreign_key_field @default_foreign_key_field ||= "#{inverse}#{FOREIGN_KEY_SUFFIX}" end
# File lib/mongoid/association/referenced/has_one.rb, line 201 def default_primary_key PRIMARY_KEY_DEFAULT end
# File lib/mongoid/association/referenced/has_one.rb, line 189 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
# File lib/mongoid/association/referenced/has_one.rb, line 185 def polymorphic_inverses(other) [ as ] end
Setup the instance methods on the class having this association type.
@return [ self ]
@since 7.0
# File lib/mongoid/association/referenced/has_one.rb, line 168 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