Class: ActiveRecord::Reflection::MacroReflection

Inherits:
Object
  • Object
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.

MacroReflection
  AggregateReflection
  AssociationReflection
    ThroughReflection

Direct Known Subclasses

AggregateReflection, AssociationReflection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(macro, name, scope, options, active_record) ⇒ MacroReflection

Returns a new instance of MacroReflection.



143
144
145
146
147
148
149
150
151
152
# File 'activerecord/lib/active_record/reflection.rb', line 143

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

Instance Attribute Details

#active_recordObject (readonly)

Returns the value of attribute active_record



139
140
141
# File 'activerecord/lib/active_record/reflection.rb', line 139

def active_record
  @active_record
end

#macroObject (readonly)

Returns the macro type.

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



129
130
131
# File 'activerecord/lib/active_record/reflection.rb', line 129

def macro
  @macro
end

#nameObject (readonly)

Returns the name of the macro.

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



123
124
125
# File 'activerecord/lib/active_record/reflection.rb', line 123

def name
  @name
end

#optionsObject (readonly)

Returns the hash of options used for the macro.

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



137
138
139
# File 'activerecord/lib/active_record/reflection.rb', line 137

def options
  @options
end

#plural_nameObject (readonly)

:nodoc:



141
142
143
# File 'activerecord/lib/active_record/reflection.rb', line 141

def plural_name
  @plural_name
end

#scopeObject (readonly)

Returns the value of attribute scope



131
132
133
# File 'activerecord/lib/active_record/reflection.rb', line 131

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.



181
182
183
184
185
186
187
# File 'activerecord/lib/active_record/reflection.rb', line 181

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



154
155
156
157
158
159
160
161
# File 'activerecord/lib/active_record/reflection.rb', line 154

def autosave=(autosave)
  @automatic_inverse_of = false
  @options[:autosave] = autosave
  _, parent_reflection = self.parent_reflection
  if parent_reflection
    parent_reflection.autosave = autosave
  end
end

#class_nameObject

Returns the class name for the macro.

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



175
176
177
# File 'activerecord/lib/active_record/reflection.rb', line 175

def class_name
  @class_name ||= (options[:class_name] || derive_class_name).to_s
end

#klassObject

Returns the class for the macro.

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



167
168
169
# File 'activerecord/lib/active_record/reflection.rb', line 167

def klass
  @klass ||= class_name.constantize
end