Class: ActiveRecord::Reflection::AssociationReflection

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

Overview

Holds all the metadata about an association as it was specified in the Active Record class.

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

Attributes inherited from MacroReflection

#active_record, #name, #options, #plural_name, #scope

Instance Method Summary collapse

Methods inherited from MacroReflection

#==, #autosave=, #scope_for

Methods inherited from AbstractReflection

#alias_candidate, #build_association, #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_keys, #join_scopes, #klass_join_scope, #primary_key_type, #quoted_table_name, #scope_chain, #scopes, #table_name, #through_reflection?

Constructor Details

#initialize(name, scope, options, active_record) ⇒ AssociationReflection

Returns a new instance of AssociationReflection.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/active_record/reflection.rb', line 409

def initialize(name, scope, options, active_record)
  super
  @automatic_inverse_of = nil
  @type         = options[:as] && (options[:foreign_type] || "#{options[:as]}_type")
  @foreign_type = options[:foreign_type] || "#{name}_type"
  @constructable = calculate_constructable(macro, options)
  @association_scope_cache = {}
  @scope_lock = Mutex.new

  if options[:class_name] && options[:class_name].class == Class
    ActiveSupport::Deprecation.warn(<<-MSG.squish)
      Passing a class to the `class_name` is deprecated and will raise
      an ArgumentError in Rails 5.2. It eagerloads more classes than
      necessary and potentially creates circular dependencies.

      Please pass the class name as a string:
      `#{macro} :#{name}, class_name: '#{options[:class_name]}'`
    MSG
  end
end

Instance Attribute Details

#foreign_type ⇒ Object (readonly)

Returns the value of attribute foreign_type.



406
407
408
 
# File 'lib/active_record/reflection.rb', line 406

def foreign_type
  @foreign_type
end

#parent_reflection ⇒ Object

Reflection



407
408
409
 
# File 'lib/active_record/reflection.rb', line 407

def parent_reflection
  @parent_reflection
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



406
407
408
 
# File 'lib/active_record/reflection.rb', line 406

def type
  @type
end

Instance Method Details

#active_record_primary_key ⇒ Object 



465
466
467
 
# File 'lib/active_record/reflection.rb', line 465

def active_record_primary_key
  @active_record_primary_key ||= options[:primary_key] || primary_key(active_record)
end

#add_as_polymorphic_through(reflection, seed) ⇒ Object 



576
577
578
 
# File 'lib/active_record/reflection.rb', line 576

def add_as_polymorphic_through(reflection, seed)
  seed + [PolymorphicReflection.new(self, reflection)]
end

#add_as_source(seed) ⇒ Object 



572
573
574
 
# File 'lib/active_record/reflection.rb', line 572

def add_as_source(seed)
  seed
end

#add_as_through(seed) ⇒ Object 



580
581
582
 
# File 'lib/active_record/reflection.rb', line 580

def add_as_through(seed)
  seed + [self]
end

#association_class ⇒ Object

Raises:

  • (NotImplementedError) 


563
 
# File 'lib/active_record/reflection.rb', line 563

def association_class; raise NotImplementedError; end

#association_foreign_key ⇒ Object 



452
453
454
 
# File 'lib/active_record/reflection.rb', line 452

def association_foreign_key
  @association_foreign_key ||= options[:association_foreign_key] || class_name.foreign_key
end

#association_primary_key(klass = nil) ⇒ Object

klass option is necessary to support loading polymorphic associations



457
458
459
 
# File 'lib/active_record/reflection.rb', line 457

def association_primary_key(klass = nil)
  options[:primary_key] || primary_key(klass || self.klass)
end

#association_primary_key_type ⇒ Object 



461
462
463
 
# File 'lib/active_record/reflection.rb', line 461

def association_primary_key_type
  klass.type_for_attribute(association_primary_key.to_s)
end

#association_scope_cache(conn, owner) ⇒ Object 



430
431
432
433
434
435
436
437
438
 
# File 'lib/active_record/reflection.rb', line 430

