anycable-rails-core 1.5.4 → 1.6.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceb26b8e5c09c7bd5500007a29a79a2933cc38848a63da16af272a4a5d11771
-  data.tar.gz: 6db49c5ceca2e5b020fb7b225ebe2e1db63df8beb9858224502883ff35392529
+  metadata.gz: 395f76c02adbd3f4878b55bb21bf4bd00969e4394e824fb7a23f086d8b221b1c
+  data.tar.gz: b300f5b2ab64aa893d462a22045587f65531bbaea8dce3a920c1fb1df67b211e
 SHA512:
-  metadata.gz: d78c540124cec98c20e2004f49324580300a9be00eea194fa09200a8b30090b3448e3411dcba1a4002efa857997e0ed66da44a808efd17ceede3ce45fd97b751
-  data.tar.gz: 4e7916ccc0f8c18ed305eab329575c1bc840be9eeeb1534d4d3c661067a5f9a96ac761af3e8f2f9871a0f3bcbc7d30816e09a3e9998d7bffdf3555d36a88f515
+  metadata.gz: f0a2f228649539c86b8e3f1a96f0c456b6ed0f933552fb93c90ef2d4a5c49261fdbdf9f3e7b650cd69b00ca38bddcf202bb6f1d730aa92ad07ec3f8504128904
+  data.tar.gz: dfce4029440d91a5a7f07abccca089b6b0bb759d152aa2fadad9ccb12ca0533a5d10cba6e200f398ce58c54c76c5b0fa5903c48aeacba2354dc8b5f9ad37d10f

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/README.md

