класс Class

Родитель:: Объект

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

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

# File activesupport/lib/active_support/core_ext/class/attribute.rb, line 71
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)

  attrs.each do |name|
    define_singleton_method(name) { nil }
    define_singleton_method("#{name}?") { !!public_send(name) } if instance_predicate

    ivar = "@#{name}"

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

      if singleton_class?
        class_eval do
          remove_possible_method(name)
          define_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
      remove_possible_method name
      define_method(name) do
        if instance_variable_defined?(ivar)
          instance_variable_get ivar
        else
          self.class.public_send name
        end
      end
      define_method("#{name}?") { !!public_send(name) } if instance_predicate
    end

    attr_writer name if instance_writer
  end
end

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

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.

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

# File activesupport/lib/active_support/core_ext/class/subclasses.rb, line 33
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]

superclass_delegating_accessor(name, options = {}) Показать исходный код

# File activesupport/lib/active_support/core_ext/class/delegating_attributes.rb, line 7
def superclass_delegating_accessor(name, options = {})
  # Create private _name and _name= methods that can still be used if the public
  # methods are overridden.
  _superclass_delegating_accessor("_#{name}", options)

  # Generate the public methods name, name=, and name?.
  # These methods dispatch to the private _name, and _name= methods, making them
  # overridable.
  singleton_class.send(:define_method, name) { send("_#{name}") }
  singleton_class.send(:define_method, "#{name}?") { !!send("_#{name}") }
  singleton_class.send(:define_method, "#{name}=") { |value| send("_#{name}=", value) }

  # If an instance_reader is needed, generate public instance methods name and name?.
  if options[:instance_reader] != false
    define_method(name) { send("_#{name}") }
    define_method("#{name}?") { !!send("#{name}") }
  end
end