Module: Mongoid::Association::Relatable

Includes:
Constrainable, Options
Included in:
Embedded::EmbeddedIn, Embedded::EmbedsMany, Embedded::EmbedsOne, Mongoid::Association::Referenced::BelongsTo, Mongoid::Association::Referenced::HasAndBelongsToMany, Mongoid::Association::Referenced::HasMany, Mongoid::Association::Referenced::HasOne
Defined in:
lib/mongoid/association/relatable.rb

Overview

This module provides behaviors shared between Association types.

Constant Summary collapse

SHARED_OPTIONS =

The options shared between all association types.

Returns:

  • (Array<Symbol>) —

    The shared options.

%i[
  class_name
  inverse_of
  validate
  extend
].freeze
PRIMARY_KEY_DEFAULT =

The primary key default.

Returns:

  • (String) —

    The primary key field default.

'_id'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Options

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

Methods included from Constrainable

#convert_to_foreign_key

Instance Attribute Details

#name ⇒ Symbol (readonly)

The name of the association.

Returns:

  • (Symbol) —

    The name of the association.



31
32
33
 
# File 'lib/mongoid/association/relatable.rb', line 31

def name
  @name
end

#options ⇒ Hash (readonly)

The options on this association.

Returns:

  • (Hash) —

    The options.



36
37
38
 
# File 'lib/mongoid/association/relatable.rb', line 36

def options
  @options
end

#owner_class ⇒ Class (readonly)

The class that owns this association.

Returns:

  • (Class) —

    The owner class.



41
42
43
 
# File 'lib/mongoid/association/relatable.rb', line 41

def owner_class
  @owner_class
end

#parent_inclusions ⇒ Array<String>

The associations above this one in the inclusion tree.

Returns:

  • (Array<String>) —

    The associations.



319
320
321
 
# File 'lib/mongoid/association/relatable.rb', line 319

def parent_inclusions
  @parent_inclusions ||= []
end

Instance Method Details

#==(other) ⇒ Object

Compare this association to another.

Returns:

  • (Object) —

    The object to compare to this association.



65
66
67
68
69
70
 
# File 'lib/mongoid/association/relatable.rb', line 65

def ==(other)
  relation_class_name == other.relation_class_name &&
    inverse_class_name == other.inverse_class_name &&
    name == other.name &&
    options == other.options
end

#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.



96
97
98
 
# File 'lib/mongoid/association/relatable.rb', line 96

def bindable?(_doc)
  false
end

#counter_cache_column_name ⇒ String

Get the counter cache column name.

Returns:

  • (String) —

    The counter cache column name.



275
276
277
278
279
280
281
282
 
# File 'lib/mongoid/association/relatable.rb', line 275

def counter_cache_column_name
  @counter_cache_column_name ||= if @options[:counter_cache].is_a?(String) ||
                                    @options[:counter_cache].is_a?(Symbol)
                                   @options[:counter_cache]
                                 else
                                   "#{inverse || inverse_class_name.demodulize.underscore.pluralize}_count"
                                 end
end

#create_relation(owner, target) ⇒ Proxy

Create an association proxy object using the owner and target.

Parameters:

  • owner (Document) —

    The document this association hangs off of.

  • target (Document | Array<Document>) —

    The target (parent) of the association.

Returns:



261
262
263
 
# File 'lib/mongoid/association/relatable.rb', line 261

def create_relation(owner, target)
  relation.new(owner, target, self)
end

#destructive? ⇒ true | false

Whether the dependent method is destructive.

Returns:

  • (true | false) —

    If the dependent method is destructive.



268
269
270
 
# File 'lib/mongoid/association/relatable.rb', line 268

def destructive?
  @destructive ||= !!(dependent && %i[delete_all destroy].include?(dependent))
end

#extension ⇒ Module

Get the extension.

Returns:

  • (Module) —

    The extension module, if one has been defined.



287
288
289
 
# File 'lib/mongoid/association/relatable.rb', line 287

def extension
  @extension ||= @options[:extend]
end

#foreign_key_check ⇒ String

Get the name of the method to check if the foreign key has changed.

Examples:

Get the foreign key check method.

association.foreign_key_check

Returns:

  • (String) —

    The foreign key check.



250
251
252
 
# File 'lib/mongoid/association/relatable.rb', line 250

