actioncable 7.1.3.2 → 8.0.1

data/lib/action_cable/server/configuration.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rack"
 
 module ActionCable
   module Server
-    # = Action Cable \Server \Configuration
+    # # Action Cable Server Configuration
     #
-    # An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration
-    # in a \Rails config initializer.
+    # An instance of this configuration object is available via
+    # ActionCable.server.config, which allows you to tweak Action Cable
+    # configuration in a Rails config initializer.
     class Configuration
       attr_accessor :logger, :log_tags
       attr_accessor :connection_class, :worker_pool_size
@@ -31,28 +34,28 @@ module ActionCable
         }
       end
 
-      # Returns constant of subscription adapter specified in config/cable.yml.
-      # If the adapter cannot be found, this will default to the Redis adapter.
-      # Also makes sure proper dependencies are required.
+      # Returns constant of subscription adapter specified in config/cable.yml. If the
+      # adapter cannot be found, this will default to the Redis adapter. Also makes
+      # sure proper dependencies are required.
       def pubsub_adapter
         adapter = (cable.fetch("adapter") { "redis" })
 
         # Require the adapter itself and give useful feedback about
-        #   1. Missing adapter gems and
-        #   2. Adapter gems' missing dependencies.
+        #     1. Missing adapter gems and
+        #     2. Adapter gems' missing dependencies.
         path_to_adapter = "action_cable/subscription_adapter/#{adapter}"
         begin
           require path_to_adapter
         rescue LoadError => e
-          # We couldn't require the adapter itself. Raise an exception that
-          # points out config typos and missing gems.
+          # We couldn't require the adapter itself. Raise an exception that points out
+          # config typos and missing gems.
           if e.path == path_to_adapter
-            # We can assume that a non-builtin adapter was specified, so it's
-            # either misspelled or missing from Gemfile.
+            # We can assume that a non-builtin adapter was specified, so it's either
+            # misspelled or missing from Gemfile.
             raise e.class, "Could not load the '#{adapter}' Action Cable pubsub adapter. Ensure that the adapter is spelled correctly in config/cable.yml and that you've added the necessary adapter gem to your Gemfile.", e.backtrace
 
-          # Bubbled up from the adapter require. Prefix the exception message
-          # with some guidance about how to address it and reraise.
+          # Bubbled up from the adapter require. Prefix the exception message with some
+          # guidance about how to address it and reraise.
           else
             raise e.class, "Error loading the '#{adapter}' Action Cable pubsub adapter. Missing a gem it depends on? #{e.message}", e.backtrace
           end

data/lib/action_cable/server/connections.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module Server
-    # = Action Cable \Server \Connections
+    # # Action Cable Server Connections
     #
-    # Collection class for all the connections that have been established on this specific server. Remember, usually you'll run many Action Cable servers, so
-    # you can't use this collection as a full list of all of the connections established against your application. Instead, use RemoteConnections for that.
+    # Collection class for all the connections that have been established on this
+    # specific server. Remember, usually you'll run many Action Cable servers, so
+    # you can't use this collection as a full list of all of the connections
+    # established against your application. Instead, use RemoteConnections for that.
     module Connections # :nodoc:
       BEAT_INTERVAL = 3
 
@@ -21,8 +25,10 @@ module ActionCable
         connections.delete connection
       end
 
-      # WebSocket connection implementations differ on when they'll mark a connection as stale. We basically never want a connection to go stale, as you
-      # then can't rely on being able to communicate with the connection. To solve this, a 3 second heartbeat runs on all connections. If the beat fails, we automatically
+      # WebSocket connection implementations differ on when they'll mark a connection
+      # as stale. We basically never want a connection to go stale, as you then can't
+      # rely on being able to communicate with the connection. To solve this, a 3
+      # second heartbeat runs on all connections. If the beat fails, we automatically
       # disconnect.
       def setup_heartbeat_timer
         @heartbeat_timer ||= event_loop.timer(BEAT_INTERVAL) do

data/lib/action_cable/server/worker/active_record_connection_management.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module Server
     class Worker

data/lib/action_cable/server/worker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/callbacks"
 require "active_support/core_ext/module/attribute_accessors_per_thread"
 require "concurrent"
