Provides a thread-isolated attributes singleton for Rails applications pre v5.2.0. The singleton is reset automatically before and after reach request. This allows you to keep all the per-request attributes easily available to the whole system.
Please note that: This gem was extracted from this commit (lands in Rails v5.2.0). It is compatible with Rails >= 4.2.
Add this line to your application's Gemfile:
gem 'activesupport-current_attributes'
And then execute:
$ bundle
Or install it yourself as:
$ gem install activesupport-current_attributes
The following full app-like example demonstrates how to use a Current
class to facilitate easy access to the global, per-request attributes without passing them deeply around everywhere:
# 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(cookies.signed[: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
# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
include Authentication
include SetCurrentRequestDetails
end
# app/controllers/messages_controller.rb
class MessagesController < ApplicationController
def create
Current.account.messages.create(message_params)
end
end
# app/models/message.rb
class Message < ApplicationRecord
belongs_to :creator, default: -> { Current.user }
after_create { |message| Event.create(record: message) }
end
# app/models/event.rb
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
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new pull request
The gem is available as open source under the terms of the MIT License.