Class: ActiveRecord::Reflection::AbstractReflection

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/reflection.rb

Overview

Holds all the methods that are shared between MacroReflection and ThroughReflection.

AbstractReflection
  MacroReflection
    AggregateReflection
    AssociationReflection
      HasManyReflection
      HasOneReflection
      BelongsToReflection
      HasAndBelongsToManyReflection
  ThroughReflection
  PolymorphicReflection
    RuntimeReflection

Defined Under Namespace

Classes: JoinKeys

Instance Method Summary collapse

Instance Method Details

#alias_candidate(name) ⇒ Object 



280
281
282
 
# File 'lib/active_record/reflection.rb', line 280

def alias_candidate(name)
  "#{plural_name}_#{name}"
end

#build_association(attributes, &block) ⇒ Object

Returns a new, unsaved instance of the associated class. attributes will be passed to the class’s constructor.



153
154
155
 
# File 'lib/active_record/reflection.rb', line 153

def build_association(attributes, &block)
  klass.new(attributes, &block)
end

#chain ⇒ Object 



284
285
286
 
# File 'lib/active_record/reflection.rb', line 284

def chain
  collect_join_chain
end

#check_validity_of_inverse! ⇒ Object 



236
237
238
239
240
241
242
 
# File 'lib/active_record/reflection.rb', line 236

def check_validity_of_inverse!
  unless polymorphic?
    if has_inverse? && inverse_of.nil?
      raise InverseOfAssociationNotFoundError.new(self)
    end
  end
end

#class_name ⇒ Object

Returns the class name for the macro.

composed_of :balance, class_name: 'Money' returns 'Money' has_many :clients returns 'Client'



169
170
171
 
# File 'lib/active_record/reflection.rb', line 169

def class_name
  @class_name ||= (options[:class_name] || derive_class_name).to_s
end

#constraints ⇒ Object 



214
215
216
 
# File 'lib/active_record/reflection.rb', line 214

def constraints
  chain.map(&:scopes).flatten
end

#counter_cache_column ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/active_record/reflection.rb', line 218

def counter_cache_column
  if belongs_to?
    if options[:counter_cache] == true
      "#{active_record.name.demodulize.underscore.pluralize}_count"
    elsif options[:counter_cache]
      options[:counter_cache].to_s
    end
  else
    options[:counter_cache] ? options[:counter_cache].to_s : "#{name}_count"
  end
end

#counter_must_be_updated_by_has_many? ⇒ Boolean

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/active_record/reflection.rb', line 276

def counter_must_be_updated_by_has_many?
  !inverse_updates_counter_in_memory? && has_cached_counter?
end

#get_join_keys(association_klass) ⇒ Object 



288
289
290
 
# File 'lib/active_record/reflection.rb', line 288

def get_join_keys(association_klass)
  JoinKeys.new(join_pk(association_klass), join_fk)
end

#has_cached_counter? ⇒ Boolean

Returns whether a counter cache should be used for this association.

The counter_cache option must be given on either the owner or inverse association, and the column must be present on the owner.

Returns:

  • (Boolean) 


270
271
272
273
274
 
# File 'lib/active_record/reflection.rb', line 270

def has_cached_counter?
  options[:counter_cache] ||
    inverse_which_updates_counter_cache && inverse_which_updates_counter_cache.options[:counter_cache] &&
    !!active_record.columns_hash[counter_cache_column]
end

#inverse_of ⇒ Object 



230
231
232
233
234
 
# File 'lib/active_record/reflection.rb', line 230

def inverse_of
  return unless inverse_name

  @inverse_of ||= klass._reflect_on_association inverse_name
end

#inverse_updates_counter_in_memory? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
 
# File 'lib/active_record/reflection.rb', line 262

def inverse_updates_counter_in_memory?
  inverse_of && inverse_which_updates_counter_cache == inverse_of
end

#inverse_which_updates_counter_cache ⇒ Object Also known as: inverse_updates_counter_cache?

This shit is nasty. We need to avoid the following situation:

* An associated record is deleted via record.destroy
* Hence the callbacks run, and they find a belongs_to on the record with a
  :counter_cache options which points back at our owner. So they update the
  counter cache.
* In which case, we must make sure to *not* update the counter cache, or else
  it will be decremented twice.

Hence this method.



254
255
256
257
258
259
 
# File 'lib/active_record/reflection.rb', line 254

def inverse_which_updates_counter_cache
  return @inverse_which_updates_counter_cache if defined?(@inverse_which_updates_counter_cache)
  @inverse_which_updates_counter_cache = klass.reflect_on_all_associations(:belongs_to).find do |inverse|
    inverse.counter_cache_column == counter_cache_column
  end
end

#join_keys ⇒ Object 



175
176
177
 
# File 'lib/active_record/reflection.rb', line 175

def join_keys
  get_join_keys klass
end

#join_scopes(table, predicate_builder) ⇒ Object

:nodoc:



190
191
192
193
194
195
196
197
 
# File 'lib/active_record/reflection.rb', line 190

def join_scopes(table, predicate_builder) # :nodoc:
  if scope
    [ActiveRecord::Relation.create(klass, table, predicate_builder)
      .instance_exec(&scope)]
  else
    []
  end
end

#klass_join_scope(table, predicate_builder) ⇒ Object

:nodoc:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/active_record/reflection.rb', line 199

def klass_join_scope(table, predicate_builder) # :nodoc:
  if klass.current_scope
    klass.current_scope.clone.tap { |scope|
      scope.joins_values = []
    }
  else
    relation = ActiveRecord::Relation.create(
      klass,
      table,
      predicate_builder,
    )
    klass.send(:build_default_scope, relation)
  end
end

#primary_key_type ⇒ Object 



161
162
163
 
# File 'lib/active_record/reflection.rb', line 161

def primary_key_type
  klass.type_for_attribute(klass.primary_key)
end

#quoted_table_name ⇒ Object 



157
158
159
 
# File 'lib/active_record/reflection.rb', line 157

def quoted_table_name
  klass.quoted_table_name
end

#scope_chain ⇒ Object 



185
186
187
 
# File 'lib/active_record/reflection.rb', line 185

def scope_chain
  chain.map(&:scopes)
end

#scopes ⇒ Object

Returns a list of scopes that should be applied for this Reflection object when querying the database.



181
182
183
 
# File 'lib/active_record/reflection.rb', line 181

def scopes
  scope ? [scope] : []
end

#table_name ⇒ Object 



147
148
149
 
# File 'lib/active_record/reflection.rb', line 147

def table_name
  klass.table_name
end

#through_reflection? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/active_record/reflection.rb', line 143

def through_reflection?
  false
end