dexiecable 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5284c177e5517bff845edf2e5317d1ab9c676deafd605a662b3dea1b7363b6a
-  data.tar.gz: 94f3e811e2bca16d05967c0c0dbf242bcae00b880212ad0dba7d1ee44f8263c9
+  metadata.gz: ef549275f108c037de78cad7dcabb5c3b3a0dfae666d6a56e413abd4bc1079f1
+  data.tar.gz: cb55611cd29a96e7fd79885b5e7575534f5f19e4ea417c745c1e8b13da9df59d
 SHA512:
-  metadata.gz: 4999890a88da548b86e19843b40a0221654eb2a144ec52f954c7723cb652c287d7884fd34e0703d5895131e3b1213ee840a427f31defa91ff21738a38133514a
-  data.tar.gz: 67bb97e60d5d9fc7416e239e0695b69ff00a4930df8d97d8380da29bd51686af9f2d70f04bd69d92322e61ea042a71704ce4e98bbc35d14ee5f0a33d13343def
+  metadata.gz: 2be1d8dcf416c79e83c6227762877c339e9bdb227956108f5f8ce80327b189c25a1c7ac9f974b330e1bf1f50dd058b3aa09ad2399f1e2642d58ed43622243b85
+  data.tar.gz: 8c2f011b0381a44ce0c5bc55ca0eeecd0beda02a359f16022770862d54b2710f6076a7388437f11d3ec673a115c8b4595fb9862332e2f3cd055fd8aaede8110b

data/README.md

@@ -5,7 +5,13 @@
 >
 > An addon providing full synchronization based on event streams is currently in development. But for now, if you need full synchronization, you'll have to roll your own.
 