def foreign_key_check
  @foreign_key_check ||= "#{foreign_key}_previously_changed?" if stores_foreign_key? && foreign_key
end

#foreign_key_setter ⇒ String

The name of the foreign key setter method.

Returns:

  • (String) —

    The name of the foreign key setter.



220
221
222
223
224
 
# File 'lib/mongoid/association/relatable.rb', line 220

def foreign_key_setter
  # NOTE: You can't check if this association stores foreign key
  # See HasOne and HasMany binding, they referenced foreign_key_setter
  @foreign_key_setter ||= "#{foreign_key}=" if foreign_key
end

#get_callbacks(callback_type) ⇒ Array<Proc | Symbol>

Get the callbacks for a given type.

Parameters:

  • callback_type (Symbol) —

    The type of callback type.

Returns:

  • (Array<Proc | Symbol>) —

    A list of the callbacks, either method names or Procs.



78
79
80
 
# File 'lib/mongoid/association/relatable.rb', line 78

def get_callbacks(callback_type)
  Array(options[callback_type])
end

#in_to? ⇒ true | false

Is this association an embedded_in or belongs_to association?

Returns:

  • (true | false) —

    true if it is an embedded_in or belongs_to association, false if not.



341
342
343
 
# File 'lib/mongoid/association/relatable.rb', line 341

def in_to?
  [ Referenced::BelongsTo, Embedded::EmbeddedIn ].any? { |a| is_a?(a) }
end

#initialize(_class, name, opts = {}, &block) ⇒ Object

Initialize the Association.

Parameters:

  • _class (Class) —

    The class of the model who owns this association.

  • name (Symbol) —

    The name of the association.

  • opts (Hash) (defaults to: {}) —

    The association options.

  • block (Block) —

    The optional block.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mongoid/association/relatable.rb', line 49

def initialize(_class, name, opts = {}, &block)
  @owner_class = _class
  @name = name
  @options = opts
  @extension = nil

  @module_path = _class.name ? _class.name.split('::')[0..-2].join('::') : ''
  @module_path << '::' unless @module_path.empty?

  create_extension!(&block)
  validate!
end

#inverse(other = nil) ⇒ Symbol

Get the inverse name.

Returns:

  • (Symbol) —

    The inverse name.



294
295
296
297
 
# File 'lib/mongoid/association/relatable.rb', line 294

def inverse(other = nil)
  candidates = inverses(other)
  candidates.detect { |c| c } if candidates
end

#inverse_association(other = nil) ⇒ Mongoid::Association::Relatable

Get the inverse's association metadata.

Parameters:

  • other (Object) (defaults to: nil) —

    The other model class or model object to use when determining inverses.

Returns:



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

def inverse_association(other = nil)
  (other || relation_class).relations[inverse(other)]
end

#inverse_class ⇒ String Also known as: inverse_klass

The class of the object owning this association.

Returns:

  • (String) —

    The owning objects' class.



190
191
192
 
# File 'lib/mongoid/association/relatable.rb', line 190

def inverse_class
  @owner_class
end

#inverse_class_name ⇒ String

The class name of the object owning this association.

Returns:

  • (String) —

    The owning objects' class name.



183
184
185
 
# File 'lib/mongoid/association/relatable.rb', line 183

def inverse_class_name
  @inverse_class_name ||= @owner_class.name
end

#inverse_setter(other = nil) ⇒ String

The name of the inverse setter method.

Returns:

  • (String) —

    The name of the inverse setter.



213
214
215
 
# File 'lib/mongoid/association/relatable.rb', line 213

def inverse_setter(other = nil)
  @inverse_setter ||= "#{inverses(other).first}=" unless inverses(other).blank?
end

#inverse_type ⇒ nil

Get the inverse type.

Returns:

  • (nil) —

    Default is nil for an association.



130
 
# File 'lib/mongoid/association/relatable.rb', line 130

def inverse_type; end

#inverse_type_setter ⇒ String

Gets the setter for the field that sets the type of document on a polymorphic association.

Examples:

Get the inverse type setter.

association.inverse_type_setter

Returns:

  • (String) —

    The name of the setter.



240
241
242
 
# File 'lib/mongoid/association/relatable.rb', line 240

def inverse_type_setter
  @inverse_type_setter ||= "#{inverse_type}=" if inverse_type
end