@@ -25,8 +27,8 @@ module ActionCable
         )
       end
 
-      # Stop processing work: any work that has not already started
-      # running will be discarded from the queue
+      # Stop processing work: any work that has not already started running will be
+      # discarded from the queue
       def halt
         @executor.shutdown
       end

data/lib/action_cable/subscription_adapter/async.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     class Async < Inline # :nodoc:

data/lib/action_cable/subscription_adapter/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     class Base

data/lib/action_cable/subscription_adapter/channel_prefix.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     module ChannelPrefix # :nodoc:

data/lib/action_cable/subscription_adapter/inline.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     class Inline < Base # :nodoc:

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 gem "pg", "~> 1.1"
 require "pg"
 require "openssl"
@@ -33,18 +35,17 @@ module ActionCable
       end
 
       def with_subscriptions_connection(&block) # :nodoc:
-        ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
-          # Action Cable is taking ownership over this database connection, and
-          # will perform the necessary cleanup tasks
-          ActiveRecord::Base.connection_pool.remove(conn)
-        end
+        # Action Cable is taking ownership over this database connection, and will
+        # perform the necessary cleanup tasks.
+        # We purposedly avoid #checkout to not end up with a pinned connection
+        ar_conn = ActiveRecord::Base.connection_pool.new_connection
         pg_conn = ar_conn.raw_connection
 
         verify!(pg_conn)
         pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(identifier)}")
         yield pg_conn
       ensure
-        ar_conn.disconnect!
+        ar_conn&.disconnect!
       end
 
       def with_broadcast_connection(&block) # :nodoc:

data/lib/action_cable/subscription_adapter/redis.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 gem "redis", ">= 4", "< 6"
 require "redis"
 
@@ -10,8 +12,9 @@ module ActionCable
     class Redis < Base # :nodoc:
       prepend ChannelPrefix
 
-      # Overwrite this factory method for Redis connections if you want to use a different Redis library than the redis gem.
-      # This is needed, for example, when using Makara proxies for distributed Redis.
+      # Overwrite this factory method for Redis connections if you want to use a
+      # different Redis library than the redis gem. This is needed, for example, when
+      # using Makara proxies for distributed Redis.
       cattr_accessor :redis_connector, default: ->(config) do
         ::Redis.new(config.except(:adapter, :channel_prefix))
       end

data/lib/action_cable/subscription_adapter/subscriber_map.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     class SubscriberMap

data/lib/action_cable/subscription_adapter/test.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
-    # == \Test adapter for Action Cable
+    # ## Test adapter for Action Cable
     #
     # The test adapter should be used only in testing. Along with
-    # ActionCable::TestHelper it makes a great tool to test your \Rails application.
+    # ActionCable::TestHelper it makes a great tool to test your Rails application.
     #
-    # To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
+    # To use the test adapter set `adapter` value to `test` in your
+    # `config/cable.yml` file.
     #
-    # NOTE: +Test+ adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter,
-    # so it could be used in system tests too.
+    # NOTE: `Test` adapter extends the `ActionCable::SubscriptionAdapter::Async`
+    # adapter, so it could be used in system tests too.
     class Test < Async
       def broadcast(channel, payload)
         broadcasts(channel) << payload

data/lib/action_cable/test_case.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/test_case"
 
 module ActionCable

data/lib/action_cable/test_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   # Provides helper methods for testing Action Cable broadcasting
   module TestHelper
@@ -18,33 +20,30 @@ module ActionCable
       ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
     end
 
-    # Asserts that the number of broadcasted messages to the stream matches the given number.
-    #
-    #   def test_broadcasts
-    #     assert_broadcasts 'messages', 0
-    #     ActionCable.server.broadcast 'messages', { text: 'hello' }
-    #     assert_broadcasts 'messages', 1
-    #     ActionCable.server.broadcast 'messages', { text: 'world' }
-    #     assert_broadcasts 'messages', 2
-    #   end
-    #
-    # If a block is passed, that block should cause the specified number of
-    # messages to be broadcasted. It returns the messages that were broadcasted.
+    # Asserts that the number of broadcasted messages to the stream matches the
+    # given number.
     #
