Module: ActiveRecord::AttributeMethods::ClassMethods

Defined in:
activerecord/lib/active_record/attribute_methods.rb

Instance Method Summary (collapse)

Instance Method Details

- (Boolean) attribute_method?(attribute)

Returns true if attribute is an attribute method and table exists, false otherwise.

class Person < ActiveRecord::Base
end

Person.attribute_method?('name')   # => true
Person.attribute_method?(:age=)    # => true
Person.attribute_method?(:nothing) # => false


171
172
173
# File 'activerecord/lib/active_record/attribute_methods.rb', line 171

def attribute_method?(attribute)
  super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
end

- (Object) attribute_names

Returns an array of column names as strings if it's not an abstract class and table exists. Otherwise it returns an empty array.

class Person < ActiveRecord::Base
end

Person.attribute_names
# => ["id", "created_at", "updated_at", "name", "age"]


183
184
185
186
187
188
189
# File 'activerecord/lib/active_record/attribute_methods.rb', line 183

def attribute_names
  @attribute_names ||= if !abstract_class? && table_exists?
      column_names
    else
      []
    end
end

- (Boolean) class_method_defined_within?(name, klass, superklass = klass.superclass)

:nodoc



140
141
142
143
144
145
146
147
148
149
150
# File 'activerecord/lib/active_record/attribute_methods.rb', line 140

def class_method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc
  if klass.respond_to?(name, true)
    if superklass.respond_to?(name, true)
      klass.method(name).owner != superklass.method(name).owner
    else
      true
    end
  else
    false
  end
end

- (Boolean) dangerous_attribute_method?(name)

A method name is 'dangerous' if it is already (re)defined by Active Record, but not by any ancestors. (So 'puts' is not dangerous but 'save' is.)



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

def dangerous_attribute_method?(name) # :nodoc:
  method_defined_within?(name, Base)
end

- (Boolean) dangerous_class_method?(method_name)

A class method is 'dangerous' if it is already (re)defined by Active Record, but not by any ancestors. (So 'puts' is not dangerous but 'new' is.)



136
137
138
# File 'activerecord/lib/active_record/attribute_methods.rb', line 136

def dangerous_class_method?(method_name)
  BLACKLISTED_CLASS_METHODS.include?(method_name.to_s) || class_method_defined_within?(method_name, Base)
end

- (Object) define_attribute_methods

Generates all the attribute related methods for columns in the database accessors, mutators and query methods.



68
69
70
71
72
73
74
75
76
77
78
# File 'activerecord/lib/active_record/attribute_methods.rb', line 68

def define_attribute_methods # :nodoc:
  # Use a mutex; we don't want two thread simultaneously trying to define
  # attribute methods.
  generated_attribute_methods.synchronize do
    return false if @attribute_methods_generated
    superclass.define_attribute_methods unless self == base_class
    super(column_names)
    @attribute_methods_generated = true
  end
  true
end

- (Object) find_generated_attribute_method(method_name)

:nodoc:



152
153
154
155
156
157
158
159
160
# File 'activerecord/lib/active_record/attribute_methods.rb', line 152

def find_generated_attribute_method(method_name) # :nodoc:
  klass = self
  until klass == Base
    gen_methods = klass.generated_attribute_methods
    return gen_methods.instance_method(method_name) if method_defined_within?(method_name, gen_methods, Object)
    klass = klass.superclass
  end
  nil
end

- (Object) inherited(child_class)

:nodoc:



55
56
57
58
# File 'activerecord/lib/active_record/attribute_methods.rb', line 55

def inherited(child_class) #:nodoc:
  child_class.initialize_generated_modules
  super
end

- (Object) initialize_generated_modules

:nodoc:



60
61
62
63
64
# File 'activerecord/lib/active_record/attribute_methods.rb', line 60

def initialize_generated_modules # :nodoc:
  @generated_attribute_methods = Module.new { extend Mutex_m }
  @attribute_methods_generated = false
  include @generated_attribute_methods
end

- (Boolean) instance_method_already_implemented?(method_name)

Raises a ActiveRecord::DangerousAttributeError exception when an Active Record method is defined in the model, otherwise false.

class Person < ActiveRecord::Base
  def save
    'already defined by Active Record'
  end
end

Person.instance_method_already_implemented?(:save)
# => ActiveRecord::DangerousAttributeError: save is defined by ActiveRecord

Person.instance_method_already_implemented?(:name)
# => false


101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'activerecord/lib/active_record/attribute_methods.rb', line 101

def instance_method_already_implemented?(method_name)
  if dangerous_attribute_method?(method_name)
    raise DangerousAttributeError, "#{method_name} is defined by Active Record"
  end

  if superclass == Base
    super
  else
    # If B < A and A defines its own attribute method, then we don't want to overwrite that.
    defined = method_defined_within?(method_name, superclass, superclass.generated_attribute_methods)
    base_defined = Base.method_defined?(method_name) || Base.private_method_defined?(method_name)
    defined && !base_defined || super
  end
end

- (Boolean) method_defined_within?(name, klass, superklass = klass.superclass)

:nodoc:



122
123
124
125
126
127
128
129
130
131
132
# File 'activerecord/lib/active_record/attribute_methods.rb', line 122

def method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc:
  if klass.method_defined?(name) || klass.private_method_defined?(name)
    if superklass.method_defined?(name) || superklass.private_method_defined?(name)
      klass.instance_method(name).owner != superklass.instance_method(name).owner
    else
      true
    end
  else
    false
  end
end

- (Object) undefine_attribute_methods

:nodoc:



80
81
82
83
84
85
# File 'activerecord/lib/active_record/attribute_methods.rb', line 80

def undefine_attribute_methods # :nodoc:
  generated_attribute_methods.synchronize do
    super if @attribute_methods_generated
    @attribute_methods_generated = false
  end
end