Class: ActiveRecord::Associations::Association

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/associations/association.rb

Overview

Active Record Associations

This is the root class of all associations ('+ Foo' signifies an included module Foo):

Association
  SingularAssociation
    HasOneAssociation + ForeignAssociation
      HasOneThroughAssociation + ThroughAssociation
    BelongsToAssociation
      BelongsToPolymorphicAssociation
  CollectionAssociation
    HasManyAssociation + ForeignAssociation
      HasManyThroughAssociation + ThroughAssociation

Associations in Active Record are middlemen between the object that holds the association, known as the owner, and the associated result set, known as the target. Association metadata is available in reflection, which is an instance of ActiveRecord::Reflection::AssociationReflection.

For example, given

class Blog < ActiveRecord::Base
  has_many :posts
end

blog = Blog.first

The association of blog.posts has the object blog as its owner, the collection of its posts as target, and the reflection object represents a :has_many macro.

Direct Known Subclasses

CollectionAssociation, SingularAssociation

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(owner, reflection) ⇒ Association

Returns a new instance of Association.


40
41
42
43
44
45
46
47
48
# File 'activerecord/lib/active_record/associations/association.rb', line 40

def initialize(owner, reflection)
  reflection.check_validity!

  @owner, @reflection = owner, reflection
  @disable_joins = @reflection.options[:disable_joins] || false

  reset
  reset_scope
end

Instance Attribute Details

#disable_joinsObject (readonly)

:nodoc:


36
37
38
# File 'activerecord/lib/active_record/associations/association.rb', line 36

def disable_joins
  @disable_joins
end

#ownerObject (readonly)

:nodoc:


36
37
38
# File 'activerecord/lib/active_record/associations/association.rb', line 36

def owner
  @owner
end

#reflectionObject (readonly)

:nodoc:


36
37
38
# File 'activerecord/lib/active_record/associations/association.rb', line 36

def reflection
  @reflection
end

#targetObject

:nodoc:


36
37
38
# File 'activerecord/lib/active_record/associations/association.rb', line 36

def target
  @target
end

Instance Method Details

#create(attributes = nil, &block) ⇒ Object


203
204
205
# File 'activerecord/lib/active_record/associations/association.rb', line 203

def create(attributes = nil, &block)
  _create_record(attributes, &block)
end

#create!(attributes = nil, &block) ⇒ Object


207
208
209
# File 'activerecord/lib/active_record/associations/association.rb', line 207

def create!(attributes = nil, &block)
  _create_record(attributes, true, &block)
end

#extensionsObject


152
153
154
155
156
157
158
159
160
# File 'activerecord/lib/active_record/associations/association.rb', line 152

def extensions
  extensions = klass.default_extensions | reflection.extensions

  if reflection.scope
    extensions |= reflection.scope_for(klass.unscoped, owner).extensions
  end

  extensions
end

#initialize_attributes(record, except_from_scope_attributes = nil) ⇒ Object

:nodoc:


193
194
195
196
197
198
199
200
201
# File 'activerecord/lib/active_record/associations/association.rb', line 193

def initialize_attributes(record, except_from_scope_attributes = nil) # :nodoc:
  except_from_scope_attributes ||= {}
  skip_assign = [reflection.foreign_key, reflection.type].compact
  assigned_keys = record.changed_attribute_names_to_save
  assigned_keys += except_from_scope_attributes.keys.map(&:to_s)
  attributes = scope_for_create.except!(*(assigned_keys - skip_assign))
  record.send(:_assign_attributes, attributes) if attributes.any?
  set_inverse_instance(record)
end

#inversed_from(record) ⇒ Object


136
137
138
# File 'activerecord/lib/active_record/associations/association.rb', line 136

def inversed_from(record)
  self.target = record
end

#inversed_from_queries(record) ⇒ Object


140
141
142
143
144
# File 'activerecord/lib/active_record/associations/association.rb', line 140

def inversed_from_queries(record)
  if inversable?(record)
    self.target = record
  end
end

#klassObject

Returns the class of the target. belongs_to polymorphic overrides this to look at the polymorphic_type field on the owner.


148
149
150
# File 'activerecord/lib/active_record/associations/association.rb', line 148

def klass
  reflection.klass
end

#load_targetObject

Loads the target if needed and returns it.

This method is abstract in the sense that it relies on find_target, which is expected to be provided by descendants.

If the target is already loaded it is just returned. Thus, you can call load_target unconditionally to get the target.

