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

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

Overview

The has_one 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.

[
    :as,
    :autobuild,
    :autosave,
    :dependent,
    :foreign_key,
    :primary_key,
    :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_SUFFIX =

The default foreign key suffix.

Returns:

  • (String)

    ‘_id’

'_id'.freeze

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, #parent_inclusions

Instance Method Summary collapse

Methods included from Buildable

#build

Methods included from Mongoid::Association::Relatable

#==, #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, #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?

Methods included from Constrainable

#convert_to_foreign_key

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.



116
117
118
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 116

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

#embedded?false

Is this association type embedded?

Returns:

  • (false)

    Always false.



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

def embedded?; false; end

#foreign_keyString

Get the foreign key field for saving the association reference.

Returns:

  • (String)

    The foreign key field for saving the association reference.



62
63
64
65
# File 'build/mongoid-master/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:



90
91
92
# File 'build/mongoid-master/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.



133
134
135
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 133

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.



97
98
99
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 97

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

#relationAssociation::HasOne::Proxy

Get the association proxy class for this association type.

Returns:

  • (Association::HasOne::Proxy)

    The proxy class.



80
81
82
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 80

def relation
  Proxy
end

#relation_complementsArray<Mongoid::Association::Relatable>

The list of association complements.

Returns:



46
47
48
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 46

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

#scopeProc | Symbol | nil

Get the scope to be applied when querying the association.

Returns:

  • (Proc | Symbol | nil)

    The association scope, if any.



140
141
142
# File 'build/mongoid-master/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.

Returns:

  • (self)


53
54
55
56
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 53

def setup!
  setup_instance_methods!
  self
end

#stores_foreign_key?false

Does this association type store the foreign key?

Returns:

  • (false)

    Always false.



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

def stores_foreign_key?; false; end

#typeString | nil

Note:

Only relevant for polymorphic associations.

The type of this association if it’s polymorphic.

Returns:

  • (String | nil)

    The type field.



106
107
108
# File 'build/mongoid-master/lib/mongoid/association/referenced/has_one.rb', line 106

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

#validation_defaulttrue

The default for validation the association object.

Returns:

  • (true)

    Always true.



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

def validation_default; true; end