Class: ActiveRecord::Associations::Association

Inherits:
Object
  • Object
show all
Defined in:
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.



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

def initialize(owner, reflection)
  reflection.check_validity!

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

  reset
  reset_scope

  @skip_strict_loading = nil
end

Instance Attribute Details

#disable_joins ⇒ Object (readonly)

Returns the value of attribute disable_joins.



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

def disable_joins
  @disable_joins
end

#owner ⇒ Object

:nodoc:



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

def owner
  @owner
end

#reflection ⇒ Object (readonly)

Returns the value of attribute reflection.



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

def reflection
  @reflection
end

#target ⇒ Object

Returns the value of attribute target.



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

def target
  @target
end

Instance Method Details

#collection? ⇒ Boolean

Whether the association represent a single record or a collection of records.

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/active_record/associations/association.rb', line 215

def collection?
  false
end

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



205
206
207
 
# File 'lib/active_record/associations/association.rb', line 205

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

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



209
210
211
 
# File 'lib/active_record/associations/association.rb', line 209

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

#extensions ⇒ Object 



154
155
156
157
158
159
160
161
162
 
# File 'lib/active_record/associations/association.rb', line 154

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:



195
196
197
198
199
200
201
202
203
 
# File 'lib/active_record/associations/association.rb', line 195

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 



138
139
140
 
# File 'lib/active_record/associations/association.rb', line 138

def inversed_from(record)
  self.target = record
end

#inversed_from_queries(record) ⇒ Object 



142
143
144
145
146
 
# File 'lib/active_record/associations/association.rb', line 142

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

#klass ⇒ Object

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



150
151
152
 
# File 'lib/active_record/associations/association.rb', line 150

def klass
  reflection.klass
end

#load_target ⇒ Object

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.



174
175
176
177
178
179
180
181
 
# File 'lib/active_record/associations/association.rb', line 174

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.



79
80
81
82
 
# File 'lib/active_record/associations/association.rb', line 79

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

#loaded? ⇒ Boolean

Has the target been already loaded?

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/active_record/associations/association.rb', line 74

def loaded?
  @loaded
end

#marshal_dump ⇒ Object

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



184
185
186
187
 
# File 'lib/active_record/associations/association.rb', line 184

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

#marshal_load(data) ⇒ Object 



189
190
191
192
193
 
# File 'lib/active_record/associations/association.rb', line 189

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.



65
66
67
68
69
70
71
 
# File 'lib/active_record/associations/association.rb', line 65

def reload(force = false)
  klass.connection_pool.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



132
133
134
135
136
 
# File 'lib/active_record/associations/association.rb', line 132

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

#reset ⇒ Object

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



54
55
56
57
 
# File 'lib/active_record/associations/association.rb', line 54

def reset
  @loaded = false
  @stale_state = nil
end

#reset_negative_cache ⇒ Object

:nodoc:



59
60
61
 
# File 'lib/active_record/associations/association.rb', line 59

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

#reset_scope ⇒ Object 



112
113
114
 
# File 'lib/active_record/associations/association.rb', line 112

def reset_scope
  @association_scope = nil
end

#scope ⇒ Object 



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

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



117
118
119
120
121
122
 
# File 'lib/active_record/associations/association.rb', line 117

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 



124
125
126
127
128
129
 
# File 'lib/active_record/associations/association.rb', line 124

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) 


90
91
92
 
# File 'lib/active_record/associations/association.rb', line 90

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