Spec-Zone.ru › Ruby on Rails 7.1

класс ActiveSupport::CurrentAttributes

Родитель:
Объект
Включённые модули:
ActiveSupport::Callbacks

Текущие атрибуты

Абстрактный базовый класс, который предоставляет изолированный по потокам синглтон атрибутов, автоматически сбрасывающий значения перед и после каждого запроса. Это позволяет легко сделать все атрибуты, относящиеся к запросу, доступными для всей системы.

Следующий пример приложения демонстрирует, как использовать класс 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, должны использоваться более или менее во всех действиях во всех запросах. Если вы начнете добавлять туда атрибуты, специфичные для контроллера, вы создадите путаницу.

Атрибуты

attributes[RW]

Публичные методы класса

after_reset(*methods, &block)
Псевдоним для: resets
attribute(*names) Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 104
def attribute(*names)
  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

  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

  ActiveSupport::CodeGenerator.batch(singleton_class, __FILE__, __LINE__) do |owner|
    names.each do |name|
      owner.define_cached_method(name, namespace: :current_attributes_delegation) do |batch|
        batch <<
          "def #{name}" <<
          "instance.#{name}" <<
          "end"
      end
      owner.define_cached_method("#{name}=", namespace: :current_attributes_delegation) do |batch|
        batch <<
          "def #{name}=(value)" <<
          "instance.#{name} = value" <<
          "end"
      end
    end
  end
end

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

before_reset(*methods, &block) Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 146
def before_reset(*methods, &block)
  set_callback :reset, :before, *methods, &block
end

Вызывает этот обратный вызов перед вызовом reset для экземпляра. Используется для сброса внешних коллабораторов, которые зависят от текущих значений.

instance() Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 99
def instance
  current_instances[current_instances_key] ||= new
end

Возвращает экземпляр синглтона для данного класса в этом потоке. Если он не существует, создаётся новый.

new() Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 197
def initialize
  @attributes = {}
end
resets(*methods, &block) Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 151
def resets(*methods, &block)
  set_callback :reset, :after, *methods, &block
end

Вызывает этот обратный вызов после вызова reset для экземпляра. Используется для сброса внешних коллабораторов, таких как Time.zone.

Также алиас для: after_reset

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

reset() Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 220
def reset
  run_callbacks :reset do
    self.attributes = {}
  end
end

Сбрасывает все атрибуты. Должен вызываться перед и после действий, когда используется в качестве синглтона для каждого запроса.

set(set_attributes) { || ... } Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 211
def set(set_attributes)
  old_attributes = compute_attributes(set_attributes.keys)
  assign_attributes(set_attributes)
  yield
ensure
  assign_attributes(old_attributes)
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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API