класс Class
Методы публичного экземпляра
# File activesupport/lib/active_support/core_ext/class/attribute.rb, line 86
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
name = name.to_sym
namespaced_name = :"__class_attr_#{name}"
::ActiveSupport::ClassAttribute.redefine(self, name, namespaced_name, default)
delegators = [
"def #{name}; #{namespaced_name}; end",
"def #{name}=(value); self.#{namespaced_name} = value; end",
]
class_methods.concat(delegators)
if singleton_class?
methods.concat(delegators)
else
methods << <<~RUBY if instance_reader
silence_redefinition_of_method def #{name}
if defined?(@#{name})
@#{name}
else
self.class.#{name}
end
end
RUBY
end
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)
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 19 def descendants subclasses.concat(subclasses.flat_map(&: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]
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.