actioncable 5.0.7.2 → 5.1.0.beta1

data/lib/action_cable/channel/broadcasting.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/object/to_param'
+require "active_support/core_ext/object/to_param"
 
 module ActionCable
   module Channel
@@ -16,7 +16,7 @@ module ActionCable
         def broadcasting_for(model) #:nodoc:
           case
           when model.is_a?(Array)
-            model.map { |m| broadcasting_for(m) }.join(':')
+            model.map { |m| broadcasting_for(m) }.join(":")
           when model.respond_to?(:to_gid_param)
             model.to_gid_param
           else

data/lib/action_cable/channel/callbacks.rb

@@ -1,4 +1,4 @@
-require 'active_support/callbacks'
+require "active_support/callbacks"
 
 module ActionCable
   module Channel

data/lib/action_cable/channel/naming.rb

@@ -10,8 +10,9 @@ module ActionCable
         #
         #   ChatChannel.channel_name # => 'chat'
         #   Chats::AppearancesChannel.channel_name # => 'chats:appearances'
+        #   FooChats::BarAppearancesChannel.channel_name # => 'foo_chats:bar_appearances'
         def channel_name
-          @channel_name ||= name.sub(/Channel$/, '').gsub('::',':').underscore
+          @channel_name ||= name.sub(/Channel$/, "").gsub("::", ":").underscore
         end
       end
 

data/lib/action_cable/channel/periodic_timers.rb

@@ -30,7 +30,7 @@ module ActionCable
         def periodically(callback_or_method_name = nil, every:, &block)
           callback =
             if block_given?
-              raise ArgumentError, 'Pass a block or provide a callback arg, not both' if callback_or_method_name
+              raise ArgumentError, "Pass a block or provide a callback arg, not both" if callback_or_method_name
               block
             else
               case callback_or_method_name

data/lib/action_cable/channel/streams.rb

@@ -19,14 +19,14 @@ module ActionCable
     #   end
     #
     # Based on the above example, the subscribers of this channel will get whatever data is put into the,
-    # let's say, `comments_for_45` broadcasting as soon as it's put there.
+    # let's say, <tt>comments_for_45</tt> broadcasting as soon as it's put there.
     #
     # An example broadcasting for this channel looks like so:
     #
     #   ActionCable.server.broadcast "comments_for_45", author: 'DHH', content: 'Rails is just swell'
     #
     # If you have a stream that is related to a model, then the broadcasting used can be generated from the model and channel.
-    # The following example would subscribe to a broadcasting like `comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE`
+    # The following example would subscribe to a broadcasting like <tt>comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE</tt>.
     #
     #   class CommentsChannel < ApplicationCable::Channel
     #     def subscribed
@@ -69,8 +69,8 @@ module ActionCable
 
       # Start streaming from the named <tt>broadcasting</tt> pubsub queue. Optionally, you can pass a <tt>callback</tt> that'll be used
       # instead of the default of just transmitting the updates straight to the subscriber.
-      # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to the callback.
-      # Defaults to `coder: nil` which does no decoding, passes raw messages.
+      # Pass <tt>coder: ActiveSupport::JSON</tt> to decode messages as JSON before passing to the callback.
+      # Defaults to <tt>coder: nil</tt> which does no decoding, passes raw messages.
       def stream_from(broadcasting, callback = nil, coder: nil, &block)
         broadcasting = String(broadcasting)
 
@@ -94,8 +94,8 @@ module ActionCable
       # <tt>callback</tt> that'll be used instead of the default of just transmitting the updates straight
       # to the subscriber.
       #
-      # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to the callback.
-      # Defaults to `coder: nil` which does no decoding, passes raw messages.
+      # Pass <tt>coder: ActiveSupport::JSON</tt> to decode messages as JSON before passing to the callback.
+      # Defaults to <tt>coder: nil</tt> which does no decoding, passes raw messages.
       def stream_for(model, callback = nil, coder: nil, &block)
         stream_from(broadcasting_for([ channel_name, model ]), callback || block, coder: coder)
       end
@@ -138,7 +138,7 @@ module ActionCable
         end
 
         # May be overridden to change the default stream handling behavior
-        # which decodes JSON and transmits to client.
+        # which decodes JSON and transmits to the client.
         #
         # TODO: Tests demonstrating this.
         #

data/lib/action_cable/connection.rb

@@ -8,8 +8,6 @@ module ActionCable
       autoload :ClientSocket
       autoload :Identification
       autoload :InternalChannel
