litecable 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ece0fdf218bcdeefe8b375d73114c28bd869c5d232d1c38dd91f0e880c1e57
-  data.tar.gz: e53c002d7179a52793a1382dd88dbb782d43319801e0f5ff51d36dd32237c005
+  metadata.gz: ce37cbd6931242e4cc18f8679e3131e3b7e1dab3b589576408b7a8b3d70737ae
+  data.tar.gz: e12346809a6b05538edb6d417ba99fa72ae465bfb79775a0f7e046cc8070e2fb
 SHA512:
-  metadata.gz: 1867f388377ea2f29c63cea936e255dcea9b7011ce83a45f93965ee98507c00e063360d62fb436a80a767c52b23f00ff853e92dbb93421ab9b0f007243cbc1d7
-  data.tar.gz: 9d344ce7aa7f3f0c07dc8c6be396cd51ae18758ffd5ad3e07ff156704fe87ee4ab0d54c67f0e619b30cb5344635f39860df0919b6a9587230ae87aa7d226d0c7
+  metadata.gz: 9f3a5bd03cb018458eb5c9c447e3f2ae240cf92d91c071c6aec89c067753bd63b023f23a7c1dea6261b2457236466e1b8dcd07f27413d7dd1aeeeb70bb5579ef
+  data.tar.gz: 1972ce3fd5adc6305a22fbfcd174ee5ec5f74fba22e553e714159b5b9c822fd3d1bcbbc774a9630292e9002bfb61e4d80c0c0916a1001d3462a84433002b8651

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master (unreleased)
 
+## 0.8.0 (2023-03-08)
+
+- Allow using custom channel lookup logic. ([@palkan][])
+
+- Ruby 2.7+ is required.
+
+## 0.7.2 (2021-07-06)
+
+- Fixed Ruby 3.0.1 compatibility.
+
 ## 0.7.1 (2021-01-06)
 
 - Fix handling client disconnection during socket write. ([@palkan][])

data/README.md

@@ -55,6 +55,21 @@ end
 App.cable.subscriptions.create('chat', ...)
 ```
 
+### Using a custom channel registry
+
+Alternatively to eager loading all channel classes and providing identifiers, you can build a custom _channel registry_ object, which can perform channel class lookups:
+
+```ruby
+# DummyRegistry which always returns a predefined channel class
+class DummyRegistry
+  def lookup(channel_id)
+    DummyChannel
+  end
+end
+
+LiteCable.channel_registry = DummyRegistry.new
+```
+
 ### Using built-in server (middleware)
 
 Lite Cable comes with a simple Rack middleware for development/testing usage.
@@ -78,9 +93,11 @@ end
 
 ### Using with AnyCable
 
-Lite Cable is AnyCable-compatible out-of-the-box:
+Lite Cable is AnyCable-compatible out-of-the-box.
+
+If AnyCable gem is loaded, you don't need to configure Lite Cable at all.
 
-- Set broadcast adapter to AnyCable:
+Otherwise, you must configure broadcast adapter manually:
 
 ```ruby
 LiteCable.broadcast_adapter = :any_cable
@@ -88,7 +105,7 @@ LiteCable.broadcast_adapter = :any_cable
 
 You can also do this via configuration, e.g., env var (`LITECABLE_BROADCAST_ADAPTER=any_cable`) or `broadcast_adapter: any_cable` in a YAML config.
 
