activesupport-current_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b109012074bb1ed8a31034fbc47b79f844333fa
+  data.tar.gz: 45e6b01cb1e3fce6daff93a13b008f1eb5527a30
+SHA512:
+  metadata.gz: 98b5474e715b5f0bf4fa3947774b4db41766fa0e4affec54391b9f8e91e5ff85e86e760e3355f86e91e4526f3d1c8f5819f4a1ea60f6e8b0982fdf8b81e7783c
+  data.tar.gz: 6d0549c0849fee4100ee5267cdf8474181c046636bddcb09c24e11371531ccc3152ea545da5b9f37df14a3564f37c78608dd8775de0d87655337b6a738862418

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ahmed Hazem
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Active Support Current Attributes
+
+[![Build Status](https://travis-ci.com/coup-mobility/activesupport-current_attributes.svg?token=BjB77zxGgewb2s2spui7&branch=master)](https://travis-ci.com/coup-mobility/activesupport-current_attributes)
+
+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](https://github.com/rails/rails/commit/24a864437e845febe91e3646ca008e8dc7f76b56) (lands in Rails v5.2.0). It is compatible with Rails >= 4.2._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'activesupport-current_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activesupport-current_attributes
+
+## Usage
+
+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:
+
+```ruby
+  # 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
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/active_support/current_attributes/current_attributes.rb

@@ -0,0 +1,194 @@
+module ActiveSupport
+  # Abstract super class that provides a thread-isolated attributes singleton, which resets automatically
+  # before and after reach request. This allows you to keep all the per-request attributes easily
+  # available to the whole system.
+  #
+  # 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
+  #
+  #   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
+  #
+  # A word of caution: It's easy to overdo a global singleton like Current and tangle your model as a result.
+  # Current should only be used for a few, top-level globals, like account, user, and request details.
+  # The attributes stuck in Current should be used by more or less all actions on all requests. If you start
+  # sticking controller-specific attributes in there, you're going to create a mess.
+  class CurrentAttributes
+    include ActiveSupport::Callbacks
+    define_callbacks :reset
+
+    class << self
+      # Returns singleton instance for this class in this thread. If none exists, one is created.
+      def instance
+        Thread.current[:"current_attributes_for_#{name}"] ||= new.tap do |instance|
+          current_instances << instance
+        end
+      end
+
+      # Declares one or more attributes that will be given both class and instance accessor methods.
+      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
+
+      # Calls this block after #reset is called on the instance. Used for resetting external collaborators, like Time.zone.
+      def resets(&block)
+        set_callback :reset, :after, &block
+      end
+
+      delegate :set, :reset, to: :instance
+
+      def reset_all # :nodoc:
+        current_instances.each(&:reset)
+      end
+
+      private
+        def generated_attribute_methods
+          @generated_attribute_methods ||= Module.new.tap { |mod| include mod }
+        end
+
+        def current_instances
+          Thread.current[:current_attributes_instances] ||= []
+        end
+
+        def method_missing(name, *args, &block)
+          # Caches the method definition as a singleton method of the receiver.
+          #
+          # By letting #delegate handle it, we avoid an enclosure that'll capture args.
+          singleton_class.delegate name, to: :instance
+
+          send(name, *args, &block)
+        end
+    end
+
+    attr_accessor :attributes
+
+    def initialize
+      @attributes = {}
+    end
+
+    # Expose one or more attributes within a block. Old values are returned after the block concludes.
+    # Example demonstrating the common use of needing to set Current attributes outside the request-cycle:
+    #
+    #   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
+    def set(set_attributes)
+      old_attributes = compute_attributes(set_attributes.keys)
+      assign_attributes(set_attributes)
+      yield
+    ensure
+      assign_attributes(old_attributes)
+    end
+
+    # Reset all attributes. Should be called before and after actions, when used as a per-request singleton.
+    def reset
+      run_callbacks :reset do
+        self.attributes = {}
+      end
+    end
+
+    private
+      def assign_attributes(new_attributes)
+        new_attributes.each { |key, value| public_send("#{key}=", value) }
+      end
+
+      def compute_attributes(keys)
+        if [].respond_to?(:to_h)
+          keys.collect { |key| [ key, public_send(key) ] }.to_h
+        else
+          keys.each_with_object({}) { |key, attributes| attributes[key] = public_send(key) }
+        end
+      end
+  end
+end

data/lib/active_support/current_attributes/railtie.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+
+module ActiveSupport
+  class Railtie < Rails::Railtie # :nodoc:
+    initializer "active_support.reset_all_current_attributes_instances", before: "active_support.deprecation_behavior" do |app|
+      app.executor.to_run      { ActiveSupport::CurrentAttributes.reset_all }
+      app.executor.to_complete { ActiveSupport::CurrentAttributes.reset_all }
+    end
+  end
+end

data/lib/active_support/current_attributes/version.rb

@@ -0,0 +1,3 @@
+module CurrentAttributes
+  VERSION = "0.0.1"
+end

data/lib/active_support/current_attributes.rb

@@ -0,0 +1,3 @@
+require "active_support/current_attributes/current_attributes"
+require "active_support/current_attributes/railtie" if defined? Rails::Railtie
+require "active_support/current_attributes/version"

data/lib/activesupport/current_attributes.rb

@@ -0,0 +1 @@
+require "active_support/current_attributes"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: activesupport-current_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Coup Mobility GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: " Provides a thread-isolated attributes singleton for Rails applications
+  pre v5.2.0. "
+email:
+- ahmed.hemdan@joincoup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/active_support/current_attributes.rb
+- lib/active_support/current_attributes/current_attributes.rb
+- lib/active_support/current_attributes/railtie.rb
+- lib/active_support/current_attributes/version.rb
+- lib/activesupport/current_attributes.rb
+homepage: https://github.com/coup-mobility/activesupport-current_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Provides a thread-isolated attributes singleton for Rails applications pre
+  v5.2.0.
+test_files: []