ActiveRecord::RecordNotFound is rescued within the method, and it is not reraised. The proxy is reset and nil is the return value.


172
173
174
175
176
177
178
179
# File 'activerecord/lib/active_record/associations/association.rb', line 172

def load_target
  @target = find_target if (@stale_state && stale_target?) || find_target?

  loaded! unless loaded?
  target
rescue ActiveRecord::RecordNotFound
  reset
end

#loaded!Object

Asserts the target has been loaded setting the loaded flag to true.


77
78
79
80
# File 'activerecord/lib/active_record/associations/association.rb', line 77

def loaded!
  @loaded = true
  @stale_state = stale_state
end

#loaded?Boolean

Has the target been already loaded?

Returns:

  • (Boolean)

72
73
74
# File 'activerecord/lib/active_record/associations/association.rb', line 72

def loaded?
  @loaded
end

#marshal_dumpObject

We can't dump @reflection and @through_reflection since it contains the scope proc


182
183
184
185
# File 'activerecord/lib/active_record/associations/association.rb', line 182

def marshal_dump
  ivars = (instance_variables - [:@reflection, :@through_reflection]).map { |name| [name, instance_variable_get(name)] }
  [@reflection.name, ivars]
end

#marshal_load(data) ⇒ Object


187
188
189
190
191
# File 'activerecord/lib/active_record/associations/association.rb', line 187

def marshal_load(data)
  reflection_name, ivars = data
  ivars.each { |name, val| instance_variable_set(name, val) }
  @reflection = @owner.class._reflect_on_association(reflection_name)
end

#reload(force = false) ⇒ Object

Reloads the target and returns self on success. The QueryCache is cleared if force is true.


63
64
65
66
67
68
69
# File 'activerecord/lib/active_record/associations/association.rb', line 63

def reload(force = false)
  klass.connection.clear_query_cache if force && klass
  reset
  reset_scope
  load_target
  self unless target.nil?
end

#remove_inverse_instance(record) ⇒ Object

Remove the inverse association, if possible


130
131
132
133
134
# File 'activerecord/lib/active_record/associations/association.rb', line 130

def remove_inverse_instance(record)
  if inverse = inverse_association_for(record)
    inverse.inversed_from(nil)
  end
end

#resetObject

Resets the loaded flag to false and sets the target to nil.


51
52
53
54
55
# File 'activerecord/lib/active_record/associations/association.rb', line 51

def reset
  @loaded = false
  @target = nil
  @stale_state = nil
end

#reset_negative_cacheObject

:nodoc:


57
58
59
# File 'activerecord/lib/active_record/associations/association.rb', line 57

def reset_negative_cache # :nodoc:
  reset if loaded? && target.nil?
end

#reset_scopeObject


110
111
112
# File 'activerecord/lib/active_record/associations/association.rb', line 110

def reset_scope
  @association_scope = nil
end

#scopeObject


98
99
100
101
102
103
104
105
106
107
108
# File 'activerecord/lib/active_record/associations/association.rb', line 98

def scope
  if disable_joins
    DisableJoinsAssociationScope.create.scope(self)
  elsif (scope = klass.current_scope) && scope.try(:proxy_association) == self
    scope.spawn
  elsif scope = klass.global_current_scope
    target_scope.merge!(association_scope).merge!(scope)
  else
    target_scope.merge!(association_scope)
  end
end

#set_inverse_instance(record) ⇒ Object

Set the inverse association, if possible


115
116
117
118
119
120
# File 'activerecord/lib/active_record/associations/association.rb', line 115

def set_inverse_instance(record)
  if inverse = inverse_association_for(record)
    inverse.inversed_from(owner)
  end
  record
end

#set_inverse_instance_from_queries(record) ⇒ Object


122
123
124
125
126
127
# File 'activerecord/lib/active_record/associations/association.rb', line 122

def set_inverse_instance_from_queries(record)
  if inverse = inverse_association_for(record)
    inverse.inversed_from_queries(owner)
  end
  record
end

#stale_target?Boolean

The target is stale if the target no longer points to the record(s) that the relevant foreign_key(s) refers to. If stale, the association accessor method on the owner will reload the target. It's up to subclasses to implement the stale_state method if relevant.

Note that if the target has not been loaded, it is not considered stale.

Returns:

  • (Boolean)

88
89
90
# File 'activerecord/lib/active_record/associations/association.rb', line 88

def stale_target?
  loaded? && @stale_state != stale_state
end