W3cubDocs

/Ruby on Rails 7.0

class ActiveRecord::Reflection::MacroReflection

Parent:
ActiveRecord::Reflection::AbstractReflection

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

Attributes

active_record[R]
name[R]

Returns the name of the macro.

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

options[R]

Returns the hash of options used for the macro.

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

scope[R]

Public Class Methods

new(name, scope, options, active_record) Show source
# File activerecord/lib/active_record/reflection.rb, line 342
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

Public Instance Methods

==(other_aggregation) Show source
# File activerecord/lib/active_record/reflection.rb, line 385
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

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.

Calls superclass method
autosave=(autosave) Show source
# File activerecord/lib/active_record/reflection.rb, line 352
def autosave=(autosave)
  @options[:autosave] = autosave
  parent_reflection = self.parent_reflection
  if parent_reflection
    parent_reflection.autosave = autosave
  end
end
compute_class(name) Show source
# File activerecord/lib/active_record/reflection.rb, line 379
def compute_class(name)
  name.constantize
end
klass() Show source
# File activerecord/lib/active_record/reflection.rb, line 375
def klass
  @klass ||= compute_class(class_name)
end

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.

scope_for(relation, owner = nil) Show source
# File activerecord/lib/active_record/reflection.rb, line 393
def scope_for(relation, owner = nil)
  relation.instance_exec(owner, &scope) || relation
end

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.