-      autoload :FayeClientSocket
-      autoload :FayeEventLoop
       autoload :MessageBuffer
       autoload :Stream
       autoload :StreamEventLoop

data/lib/action_cable/connection/authorization.rb

@@ -3,11 +3,11 @@ module ActionCable
     module Authorization
       class UnauthorizedError < StandardError; end
 
-      # Closes the \WebSocket connection if it is open and returns a 404 "File not Found" response.
-      def reject_unauthorized_connection
-        logger.error "An unauthorized connection attempt was rejected"
-        raise UnauthorizedError
-      end
+      private
+        def reject_unauthorized_connection
+          logger.error "An unauthorized connection attempt was rejected"
+          raise UnauthorizedError
+        end
     end
   end
-end
+end

data/lib/action_cable/connection/base.rb

@@ -1,8 +1,8 @@
-require 'action_dispatch'
+require "action_dispatch"
 
 module ActionCable
   module Connection
-    # For every WebSocket the Action Cable server accepts, a Connection object will be instantiated. This instance becomes the parent
+    # For every WebSocket connection the Action Cable server accepts, a Connection object will be instantiated. This instance becomes the parent
     # of all of the channel subscriptions that are created from there on. Incoming messages are then routed to these channel subscriptions
     # based on an identifier sent by the Action Cable consumer. The Connection itself does not deal with any specific application logic beyond
     # authentication and authorization.
@@ -22,13 +22,10 @@ module ActionCable
     #         # Any cleanup work needed when the cable connection is cut.
     #       end
     #
-    #       protected
+    #       private
     #         def find_verified_user
-    #           if current_user = User.find_by_identity cookies.signed[:identity_id]
-    #             current_user
-    #           else
+    #           User.find_by_identity(cookies.signed[:identity_id]) ||
     #             reject_unauthorized_connection
-    #           end
     #         end
     #     end
     #   end
@@ -57,7 +54,7 @@ module ActionCable
         @worker_pool = server.worker_pool
         @logger = new_tagged_logger
 
-        @websocket      = ActionCable::Connection::WebSocket.new(env, self, event_loop, server.config.client_socket_class)
+        @websocket      = ActionCable::Connection::WebSocket.new(env, self, event_loop)
         @subscriptions  = ActionCable::Connection::Subscriptions.new(self)
         @message_buffer = ActionCable::Connection::MessageBuffer.new(self)
 
@@ -105,14 +102,14 @@ module ActionCable
         worker_pool.async_invoke(self, method, *arguments)
       end
 
-      # Return a basic hash of statistics for the connection keyed with `identifier`, `started_at`, and `subscriptions`.
+      # Return a basic hash of statistics for the connection keyed with <tt>identifier</tt>, <tt>started_at</tt>, <tt>subscriptions</tt>, and <tt>request_id</tt>.
       # This can be returned by a health check against the connection.
       def statistics
         {
           identifier: connection_identifier,
           started_at: @started_at,
           subscriptions: subscriptions.identifiers,
-          request_id: @env['action_dispatch.request_id']
+          request_id: @env["action_dispatch.request_id"]
         }
       end
 
@@ -136,9 +133,15 @@ module ActionCable
         send_async :handle_close
       end
 
+      # TODO Change this to private once we've dropped Ruby 2.2 support.
+      # Workaround for Ruby 2.2 "private attribute?" warning.
       protected
+        attr_reader :websocket
+        attr_reader :message_buffer
+
+      private
         # The request that initiated the WebSocket connection is available here. This gives access to the environment, cookies, etc.
-        def request
+        def request # :doc:
           @request ||= begin
             environment = Rails.application.env_config.merge(env) if defined?(Rails.application) && Rails.application
             ActionDispatch::Request.new(environment || env)
@@ -146,14 +149,10 @@ module ActionCable
         end
 
         # The cookies of the request that initiated the WebSocket connection. Useful for performing authorization checks.
-        def cookies
+        def cookies # :doc:
           request.cookie_jar
         end
 
-        attr_reader :websocket
-        attr_reader :message_buffer
-
-      private
         def encode(cable_message)
           @coder.encode cable_message
         end
@@ -216,7 +215,7 @@ module ActionCable
 
           logger.error invalid_request_message
           logger.info finished_request_message
-          [ 404, { 'Content-Type' => 'text/plain' }, [ 'Page not found' ] ]
+          [ 404, { "Content-Type" => "text/plain" }, [ "Page not found" ] ]
         end
 
         # Tags are declared in the server but computed in the connection. This allows us per-connection tailored tags.
