class Class

# File activesupport/lib/active_support/core_ext/class/attribute.rb, line 87
def class_attribute(*attrs)
  options = attrs.extract_options!
  instance_reader    = options.fetch(:instance_accessor, true) && options.fetch(:instance_reader, true)
  instance_writer    = options.fetch(:instance_accessor, true) && options.fetch(:instance_writer, true)
  instance_predicate = options.fetch(:instance_predicate, true)
  default_value      = options.fetch(:default, nil)

  attrs.each do |name|
    singleton_class.silence_redefinition_of_method(name)
    define_singleton_method(name) { nil }

    singleton_class.silence_redefinition_of_method("#{name}?")
    define_singleton_method("#{name}?") { !!public_send(name) } if instance_predicate

    ivar = "@#{name}"

    singleton_class.silence_redefinition_of_method("#{name}=")
    define_singleton_method("#{name}=") do |val|
      singleton_class.class_eval do
        redefine_method(name) { val }
      end

      if singleton_class?
        class_eval do
          redefine_method(name) do
            if instance_variable_defined? ivar
              instance_variable_get ivar
            else
              singleton_class.send name
            end
          end
        end
      end
      val
    end

    if instance_reader
      redefine_method(name) do
        if instance_variable_defined?(ivar)
          instance_variable_get ivar
        else
          self.class.public_send name
        end
      end

      redefine_method("#{name}?") { !!public_send(name) } if instance_predicate
    end

    if instance_writer
      redefine_method("#{name}=") do |val|
        instance_variable_set ivar, val
      end
    end

    unless default_value.nil?
      self.send("#{name}=", default_value)
    end
  end
end

Объявляет атрибут уровня класса, значение которого наследуется подклассами. Подклассы могут изменять собственное значение, и это не повлияет на родительский класс.

Параметры

• :instance_reader - Устанавливает метод чтения экземпляра (по умолчанию true).

• :instance_writer - Устанавливает метод записи экземпляра (по умолчанию true).

• :instance_accessor - Устанавливает оба метода экземпляра (по умолчанию true).

• :instance_predicate - Устанавливает предикатный метод (по умолчанию true).

• :default - Устанавливает значение по умолчанию для атрибута (по умолчанию nil).

Примеры

class Base
  class_attribute :setting
end

class Subclass < Base
end

Base.setting = true
Subclass.setting            # => true
Subclass.setting = false
Subclass.setting            # => false
Base.setting                # => true

В приведенном выше случае, пока подкласс не присвоит значение, выполнив Subclass.setting = something, Subclass.setting будет считывать значение, присвоенное родительскому классу. Как только подкласс присвоит значение, возвращаемое значение будет присвоенное подклассом.

Это соответствует обычному наследованию методов Ruby: представьте себе, что написание атрибута в подклассе — это переопределение метода чтения. Однако вы должны быть внимательны, когда используете class_attribute с изменяемыми структурами, такими как Array или Hash. В таких случаях вам не нужно изменять значение на месте. Вместо этого используйте методы записи:

Base.setting = []
Base.setting                # => []
Subclass.setting            # => []

# Appending in child changes both parent and child because it is the same object:
Subclass.setting << :foo
Base.setting               # => [:foo]
Subclass.setting           # => [:foo]

# Use setters to not propagate changes:
Base.setting = []
Subclass.setting += [:foo]
Base.setting               # => []
Subclass.setting           # => [:foo]

Для удобства также определен предикатный метод экземпляра. Чтобы его пропустить, передайте instance_predicate: false.

Subclass.setting?       # => false

Экземпляры могут перезаписывать значение класса аналогичным образом:

Base.setting = true
object = Base.new
object.setting          # => true
object.setting = false
object.setting          # => false
Base.setting            # => true

Чтобы отказаться от метода чтения экземпляра, передайте instance_reader: false.

object.setting          # => NoMethodError
object.setting?         # => NoMethodError

Чтобы отказаться от метода записи экземпляра, передайте instance_writer: false.

object.setting = false  # => NoMethodError

Чтобы отказаться от обоих методов экземпляра, передайте instance_accessor: false.

Чтобы установить значение по умолчанию для атрибута, передайте default:, как показано ниже:

class_attribute :settings, default: {}

# File activesupport/lib/active_support/core_ext/class/subclasses.rb, line 21
def descendants
  descendants = []
  ObjectSpace.each_object(singleton_class) do |k|
    next if k.singleton_class?
    descendants.unshift k unless k == self
  end
  descendants
end

Возвращает массив всех классов, которые являются потомками получателя.

class C; end
C.descendants # => []

class B < C; end
C.descendants # => [B]

class A < B; end
C.descendants # => [B, A]

class D < C; end
C.descendants # => [B, A, D]

# File activesupport/lib/active_support/core_ext/class/subclasses.rb, line 47
def subclasses
  subclasses, chain = [], descendants
  chain.each do |k|
    subclasses << k unless chain.any? { |c| c > k }
  end
  subclasses
end

Возвращает массив непосредственных потомков self.

class Foo; end
class Bar < Foo; end
class Baz < Bar; end

Foo.subclasses # => [Bar]