Class: ActiveRecord::Reflection::AssociationReflection
Overview
Holds all the meta-data about an association as it was specified in the Active Record class.
Instance Attribute Summary collapse
#active_record, #macro, #name, #options, #plural_name
Instance Method Summary
collapse
#==, #class_name, #sanitized_conditions
Constructor Details
#initialize(macro, name, options, active_record) ⇒ AssociationReflection
Returns a new instance of AssociationReflection.
176
177
178
179
|
# File 'lib/active_record/reflection.rb', line 176
def initialize(macro, name, options, active_record)
super
@collection = macro.in?([:has_many, :has_and_belongs_to_many])
end
|
Instance Attribute Details
#original_build_association_called ⇒ Object
This is a hack so that we can tell if build_association was overridden, in order to provide an appropriate deprecation if the overridden method ignored the &block. Please see Association#build_record for details.
184
185
186
|
# File 'lib/active_record/reflection.rb', line 184
def original_build_association_called
@original_build_association_called
end
|
Instance Method Details
#active_record_primary_key ⇒ Object
233
234
235
|
# File 'lib/active_record/reflection.rb', line 233
def active_record_primary_key
@active_record_primary_key ||= options[:primary_key] || active_record.primary_key
end
|
#association_class ⇒ Object
#association_foreign_key ⇒ Object
222
223
224
|
# File 'lib/active_record/reflection.rb', line 222
def association_foreign_key
@association_foreign_key ||= options[:association_foreign_key] || class_name.foreign_key
end
|
#association_primary_key ⇒ Object
226
227
228
229
230
231
|
# File 'lib/active_record/reflection.rb', line 226
def association_primary_key
@association_primary_key ||=
options[:primary_key] ||
!options[:polymorphic] && klass.primary_key ||
'id'
end
|
#belongs_to? ⇒ Boolean
Returns true
if self
is a belongs_to
reflection.
329
330
331
|
# File 'lib/active_record/reflection.rb', line 329
def belongs_to?
macro == :belongs_to
end
|
#build_association(*options, &block) ⇒ Object
Returns a new, unsaved instance of the associated class. options
will be passed to the class’s constructor.
188
189
190
191
|
# File 'lib/active_record/reflection.rb', line 188
def build_association(*options, &block)
@original_build_association_called = true
klass.new(*options, &block)
end
|
#chain ⇒ Object
A chain of reflections from this one back to the owner. For more see the explanation in ThroughReflection.
275
276
277
|
# File 'lib/active_record/reflection.rb', line 275
def chain
[self]
end
|
#check_validity! ⇒ Object
253
254
255
|
# File 'lib/active_record/reflection.rb', line 253
def check_validity!
check_validity_of_inverse!
end
|
#check_validity_of_inverse! ⇒ Object
257
258
259
260
261
262
263
|
# File 'lib/active_record/reflection.rb', line 257
def check_validity_of_inverse!
unless options[:polymorphic]
if has_inverse? && inverse_of.nil?
raise InverseOfAssociationNotFoundError.new(self)
end
end
end
|
#collection? ⇒ Boolean
Returns whether or not this association reflection is for a collection association. Returns true
if the macro
is either has_many
or has_and_belongs_to_many
, false
otherwise.
311
312
313
|
# File 'lib/active_record/reflection.rb', line 311
def collection?
@collection
end
|
#columns(tbl_name, log_msg) ⇒ Object
245
246
247
|
# File 'lib/active_record/reflection.rb', line 245
def columns(tbl_name, log_msg)
@columns ||= klass.connection.columns(tbl_name, log_msg)
end
|
#conditions ⇒ Object
An array of arrays of conditions. Each item in the outside array corresponds to a reflection in the #chain. The inside arrays are simply conditions (and each condition may itself be a hash, array, arel predicate, etc…)
282
283
284
|
# File 'lib/active_record/reflection.rb', line 282
def conditions
[[options[:conditions]].compact]
end
|
#counter_cache_column ⇒ Object
237
238
239
240
241
242
243
|
# File 'lib/active_record/reflection.rb', line 237
def counter_cache_column
if options[:counter_cache] == true
"#{active_record.name.demodulize.underscore.pluralize}_count"
elsif options[:counter_cache]
options[:counter_cache]
end
end
|
#foreign_key ⇒ Object
201
202
203
|
# File 'lib/active_record/reflection.rb', line 201
def foreign_key
@foreign_key ||= options[:foreign_key] || derive_foreign_key
end
|
#foreign_type ⇒ Object
210
211
212
|
# File 'lib/active_record/reflection.rb', line 210
def foreign_type
@foreign_type ||= options[:foreign_type] || "#{name}_type"
end
|
#has_inverse? ⇒ Boolean
288
289
290
|
# File 'lib/active_record/reflection.rb', line 288
def has_inverse?
@options[:inverse_of]
end
|
#inverse_of ⇒ Object
292
293
294
295
296
|
# File 'lib/active_record/reflection.rb', line 292
def inverse_of
if has_inverse?
@inverse_of ||= klass.reflect_on_association(options[:inverse_of])
end
end
|
#klass ⇒ Object
Returns the target association’s class.
class Author < ActiveRecord::Base
has_many :books
end
Author.reflect_on_association(:books).klass
Note: Do not call klass.new
or klass.create
to instantiate a new association object. Use build_association
or create_association
instead. This allows plugins to hook into association object creation.
172
173
174
|
# File 'lib/active_record/reflection.rb', line 172
def klass
@klass ||= active_record.send(:compute_type, class_name)
end
|
#polymorphic_inverse_of(associated_class) ⇒ Object
298
299
300
301
302
303
304
305
306
|
# File 'lib/active_record/reflection.rb', line 298
def polymorphic_inverse_of(associated_class)
if has_inverse?
if inverse_relationship = associated_class.reflect_on_association(options[:inverse_of])
inverse_relationship
else
raise InverseOfAssociationNotFoundError.new(self, associated_class)
end
end
end
|
#primary_key_column ⇒ Object
218
219
220
|
# File 'lib/active_record/reflection.rb', line 218
def primary_key_column
@primary_key_column ||= klass.columns.find { |c| c.name == klass.primary_key }
end
|
#primary_key_name ⇒ Object
205
206
207
|
# File 'lib/active_record/reflection.rb', line 205
def primary_key_name
foreign_key
end
|
#quoted_table_name ⇒ Object
197
198
199
|
# File 'lib/active_record/reflection.rb', line 197
def quoted_table_name
@quoted_table_name ||= klass.quoted_table_name
end
|
249
250
251
|
# File 'lib/active_record/reflection.rb', line 249
def reset_column_information
@columns = nil
end
|
#source_reflection ⇒ Object
269
270
271
|
# File 'lib/active_record/reflection.rb', line 269
def source_reflection
nil
end
|
#table_name ⇒ Object
193
194
195
|
# File 'lib/active_record/reflection.rb', line 193
def table_name
@table_name ||= klass.table_name
end
|
#through_reflection ⇒ Object
265
266
267
|
# File 'lib/active_record/reflection.rb', line 265
def through_reflection
nil
end
|
#type ⇒ Object
214
215
216
|
# File 'lib/active_record/reflection.rb', line 214
def type
@type ||= options[:as] && "#{options[:as]}_type"
end
|
#validate? ⇒ Boolean
Returns whether or not the association should be validated as part of the parent’s validation.
Unless you explicitly disable validation with :validate => false
, validation will take place when:
-
you explicitly enable validation; :validate => true
-
you use autosave; :autosave => true
-
the association is a has_many
association
324
325
326
|
# File 'lib/active_record/reflection.rb', line 324
def validate?
!options[:validate].nil? ? options[:validate] : (options[:autosave] == true || macro == :has_many)
end
|