#inverses(other = nil) ⇒ Array<Symbol>

Get the inverse names.

Parameters:

  • other (Object) (defaults to: nil) —

    The other model class or model object to use when determining inverses.

Returns:

  • (Array<Symbol>) —

    The list of inverse names.



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mongoid/association/relatable.rb', line 106

def inverses(other = nil)
  return [ inverse_of ] if inverse_of
  return [] if @options.key?(:inverse_of) && !inverse_of

  if polymorphic?
    polymorphic_inverses(other)
  else
    determine_inverses(other)
  end
end

#key ⇒ Symbol | String

The foreign key field if this association stores a foreign key. Otherwise, the primary key.

Returns:

  • (Symbol | String) —

    The primary key.



199
200
201
 
# File 'lib/mongoid/association/relatable.rb', line 199

def key
  stores_foreign_key? ? foreign_key : primary_key
end

#many? ⇒ true | false

Is this association an embeds_many or has_many association?

Returns:

  • (true | false) —

    true if it is a *_many association, false if not.



326
327
328
 
# File 'lib/mongoid/association/relatable.rb', line 326

def many?
  [ Referenced::HasMany, Embedded::EmbedsMany ].any? { |a| is_a?(a) }
end

#one? ⇒ true | false

Is this association an embeds_one or has_one association?

Returns:

  • (true | false) —

    true if it is a *_one association, false if not.



333
334
335
 
# File 'lib/mongoid/association/relatable.rb', line 333

def one?
  [ Referenced::HasOne, Embedded::EmbedsOne ].any? { |a| is_a?(a) }
end

#path(document) ⇒ Mongoid::Atomic::Paths::Root

The atomic path for this association.

Returns:



229
230
231
 
# File 'lib/mongoid/association/relatable.rb', line 229

def path(document)
  relation.path(document)
end

#relation_class ⇒ String Also known as: klass

The class of the association object(s).

This method returns the class instance corresponding to relation_class_name, resolved relative to the host document class.

If the class does not exist, this method raises NameError. This can happen because the target class has not yet been defined. Note that polymorphic associations generally do not have a well defined target class because the target class can change from one object to another, and calling this method on a polymorphic association will generally fail with a NameError or produce misleading results (if a class does happen to be defined with the same name as the association name).

Returns:

  • (String) —

    The association objects' class.



172
173
174
175
176
177
 
# File 'lib/mongoid/association/relatable.rb', line 172

def relation_class
  @klass ||= begin
    cls_name = @options[:class_name] || ActiveSupport::Inflector.classify(name)
    resolve_name(inverse_class, cls_name)
  end
end

#relation_class_name ⇒ String Also known as: class_name

Note:

The return value of this method should not be used to determine whether two associations have the same target class, because the return value is not always a fully qualified class name. To compare classes, retrieve the class instance of the association target using the relation_class method.

The class name, possibly unqualified or

prefixed, of the association

object(s).

This method returns the class name as it is used in the association definition. If :class_name option is given in the association, the exact value of that option is returned here. If :class_name option is not given, the name of the class is calculated from association name but is not resolved to the actual class.

The class name returned by this method may not correspond to a defined class, either because the corresponding class has not been loaded yet, or because the association references a non-existent class altogether. To obtain the association class, use relation_class method.

Returns:

  • (String) —

    The association objects' class name.



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

def relation_class_name
  @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name)
end

#setter ⇒ String

The name of the setter on this object for assigning an associated object.

Returns:

  • (String) —

    The setter name.



206
207
208
 
# File 'lib/mongoid/association/relatable.rb', line 206

def setter
  @setter ||= "#{name}="
end

#type_setter ⇒ String

Note:

Only relevant for polymorphic associations that take the :as option.

Get the type setter.

Returns:

  • (String) —

    The type setter method.



86
87
88
 
# File 'lib/mongoid/association/relatable.rb', line 86

def type_setter
  @type_setter ||= "#{type}=" if type
end

#validate? ⇒ true | false

Whether the associated object(s) should be validated.

Returns:

  • (true | false) —

    If the associated object(s) should be validated.



303
304
305
306
307
308
309
 
# File 'lib/mongoid/association/relatable.rb', line 303

def validate?
  @validate ||= if @options[:validate].nil?
                  validation_default
                else
                  !!@options[:validate]
                end
end