Sha256: fa455d0c6a152c5cdc0243fdf4f9ef27c02d8b189661144bf934f4aca3d8e044

Contents?: true

Size: 1.42 KB

Versions: 32

Compression:

Stored size: 1.42 KB

Contents

require 'set'

module ActionCable
  module Connection
    module Identification
      extend ActiveSupport::Concern

      included do
        class_attribute :identifiers
        self.identifiers = Set.new
      end

      class_methods do
        # Mark a key as being a connection identifier index that can then be used to find the specific connection again later.
        # Common identifiers are current_user and current_account, but could be anything, really.
        #
        # Note that anything marked as an identifier will automatically create a delegate by the same name on any
        # channel instances created off the connection.
        def identified_by(*identifiers)
          Array(identifiers).each { |identifier| attr_accessor identifier }
          self.identifiers += identifiers
        end
      end

      # Return a single connection identifier that combines the value of all the registered identifiers into a single gid.
      def connection_identifier
        unless defined? @connection_identifier
          @connection_identifier = connection_gid identifiers.map { |id| instance_variable_get("@#{id}") }.compact
        end

        @connection_identifier
      end

      private
        def connection_gid(ids)
          ids.map do |o|
            if o.respond_to? :to_gid_param
              o.to_gid_param
            else
              o.to_s
            end
          end.sort.join(":")
        end
    end
  end
end

Version data entries

32 entries across 32 versions & 4 rubygems

Version Path
actioncable-5.0.7.2 lib/action_cable/connection/identification.rb
actioncable-5.0.7.1 lib/action_cable/connection/identification.rb
actioncable-5.0.7 lib/action_cable/connection/identification.rb
actioncable-5.0.6 lib/action_cable/connection/identification.rb
actioncable-5.0.6.rc1 lib/action_cable/connection/identification.rb
actioncable-5.0.5 lib/action_cable/connection/identification.rb
actioncable-5.0.5.rc2 lib/action_cable/connection/identification.rb
actioncable-5.0.5.rc1 lib/action_cable/connection/identification.rb
actioncable-5.0.4 lib/action_cable/connection/identification.rb
actioncable-5.0.4.rc1 lib/action_cable/connection/identification.rb
actioncable-5.0.3 lib/action_cable/connection/identification.rb
enju_leaf-1.2.1 vendor/bundle/ruby/2.3/gems/actioncable-5.0.2/lib/action_cable/connection/identification.rb
actioncable-5.0.2 lib/action_cable/connection/identification.rb
actioncable-5.0.2.rc1 lib/action_cable/connection/identification.rb
autocompl-0.2.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb
autocompl-0.2.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb
autocompl-0.2.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb
autocompl-0.1.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb
autocompl-0.1.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb
autocompl-0.1.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/actioncable-5.0.1/lib/action_cable/connection/identification.rb