-- Configure connection factory:
+**At the AnyCable side**, you must configure a connection factory:
 
 ```ruby
 AnyCable.connection_factory = MyApp::Connection

data/lib/lite_cable/anycable.rb

@@ -9,7 +9,7 @@ module LiteCable # :nodoc:
       end
 
       def call(socket, **options)
-        new(socket, options)
+        new(socket, **options)
       end
 
       module InstanceMethods # :nodoc:
@@ -23,7 +23,6 @@ module LiteCable # :nodoc:
           @request ||= Rack::Request.new(socket.env)
         end
 
-        # rubocop: disable Metrics/MethodLength
         def handle_channel_command(identifier, command, data)
           channel = subscriptions.add(identifier, false)
           case command
@@ -45,7 +44,6 @@ module LiteCable # :nodoc:
           close
           false
         end
-        # rubocop: enable Metrics/MethodLength
       end
     end
   end

data/lib/lite_cable/broadcast_adapters/base.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal: true
-
 module LiteCable
   module BroadcastAdapters
     class Base

data/lib/lite_cable/broadcast_adapters.rb

@@ -6,7 +6,6 @@ module LiteCable
   module BroadcastAdapters # :nodoc:
     module_function
 
-    # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
     def lookup_adapter(args)
       adapter, options = Array(args)
       path_to_adapter = "lite_cable/broadcast_adapters/#{adapter}"
@@ -30,6 +29,5 @@ module LiteCable
 
       BroadcastAdapters.const_get(adapter_class_name, false).new(**(options || {}))
     end
-    # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/lite_cable/channel/registry.rb

@@ -21,6 +21,8 @@ module LiteCable
           channels[id]
         end
 
+        alias_method :lookup, :find
+
         def find!(id)
           channel_class = find(id)
           raise UnknownChannelError unless channel_class

data/lib/lite_cable/config.rb

@@ -13,7 +13,7 @@ module LiteCable
 
     attr_config :logger,
       coder: Coders::JSON,
-      broadcast_adapter: :memory,
+      broadcast_adapter: defined?(::AnyCable::VERSION) ? :any_cable : :memory,
       identifier_coder: Coders::Raw,
       log_level: Logger::INFO
   end

data/lib/lite_cable/connection/subscriptions.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
 module LiteCable
+  class UnknownChannelError < StandardError
+    attr_reader :channel_id
+
+    def initialize(channel_id)
+      @channel_id = channel_id
+      super("Unknown channel: #{channel_id}")
+    end
+  end
+
   module Connection
     # Manage the connection channels and route messages
     class Subscriptions
@@ -30,7 +39,9 @@ module LiteCable
 
         channel_id = params.delete("channel")
 
-        channel_class = Channel::Registry.find!(channel_id)
+        channel_class = LiteCable.channel_registry.lookup(channel_id)
+
+        raise UnknownChannelError, channel_id unless channel_class
 
         subscriptions[identifier] = channel_class.new(connection, identifier, params)
         subscribe ? subscribe_channel(subscriptions[identifier]) : subscriptions[identifier]
@@ -92,17 +103,17 @@ module LiteCable
 
       def transmit_subscription_confirmation(identifier)
         connection.transmit identifier: identifier,
-                            type: LiteCable::INTERNAL[:message_types][:confirmation]
+          type: LiteCable::INTERNAL[:message_types][:confirmation]
       end
 
       def transmit_subscription_rejection(identifier)
         connection.transmit identifier: identifier,
-                            type: LiteCable::INTERNAL[:message_types][:rejection]
+          type: LiteCable::INTERNAL[:message_types][:rejection]
       end
 
       def transmit_subscription_cancel(identifier)
         connection.transmit identifier: identifier,
-                            type: LiteCable::INTERNAL[:message_types][:cancel]
+          type: LiteCable::INTERNAL[:message_types][:cancel]
       end
 
       def log_fmt(msg)

data/lib/lite_cable/server/client_socket/base.rb

@@ -64,7 +64,6 @@ module LiteCable
           @error_handlers << block
         end
 
-        # rubocop: disable Metrics/MethodLength
         def listen
           keepalive
           Thread.new do
@@ -74,7 +73,7 @@ module LiteCable
               each_frame do |data|
                 @message_handlers.each do |h|
                   h.call(data)
-                rescue => e # rubocop: disable Style/RescueStandardError
+                rescue => e
                   log(:error, "Socket receive failed: #{e}")
                   @error_handlers.each { |eh| eh.call(e, data) }
                   close if close_on_error
@@ -85,7 +84,6 @@ module LiteCable
             end
           end
         end
-        # rubocop: enable Metrics/MethodLength
 
         def close
           return unless @active
@@ -116,7 +114,7 @@ module LiteCable
           frame = WebSocket::Frame::Outgoing::Server.new(version: version, type: :close, code: 1000)
           @socket.write(frame.to_s) if frame.supported?
           @socket.close
-        rescue IOError, Errno::EPIPE, Errno::ETIMEDOUT # rubocop:disable Lint/HandleExceptions
+        rescue IOError, Errno::EPIPE, Errno::ETIMEDOUT
           # already closed
         end
 
@@ -137,7 +135,7 @@ module LiteCable
         def each_frame
           framebuffer = WebSocket::Frame::Incoming::Server.new(version: version)
 
-          while IO.select([socket])
+          while socket.wait_readable
             data = socket.respond_to?(:recv) ? socket.recv(2000) : socket.readpartial(2000)
             break if data.empty?
 

data/lib/lite_cable/server/heart_beat.rb

@@ -23,7 +23,6 @@ module LiteCable
         @stopped = true
       end
 
-      # rubocop: disable Metrics/MethodLength
       def run
         Thread.new do
           Thread.current.abort_on_exception = true
@@ -41,7 +40,6 @@ module LiteCable
           end
         end
       end
-      # rubocop: enable Metrics/MethodLength
 
       private
 

data/lib/lite_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiteCable
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/lite_cable.rb

@@ -23,6 +23,8 @@ module LiteCable
       @config ||= Config.new
     end
 
+    attr_accessor :channel_registry
+
     # Broadcast encoded message to the stream
     def broadcast(stream, message, coder: LiteCable.config.coder)
       broadcast_adapter.broadcast(stream, message, coder: coder)
@@ -47,4 +49,6 @@ module LiteCable
       @broadcast_adapter = adapter
     end
   end
+
+  self.channel_registry = Channel::Registry
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litecable
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +187,7 @@ metadata:
   documentation_uri: http://github.com/palkan/litecable
   homepage_uri: http://github.com/palkan/litecable
   source_code_uri: http://github.com/palkan/litecable
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,15 +195,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Fat-free ActionCable implementation
 test_files: []