anycable-rails-core 1.5.4 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceb26b8e5c09c7bd5500007a29a79a2933cc38848a63da16af272a4a5d11771
-  data.tar.gz: 6db49c5ceca2e5b020fb7b225ebe2e1db63df8beb9858224502883ff35392529
+  metadata.gz: 06a551d757afa07138babbf351024554d52b667ab35893bc995cc1fb56edd8af
+  data.tar.gz: c630ecf586cfd0068b0d248c00dc1372ffd7d83a3abf0e76dc9ecd52ae960a7c
 SHA512:
-  metadata.gz: d78c540124cec98c20e2004f49324580300a9be00eea194fa09200a8b30090b3448e3411dcba1a4002efa857997e0ed66da44a808efd17ceede3ce45fd97b751
-  data.tar.gz: 4e7916ccc0f8c18ed305eab329575c1bc840be9eeeb1534d4d3c661067a5f9a96ac761af3e8f2f9871a0f3bcbc7d30816e09a3e9998d7bffdf3555d36a88f515
+  metadata.gz: 2d46a5b21269ef7cb9cfc562ecee2cfd9830e055dd18fb20bce468409f0a84bc3ca3dc1ba56d9d340202039de3ab93aeba2e600388b7130b99bff101cbf00448
+  data.tar.gz: 64a083bf7d4046b5a1bfa57058f0aa1cedded844067b15f5f9ea660a8d5291bbe2c8f6db6c4a63768f2d17f67d40bb920f4abe8e55b9fbc9241f72c4a4d9c587

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 1.5.5 (2024-12-12)
+
+- Publish RuboCop cops as a separate gem (`rubocop-anycable-rails`). ([@palkan][])
+
+- Upgrade RuboCop cops. ([@palkan][])
+
 ## 1.5.4 (2024-10-08)
 
 - Add [actioncable-next](https://github.com/anycable/actioncable-next) support. ([@palkan][])

data/lib/anycable/rails/action_cable_ext/channel.rb

@@ -3,17 +3,6 @@
 require "action_cable"
 
 ActionCable::Channel::Base.prepend(Module.new do
-  def subscribe_to_channel
-    super unless anycabled? && !@__anycable_subscribing__
-  end
-
-  def handle_subscribe
-    @__anycable_subscribing__ = true
-    subscribe_to_channel
-  ensure
-    @__anycable_subscribing__ = false
-  end
-
   def start_periodic_timers
     super unless anycabled?
   end

data/lib/anycable/rails/compatibility/rubocop.rb

@@ -1,27 +1,4 @@
 # frozen_string_literal: true
 
-require "rubocop"
-require "pathname"
-
-require_relative "rubocop/cops/anycable/stream_from"
-require_relative "rubocop/cops/anycable/periodical_timers"
-require_relative "rubocop/cops/anycable/instance_vars"
-
-module RuboCop
-  module AnyCable # :nodoc:
-    CONFIG_DEFAULT = Pathname.new(__dir__).join("rubocop", "config", "default.yml").freeze
-
-    # Merge anycable config into default configuration
-    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-    def self.inject!
-      path = CONFIG_DEFAULT.to_s
-      puts "configuration from #{path}" if ConfigLoader.debug?
-      hash = ConfigLoader.send(:load_yaml_configuration, path)
-      config = Config.new(hash, path)
-      config = ConfigLoader.merge_with_default(config, path)
-      ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
-  end
-end
-
-RuboCop::AnyCable.inject!
+# For backwards compatibility
+require_relative "../rubocop"

data/lib/anycable/rails/connection.rb

@@ -31,15 +31,65 @@ module AnyCable
       end
 
       refine ActionCable::Connection::Subscriptions do
-        # Find or add a subscription to the list
-        def fetch(identifier)
-          add("identifier" => identifier) unless subscriptions[identifier]
+        # Override the original #execute_command to pre-initialize the channel for unsubscribe/message and
+        # return true/false to indicate successful/unsuccessful subscription.
+        # We also must not lose any exceptions raised in the process.
+        def execute_rpc_command(data)
+          # First, verify the channel name
+          raise "Channel not found: #{ActiveSupport::JSON.decode(data["identifier"]).fetch("channel")}" unless subscription_class_from_identifier(data["identifier"])
+
+          if data["command"] == "subscribe"
+            add data
+            subscription = subscriptions[data["identifier"]]
+            return !(subscription.nil? || subscription.rejected?)
+          end
+
+          load(data["identifier"])
 
-          unless subscriptions[identifier]
-            raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}"
+          case data["command"]
+          when "unsubscribe"
+            remove data
+          when "message"
+            perform_action data
+          when "whisper"
+            whisper data
+          else
+            raise UnknownCommandError, data["command"]
           end
 
-          subscriptions[identifier]
+          true
+        end
+
+        # Restore channels from the list of identifiers and the state
+        def restore(subscriptions, istate)
+          subscriptions.each do |id|
+            channel = load(id)
+            channel.__istate__ = ActiveSupport::JSON.decode(istate[id]) if istate[id]
+          end
+        end
+
+        # Find or create a channel for a given identifier
+        def load(identifier)
+          return subscriptions[identifier] if subscriptions[identifier]
+
+          subscription = subscription_from_identifier(identifier)
+          raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}" unless subscription
+
+          subscriptions[identifier] = subscription
+        end
+
+        def subscription_class_from_identifier(id_key)
+          id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
+          id_options[:channel].safe_constantize
+        end
+
+        def subscription_from_identifier(id_key)
+          subscription_klass = subscription_class_from_identifier(id_key)
+
+          if subscription_klass && subscription_klass < ActionCable::Channel::Base
+            id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
+            subscription_klass.new(connection, id_key, id_options)
+          end
         end
       end
     end)
