Class: ActiveRecord::Reflection::MacroReflection

Inherits:
Object
  • Object
show all
Defined in:
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.



110
111
112
113
114
115
116
117
118
# File 'lib/active_record/reflection.rb', line 110

def initialize(macro, name, scope, options, active_record)
  @macro         = macro
  @name          = name
  @scope         = scope
  @options       = options
  @active_record = active_record
  @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.



106
107
108
# File 'lib/active_record/reflection.rb', line 106

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



96
97
98
# File 'lib/active_record/reflection.rb', line 96

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



90
91
92
# File 'lib/active_record/reflection.rb', line 90

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 {}



104
105
106
# File 'lib/active_record/reflection.rb', line 104

def options
  @options
end

#plural_nameObject (readonly)

:nodoc:



108
109
110
# File 'lib/active_record/reflection.rb', line 108

def plural_name
  @plural_name
end

#scopeObject (readonly)

Returns the value of attribute scope.



98
99
100
# File 'lib/active_record/reflection.rb', line 98

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.



138
139
140
141
142
143
144
# File 'lib/active_record/reflection.rb', line 138

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

#class_nameObject

Returns the class name for the macro.

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



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

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



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

def klass
  @klass ||= class_name.constantize
end