модуль ActiveRecord::Integration
Публичные методы класса
# File activerecord/lib/active_record/integration.rb, line 16 class_attribute :cache_timestamp_format, instance_writer: false, default: :usec
Указывает формат, используемый для генерации метки времени в ключе кеша, если версия не включена. Принимает любой из символов в Time::DATE_FORMATS.
По умолчанию это :usec.
# File activerecord/lib/active_record/integration.rb, line 24 class_attribute :cache_versioning, instance_writer: false, default: false
Указывает, использовать ли стабильный метод cache_key, сопровождаемый изменяющейся версией в методе cache_version.
По умолчанию это true, начиная с Rails 5.2.
# File activerecord/lib/active_record/integration.rb, line 32 class_attribute :collection_cache_versioning, instance_writer: false, default: false
Указывает, использовать ли стабильный метод cache_key, сопровождаемый изменяющейся версией в методе cache_version для коллекций.
По умолчанию это false, до Rails 6.1.
Публичные методы экземпляра
# File activerecord/lib/active_record/integration.rb, line 72
def cache_key
if new_record?
"#{model_name.cache_key}/new"
else
if cache_version
"#{model_name.cache_key}/#{id}"
else
timestamp = max_updated_column_timestamp
if timestamp
timestamp = timestamp.utc.to_fs(cache_timestamp_format)
"#{model_name.cache_key}/#{id}-#{timestamp}"
else
"#{model_name.cache_key}/#{id}"
end
end
end
end Возвращает стабильный ключ кеша, который можно использовать для идентификации этой записи.
Product.new.cache_key # => "products/new" Product.find(5).cache_key # => "products/5"
Если ActiveRecord::Base.cache_versioning выключен, как это было в Rails 5.1 и ранее, ключ кеша также будет содержать версию.
Product.cache_versioning = false Product.find(5).cache_key # => "products/5-20071224150000" (updated_at available)
# File activerecord/lib/active_record/integration.rb, line 114
def cache_key_with_version
if version = cache_version
"#{cache_key}-#{version}"
else
cache_key
end
end Возвращает ключ кеша вместе с версией.
# File activerecord/lib/active_record/integration.rb, line 97
def cache_version
return unless cache_versioning
if has_attribute?("updated_at")
timestamp = updated_at_before_type_cast
if can_use_fast_cache_version?(timestamp)
raw_timestamp_to_cache_version(timestamp)
elsif timestamp = updated_at
timestamp.utc.to_fs(cache_timestamp_format)
end
elsif self.class.has_attribute?("updated_at")
raise ActiveModel::MissingAttributeError, "missing attribute 'updated_at' for #{self.class}"
end
end Возвращает версию кеша, которая может быть использована вместе с ключом кеша для формирования схемы рециркуляции кэширования. По умолчанию для cache_version используется столбец updated_at, но этот метод можно переопределить, чтобы вернуть что-то другое.
Обратите внимание, что этот метод вернёт nil, если ActiveRecord::Base.cache_versioning установлено в false.
# File activerecord/lib/active_record/integration.rb, line 57 def to_param return unless id Array(id).join(self.class.param_delimiter) end
Возвращает String, которое Action Pack использует для построения URL для этого объекта. По умолчанию реализация возвращает идентификатор этой записи в качестве String, или nil, если запись не сохранена.
Например, предположим, что у вас есть модель User и маршрут resources :users. Обычно user_path построит путь с 'id' объекта пользователя в нём:
user = User.find_by(name: 'Phusion') user_path(user) # => "/users/1"
Вы можете переопределить to_param в своей модели, чтобы user_path строил путь, используя имя пользователя вместо идентификатора пользователя:
class User < ActiveRecord::Base
def to_param # overridden
name
end
end
user = User.find_by(name: 'Phusion')
user_path(user) # => "/users/Phusion"
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.