@@ -74,15 +124,8 @@ module AnyCable
         conn.cached_ids = {}
         conn.anycable_request_builder = self
 
-        return unless subscriptions
-
         # Pre-initialize channels (for disconnect)
-        subscriptions.each do |id|
-          channel = conn.subscriptions.fetch(id)
-          next unless socket.istate[id]
-
-          channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
-        end
+        conn.subscriptions.restore(subscriptions, socket.istate) if subscriptions
       end
 
       def handle_open
@@ -111,26 +154,8 @@ module AnyCable
 
       def handle_channel_command(identifier, command, data)
         conn.run_callbacks :command do
-          # We cannot use subscriptions#execute_command here,
-          # since we MUST return true of false, depending on the status
-          # of execution
-          channel = conn.subscriptions.fetch(identifier)
-          case command
-          when "subscribe"
-            channel.handle_subscribe
-            !channel.rejected?
-          when "unsubscribe"
-            conn.subscriptions.remove_subscription(channel)
-            true
-          when "message"
-            channel.perform_action ActiveSupport::JSON.decode(data)
-            true
-          else
-            false
-          end
+          conn.subscriptions.execute_rpc_command({"command" => command, "identifier" => identifier, "data" => data})
         end
-      # Support rescue_from
-      # https://github.com/rails/rails/commit/d2571e560c62116f60429c933d0c41a0e249b58b
       rescue Exception => e # rubocop:disable Lint/RescueException
         rescue_with_handler(e) || raise
         false

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/instance_vars.rb

@@ -24,7 +24,7 @@ module RuboCop
       #     end
       #   end
       #
-      class InstanceVars < RuboCop::Cop::Cop
+      class InstanceVars < RuboCop::Cop::Base
         MSG = "Channel instance variables are not supported in AnyCable. Use `state_attr_accessor` instead"
 
         def on_class(node)

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/periodical_timers.rb

@@ -13,7 +13,7 @@ module RuboCop
       #     periodically(:do_something, every: 2.seconds)
       #   end
       #
-      class PeriodicalTimers < RuboCop::Cop::Cop
+      class PeriodicalTimers < RuboCop::Cop::Base
         MSG = "Periodical Timers are not supported in AnyCable"
 
         def_node_matcher :calls_periodically?, <<-PATTERN

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/stream_from.rb

@@ -34,7 +34,7 @@ module RuboCop
       #     end
       #   end
       #
