Class: ActiveRecord::Reflection::AssociationReflection
- Inherits:
-
MacroReflection
- Object
- AbstractReflection
- MacroReflection
- ActiveRecord::Reflection::AssociationReflection
- Defined in:
- activerecord/lib/active_record/reflection.rb
Overview
Holds all the metadata about an association as it was specified in the Active Record class.
Direct Known Subclasses
BelongsToReflection, HasAndBelongsToManyReflection, HasManyReflection, HasOneReflection
Constant Summary collapse
- VALID_AUTOMATIC_INVERSE_MACROS =
[:has_many, :has_one, :belongs_to]
- INVALID_AUTOMATIC_INVERSE_OPTIONS =
[:through, :foreign_key]
Instance Attribute Summary collapse
-
#foreign_type ⇒ Object
readonly
Returns the value of attribute foreign_type.
-
#parent_reflection ⇒ Object
Reflection.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
Attributes inherited from MacroReflection
#active_record, #name, #options, #plural_name, #scope
Instance Method Summary collapse
- #active_record_primary_key ⇒ Object
- #add_as_polymorphic_through(reflection, seed) ⇒ Object
- #add_as_source(seed) ⇒ Object
- #add_as_through(seed) ⇒ Object
- #association_class ⇒ Object
- #association_foreign_key ⇒ Object
-
#association_primary_key(klass = nil) ⇒ Object
klass option is necessary to support loading polymorphic associations.
- #association_scope_cache(conn, owner, &block) ⇒ Object
-
#belongs_to? ⇒ Boolean
Returns
true
ifself
is abelongs_to
reflection. - #check_preloadable! ⇒ Object (also: #check_eager_loadable!)
- #check_validity! ⇒ Object
-
#clear_association_scope_cache ⇒ Object
This is for clearing cache on the reflection.
-
#collect_join_chain ⇒ Object
A chain of reflections from this one back to the owner.
-
#collection? ⇒ Boolean
Returns whether or not this association reflection is for a collection association.
-
#compute_class(name) ⇒ Object
:nodoc:.
-
#constructable? ⇒ Boolean
:nodoc:.
- #extensions ⇒ Object
- #foreign_key ⇒ Object
- #has_inverse? ⇒ Boolean
-
#has_one? ⇒ Boolean
Returns
true
ifself
is ahas_one
reflection. - #has_scope? ⇒ Boolean
-
#initialize(name, scope, options, active_record) ⇒ AssociationReflection
constructor
A new instance of AssociationReflection.
-
#join_id_for(owner) ⇒ Object
:nodoc:.
- #join_table ⇒ Object
-
#macro ⇒ Object
Returns the macro type.
- #nested? ⇒ Boolean
- #polymorphic? ⇒ Boolean
- #polymorphic_inverse_of(associated_class) ⇒ Object
- #source_reflection ⇒ 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
#==, #autosave=, #klass, #scope_for
Methods inherited from AbstractReflection
#alias_candidate, #build_association, #build_scope, #chain, #check_validity_of_inverse!, #class_name, #constraints, #counter_cache_column, #counter_must_be_updated_by_has_many?, #get_join_keys, #has_cached_counter?, #inverse_of, #inverse_updates_counter_in_memory?, #inverse_which_updates_counter_cache, #join_foreign_key, #join_keys, #join_primary_key, #join_scope, #join_scopes, #klass_join_scope, #scopes, #table_name, #through_reflection?
Constructor Details
#initialize(name, scope, options, active_record) ⇒ AssociationReflection
Returns a new instance of AssociationReflection.
428 429 430 431 432 433 434 435 436 437 438 |
# File 'activerecord/lib/active_record/reflection.rb', line 428 def initialize(name, scope, , active_record) super @type = [:as] && ([:foreign_type] || "#{[:as]}_type") @foreign_type = [:polymorphic] && ([:foreign_type] || "#{name}_type") @constructable = calculate_constructable(macro, ) @association_scope_cache = Concurrent::Map.new if [:class_name] && [:class_name].class == Class raise ArgumentError, "A class was passed to `:class_name` but we are expecting a string." end end |
Instance Attribute Details
#foreign_type ⇒ Object (readonly)
Returns the value of attribute foreign_type
425 426 427 |
# File 'activerecord/lib/active_record/reflection.rb', line 425 def foreign_type @foreign_type end |
#parent_reflection ⇒ Object
Reflection
426 427 428 |
# File 'activerecord/lib/active_record/reflection.rb', line 426 def parent_reflection @parent_reflection end |
#type ⇒ Object (readonly)
Returns the value of attribute type
425 426 427 |
# File 'activerecord/lib/active_record/reflection.rb', line 425 def type @type end |
Instance Method Details
#active_record_primary_key ⇒ Object
469 470 471 |
# File 'activerecord/lib/active_record/reflection.rb', line 469 def active_record_primary_key @active_record_primary_key ||= [:primary_key] || primary_key(active_record) end |
#add_as_polymorphic_through(reflection, seed) ⇒ Object
580 581 582 |
# File 'activerecord/lib/active_record/reflection.rb', line 580 def add_as_polymorphic_through(reflection, seed) seed + [PolymorphicReflection.new(self, reflection)] end |
#add_as_source(seed) ⇒ Object
576 577 578 |
# File 'activerecord/lib/active_record/reflection.rb', line 576 def add_as_source(seed) seed end |
#add_as_through(seed) ⇒ Object
584 585 586 |
# File 'activerecord/lib/active_record/reflection.rb', line 584 def add_as_through(seed) seed + [self] end |
#association_class ⇒ Object
567 |
# File 'activerecord/lib/active_record/reflection.rb', line 567 def association_class; raise NotImplementedError; end |
#association_foreign_key ⇒ Object
460 461 462 |
# File 'activerecord/lib/active_record/reflection.rb', line 460 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
465 466 467 |
# File 'activerecord/lib/active_record/reflection.rb', line 465 def association_primary_key(klass = nil) [:primary_key] || primary_key(klass || self.klass) end |
#association_scope_cache(conn, owner, &block) ⇒ Object
440 441 442 443 444 445 446 |
# File 'activerecord/lib/active_record/reflection.rb', line 440 def association_scope_cache(conn, owner, &block) key = conn.prepared_statements if polymorphic? key = [key, owner._read_attribute(@foreign_type)] end @association_scope_cache.compute_if_absent(key) { StatementCache.create(conn, &block) } end |
#belongs_to? ⇒ Boolean
Returns true
if self
is a belongs_to
reflection.
562 |
# File 'activerecord/lib/active_record/reflection.rb', line 562 def belongs_to?; false; end |
#check_preloadable! ⇒ Object Also known as: check_eager_loadable!
477 478 479 480 481 482 483 484 485 486 487 |
# File 'activerecord/lib/active_record/reflection.rb', line 477 def check_preloadable! return unless scope unless scope.arity == 0 raise ArgumentError, <<-MSG.squish The association scope '#{name}' is instance dependent (the scope block takes an argument). Preloading instance dependent scopes is not supported. MSG end end |
#check_validity! ⇒ Object
473 474 475 |
# File 'activerecord/lib/active_record/reflection.rb', line 473 def check_validity! check_validity_of_inverse! end |
#clear_association_scope_cache ⇒ Object
This is for clearing cache on the reflection. Useful for tests that need to compare SQL queries on associations.
510 511 512 |
# File 'activerecord/lib/active_record/reflection.rb', line 510 def clear_association_scope_cache # :nodoc: @association_scope_cache.clear end |
#collect_join_chain ⇒ Object
A chain of reflections from this one back to the owner. For more see the explanation in ThroughReflection.
504 505 506 |
# File 'activerecord/lib/active_record/reflection.rb', line 504 def collect_join_chain [self] 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.
544 545 546 |
# File 'activerecord/lib/active_record/reflection.rb', line 544 def collection? false end |
#compute_class(name) ⇒ Object
:nodoc:
418 419 420 421 422 423 |
# File 'activerecord/lib/active_record/reflection.rb', line 418 def compute_class(name) if polymorphic? raise ArgumentError, "Polymorphic associations do not support computing the class." end active_record.send(:compute_type, name) end |
#constructable? ⇒ Boolean
:nodoc:
448 449 450 |
# File 'activerecord/lib/active_record/reflection.rb', line 448 def constructable? # :nodoc: @constructable end |
#extensions ⇒ Object
588 589 590 |
# File 'activerecord/lib/active_record/reflection.rb', line 588 def extensions Array([:extend]) end |
#foreign_key ⇒ Object
456 457 458 |
# File 'activerecord/lib/active_record/reflection.rb', line 456 def foreign_key @foreign_key ||= [:foreign_key] || derive_foreign_key.freeze end |
#has_inverse? ⇒ Boolean
522 523 524 |
# File 'activerecord/lib/active_record/reflection.rb', line 522 def has_inverse? inverse_name end |
#has_one? ⇒ Boolean
Returns true
if self
is a has_one
reflection.
565 |
# File 'activerecord/lib/active_record/reflection.rb', line 565 def has_one?; false; end |
#has_scope? ⇒ Boolean
518 519 520 |
# File 'activerecord/lib/active_record/reflection.rb', line 518 def has_scope? scope end |
#join_id_for(owner) ⇒ Object
:nodoc:
490 491 492 |
# File 'activerecord/lib/active_record/reflection.rb', line 490 def join_id_for(owner) # :nodoc: owner[join_foreign_key] end |
#join_table ⇒ Object
452 453 454 |
# File 'activerecord/lib/active_record/reflection.rb', line 452 def join_table @join_table ||= [:join_table] || derive_join_table end |
#macro ⇒ Object
Returns the macro type.
has_many :clients
returns :has_many
539 |
# File 'activerecord/lib/active_record/reflection.rb', line 539 def macro; raise NotImplementedError; end |
#nested? ⇒ Boolean
514 515 516 |
# File 'activerecord/lib/active_record/reflection.rb', line 514 def nested? false end |
#polymorphic? ⇒ Boolean
569 570 571 |
# File 'activerecord/lib/active_record/reflection.rb', line 569 def polymorphic? [:polymorphic] end |
#polymorphic_inverse_of(associated_class) ⇒ Object
526 527 528 529 530 531 532 533 534 |
# File 'activerecord/lib/active_record/reflection.rb', line 526 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 |
#source_reflection ⇒ Object
498 499 500 |
# File 'activerecord/lib/active_record/reflection.rb', line 498 def source_reflection self end |
#through_reflection ⇒ Object
494 495 496 |
# File 'activerecord/lib/active_record/reflection.rb', line 494 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
557 558 559 |
# File 'activerecord/lib/active_record/reflection.rb', line 557 def validate? ![:validate].nil? ? [:validate] : ([:autosave] == true || collection?) end |