Class: ActiveRecord::Reflection::MacroReflection

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

Overview

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

Direct Known Subclasses

AggregateReflection, AssociationReflection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MacroReflection


105
106
107
108
109
110
111
112
# File 'activerecord/lib/active_record/reflection.rb', line 105

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


101
102
103
# File 'activerecord/lib/active_record/reflection.rb', line 101

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


93
94
95
# File 'activerecord/lib/active_record/reflection.rb', line 93

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


87
88
89
# File 'activerecord/lib/active_record/reflection.rb', line 87

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


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

def options
  @options
end

#plural_nameObject (readonly)

:nodoc:


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

def plural_name
  @plural_name
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.


132
133
134
135
136
137
138
# File 'activerecord/lib/active_record/reflection.rb', line 132

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'


126
127
128
# File 'activerecord/lib/active_record/reflection.rb', line 126

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


118
119
120
# File 'activerecord/lib/active_record/reflection.rb', line 118

def klass
  @klass ||= class_name.constantize
end

#sanitized_conditionsObject

:nodoc:


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

def sanitized_conditions #:nodoc:
  @sanitized_conditions ||= klass.send(:sanitize_sql, options[:conditions]) if options[:conditions]
end