-      class StreamFrom < RuboCop::Cop::Cop
+      class StreamFrom < RuboCop::Cop::Base
         def_node_matcher :stream_from_with_block?, <<-PATTERN
           (block {(send _ :stream_from ...) (send _ :stream_for ...)} ...)
         PATTERN
@@ -81,16 +81,14 @@ module RuboCop
 
         def add_callback_offense(node)
           add_offense(
-            node,
-            location: :expression,
+            node.loc.expression,
             message: "Custom stream callbacks are not supported in AnyCable"
           )
         end
 
         def add_custom_coder_offense(node)
           add_offense(
-            node,
-            location: :expression,
+            node.loc.expression,
             message: "Custom coders are not supported in AnyCable"
           )
         end

data/lib/anycable/rails/rubocop.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "pathname"
+
+require_relative "rubocop/cops/anycable/stream_from"
+require_relative "rubocop/cops/anycable/periodical_timers"
+require_relative "rubocop/cops/anycable/instance_vars"
+
+module RuboCop
+  module AnyCable # :nodoc:
+    CONFIG_DEFAULT = Pathname.new(__dir__).join("rubocop", "config", "default.yml").freeze
+
+    # Merge anycable config into default configuration
+    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+    def self.inject!
+      path = CONFIG_DEFAULT.to_s
+      puts "configuration from #{path}" if ConfigLoader.debug?
+      hash = ConfigLoader.send(:load_yaml_configuration, path)
+      config = Config.new(hash, path)
+      config = ConfigLoader.merge_with_default(config, path)
+      ConfigLoader.instance_variable_set(:@default_configuration, config)
+    end
+  end
+end
+
+RuboCop::AnyCable.inject!

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.5.4"
+    VERSION = "1.5.6"
   end
 end

data/lib/anycable/rails.rb

@@ -84,7 +84,7 @@ end
 
 # Warn if application has been already initialized.
 # AnyCable should be loaded before initialization in order to work correctly.
-if defined?(::Rails) && ::Rails.application && ::Rails.application.initialized?
+if defined?(::Rails) && ::Rails.application&.initialized?
   puts("\n**************************************************")
   puts(
     "⛔️  WARNING: AnyCable loaded after application initialization. Might not work correctly.\n" \

data/lib/generators/anycable/setup/templates/config/anycable.yml.tt

@@ -23,7 +23,7 @@ default: &default
   <%- else -%>
   # Use HTTP broadcaster
   broadcast_adapter: http
-  http_broadcast_url: "http://localhost:8090/_anycable"
+  http_broadcast_url: "http://localhost:8090/_broadcast"
   <%- end -%>
   <%- if redis? -%>
   # You can use REDIS_URL env var to configure Redis URL.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.6
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
@@ -80,10 +80,6 @@ files:
 - lib/anycable/rails/channel_state.rb
 - lib/anycable/rails/compatibility.rb
 - lib/anycable/rails/compatibility/rubocop.rb
-- lib/anycable/rails/compatibility/rubocop/config/default.yml
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/instance_vars.rb
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/periodical_timers.rb
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb
 - lib/anycable/rails/config.rb
 - lib/anycable/rails/connection.rb
 - lib/anycable/rails/connection_factory.rb
@@ -105,6 +101,11 @@ files:
 - lib/anycable/rails/pubsub_channel.rb
 - lib/anycable/rails/rack.rb
 - lib/anycable/rails/railtie.rb
+- lib/anycable/rails/rubocop.rb
+- lib/anycable/rails/rubocop/config/default.yml
+- lib/anycable/rails/rubocop/cops/anycable/instance_vars.rb
+- lib/anycable/rails/rubocop/cops/anycable/periodical_timers.rb
+- lib/anycable/rails/rubocop/cops/anycable/stream_from.rb
 - lib/anycable/rails/socket_id_tracking.rb
 - lib/anycable/rails/version.rb
 - lib/generators/anycable/bin/USAGE
@@ -130,7 +131,7 @@ metadata:
   homepage_uri: https://anycable.io/
   source_code_uri: http://github.com/anycable/anycable-rails
   funding_uri: https://github.com/sponsors/anycable
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: AnyCable integration for Rails (w/o RPC dependencies)
 test_files: []