Module: ActiveRecord::AttributeMethods::ClassMethods

Defined in:
lib/active_record/attribute_methods.rb

Constant Summary collapse

COLUMN_NAME_WHITELIST =

Regexp whitelist. Matches the following:

"#{table_name}.#{column_name}"
"#{column_name}"

/\A(?:\w+\.)?\w+\z/i
COLUMN_NAME_ORDER_WHITELIST =

Regexp whitelist. Matches the following:

"#{table_name}.#{column_name}"
"#{table_name}.#{column_name} #{direction}"
"#{table_name}.#{column_name} #{direction} NULLS FIRST"
"#{table_name}.#{column_name} NULLS LAST"
"#{column_name}"
"#{column_name} #{direction}"
"#{column_name} #{direction} NULLS FIRST"
"#{column_name} NULLS LAST"

/
  \A
  (?:\w+\.)?
  \w+
  (?:\s+asc|\s+desc)?
  (?:\s+nulls\s+(?:first|last))?
  \z
/ix

Instance Method Summary collapse

Instance Method Details

#attribute_method?(attribute) ⇒ Boolean

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

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/active_record/attribute_methods.rb', line 150

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

#attribute_names ⇒ Object

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"]



162
163
164
165
166
167
168
 
# File 'lib/active_record/attribute_methods.rb', line 162

def attribute_names
  @attribute_names ||= if !abstract_class? && table_exists?
    attribute_types.keys
  else
    []
  end
end

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

:nodoc:

Returns:

  • (Boolean) 


129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/active_record/attribute_methods.rb', line 129

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

#column_for_attribute(name) ⇒ Object

Returns the column object for the named attribute. Returns a ActiveRecord::ConnectionAdapters::NullColumn if the named attribute does not exist.

class Person < ActiveRecord::Base
end

person = Person.new
person.column_for_attribute(:name) # the result depends on the ConnectionAdapter
# => #<ActiveRecord::ConnectionAdapters::Column:0x007ff4ab083980 @name="name", @sql_type="varchar(255)", @null=true, ...>

person.column_for_attribute(:nothing)
# => #<ActiveRecord::ConnectionAdapters::NullColumn:0xXXX @name=nil, @sql_type=nil, @cast_type=#<Type::Value>, ...>



246
247
248
249
250
251
 
# File 'lib/active_record/attribute_methods.rb', line 246

def column_for_attribute(name)
  name = name.to_s
  columns_hash.fetch(name) do
    ConnectionAdapters::NullColumn.new(name)
  end
end

#dangerous_attribute_method?(name) ⇒ Boolean

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.)

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/active_record/attribute_methods.rb', line 107

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

#dangerous_class_method?(method_name) ⇒ Boolean

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.)

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/active_record/attribute_methods.rb', line 125

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

#define_attribute_methods ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/active_record/attribute_methods.rb', line 56

def define_attribute_methods # :nodoc:
  return false if @attribute_methods_generated
  # Use a mutex; we don't want two threads 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(attribute_names)
    @attribute_methods_generated = true
  end
end

#enforce_raw_sql_whitelist(args, whitelist: COLUMN_NAME_WHITELIST) ⇒ Object

:nodoc:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/active_record/attribute_methods.rb', line 193

def enforce_raw_sql_whitelist(args, whitelist: COLUMN_NAME_WHITELIST) # :nodoc:
  unexpected = args.reject do |arg|
    arg.kind_of?(Arel::Node) ||
      arg.is_a?(Arel::Nodes::SqlLiteral) ||
      arg.is_a?(Arel::Attributes::Attribute) ||
      arg.to_s.split(/\s*,\s*/).all? { |part| whitelist.match?(part) }
  end

  return if unexpected.none?

  if allow_unsafe_raw_sql == :deprecated
    ActiveSupport::Deprecation.warn(
      "Dangerous query method (method whose arguments are used as raw " \
      "SQL) called with non-attribute argument(s): " \
      "#{unexpected.map(&:inspect).join(", ")}. Non-attribute " \
      "arguments will be disallowed in Rails 6.0. This method should " \
      "not be called with user-provided values, such as request " \
      "parameters or model attributes. Known-safe values can be passed " \
      "by wrapping them in Arel.sql()."
    )
  else
    raise(ActiveRecord::UnknownAttributeReference,
      "Query method called with non-attribute argument(s): " +
      unexpected.map(&:inspect).join(", ")
    )
  end
end

#has_attribute?(attr_name) ⇒ Boolean

Returns true if the given attribute exists, otherwise false.

class Person < ActiveRecord::Base
end

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

Returns:

  • (Boolean) 


229
230
231
 
# File 'lib/active_record/attribute_methods.rb', line 229

def has_attribute?(attr_name)
  attribute_types.key?(attr_name.to_s)
end

#inherited(child_class) ⇒ Object

:nodoc:



41
42
43
44
 
# File 'lib/active_record/attribute_methods.rb', line 41

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

#initialize_generated_modules ⇒ Object

:nodoc:



46
47
48
49
50
51
52
 
# File 'lib/active_record/attribute_methods.rb', line 46

def initialize_generated_modules # :nodoc:
  @generated_attribute_methods = GeneratedAttributeMethods.new
  @attribute_methods_generated = false
  include @generated_attribute_methods

  super
end

#instance_method_already_implemented?(method_name) ⇒ Boolean

Raises an 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 Active Record. Check to make sure that you don't have an attribute or method with the same name.

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

Returns:

  • (Boolean) 


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/active_record/attribute_methods.rb', line 89

def instance_method_already_implemented?(method_name)
  if dangerous_attribute_method?(method_name)
    raise DangerousAttributeError, "#{method_name} is defined by Active Record. Check to make sure that you don't have an attribute or method with the same name."
  end

  if superclass == Base
    super
  else
    # If ThisClass < ... < SomeSuperClass < ... < Base and SomeSuperClass
    # defines its own attribute method, then we don't want to overwrite that.
    defined = method_defined_within?(method_name, superclass, Base) &&
      ! superclass.instance_method(method_name).owner.is_a?(GeneratedAttributeMethods)
    defined || super
  end
end

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

:nodoc:

Returns:

  • (Boolean) 


111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/active_record/attribute_methods.rb', line 111

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

#undefine_attribute_methods ⇒ Object

:nodoc:



68
69
70
71
72
73
 
# File 'lib/active_record/attribute_methods.rb', line 68

def undefine_attribute_methods # :nodoc:
  generated_attribute_methods.synchronize do
    super if defined?(@attribute_methods_generated) && @attribute_methods_generated
    @attribute_methods_generated = false
  end
end