@@ -229,7 +228,7 @@ module ActionCable
           'Started %s "%s"%s for %s at %s' % [
             request.request_method,
             request.filtered_path,
-            websocket.possible? ? ' [WebSocket]' : '[non-WebSocket]',
+            websocket.possible? ? " [WebSocket]" : "[non-WebSocket]",
             request.ip,
             Time.now.to_s ]
         end
@@ -237,19 +236,19 @@ module ActionCable
         def finished_request_message
           'Finished "%s"%s for %s at %s' % [
             request.filtered_path,
-            websocket.possible? ? ' [WebSocket]' : '[non-WebSocket]',
+            websocket.possible? ? " [WebSocket]" : "[non-WebSocket]",
             request.ip,
             Time.now.to_s ]
         end
 
         def invalid_request_message
-          'Failed to upgrade to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)' % [
+          "Failed to upgrade to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)" % [
             env["REQUEST_METHOD"], env["HTTP_CONNECTION"], env["HTTP_UPGRADE"]
           ]
         end
 
         def successful_request_message
-          'Successfully upgraded to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)' % [
+          "Successfully upgraded to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)" % [
             env["REQUEST_METHOD"], env["HTTP_CONNECTION"], env["HTTP_UPGRADE"]
           ]
         end

data/lib/action_cable/connection/client_socket.rb

@@ -1,4 +1,4 @@
-require 'websocket/driver'
+require "websocket/driver"
 
 module ActionCable
   module Connection
@@ -8,16 +8,16 @@ module ActionCable
     # Copyright (c) 2010-2015 James Coglan
     class ClientSocket # :nodoc:
       def self.determine_url(env)
-        scheme = secure_request?(env) ? 'wss:' : 'ws:'
+        scheme = secure_request?(env) ? "wss:" : "ws:"
         "#{ scheme }//#{ env['HTTP_HOST'] }#{ env['REQUEST_URI'] }"
       end
 
       def self.secure_request?(env)
-        return true if env['HTTPS'] == 'on'
-        return true if env['HTTP_X_FORWARDED_SSL'] == 'on'
-        return true if env['HTTP_X_FORWARDED_SCHEME'] == 'https'
-        return true if env['HTTP_X_FORWARDED_PROTO'] == 'https'
-        return true if env['rack.url_scheme'] == 'https'
+        return true if env["HTTPS"] == "on"
+        return true if env["HTTP_X_FORWARDED_SSL"] == "on"
+        return true if env["HTTP_X_FORWARDED_SCHEME"] == "https"
+        return true if env["HTTP_X_FORWARDED_PROTO"] == "https"
+        return true if env["rack.url_scheme"] == "https"
 
         return false
       end
@@ -37,7 +37,7 @@ module ActionCable
         @url = ClientSocket.determine_url(@env)
 
         @driver = @driver_started = nil
-        @close_params = ['', 1006]
+        @close_params = ["", 1006]
 
         @ready_state = CONNECTING
 
@@ -56,7 +56,7 @@ module ActionCable
         return if @driver.nil? || @driver_started
         @stream.hijack_rack_socket
 
-        if callback = @env['async.callback']
+        if callback = @env["async.callback"]
           callback.call([101, {}, @stream])
         end
 
@@ -78,20 +78,20 @@ module ActionCable
       def transmit(message)
         return false if @ready_state > OPEN
         case message
-          when Numeric then @driver.text(message.to_s)
-          when String  then @driver.text(message)
-          when Array   then @driver.binary(message)
+        when Numeric then @driver.text(message.to_s)
+        when String  then @driver.text(message)
+        when Array   then @driver.binary(message)
           else false
         end
       end
 
       def close(code = nil, reason = nil)
         code   ||= 1000
-        reason ||= ''
+        reason ||= ""
 
-        unless code == 1000 or (code >= 3000 and code <= 4999)
-          raise ArgumentError, "Failed to execute 'close' on WebSocket: " +
-                               "The code must be either 1000, or between 3000 and 4999. " +
+        unless code == 1000 || (code >= 3000 && code <= 4999)
+          raise ArgumentError, "Failed to execute 'close' on WebSocket: " \
+                               "The code must be either 1000, or between 3000 and 4999. " \
                                "#{code} is neither."
         end
 

data/lib/action_cable/connection/identification.rb

@@ -1,4 +1,4 @@
-require 'set'
+require "set"
 
 module ActionCable
   module Connection

data/lib/action_cable/connection/internal_channel.rb

@@ -27,8 +27,8 @@ module ActionCable
         end
 
         def process_internal_message(message)
-          case message['type']
-          when 'disconnect'
+          case message["type"]
+          when "disconnect"
             logger.info "Removing connection (#{connection_identifier})"
             websocket.close
           end

data/lib/action_cable/connection/message_buffer.rb

@@ -28,6 +28,8 @@ module ActionCable
         receive_buffered_messages
       end
 
+      # TODO Change this to private once we've dropped Ruby 2.2 support.
+      # Workaround for Ruby 2.2 "private attribute?" warning.
       protected
         attr_reader :connection
         attr_reader :buffered_messages

data/lib/action_cable/connection/stream.rb

@@ -1,4 +1,4 @@
-require 'thread'
+require "thread"
 
 module ActionCable
   module Connection
@@ -10,7 +10,7 @@ module ActionCable
       def initialize(event_loop, socket)
         @event_loop    = event_loop
         @socket_object = socket
-        @stream_send   = socket.env['stream.send']
+        @stream_send   = socket.env["stream.send"]
 
         @rack_hijack_io = nil
         @write_lock = Mutex.new
@@ -94,10 +94,10 @@ module ActionCable
       end
 
       def hijack_rack_socket
-        return unless @socket_object.env['rack.hijack']
+        return unless @socket_object.env["rack.hijack"]
 
-        @socket_object.env['rack.hijack'].call
-        @rack_hijack_io = @socket_object.env['rack.hijack_io']
+        @socket_object.env["rack.hijack"].call
+        @rack_hijack_io = @socket_object.env["rack.hijack_io"]
 
         @event_loop.attach(@rack_hijack_io, self)
       end

data/lib/action_cable/connection/stream_event_loop.rb

@@ -1,5 +1,5 @@
-require 'nio'
-require 'thread'
+require "nio"
+require "thread"
 
 module ActionCable
   module Connection

data/lib/action_cable/connection/subscriptions.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/hash/indifferent_access'
+require "active_support/core_ext/hash/indifferent_access"
 
 module ActionCable
   module Connection
@@ -11,19 +11,19 @@ module ActionCable
       end
 
       def execute_command(data)
-        case data['command']
-        when 'subscribe'   then add data
-        when 'unsubscribe' then remove data
-        when 'message'     then perform_action data
+        case data["command"]
+        when "subscribe"   then add data
+        when "unsubscribe" then remove data
+        when "message"     then perform_action data
         else
           logger.error "Received unrecognized command in #{data.inspect}"
         end
       rescue Exception => e
-        logger.error "Could not execute command from #{data.inspect}) [#{e.class} - #{e.message}]: #{e.backtrace.first(5).join(" | ")}"
+        logger.error "Could not execute command from (#{data.inspect}) [#{e.class} - #{e.message}]: #{e.backtrace.first(5).join(" | ")}"
       end
 
       def add(data)
-        id_key = data['identifier']
+        id_key = data["identifier"]
         id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
 
         return if subscriptions.key?(id_key)
@@ -41,7 +41,7 @@ module ActionCable
 
       def remove(data)
         logger.info "Unsubscribing from channel: #{data['identifier']}"
-        remove_subscription subscriptions[data['identifier']]
+        remove_subscription subscriptions[data["identifier"]]
       end
 
       def remove_subscription(subscription)
@@ -50,7 +50,7 @@ module ActionCable
       end
 
       def perform_action(data)
-        find(data).perform_action ActiveSupport::JSON.decode(data['data'])
+        find(data).perform_action ActiveSupport::JSON.decode(data["data"])
       end
 
       def identifiers
@@ -61,6 +61,8 @@ module ActionCable
         subscriptions.each { |id, channel| remove_subscription(channel) }
       end
 
+      # TODO Change this to private once we've dropped Ruby 2.2 support.
+      # Workaround for Ruby 2.2 "private attribute?" warning.
       protected
         attr_reader :connection, :subscriptions
 
@@ -68,7 +70,7 @@ module ActionCable
         delegate :logger, to: :connection
 
         def find(data)
-          if subscription = subscriptions[data['identifier']]
+          if subscription = subscriptions[data["identifier"]]
             subscription
           else
             raise "Unable to find subscription with identifier: #{data['identifier']}"