@@ -1,30 +1,18 @@
-[![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails)
+[![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable)
 [![Build](https://github.com/anycable/anycable-rails/workflows/Build/badge.svg)](https://github.com/anycable/anycable-rails/actions)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/rails/getting_started)
 
-# AnyCable Rails
+# AnyCable SDK for Ruby on Rails
 
-AnyCable allows you to use any WebSocket server (written in any language) as a replacement for built-in Rails Action Cable server.
+<img align="right" height="150" width="129"
+     title="AnyCable logo" src="https://docs.anycable.io/assets/images/logo.svg">
 
-With AnyCable you can use channels, client-side JS, broadcasting - (almost) all that you can do with Action Cable.
+[AnyCable](https://github.com/anycable/anycable) is an open-source language-agnostic realtime server for reliable two-way communication over WebSockets and SSE.
+This repository contains code for AnyCable Rails SKD that allows you to use AnyCable as a drop-in replacement for Action Cable.
 
-💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
+🌐 [Website](https://anycable.io) · 📚 [Documentation](https://docs.anycable.io/rails/getting_started) · 💾 [Example Rails Application](https://github.com/anycable/anycable_rails_demo)
 
-📑 [Documentation](https://docs.anycable.io/rails/getting_started).
-
-> [AnyCable Pro](https://docs.anycable.io/pro) has been launched 🚀
-
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
-
-## Requirements
-
-- Ruby >= 3.1
-- Rails >= 6.0\*
-
-\* Recent `anycable-rails` versions only work with Rails 8+; older versions compatible with Rails 6 and Rails 7 still receive fixes and minor updates (patch releases).
-
-## Usage
+## Quick Start
 
 Add `anycable-rails` gem to your Gemfile:
 
@@ -32,62 +20,13 @@ Add `anycable-rails` gem to your Gemfile:
 gem "anycable-rails"
 ```
 
-### Interactive set up
-
-After the gem was installed, you can run an interactive wizard to configure your Rails application for using with AnyCable by running a generator:
+Then run our interactive setup command:
 
 ```sh
 bundle exec rails g anycable:setup
 ```
 
-### Manual set up
-
-Specify AnyCable subscription adapter for Action Cable:
-
-```yml
-# config/cable.yml
-development:
-  adapter: any_cable # or anycable
-
-production:
-  adapter: any_cable
-```
-
-and specify AnyCable WebSocket server URL:
-
-```ruby
-# For development it's likely the localhost
-
-# config/environments/development.rb
-config.action_cable.url = "ws://localhost:8080/cable"
-
-# For production it's likely to have a sub-domain and secure connection
-
-# config/environments/production.rb
-config.action_cable.url = "wss://ws.example.com/cable"
-```
-
-Then, run AnyCable RPC server:
-
-```sh
-$ bundle exec anycable
-
-# don't forget to provide Rails env
-
-$ RAILS_ENV=production bundle exec anycable
-```
-
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/anycable-go/getting_started):
-
-```sh
-anycable-go --host=localhost --port=8080
-```
-
-See [documentation](https://docs.anycable.io/rails/getting_started) for more information on AnyCable + Rails usage.
-
-## Action Cable Compatibility
-
-See [documentation](https://docs.anycable.io/rails/compatibility).
+Learn more [here](https://docs.anycable.io/rails/getting_started).
 
 ## Contributing
 

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Channel
+      # Presence API for Action Cable channels (backed by AnyCable)
+      module Presence
+        extend ActiveSupport::Concern
+
+        def join_presence(stream = nil, id: user_presence_id, info: user_presence_info)
+          return unless anycabled?
+
+          stream ||= connection.anycable_socket.streams[:start].first || raise(ArgumentError, "Provide a stream name for presence updates")
+
+          connection.anycable_socket.presence_join(stream, id, info)
+        end
+
+        def leave_presence(id = user_presence_id)
+          return unless anycabled?
+
+          connection.anycable_socket.presence_leave(id)
+        end
+
+        private
+
+        def user_presence_id
+          connection.connection_identifier
+        end
+
+        def user_presence_info
+          # nothing
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Channel
+      autoload :Presence, "anycable/rails/channel/presence"
+    end
+  end
+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/connections/serializable_identification.rb

@@ -6,6 +6,20 @@ module AnyCable
       module SerializableIdentification
         extend ActiveSupport::Concern
 
+        module ConnectionGID
+          def connection_identifier
+            unless defined? @connection_identifier
+              @connection_identifier = connection_gid identifiers.filter_map { |id| instance_variable_get(:"@#{id}") || __send__(id) }
+            end
+
+            @connection_identifier
+          end
+        end
+
+        included do
+          prepend ConnectionGID
+        end
+
         class_methods do
           def identified_by(*identifiers)
             super

data/lib/anycable/rails/railtie.rb

@@ -123,11 +123,12 @@ module AnyCable
 
       initializer "anycable.verify_pool_sizes" do
         next if AnyCable.config.disable_rpc_pool_size_warning?
-        # Skip if non-gRPC server is used
-        next unless AnyCable.config.respond_to?(:rpc_pool_size)
 
         # Log current db vs. gRPC pool sizes
         AnyCable.configure_server do
+          # Skip if non-gRPC server is used
+          next unless AnyCable.config.respond_to?(:rpc_pool_size)
+
           ActiveSupport.on_load(:active_record) do
             db_pool_size = ::ActiveRecord::Base.connection_pool.size
             rpc_pool_size = AnyCable.config.rpc_pool_size

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.6.0.rc.1"
   end
 end

data/lib/anycable/rails.rb

@@ -9,6 +9,7 @@ require "globalid"
 require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 require "anycable/rails/ext"
+require "anycable/rails/channel"
 
 module AnyCable
   # Rails handler for AnyCable
@@ -84,7 +85,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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0.rc.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0.rc.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0.rc.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
@@ -77,13 +83,11 @@ files:
 - lib/anycable/rails/action_cable_ext/channel.rb
 - lib/anycable/rails/action_cable_ext/connection.rb
 - lib/anycable/rails/action_cable_ext/remote_connections.rb
+- lib/anycable/rails/channel.rb
+- lib/anycable/rails/channel/presence.rb
 - 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 +109,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
@@ -141,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.19
 signing_key: