Class: ActiveRecord::Reflection::AssociationReflection
- Inherits:
-
MacroReflection
- Object
- MacroReflection
- ActiveRecord::Reflection::AssociationReflection
- Defined in:
- lib/active_record/reflection.rb
Overview
Holds all the meta-data about an association as it was specified in the Active Record class.
Direct Known Subclasses
Constant Summary collapse
- VALID_AUTOMATIC_INVERSE_MACROS =
[:has_many, :has_one, :belongs_to]
- INVALID_AUTOMATIC_INVERSE_OPTIONS =
[:conditions, :through, :polymorphic, :foreign_key]
Instance Attribute Summary collapse
-
#foreign_type ⇒ Object
readonly
Returns the value of attribute foreign_type.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
Attributes inherited from MacroReflection
#active_record, #macro, #name, #options, #plural_name, #scope
Instance Method Summary collapse
- #active_record_primary_key ⇒ Object
- #association_class ⇒ Object
- #association_foreign_key ⇒ Object
-
#association_primary_key(klass = nil) ⇒ Object
klass option is necessary to support loading polymorphic associations.
-
#belongs_to? ⇒ Boolean
Returns
true
ifself
is abelongs_to
reflection. -
#build_association(attributes, &block) ⇒ Object
Returns a new, unsaved instance of the associated class.
-
#chain ⇒ Object
A chain of reflections from this one back to the owner.
- #check_validity! ⇒ Object
- #check_validity_of_inverse! ⇒ Object
-
#collection? ⇒ Boolean
Returns whether or not this association reflection is for a collection association.
-
#constructable? ⇒ Boolean
:nodoc:.
- #counter_cache_column ⇒ Object
- #foreign_key ⇒ Object
- #has_inverse? ⇒ Boolean
-
#initialize(macro, name, scope, options, active_record) ⇒ AssociationReflection
constructor
A new instance of AssociationReflection.
- #inverse_of ⇒ Object
- #join_table ⇒ Object
-
#klass ⇒ Object
Returns the target association’s class.
- #nested? ⇒ Boolean
- #polymorphic? ⇒ Boolean
- #polymorphic_inverse_of(associated_class) ⇒ Object
- #primary_key_column ⇒ Object
- #quoted_table_name ⇒ Object
-
#scope_chain ⇒ Object
An array of arrays of scopes.
- #source_reflection ⇒ Object
- #table_name ⇒ Object
- #through_reflection ⇒ Object
-
#validate? ⇒ Boolean
Returns whether or not the association should be validated as part of the parent’s validation.
Methods inherited from MacroReflection
Constructor Details
#initialize(macro, name, scope, options, active_record) ⇒ AssociationReflection
Returns a new instance of AssociationReflection.
195 196 197 198 199 200 201 202 |
# File 'lib/active_record/reflection.rb', line 195 def initialize(macro, name, scope, , active_record) super @collection = :has_many == macro @automatic_inverse_of = nil @type = [:as] && "#{[:as]}_type" @foreign_type = [:foreign_type] || "#{name}_type" @constructable = calculate_constructable(macro, ) end |
Instance Attribute Details
#foreign_type ⇒ Object (readonly)
Returns the value of attribute foreign_type.
193 194 195 |
# File 'lib/active_record/reflection.rb', line 193 def foreign_type @foreign_type end |
#type ⇒ Object (readonly)
Returns the value of attribute type.
193 194 195 |
# File 'lib/active_record/reflection.rb', line 193 def type @type end |
Instance Method Details
#active_record_primary_key ⇒ Object
243 244 245 |
# File 'lib/active_record/reflection.rb', line 243 def active_record_primary_key @active_record_primary_key ||= [:primary_key] || primary_key(active_record) end |
#association_class ⇒ Object
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/active_record/reflection.rb', line 338 def association_class case macro when :belongs_to if [:polymorphic] Associations::BelongsToPolymorphicAssociation else Associations::BelongsToAssociation end when :has_many if [:through] Associations::HasManyThroughAssociation else Associations::HasManyAssociation end when :has_one if [:through] Associations::HasOneThroughAssociation else Associations::HasOneAssociation end end end |
#association_foreign_key ⇒ Object
234 235 236 |
# File 'lib/active_record/reflection.rb', line 234 def association_foreign_key @association_foreign_key ||= [:association_foreign_key] || class_name.foreign_key end |
#association_primary_key(klass = nil) ⇒ Object
klass option is necessary to support loading polymorphic associations
239 240 241 |
# File 'lib/active_record/reflection.rb', line 239 def association_primary_key(klass = nil) [:primary_key] || primary_key(klass || self.klass) end |
#belongs_to? ⇒ Boolean
Returns true
if self
is a belongs_to
reflection.
334 335 336 |
# File 'lib/active_record/reflection.rb', line 334 def belongs_to? macro == :belongs_to end |
#build_association(attributes, &block) ⇒ Object
Returns a new, unsaved instance of the associated class. attributes
will be passed to the class’s constructor.
206 207 208 |
# File 'lib/active_record/reflection.rb', line 206 def build_association(attributes, &block) klass.new(attributes, &block) end |
#chain ⇒ Object
A chain of reflections from this one back to the owner. For more see the explanation in ThroughReflection.
277 278 279 |
# File 'lib/active_record/reflection.rb', line 277 def chain [self] end |
#check_validity! ⇒ Object
255 256 257 |
# File 'lib/active_record/reflection.rb', line 255 def check_validity! check_validity_of_inverse! end |
#check_validity_of_inverse! ⇒ Object
259 260 261 262 263 264 265 |
# File 'lib/active_record/reflection.rb', line 259 def check_validity_of_inverse! unless [: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.
316 317 318 |
# File 'lib/active_record/reflection.rb', line 316 def collection? @collection end |
#constructable? ⇒ Boolean
:nodoc:
210 211 212 |
# File 'lib/active_record/reflection.rb', line 210 def constructable? # :nodoc: @constructable end |
#counter_cache_column ⇒ Object
247 248 249 250 251 252 253 |
# File 'lib/active_record/reflection.rb', line 247 def counter_cache_column if [:counter_cache] == true "#{active_record.name.demodulize.underscore.pluralize}_count" elsif [:counter_cache] [:counter_cache].to_s end end |
#foreign_key ⇒ Object
226 227 228 |
# File 'lib/active_record/reflection.rb', line 226 def foreign_key @foreign_key ||= [:foreign_key] || derive_foreign_key end |
#has_inverse? ⇒ Boolean
293 294 295 |
# File 'lib/active_record/reflection.rb', line 293 def has_inverse? inverse_name end |
#inverse_of ⇒ Object
297 298 299 300 301 |
# File 'lib/active_record/reflection.rb', line 297 def inverse_of return unless inverse_name @inverse_of ||= klass.reflect_on_association inverse_name end |
#join_table ⇒ Object
222 223 224 |
# File 'lib/active_record/reflection.rb', line 222 def join_table @join_table ||= [:join_table] || derive_join_table end |
#klass ⇒ Object
Returns the target association’s class.
class Author < ActiveRecord::Base
has_many :books
end
Author.reflect_on_association(:books).klass
# => Book
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.
189 190 191 |
# File 'lib/active_record/reflection.rb', line 189 def klass @klass ||= active_record.send(:compute_type, class_name) end |
#nested? ⇒ Boolean
281 282 283 |
# File 'lib/active_record/reflection.rb', line 281 def nested? false end |
#polymorphic? ⇒ Boolean
361 362 363 |
# File 'lib/active_record/reflection.rb', line 361 def polymorphic? .key? :polymorphic end |
#polymorphic_inverse_of(associated_class) ⇒ Object
303 304 305 306 307 308 309 310 311 |
# File 'lib/active_record/reflection.rb', line 303 def polymorphic_inverse_of(associated_class) if has_inverse? if inverse_relationship = associated_class.reflect_on_association([:inverse_of]) inverse_relationship else raise InverseOfAssociationNotFoundError.new(self, associated_class) end end end |
#primary_key_column ⇒ Object
230 231 232 |
# File 'lib/active_record/reflection.rb', line 230 def primary_key_column klass.columns_hash[klass.primary_key] end |
#quoted_table_name ⇒ Object
218 219 220 |
# File 'lib/active_record/reflection.rb', line 218 def quoted_table_name klass.quoted_table_name end |
#scope_chain ⇒ Object
An array of arrays of scopes. Each item in the outside array corresponds to a reflection in the #chain.
287 288 289 |
# File 'lib/active_record/reflection.rb', line 287 def scope_chain scope ? [[scope]] : [[]] end |
#source_reflection ⇒ Object
271 272 273 |
# File 'lib/active_record/reflection.rb', line 271 def source_reflection self end |
#table_name ⇒ Object
214 215 216 |
# File 'lib/active_record/reflection.rb', line 214 def table_name klass.table_name end |
#through_reflection ⇒ Object
267 268 269 |
# File 'lib/active_record/reflection.rb', line 267 def through_reflection nil 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
329 330 331 |
# File 'lib/active_record/reflection.rb', line 329 def validate? ![:validate].nil? ? [:validate] : ([:autosave] == true || macro == :has_many) end |