Sha256: 2d50f1d42037c29e5e1df779952b89a8b403008ca31be54a57c582f7da926dc8

Contents?: true

Size: 1.47 KB

Versions: 21

Compression:

Stored size: 1.47 KB

Contents

# frozen_string_literal: true

# :markup: markdown

require "set"

module ActionCable
  module Connection
    module Identification
      extend ActiveSupport::Concern

      included do
        class_attribute :identifiers, default: Set.new
      end

      module ClassMethods
        # 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.filter_map { |id| instance_variable_get("@#{id}") }
        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

21 entries across 21 versions & 3 rubygems

Version Path
actioncable-next-0.2.0 lib/action_cable/connection/identification.rb
actioncable-next-0.1.2 lib/action_cable/connection/identification.rb
actioncable-7.2.2.1 lib/action_cable/connection/identification.rb
actioncable-7.2.2 lib/action_cable/connection/identification.rb
actioncable-7.2.1.2 lib/action_cable/connection/identification.rb
actioncable-7.2.1.1 lib/action_cable/connection/identification.rb
actioncable-next-0.1.1 lib/action_cable/connection/identification.rb
actioncable-next-0.1.0 lib/action_cable/connection/identification.rb
actioncable-8.0.0.beta1 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha9 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha8 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha7 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha4 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha3 lib/action_cable/connection/identification.rb
omg-actioncable-8.0.0.alpha2 lib/action_cable/connection/identification.rb
actioncable-7.2.1 lib/action_cable/connection/identification.rb
actioncable-7.2.0 lib/action_cable/connection/identification.rb
actioncable-7.2.0.rc1 lib/action_cable/connection/identification.rb
actioncable-7.2.0.beta3 lib/action_cable/connection/identification.rb
actioncable-7.2.0.beta2 lib/action_cable/connection/identification.rb