Class: ActiveRecord::Reflection::MacroReflection

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

Overview

Abstract base class for AggregateReflection and AssociationReflection that describes the interface available for both of those classes. 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.



81
82
83
 
# File 'lib/active_record/reflection.rb', line 81

def initialize(macro, name, options, active_record)
  @macro, @name, @options, @active_record = macro, name, options, active_record
end

Instance Attribute Details

#active_record ⇒ Object (readonly)

Returns the value of attribute active_record.



79
80
81
 
# File 'lib/active_record/reflection.rb', line 79

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



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

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

#belongs_to? ⇒ Boolean

Returns true if self is a belongs_to reflection.

Returns:

  • (Boolean) 


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

def belongs_to?
  macro == :belongs_to
end

#class_name ⇒ Object

Returns the class name for the macro. For example, composed_of :balance, :class_name => 'Money' returns 'Money' and has_many :clients returns 'Client'.



111
112
113
 
# File 'lib/active_record/reflection.rb', line 111

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

#klass ⇒ Object

Returns the class for the macro. For example, composed_of :balance, :class_name => 'Money' returns the Money class and has_many :clients returns the Client class.



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

def klass
  @klass ||= class_name.constantize
end

#macro ⇒ Object

Returns the macro type. For example, composed_of :balance, :class_name => 'Money' will return :composed_of or for has_many :clients will return :has_many.



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

def macro
  @macro
end

#name ⇒ Object

Returns the name of the macro. For example, composed_of :balance, :class_name => 'Money' will return :balance or for has_many :clients it will return :clients.



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

def name
  @name
end

#options ⇒ Object

Returns the hash of options used for the macro. For example, it would return { :class_name => "Money" } for composed_of :balance, :class_name => 'Money' or {} for has_many :clients.



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

def options
  @options
end

#sanitized_conditions ⇒ Object

:nodoc:



121
122
123
 
# File 'lib/active_record/reflection.rb', line 121

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