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

Атрибуты

abstract_class[RW]

Установите это в true, если это абстрактный класс (см. abstract_class?). Если вы используете наследование с Active Record и не хотите, чтобы класс учитывался как часть иерархии STI, вы должны установить это в true. ApplicationRecord, например, генерируется как абстрактный класс.

Рассмотрим следующее поведение по умолчанию:

Shape = Class.new(ActiveRecord::Base)
Polygon = Class.new(Shape)
Square = Class.new(Polygon)

Shape.table_name   # => "shapes"
Polygon.table_name # => "shapes"
Square.table_name  # => "shapes"
Shape.create!      # => #<Shape id: 1, type: nil>
Polygon.create!    # => #<Polygon id: 2, type: "Polygon">
Square.create!     # => #<Square id: 3, type: "Square">

Однако, при использовании abstract_class, Shape опускается из иерархии:

class Shape < ActiveRecord::Base
  self.abstract_class = true
end
Polygon = Class.new(Shape)
Square = Class.new(Polygon)

Shape.table_name   # => nil
Polygon.table_name # => "polygons"
Square.table_name  # => "polygons"
Shape.create!      # => NotImplementedError: Shape is an abstract class and cannot be instantiated.
Polygon.create!    # => #<Polygon id: 1, type: nil>
Square.create!     # => #<Square id: 2, type: "Square">

Обратите внимание, что в приведенном выше примере, чтобы запретить создание обычного Polygon, вы должны использовать validates :type, presence: true, а не устанавливать его как абстрактный класс. Таким образом, Polygon останется в иерархии, и Active Record продолжит правильно выводить имя таблицы.

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

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

# File activerecord/lib/active_record/inheritance.rb, line 161
def abstract_class?
  defined?(@abstract_class) && @abstract_class == true
end

Возвращает, является ли этот класс абстрактным классом или нет.

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

# File activerecord/lib/active_record/inheritance.rb, line 99
def base_class
  unless self < Base
    raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
  end

  if superclass == Base || superclass.abstract_class?
    self
  else
    superclass.base_class
  end
end

Возвращает класс, непосредственно наследуемый от ActiveRecord::Base, или абстрактный класс, если таковой имеется, в иерархии наследования.

Если A расширяет ActiveRecord::Base, A.base_class вернет A. Если B происходит от A через иерархию произвольной глубины, B.base_class вернет A.

Если B < A и C < B и если A является #abstract_class, то как B.base_class, так и C.base_class вернут B в качестве ответа, поскольку A является абстрактным классом.

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

# File activerecord/lib/active_record/inheritance.rb, line 113
def base_class?
  base_class == self
end

Возвращает, является ли класс базовым классом. См. base_class для получения дополнительной информации.

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

# File activerecord/lib/active_record/inheritance.rb, line 76
def descends_from_active_record?
  if self == Base
    false
  elsif superclass.abstract_class?
    superclass.descends_from_active_record?
  else
    superclass == Base || !columns_hash.include?(inheritance_column)
  end
end

Возвращает true, если для этого не требуется условие типа STI. Возвращает false, если необходимо применять условие типа STI.

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

# File activerecord/lib/active_record/inheritance.rb, line 173
def inherited(subclass)
  subclass.instance_variable_set(:@_type_candidates_cache, Concurrent::Map.new)
  super
end

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

new(attributes = nil, &block) Показать исходный код

# File activerecord/lib/active_record/inheritance.rb, line 50
def new(attributes = nil, &block)
  if abstract_class? || self == Base
    raise NotImplementedError, "#{self} is an abstract class and cannot be instantiated."
  end

  if has_attribute?(inheritance_column)
    subclass = subclass_from_attributes(attributes)

    if subclass.nil? && scope_attributes = current_scope&.scope_for_create
      subclass = subclass_from_attributes(scope_attributes)
    end

    if subclass.nil? && base_class?
      subclass = subclass_from_attributes(column_defaults)
    end
  end

  if subclass && subclass != self
    subclass.new(attributes, &block)
  else
    super
  end
end

Определяет, является ли один из переданных атрибутов столбцом наследования, и если столбец наследования доступен как атрибут, инициализирует экземпляр указанного подкласса вместо базового класса.

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

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

# File activerecord/lib/active_record/inheritance.rb, line 169
def polymorphic_name
  base_class.name
end

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

# File activerecord/lib/active_record/inheritance.rb, line 165
def sti_name
  store_full_sti_class ? name : name.demodulize
end

Защищенные методы экземпляра

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

# File activerecord/lib/active_record/inheritance.rb, line 182
def compute_type(type_name)
  if type_name.start_with?("::")
    # If the type is prefixed with a scope operator then we assume that
    # the type_name is an absolute reference.
    ActiveSupport::Dependencies.constantize(type_name)
  else
    type_candidate = @_type_candidates_cache[type_name]
    if type_candidate && type_constant = ActiveSupport::Dependencies.safe_constantize(type_candidate)
      return type_constant
    end

    # Build a list of candidates to search for
    candidates = []
    name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
    candidates << type_name

    candidates.each do |candidate|
      constant = ActiveSupport::Dependencies.safe_constantize(candidate)
      if candidate == constant.to_s
        @_type_candidates_cache[type_name] = candidate
        return constant
      end
    end

    raise NameError.new("uninitialized constant #{candidates.first}", candidates.first)
  end
end

Возвращает тип класса записи с использованием текущего модуля в качестве префикса. Так, потомки MyApp::Business::Account будут отображаться как MyApp::Business::AccountSubclass.