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.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (MacroReflection) initialize(macro, name, options, active_record)

Returns a new instance of MacroReflection



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

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

- (Object) active_record (readonly)

Returns the value of attribute active_record



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

def active_record
  @active_record
end

- (Object) macro (readonly)

Returns the macro type.

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



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

def macro
  @macro
end

- (Object) name (readonly)

Returns the name of the macro.

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



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

def name
  @name
end

- (Object) options (readonly)

Returns the hash of options used for the macro.

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



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

def options
  @options
end

- (Object) plural_name (readonly)

:nodoc:



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

def plural_name
  @plural_name
end

Instance Method Details

- (Object) ==(other_aggregation)

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.



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

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

- (Object) class_name

Returns the class name for the macro.

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



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

def class_name
  @class_name ||= options[:class_name] || derive_class_name
end

- (Object) klass

Returns the class for the macro.

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



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

def klass
  @klass ||= class_name.constantize
end

- (Object) sanitized_conditions

:nodoc:



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

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