def association_scope_cache(conn, owner)
  key = conn.prepared_statements
  if polymorphic?
    key = [key, owner._read_attribute(@foreign_type)]
  end
  @association_scope_cache[key] ||= @scope_lock.synchronize {
    @association_scope_cache[key] ||= yield
  }
end

#belongs_to? ⇒ Boolean

Returns true if self is a belongs_to reflection.

Returns:

  • (Boolean) 


558
 
# File 'lib/active_record/reflection.rb', line 558

def belongs_to?; false; end

#check_preloadable! ⇒ Object Also known as: check_eager_loadable! 



473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/active_record/reflection.rb', line 473

def check_preloadable!
  return unless scope

  if 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 



469
470
471
 
# File 'lib/active_record/reflection.rb', line 469

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.



506
507
508
 
# File 'lib/active_record/reflection.rb', line 506

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.



500
501
502
 
# File 'lib/active_record/reflection.rb', line 500

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.

Returns:

  • (Boolean) 


540
541
542
 
# File 'lib/active_record/reflection.rb', line 540

def collection?
  false
end

#compute_class(name) ⇒ Object 



402
403
404
 
# File 'lib/active_record/reflection.rb', line 402

def compute_class(name)
  active_record.send(:compute_type, name)
end

#constructable? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


440
441
442
 
# File 'lib/active_record/reflection.rb', line 440

def constructable? # :nodoc:
  @constructable
end

#foreign_key ⇒ Object 



448
449
450
 
# File 'lib/active_record/reflection.rb', line 448

def foreign_key
  @foreign_key ||= options[:foreign_key] || derive_foreign_key.freeze
end

#has_inverse? ⇒ Boolean

Returns:

  • (Boolean) 


518
519
520
 
# File 'lib/active_record/reflection.rb', line 518

def has_inverse?
  inverse_name
end

#has_one? ⇒ Boolean

Returns true if self is a has_one reflection.

Returns:

  • (Boolean) 


561
 
# File 'lib/active_record/reflection.rb', line 561

def has_one?; false; end

#has_scope? ⇒ Boolean

Returns:

  • (Boolean) 


514
515
516
 
# File 'lib/active_record/reflection.rb', line 514

def has_scope?
  scope
end

#join_id_for(owner) ⇒ Object

:nodoc:



486
487
488
 
# File 'lib/active_record/reflection.rb', line 486

def join_id_for(owner) # :nodoc:
  owner[active_record_primary_key]
end

#join_table ⇒ Object 



444
445
446
 
# File 'lib/active_record/reflection.rb', line 444

def join_table
  @join_table ||= options[: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.



398
399
400
 
# File 'lib/active_record/reflection.rb', line 398

def klass
  @klass ||= compute_class(class_name)
end

#macro ⇒ Object

Returns the macro type.

has_many :clients returns :has_many

Raises:

  • (NotImplementedError) 


535
 
# File 'lib/active_record/reflection.rb', line 535

def macro; raise NotImplementedError; end

#nested? ⇒ Boolean

Returns:

  • (Boolean) 


510
511
512
 
# File 'lib/active_record/reflection.rb', line 510

def nested?
  false
end

#polymorphic? ⇒ Boolean

Returns:

  • (Boolean) 


565
566
567
 
# File 'lib/active_record/reflection.rb', line 565

def polymorphic?
  options[:polymorphic]
end

#polymorphic_inverse_of(associated_class) ⇒ Object 



522
523
524
525
526
527
528
529
530
 
# File 'lib/active_record/reflection.rb', line 522

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

#source_reflection ⇒ Object 



494
495
496
 
# File 'lib/active_record/reflection.rb', line 494

def source_reflection
  self
end

#through_reflection ⇒ Object 



490
491
492
 
# File 'lib/active_record/reflection.rb', line 490

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

Returns:

  • (Boolean) 


553
554
555
 
# File 'lib/active_record/reflection.rb', line 553

def validate?
  !options[:validate].nil? ? options[:validate] : (options[:autosave] == true || collection?)
end