Spec-Zone.ru › Ruby on Rails 6.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(&block)
Псевдоним для: resets
attribute(*names) Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 99
def attribute(*names)
  generated_attribute_methods.module_eval do
    names.each do |name|
      define_method(name) do
        attributes[name.to_sym]
      end

      define_method("#{name}=") do |attribute|
        attributes[name.to_sym] = attribute
      end
    end
  end

  names.each do |name|
    define_singleton_method(name) do
      instance.public_send(name)
    end

    define_singleton_method("#{name}=") do |attribute|
      instance.public_send("#{name}=", attribute)
    end
  end
end

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

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

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

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

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

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

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

Также используется как: after_reset

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

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

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

set(set_attributes) { || ... } Показать исходный код
# File activesupport/lib/active_support/current_attributes.rb, line 184
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–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

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