Class: ActiveRecord::Reflection::MacroReflection

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

Overview

Base class for AggregateReflection and AssociationReflection. Objects of AggregateReflection and AssociationReflection are returned by the Reflection::ClassMethods.

Instance Attribute Summary collapse

Instance Method Summary collapse

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) ⇒ MacroReflection

Returns a new instance of MacroReflection.



345
346
347
348
349
350
351
352
353
 
# File 'activerecord/lib/active_record/reflection.rb', line 345

def initialize(name, scope, options, active_record)
  @name          = name
  @scope         = scope
  @options       = options
  @active_record = active_record
  @klass         = options[:anonymous_class]
  @plural_name   = active_record.pluralize_table_names ?
                      name.to_s.pluralize : name.to_s
end

Instance Attribute Details

#active_record ⇒ Object (readonly)

Returns the value of attribute active_record



341
342
343
 
# File 'activerecord/lib/active_record/reflection.rb', line 341

def active_record
  @active_record
end

#name ⇒ Object (readonly)

Returns the name of the macro.

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



331
332
333
 
# File 'activerecord/lib/active_record/reflection.rb', line 331

def name
  @name
end

#options ⇒ Object (readonly)

Returns the hash of options used for the macro.

composed_of :balance, class_name: 'Money' returns { class_name: "Money" } has_many :clients returns {}



339
340
341
 
# File 'activerecord/lib/active_record/reflection.rb', line 339

def options
  @options
end

#plural_name ⇒ Object (readonly)

:nodoc:



343
344
345
 
# File 'activerecord/lib/active_record/reflection.rb', line 343

def plural_name
  @plural_name
end

#scope ⇒ Object (readonly)

Returns the value of attribute scope



333
334
335
 
# File 'activerecord/lib/active_record/reflection.rb', line 333

def scope
  @scope
end

Instance Method Details

#==(other_aggregation) ⇒ Object

Returns true if self and other_aggregation have the same name attribute, active_record attribute, and other_aggregation has an options hash assigned to it.



388
389
390
391
392
393
394
 
# File 'activerecord/lib/active_record/reflection.rb', line 388

def ==(other_aggregation)
  super ||
    other_aggregation.kind_of?(self.class) &&
    name == other_aggregation.name &&
    !other_aggregation.options.nil? &&
    active_record == other_aggregation.active_record
end

#autosave=(autosave) ⇒ Object 



355
356
357
358
359
360
361
 
# File 'activerecord/lib/active_record/reflection.rb', line 355

def autosave=(autosave)
  @options[:autosave] = autosave
  parent_reflection = self.parent_reflection
  if parent_reflection
    parent_reflection.autosave = autosave
  end
end

#compute_class(name) ⇒ Object 



382
383
384
 
# File 'activerecord/lib/active_record/reflection.rb', line 382

def compute_class(name)
  name.constantize
end

#klass ⇒ Object

Returns the class for the macro.

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

class Company < ActiveRecord::Base
  has_many :clients
end

Company.reflect_on_association(:clients).klass
# => Client

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.



378
379
380
 
# File 'activerecord/lib/active_record/reflection.rb', line 378

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

#scope_for(relation, owner = nil) ⇒ Object 



396
397
398
 
# File 'activerecord/lib/active_record/reflection.rb', line 396

def scope_for(relation, owner = nil)
  relation.instance_exec(owner, &scope) || relation
end