-    #   def test_broadcasts_again
-    #     message = assert_broadcasts('messages', 1) do
+    #     def test_broadcasts
+    #       assert_broadcasts 'messages', 0
     #       ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #       assert_broadcasts 'messages', 1
+    #       ActionCable.server.broadcast 'messages', { text: 'world' }
+    #       assert_broadcasts 'messages', 2
     #     end
-    #     assert_equal({ text: 'hello' }, message)
     #
-    #     messages = assert_broadcasts('messages', 2) do
-    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
-    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    # If a block is passed, that block should cause the specified number of messages
+    # to be broadcasted.
+    #
+    #     def test_broadcasts_again
+    #       assert_broadcasts('messages', 1) do
+    #         ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #       end
+    #
+    #       assert_broadcasts('messages', 2) do
+    #         ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #         ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #       end
     #     end
-    #     assert_equal 2, messages.length
-    #     assert_equal({ text: 'hi' }, messages.first)
-    #     assert_equal({ text: 'how are you?' }, messages.last)
-    #   end
     #
     def assert_broadcasts(stream, number, &block)
       if block_given?
@@ -60,23 +59,23 @@ module ActionCable
 
     # Asserts that no messages have been sent to the stream.
     #
-    #   def test_no_broadcasts
-    #     assert_no_broadcasts 'messages'
-    #     ActionCable.server.broadcast 'messages', { text: 'hi' }
-    #     assert_broadcasts 'messages', 1
-    #   end
+    #     def test_no_broadcasts
+    #       assert_no_broadcasts 'messages'
+    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #       assert_broadcasts 'messages', 1
+    #     end
     #
     # If a block is passed, that block should not cause any message to be sent.
     #
-    #   def test_broadcasts_again
-    #     assert_no_broadcasts 'messages' do
-    #       # No job messages should be sent from this block
+    #     def test_broadcasts_again
+    #       assert_no_broadcasts 'messages' do
+    #         # No job messages should be sent from this block
+    #       end
     #     end
-    #   end
     #
     # Note: This assertion is simply a shortcut for:
     #
-    #   assert_broadcasts 'messages', 0, &block
+    #     assert_broadcasts 'messages', 0, &block
     #
     def assert_no_broadcasts(stream, &block)
       assert_broadcasts stream, 0, &block
@@ -84,15 +83,15 @@ module ActionCable
 
     # Returns the messages that are broadcasted in the block.
     #
-    #   def test_broadcasts
-    #     messages = capture_broadcasts('messages') do
-    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
-    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #     def test_broadcasts
+    #       messages = capture_broadcasts('messages') do
+    #         ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #         ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #       end
+    #       assert_equal 2, messages.length
+    #       assert_equal({ text: 'hi' }, messages.first)
+    #       assert_equal({ text: 'how are you?' }, messages.last)
     #     end
-    #     assert_equal 2, messages.length
-    #     assert_equal({ text: 'hi' }, messages.first)
-    #     assert_equal({ text: 'how are you?' }, messages.last)
-    #   end
     #
     def capture_broadcasts(stream, &block)
       new_broadcasts_from(broadcasts(stream), stream, "capture_broadcasts", &block).map { |m| ActiveSupport::JSON.decode(m) }
@@ -100,23 +99,23 @@ module ActionCable
 
     # Asserts that the specified message has been sent to the stream.
     #
-    #   def test_assert_transmitted_message
-    #     ActionCable.server.broadcast 'messages', text: 'hello'
-    #     assert_broadcast_on('messages', text: 'hello')
-    #   end
+    #     def test_assert_transmitted_message
+    #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #       assert_broadcast_on('messages', text: 'hello')
+    #     end
     #
-    # If a block is passed, that block should cause a message with the specified data to be sent.
+    # If a block is passed, that block should cause a message with the specified
+    # data to be sent.
     #
-    #   def test_assert_broadcast_on_again
-    #     assert_broadcast_on('messages', text: 'hello') do
-    #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #     def test_assert_broadcast_on_again
+    #       assert_broadcast_on('messages', text: 'hello') do
+    #         ActionCable.server.broadcast 'messages', text: 'hello'
+    #       end
     #     end