-DexieCable gives your ActionCable channel a query DSL that mirrors the Dexie.js API, letting you push database mutations from the server to the client in real time. It also gives you a [`syncs_to_dexie`](#syncs_to_dexie-automatic-model-streaming) ActiveRecord macro for automatic change syncing.
+## Who's this for?
+
+DexieCable is made for Ruby on Rails apps that manage their client-side state in [Dexie](https://dexie.org) and use Dexie live queries for reactive UI updates. It's an alternative to Turbo Streams for apps that opt to use component frameworks (React, Vue, Svelte, etc.) instead of Turbo. 
+
+## How does it work?
+
+DexieCable gives your ActionCable channel a query DSL that mirrors the [Dexie.js API](https://dexie.org/docs), letting you push database mutations from the server to the client in real time. It also gives you a [`syncs_to_dexie`](#syncs_to_dexie-automatic-model-streaming) ActiveRecord macro for automatic change syncing.
 
 Push Dexie table updates to a client from anywhere on the server:
 
@@ -28,6 +34,8 @@ end
 
 ## What's new in 2.0
 
+### Custom Channels
+
 DexieCable 2.0 is a mixin. Create your own `DexieChannel` and `include DexieCable`:
 
 ```ruby
@@ -36,6 +44,8 @@ class DexieChannel < ApplicationCable::Channel
 end
 ```
 
+### Reuse the same subscription for multiple streams
+
 On the client, subscribe to that channel and add streams as needed. `addStream` accepts a signed token or a plain string, and returns a function that removes the stream:
 
 ```js
@@ -43,19 +53,28 @@ const subscription = subscribe(db);
 const unsubscribe = subscription.addStream(userStreamToken);
 ```
 
-You can then use the new `subscribed_to` hook to push initial data before any live mutation arrives. The first argument is the record the token was issued for, or the plain stream name for a public stream:
+## What's new in 3.0
+
+### `subscribed_to` moved to the model
+
+The `subscribed_to` hook now lives on the record rather than on the channel. Private streams declare their initial snapshot on the record the token was issued for, and receive the channel plus any params sent from the client:
+
+```ruby
+class User < ApplicationRecord
+  subscribed_to do |channel, params|
+    channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
+  end
+end
+```
+
+Public streams register a handler by name in your channel. The block runs in the channel's context, so `table` and `transmit` are available:
 
 ```ruby
 class DexieChannel < ApplicationCable::Channel
   include DexieCable
 
-  def subscribed_to(record, params)
-    case record
-    when "feed"
-      table(record).bulkAdd(Announcement.for_stream(record).map(&:as_json_for_dexie))
-    when User
-      table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
-    end
+  subscribed_to "feed" do |params|
+    table("announcements").bulkAdd(Announcement.for_stream("feed").map(&:as_json_for_dexie))
   end
 end
 ```
@@ -165,22 +184,46 @@ Add custom actions or push initial data directly on your channel:
 class DexieChannel < ApplicationCable::Channel
   include DexieCable
 
-  # Push a snapshot when a stream is added. `record` is a record for private
-  # streams, or the stream name (String) for public streams.
-  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))
-    when String
-      table(record).bulkAdd(Announcement.for_stream(record).map(&:as_json_for_dexie))
-    end
+  # Push a snapshot when a public stream is added. The block receives the
+  # params sent from the client and runs in the channel's context, so
+  # `table(...)` and `transmit` are available.
+  subscribed_to "feed" do |params|
+    table("feed").bulkAdd(Announcement.for_stream("feed").map(&:as_json_for_dexie))
   end
 
-  # Any public method is a custom action the client can perform.
+  # Any public method is a custom action the client can perform. Always
+  # resolve records through the connection's actor, never from the payload:
+  # `Message.find(data["id"])` would let any client mark anyone's message
+  # read.
   def mark_as_read(data)
-    Message.find(data["id"]).update!(read: true)
+    current_user.messages.find(data["id"]).update!(read: true)
+  end
+end
+```
+
+Private streams declare their snapshot on the record itself, which is where the stream was opened for. The block runs in the record's context and receives the channel — so `channel.table(...)` transmits to just this subscriber — plus the params sent from the client:
+
+```ruby
+class User < ApplicationRecord
+  subscribed_to do |channel, params|
+    channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
+  end
+end
+
+class Conversation < ApplicationRecord
+  subscribed_to do |channel, params|
+    channel.table("messages").bulkAdd(messages.where("seq_id > ?", params[:last_seq_id]).map(&:as_json_for_dexie))
+  end
+end
+```
+
+Declare `subscribed_to` more than once to push several snapshots — the blocks run in declaration order. To share a snapshot across models, or take full control, override the instance method instead and call `super` to keep any registered blocks running:
+
+```ruby
+module HasNotifications
+  def subscribed_to(channel, params)
+    channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
+    super
   end
 end
 ```
@@ -197,7 +240,7 @@ Pass params from the client when adding a stream:
 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 })`.
+`subscribed_to` runs after the stream is opened, and the snapshot it pushes (via `table(...)` on the channel, or `channel.table(...)` on the record) transmits to just this subscriber, so it arrives before any live mutation. Custom actions are triggered like any ActionCable action: `subscription.perform("mark_as_read", { id: 42 })`. The payload is client-controlled, so pass it through the authenticated actor — `current_user.messages.find(data["id"])`, not `Message.find(data["id"])`.
 
 #### Public streams
 

data/lib/dexiecable/active_record_ext.rb

@@ -70,6 +70,51 @@ module DexieCable
           end
         end
       end
+
+      # Declares what to push to a single subscriber when they subscribe to
+      # this record's stream, before any live mutation is delivered. The block
+      # runs in the record's context and receives the channel and the params
+      # sent by the client:
+      #
+      #   class User < ApplicationRecord
+      #     subscribed_to do |channel, params|
+      #       channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
+      #     end
+      #   end
+      #
+      # Declare it more than once to push several snapshots; blocks run in
+      # declaration order.
+      def subscribed_to(&block)
+        raise ArgumentError, "subscribed_to requires a block" if block.nil?
+
+        dexie_subscribed_to_blocks << block
+      end
+
+      # The blocks registered with +subscribed_to+, inherited from
+      # superclasses.
+      def dexie_subscribed_to_blocks
+        @dexie_subscribed_to_blocks ||=
+          if superclass.respond_to?(:dexie_subscribed_to_blocks)
+            superclass.dexie_subscribed_to_blocks.dup
+          else
+            []
+          end
+      end
+    end
+
+    # Called when a client subscribes to this record's private stream. Runs
+    # every block registered with the +subscribed_to+ macro in the record's
+    # context. Override in your model for full control, calling +super+ if you
+    # still want the registered blocks to run:
+    #
+    #   def subscribed_to(channel, params)
+    #     channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
+    #     super
+    #   end
+    def subscribed_to(channel, params)
+      self.class.dexie_subscribed_to_blocks.each do |block|
+        instance_exec(channel, params, &block)
+      end
     end
 
     private

data/lib/dexiecable/concern.rb

@@ -7,12 +7,18 @@ module DexieCable
   #   class DexieChannel < ApplicationCable::Channel
   #     include DexieCable
   #
-  #     # Push initial data 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))
-  #       end
+  #     # Push initial data when a public stream is added. The block runs in
+  #     # the channel's context, so +table+ and +transmit+ are available.
+  #     subscribed_to "feed" do |params|
+  #       table("announcements").bulkAdd(Announcement.for_stream("feed").map(&:as_json_for_dexie))
+  #     end
+  #   end
+  #
+  # Private streams push their initial data from the record itself:
+  #
+  #   class User < ApplicationRecord
+  #     def subscribed_to(channel, params)
+  #       channel.table("notifications").bulkAdd(notifications.map(&:as_json_for_dexie))
   #     end
   #   end
   #
@@ -41,6 +47,28 @@ module DexieCable
       ScopedChannel.new(self, target)
     end
 
+    # Register a handler for a public stream. When a client subscribes to
+    # +name+ (for example +subscription.addStream("feed")+), the block is
+    # evaluated in the channel's context with the params sent by the client:
+    #
+    #   subscribed_to "feed" do |params|
+    #     table("announcements").bulkAdd(Announcement.for_stream("feed"))
+    #   end
+    def subscribed_to(name, &block)
+      dexie_subscribed_to_handlers[name.to_s] = block
+    end
+
+    # The registered public stream handlers. Subclasses inherit the handlers
+    # registered on their superclass.
+    def dexie_subscribed_to_handlers
+      @dexie_subscribed_to_handlers ||=
+        if superclass.respond_to?(:dexie_subscribed_to_handlers)
+          superclass.dexie_subscribed_to_handlers.dup
+        else
+          {}
+        end
+    end
+
     # Returns a signed token for +target+ (a record). Send it to the client,
     # which passes it to +subscription.addStream+.
     #
@@ -82,12 +110,12 @@ module DexieCable
       return unless record
 
       stream_for record
-      subscribed_to(record, params)
+      record.subscribed_to(self, params) if record.respond_to?(:subscribed_to)
     else
       return if token.blank?
 
       stream_from public_stream_name(token)
-      subscribed_to(token, params)
+      run_subscribed_to_handler(token, params)
     end
   end
 
@@ -108,14 +136,15 @@ module DexieCable
     stop_all_streams
   end
 
-  # Override to push initial data when a stream is added. +record+ is the
-  # resolved target — a record for private streams, or the stream name for
-  # public streams — and +params+ are any extra params sent from the client.
-  def subscribed_to(_record, _params)
-  end
-
   private
 
+  # Runs the handler registered with +subscribed_to+ for a public stream, in
+  # the channel's context.
+  def run_subscribed_to_handler(name, params)
+    handler = self.class.dexie_subscribed_to_handlers[name]
+    instance_exec(params, &handler) if handler
+  end
+
   # Distinguishes a signed stream token from a public stream name. A signed
   # token keeps a valid signature even after it expires, which is what lets us
   # reject expired tokens instead of falling back to a public stream.

data/lib/dexiecable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DexieCable
-  VERSION = "2.0.2"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Stefan Buhrmester