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

Inherits:
Object
  • Object
show all
Includes:
Buildable, Relatable
Defined in:
lib/mongoid/association/embedded/embeds_one.rb,
lib/mongoid/association/embedded/embeds_one/proxy.rb,
lib/mongoid/association/embedded/embeds_one/binding.rb,
lib/mongoid/association/embedded/embeds_one/buildable.rb

Overview

The EmbedsOne type association.

Since:

  • 7.0

Defined Under Namespace

Modules: Buildable Classes: Binding, 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.

Since:

  • 7.0

[
    :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.

Since:

  • 7.0

(ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze

Constants included from Relatable

Relatable::PRIMARY_KEY_DEFAULT, Relatable::SHARED_OPTIONS

Instance Attribute Summary

Attributes included from Relatable

#name, #options

Instance Method Summary collapse

Methods included from Buildable

#build

Methods included from Relatable

#==, #bindable?, #counter_cache_column_name, #create_relation, #destructive?, #extension, #foreign_key_check, #foreign_key_setter, #get_callbacks, #initialize, #inverse, #inverse_association, #inverse_class, #inverse_class_name, #inverse_setter, #inverse_type, #inverse_type_setter, #inverses, #path, #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, #touch_field

Methods included from Constrainable

#convert_to_foreign_key

Instance Method Details

#embedded? ⇒ true

Is this association type embedded?

Returns:

  • (true) —

    Always true.

Since:

  • 7.0



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

def embedded?; true; 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 relation.

Since:

  • 7.0



64
65
66
 
# File 'lib/mongoid/association/embedded/embeds_one.rb', line 64

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:

Since:

  • 7.0



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

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

#polymorphic? ⇒ true, false

Is this association polymorphic?

Returns:

  • (true, false) —

    Whether this association is polymorphic.

Since:

  • 7.0



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

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

#primary_key ⇒ nil

The primary key

Returns:

  • (nil) —

    Not relevant for this relation

Since:

  • 7.0



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

def primary_key; end

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

Get the relation proxy class for this association type.

Returns:

Since:

  • 7.0



103
104
105
 
# File 'lib/mongoid/association/embedded/embeds_one.rb', line 103

def relation
  Proxy
end

#setup! ⇒ self

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

Returns:

  • (self)

Since:

  • 7.0



43
44
45
46
47
48
 
# 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

#store_as ⇒ String

The field key used to store the association object.

Returns:

  • (String) —

    The field name.

Since:

  • 7.0



55
56
57
 
# 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

#stores_foreign_key? ⇒ false

Does this association type store the foreign key?

Returns:

  • (false) —

    Always false.

Since:

  • 7.0



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

def stores_foreign_key?; false; end

#type ⇒ String?

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.

Since:

  • 7.0



123
124
125
 
# File 'lib/mongoid/association/embedded/embeds_one.rb', line 123

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

#validation_default ⇒ true, false

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

Examples:

Get the validation default.

Proxy.validation_default

Returns:

  • (true, false) —

    The validation default.

Since:

  • 2.1.9



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

def validation_default; true; end