-    #   end
     #
     def assert_broadcast_on(stream, data, &block)
-      # Encode to JSON and back–we want to use this value to compare
-      # with decoded JSON.
-      # Comparing JSON strings doesn't work due to the order if the keys.
+      # Encode to JSON and back–we want to use this value to compare with decoded
+      # JSON. Comparing JSON strings doesn't work due to the order if the keys.
       serialized_msg =
         ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
 

data/lib/action_cable/version.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require_relative "gem_version"
 
 module ActionCable
-  # Returns the currently loaded version of Action Cable as a +Gem::Version+.
+  # Returns the currently loaded version of Action Cable as a `Gem::Version`.
   def self.version
     gem_version
   end

data/lib/action_cable.rb

@@ -27,24 +27,30 @@ require "active_support"
 require "active_support/rails"
 require "zeitwerk"
 
+# We compute lib this way instead of using __dir__ because __dir__ gives a real
+# path, while __FILE__ honors symlinks. If the gem is stored under a symlinked
+# directory, this matters.
+lib = File.dirname(__FILE__)
+
 Zeitwerk::Loader.for_gem.tap do |loader|
   loader.ignore(
-    "#{__dir__}/rails", # Contains generators, templates, docs, etc.
-    "#{__dir__}/action_cable/gem_version.rb",
-    "#{__dir__}/action_cable/deprecator.rb",
+    "#{lib}/rails", # Contains generators, templates, docs, etc.
+    "#{lib}/action_cable/gem_version.rb",
+    "#{lib}/action_cable/version.rb",
+    "#{lib}/action_cable/deprecator.rb",
   )
 
   loader.do_not_eager_load(
-    "#{__dir__}/action_cable/subscription_adapter", # Adapters are required and loaded on demand.
-    "#{__dir__}/action_cable/test_helper.rb",
-    Dir["#{__dir__}/action_cable/**/test_case.rb"]
+    "#{lib}/action_cable/subscription_adapter", # Adapters are required and loaded on demand.
+    "#{lib}/action_cable/test_helper.rb",
+    Dir["#{lib}/action_cable/**/test_case.rb"]
   )
 
   loader.inflector.inflect("postgresql" => "PostgreSQL")
 end.setup
 
 # :markup: markdown
-# :include: actioncable/README.md
+# :include: ../README.md
 module ActionCable
   require_relative "action_cable/version"
   require_relative "action_cable/deprecator"

data/lib/rails/generators/channel/channel_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module Rails
   module Generators
     class ChannelGenerator < NamedBase
@@ -103,8 +105,8 @@ pin_all_from "app/javascript/channels", under: "channels"
         end
 
         def using_bun?
-          # Cannot assume bun.lockb has been generated yet so we look for
-          # a file known to be generated by the jsbundling-rails gem
+          # Cannot assume bun.lockb has been generated yet so we look for a file known to
+          # be generated by the jsbundling-rails gem
           @using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
         end
 

data/lib/rails/generators/test_unit/channel_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module TestUnit
   module Generators
     class ChannelGenerator < ::Rails::Generators::NamedBase

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 7.1.3.2
+  version: 8.0.1
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: 8.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: 8.0.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: 8.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: 8.0.1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -141,8 +141,8 @@ files:
 - lib/action_cable/version.rb
 - lib/rails/generators/channel/USAGE
 - lib/rails/generators/channel/channel_generator.rb
-- lib/rails/generators/channel/templates/application_cable/channel.rb
-- lib/rails/generators/channel/templates/application_cable/connection.rb
+- lib/rails/generators/channel/templates/application_cable/channel.rb.tt
+- lib/rails/generators/channel/templates/application_cable/connection.rb.tt
 - lib/rails/generators/channel/templates/channel.rb.tt
 - lib/rails/generators/channel/templates/javascript/channel.js.tt
 - lib/rails/generators/channel/templates/javascript/consumer.js.tt
@@ -154,12 +154,12 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.1.3.2/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.1.3.2/
+  changelog_uri: https://github.com/rails/rails/blob/v8.0.1/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.0.1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.1.3.2/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v8.0.1/actioncable
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,15 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: WebSocket framework for Rails.
 test_files: []