dexiecable 2.0.0.alpha2 → 2.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714562cd7c933eb48e81e9159acd326d77b6133a807cdd541000f350281c1c94
-  data.tar.gz: d3bcacdc18d5f9c7a8be970f9ede859be19e282e8ca35aa4d27c81e581310eb3
+  metadata.gz: 2c2de6d52cf60491a659aebc8452a88ca8b8878142d08e842fadc8fb4bb1050b
+  data.tar.gz: 6be72c303e815a4809aff6b88a718b3e9ec1df8d5ebd341af03768225ee86bc3
 SHA512:
-  metadata.gz: ed0dbe4fdfade70f3300d9c2a61882f6a00320c384fe74ad76b6ba11ef0733a26b86f6949606117b4847efdd5221709bf1a091088a510a0155d6ff9f48a87774
-  data.tar.gz: d5cef46c7417c0e34ff4e08c08e0df846ff653f19ae0eeacbffe9de433a362c9ae9af60b32f669a6daa301b64a05d3844f227587cf20af4da23ecf149b39cfb9
+  metadata.gz: ac607ef7627a7a0562459042bcc8b23244362553624cb2f7543a7997430842c5185d5c889b8557c3ad28f10265d286f7a557a1ce76c397473adc97ead82b13d5
+  data.tar.gz: 1386543cc03df9409d17f184a8e1b4b80e85f993663009a32324da9b8e79561000c907c42e25c84c683bef4d4f11e525a5c1cd6dda58a0817595d53417880786

data/README.md

@@ -73,7 +73,7 @@ setConsumer(createConsumer("wss://example.com/cable"));
 
 ### DexieChannel
 
-DexieCable ships one channel — `DexieChannel` — so you never define your own channels or include anything. Every Dexie broadcast goes through it.
+DexieCable ships one channel — `DexieChannel` — so you don't need to define channels yourself. Every Dexie broadcast goes through it, and you can reopen it to add custom actions or push initial data.
 
 Stream tokens are signed with the application secret, so a client can only subscribe to streams the server has issued for it:
 
@@ -107,23 +107,43 @@ subscription.removeStream(userStream);
 subscription.removeAllStreams();
 ```
 
-#### Initial data on subscribe
+#### Extending DexieChannel
 
-To push a snapshot when a stream is added, set `DexieChannel.on_subscribe`. It receives the channel and the subscribed record (resolved from the signed GlobalID), so you can dispatch on the record type:
+To add custom actions or push initial data, reopen `DexieChannel` in your app:
 
 ```ruby
 # config/initializers/dexiecable.rb
-DexieChannel.on_subscribe = ->(channel, record) do
-  case record
-  when User
-    channel.table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
-  when Conversation
-    channel.table("messages").bulkAdd(record.messages.map(&:as_json_for_dexie))
+class DexieCable::DexieChannel
+  # Push a snapshot when a private stream is added.
+  def subscribed_to(record, params)
+    case record
+    when User
+      table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
+    when Conversation
+      table("messages").bulkAdd(record.messages.where("seq_id > ?", params[:last_seq_id]).map(&:as_json_for_dexie))
+    end
+  end
+
+  # Any public method is a custom action the client can perform.
+  def mark_as_read(data)
+    Message.find(data["id"]).update!(read: true)
   end
 end
 ```
 
-The callback runs after the stream is opened, and `channel.table(...)` transmits to just this subscriber — so the snapshot arrives before any live mutation.
+The client still subscribes to `DexieCable::DexieChannel`, so no extra client config is needed:
+
+```js
+const subscription = subscribe(db);
+```
+
+Pass params from the client when adding a stream:
+
+```js
+subscription.addStream(userStream, { last_seq_id: 100 });
+```
+
+`subscribed_to` runs after the stream is opened, and `table(...)` transmits to just this subscriber — so the snapshot arrives before any live mutation. Custom actions are triggered like any ActionCable action: `subscription.perform("mark_as_read", { id: 42 })`.
 
 #### Public streams
 

data/lib/dexiecable/dexie_channel.rb

@@ -13,23 +13,25 @@ module DexieCable
   #   # public (no signature, namespaced under "public:")
   #   subscription.addPublicStream("feed")
   #
-  # When a private stream is added, +on_subscribe+ is invoked with the
-  # channel and the subscribed record, so initial data can be pushed:
+  # Reopen this channel in your app to push initial data or add custom
+  # actions:
   #
-  #   DexieChannel.on_subscribe = ->(channel, record) do
-  #     case record
-  #     when User
-  #       channel.table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
-  #     when Conversation
-  #       channel.table("messages").bulkAdd(record.messages.map(&:as_json_for_dexie))
+  #   class DexieCable::DexieChannel
+  #     def subscribed_to(record, params)
+  #       case record
+  #       when User
+  #         table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
+  #       end
+  #     end
+  #
+  #     def my_custom_action(data)
+  #       # ...
   #     end
   #   end
   #
   class DexieChannel < ActionCable::Channel::Base
     PUBLIC_STREAM_PREFIX = "public:"
 
-    class_attribute :on_subscribe, instance_accessor: false, default: nil
-
     public :transmit
 
     # Open a scoped channel for broadcasting to a specific recipient.
@@ -74,7 +76,8 @@ module DexieCable
       return unless target
 
       stream_for target
-      self.class.on_subscribe&.call(self, resolve_subscribe_target(target))
+      params = data.except("action", "stream").with_indifferent_access
+      subscribed_to(resolve_subscribe_target(target), params)
     end
 
     def remove_stream(data)
@@ -98,6 +101,12 @@ module DexieCable
       stop_stream_from public_stream_name(name) if name.present?
     end
 
+    # Override by reopening the channel to push initial data when a private
+    # stream is added. +record+ is the resolved target and +params+ are any
+    # extra params sent from the client.
+    def subscribed_to(_record, _params)
+    end
+
     private
 
     def public_stream_name(name)

data/lib/dexiecable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DexieCable
-  VERSION = "2.0.0.alpha2"
+  VERSION = "2.0.0.alpha3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha2
+  version: 2.0.0.alpha3
 platform: ruby
 authors:
 - Stefan Buhrmester