класс ActiveSupport::CurrentAttributes
Текущие атрибуты
Абстрактный суперкласс, предоставляющий изолированный для потока синглтон атрибутов, который автоматически сбрасывается до и после каждого запроса. Это позволяет легко сделать все атрибуты, относящиеся к запросу, доступными во всей системе.
В следующем примере, похожем на полноценное приложение, показано, как использовать класс Current для удобного доступа к глобальным атрибутам, относящимся к запросу, без необходимости передавать их повсюду по цепочке вызовов:
# app/models/current.rb
class Current < ActiveSupport::CurrentAttributes
attribute :account, :user
attribute :request_id, :user_agent, :ip_address
resets { Time.zone = nil }
def user=(user)
super
self.account = user.account
Time.zone = user.time_zone
end
end
# app/controllers/concerns/authentication.rb
module Authentication
extend ActiveSupport::Concern
included do
before_action :authenticate
end
private
def authenticate
if authenticated_user = User.find_by(id: cookies.encrypted[:user_id])
Current.user = authenticated_user
else
redirect_to new_session_url
end
end
end
# app/controllers/concerns/set_current_request_details.rb
module SetCurrentRequestDetails
extend ActiveSupport::Concern
included do
before_action do
Current.request_id = request.uuid
Current.user_agent = request.user_agent
Current.ip_address = request.ip
end
end
end
class ApplicationController < ActionController::Base
include Authentication
include SetCurrentRequestDetails
end
class MessagesController < ApplicationController
def create
Current.account.messages.create(message_params)
end
end
class Message < ApplicationRecord
belongs_to :creator, default: -> { Current.user }
after_create { |message| Event.create(record: message) }
end
class Event < ApplicationRecord
before_create do
self.request_id = Current.request_id
self.user_agent = Current.user_agent
self.ip_address = Current.ip_address
end
end
Предупреждение: с глобальным синглтоном вроде Current легко перестараться и в результате запутать модель. Current следует использовать только для нескольких глобальных атрибутов верхнего уровня, например сведений об учетной записи, пользователе и запросе. Атрибуты, хранящиеся в Current, должны использоваться большинством или всеми действиями во всех запросах. Если начать помещать туда атрибуты, специфичные для контроллера, получится беспорядок.
Атрибуты
Открытые методы класса
# File activesupport/lib/active_support/current_attributes.rb, line 115
def attribute(*names, default: NOT_SET)
invalid_attribute_names = names.map(&:to_sym) & INVALID_ATTRIBUTE_NAMES
if invalid_attribute_names.any?
raise ArgumentError, "Restricted attribute names: #{invalid_attribute_names.join(", ")}"
end
Delegation.generate(singleton_class, names, to: :instance, nilable: false, signature: "")
Delegation.generate(singleton_class, names.map { |n| "#{n}=" }, to: :instance, nilable: false, signature: "value")
ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
names.each do |name|
owner.define_cached_method(name, namespace: :current_attributes) do |batch|
batch <<
"def #{name}" <<
"@attributes[:#{name}]" <<
"end"
end
owner.define_cached_method("#{name}=", namespace: :current_attributes) do |batch|
batch <<
"def #{name}=(value)" <<
"@attributes[:#{name}] = value" <<
"end"
end
end
end
self.defaults = defaults.merge(names.index_with { default })
end Объявляет один или несколько атрибутов, для которых будут созданы методы доступа класса и экземпляра.
Параметры
-
:default— значение атрибутов по умолчанию. Если значение является proc или lambda, оно будет вызвано при создании каждого экземпляра. В противном случае значение будет скопировано с помощью dup. Значения по умолчанию назначаются повторно при сбросе атрибутов.
# File activesupport/lib/active_support/current_attributes.rb, line 145 def before_reset(*methods, &block) set_callback :reset, :before, *methods, &block end
Вызывает этот обратный вызов перед вызовом reset для экземпляра. Используется для сброса внешних зависимых объектов, которые зависят от текущих значений.
# File activesupport/lib/active_support/current_attributes.rb, line 103 def instance current_instances[current_instances_key] ||= new end
Возвращает синглтон-экземпляр этого класса в текущем потоке. Если экземпляра нет, он создается.
# File activesupport/lib/active_support/current_attributes.rb, line 205 def initialize @attributes = resolve_defaults end
# File activesupport/lib/active_support/current_attributes.rb, line 150 def resets(*methods, &block) set_callback :reset, :after, *methods, &block end
Вызывает этот обратный вызов после вызова reset для экземпляра. Используется для сброса внешних зависимых объектов, например Time.zone.
Открытые методы экземпляра
# File activesupport/lib/active_support/current_attributes.rb, line 209 def attributes @attributes.dup end
# File activesupport/lib/active_support/current_attributes.rb, line 228
def reset
run_callbacks :reset do
self.attributes = resolve_defaults
end
end Сбрасывает все атрибуты. При использовании в качестве синглтона на время запроса этот метод следует вызывать до и после действий.
# File activesupport/lib/active_support/current_attributes.rb, line 223 def set(attributes, &block) with(**attributes, &block) end
Предоставляет доступ к одному или нескольким атрибутам внутри блока. После завершения блока восстанавливаются прежние значения. Ниже приведен пример распространенного случая, когда атрибуты Current необходимо задать за пределами цикла обработки запроса:
class Chat::PublicationJob < ApplicationJob
def perform(attributes, room_number, creator)
Current.set(person: creator) do
Chat::Publisher.publish(attributes: attributes, room_number: room_number)
end
end
end
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.