class Class

# File activesupport/lib/active_support/core_ext/class/attribute.rb, line 85
  def class_attribute(*attrs, instance_accessor: true,
    instance_reader: instance_accessor, instance_writer: instance_accessor, instance_predicate: true, default: nil)

    class_methods, methods = [], []
    attrs.each do |name|
      unless name.is_a?(Symbol) || name.is_a?(String)
        raise TypeError, "#{name.inspect} is not a symbol nor a string"
      end

      class_methods << <<~RUBY # In case the method exists and is not public
        silence_redefinition_of_method def #{name}
        end
      RUBY

      methods << <<~RUBY if instance_reader
        silence_redefinition_of_method def #{name}
          defined?(@#{name}) ? @#{name} : self.class.#{name}
        end
      RUBY

      class_methods << <<~RUBY
        silence_redefinition_of_method def #{name}=(value)
          redefine_method(:#{name}) { value } if singleton_class?
          redefine_singleton_method(:#{name}) { value }
          value
        end
      RUBY

      methods << <<~RUBY if instance_writer
        silence_redefinition_of_method(:#{name}=)
        attr_writer :#{name}
      RUBY

      if instance_predicate
        class_methods << "silence_redefinition_of_method def #{name}?; !!self.#{name}; end"
        if instance_reader
          methods << "silence_redefinition_of_method def #{name}?; !!self.#{name}; end"
        end
      end
    end

    location = caller_locations(1, 1).first
    class_eval(["class << self", *class_methods, "end", *methods].join(";").tr("\n", ";"), location.path, location.lineno)

    attrs.each { |name| public_send("#{name}=", default) }
  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 не присвоит значение параметру, выполнив Subclass.setting = something, Subclass.setting будет считывать значение, присвоенное родительскому классу. Как только Subclass присвоит значение, будет возвращено значение, присвоенное Subclass.

Это соответствует обычному наследованию методов 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 38
def subclasses
  descendants.select { |descendant| descendant.superclass == self }
end

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

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

Foo.subclasses # => [Bar]