модуль ActiveRecord::AttributeMethods::ClassMethods

Публичные методы экземпляров

alias_attribute(new_name, old_name) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 66
def alias_attribute(new_name, old_name)
  super

  if @alias_attributes_mass_generated
    ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |code_generator|
      generate_alias_attribute_methods(code_generator, new_name, old_name)
    end
  end
end

Позволяет создавать псевдонимы для атрибутов.

class Person < ActiveRecord::Base
  alias_attribute :nickname, :name
end

person = Person.create(name: 'Bob')
person.name     # => "Bob"
person.nickname # => "Bob"

Псевдоним также можно использовать для запросов:

Person.where(nickname: "Bob")
# SELECT "people".* FROM "people" WHERE "people"."name" = "Bob"

Вызывает метод суперкласса

alias_attribute_method_definition(code_generator, pattern, new_name, old_name) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 87
def alias_attribute_method_definition(code_generator, pattern, new_name, old_name)
  old_name = old_name.to_s

  if !abstract_class? && !has_attribute?(old_name)
    raise ArgumentError, "#{self.name} model aliases `#{old_name}`, but `#{old_name}` is not an attribute. " \
      "Use `alias_method :#{new_name}, :#{old_name}` or define the method manually."
  else
    define_attribute_method_pattern(pattern, old_name, owner: code_generator, as: new_name, override: true)
  end
end

attribute_method?(attribute) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 223
def attribute_method?(attribute)
  super || (table_exists? && column_names.include?(attribute.to_s.delete_suffix("=")))
end

Возвращает true если attribute является методом атрибута и таблица существует, false в противном случае.

class Person < ActiveRecord::Base
end

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

Вызывает метод суперкласса

attribute_names() Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 235
def attribute_names
  @attribute_names ||= if !abstract_class? && table_exists?
    attribute_types.keys
  else
    []
  end.freeze
end

Возвращает массив имён столбцов в виде строк, если это не абстрактный класс и таблица существует. В противном случае возвращает пустой массив.

class Person < ActiveRecord::Base
end

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

dangerous_class_method?(method_name) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 200
def dangerous_class_method?(method_name)
  return true if RESTRICTED_CLASS_METHODS.include?(method_name.to_s)

  if Base.respond_to?(method_name, true)
    if Object.respond_to?(method_name, true)
      Base.method(method_name).owner != Object.method(method_name).owner
    else
      true
    end
  else
    false
  end
end

Метод класса считается «опасным», если он уже (пере)определён в Active Record, но не в каком-либо предке. (Например, «puts» неопасный, а «new» - опасный).

has_attribute?(attr_name) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 253
def has_attribute?(attr_name)
  attr_name = attr_name.to_s
  attr_name = attribute_aliases[attr_name] || attr_name
  attribute_types.key?(attr_name)
end

Возвращает true, если заданный атрибут существует, иначе false.

class Person < ActiveRecord::Base
  alias_attribute :new_name, :name
end

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

instance_method_already_implemented?(method_name) Показать исходный код

# File activerecord/lib/active_record/attribute_methods.rb, line 164
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 override that.
    defined = method_defined_within?(method_name, superclass, Base) &&
      ! superclass.instance_method(method_name).owner.is_a?(GeneratedAttributeMethods)
    defined || super
  end
end

Вызывает исключение ActiveRecord::DangerousAttributeError, если метод Active Record определён в модели, иначе 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

Вызывает метод суперкласса