actioncable 7.1.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91df46c82676862ec16ec0e905d252583e103a136754fc8b90c0c439b59f793b
-  data.tar.gz: 84fae8a4fcf04c709b62be2c7253d2604c4dde21157b952b7a76ca58de0ed82c
+  metadata.gz: aa223855ae2af9c70e27271ec03c83d04e21c180c062f471d7bc388636e7e90a
+  data.tar.gz: f0188f07302139302eafc4cb12f2e7dd79d9391cde0079f6192dbed309278f07
 SHA512:
-  metadata.gz: 8bbb134371e5f1779e5c233ae52ea3be80b890b5ac3d7f9698c19473f84146cfb8cebb5ae33c8097692563de01936ce0d89f87ba971761473dbcb5ceea4bede4
-  data.tar.gz: 89eef4bd17afe2a547f950c46c9b999c1eed44fef810dd0c16a34b14d8c7b072137657a816d3b39c1e600a602760be628c41e75693dcceed915726bc9ef38479
+  metadata.gz: 1c2d900a7b3a882b196b3b4ae2b490d4ab2335add9f250b869201bcff68adebd0dbc5bd8e63d437be9db7844dd0b866ce803774ff2592b87282018dd9faedfe2
+  data.tar.gz: be12b84cff9a8e0b089e75a97071a8e030ca10cd00fbe7d5f77e22824a583109f3ccf9ec77474cbd81fe33b5ae2c91541185657ac810e041590eaef3e40cc5cc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Rails 7.1.1 (October 11, 2023) ##
+
+*   No changes.
+
+
 ## Rails 7.1.0 (October 05, 2023) ##
 
 *   No changes.

data/lib/action_cable/channel/callbacks.rb

@@ -6,19 +6,31 @@ module ActionCable
   module Channel
     # = Action Cable \Channel \Callbacks
     #
-    # Action Cable Channel provides hooks during the life cycle of a channel subscription.
-    # Callbacks allow triggering logic during this cycle. Available callbacks are:
+    # Action Cable Channel provides callback hooks that are invoked during the
+    # life cycle of a channel:
     #
-    # * <tt>before_subscribe</tt>
-    # * <tt>after_subscribe</tt> (also aliased as: <tt>on_subscribe</tt>)
-    # * <tt>before_unsubscribe</tt>
-    # * <tt>after_unsubscribe</tt> (also aliased as: <tt>on_unsubscribe</tt>)
+    # * {before_subscribe}[rdoc-ref:ClassMethods#before_subscribe]
+    # * {after_subscribe}[rdoc-ref:ClassMethods#after_subscribe] (aliased as
+    #   {on_subscribe}[rdoc-ref:ClassMethods#on_subscribe])
+    # * {before_unsubscribe}[rdoc-ref:ClassMethods#before_unsubscribe]
+    # * {after_unsubscribe}[rdoc-ref:ClassMethods#after_unsubscribe] (aliased as
+    #   {on_unsubscribe}[rdoc-ref:ClassMethods#on_unsubscribe])
     #
-    # NOTE: the <tt>after_subscribe</tt> callback is triggered whenever
-    # the <tt>subscribed</tt> method is called, even if subscription was rejected
-    # with the <tt>reject</tt> method.
-    # To trigger <tt>after_subscribe</tt> only on successful subscriptions,
-    # use <tt>after_subscribe :my_method_name, unless: :subscription_rejected?</tt>
+    # ==== Example
+    #
+    #   class ChatChannel < ApplicationCable::Channel
+    #     after_subscribe :send_welcome_message, unless: :subscription_rejected?
+    #     after_subscribe :track_subscription
+    #
+    #     private
+    #       def send_welcome_message
+    #         broadcast_to(...)
+    #       end
+    #
+    #       def track_subscription
+    #         # ...
+    #       end
+    #   end
     #
     module Callbacks
       extend  ActiveSupport::Concern
@@ -34,6 +46,15 @@ module ActionCable
           set_callback(:subscribe, :before, *methods, &block)
         end
 
+        # This callback will be triggered after the Base#subscribed method is
+        # called, even if the subscription was rejected with the Base#reject
+        # method.
+        #
+        # To trigger the callback only on successful subscriptions, use the
+        # Base#subscription_rejected? method:
+        #
+        #   after_subscribe :my_method, unless: :subscription_rejected?
+        #
         def after_subscribe(*methods, &block)
           set_callback(:subscribe, :after, *methods, &block)
         end

data/lib/action_cable/connection/callbacks.rb

@@ -6,9 +6,13 @@ module ActionCable
   module Connection
     # = Action Cable \Connection \Callbacks
     #
-    # There are <tt>before_command</tt>, <tt>after_command</tt>, and <tt>around_command</tt> callbacks
-    # available to be invoked before, after or around every command received by a client respectively.
-    # The term "command" here refers to any interaction received by a client (subscribing, unsubscribing or performing actions):
+    # The {before_command}[rdoc-ref:ClassMethods#before_command],
+    # {after_command}[rdoc-ref:ClassMethods#after_command], and
+    # {around_command}[rdoc-ref:ClassMethods#around_command] callbacks are
+    # invoked when sending commands to the client, such as when subscribing,
+    # unsubscribing, or performing an action.
+    #
+    # ==== Example
     #
     #    module ApplicationCable
     #      class Connection < ActionCable::Connection::Base

data/lib/action_cable/gem_version.rb

@@ -9,7 +9,7 @@ module ActionCable
   module VERSION
     MAJOR = 7
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.1.1
 platform: ruby
 authors:
 - Pratik Naik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2023-10-11 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.0
+        version: 7.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -154,10 +154,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.1.0/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.1.0/
+  changelog_uri: https://github.com/rails/rails/blob/v7.1.1/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.1.1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.1.0/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v7.1.1/actioncable
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []