dexiecable 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bc64f029d73e3630a14e254852ea7e6b3cf2b00d369f144c0b40ebdd6d4de1f
-  data.tar.gz: ea3df61fd1319c5f8fcc8697e99a7954213b5c4f97748ae55e3e012e00f156ac
+  metadata.gz: 390eddcb71f97e5e8755696c49a8ce2417e7f8636e0e43be8742acd4f31f4b59
+  data.tar.gz: 2058ae8d76759483bc047b4e74622154335eb55fa2124052f518f51d14539a0d
 SHA512:
-  metadata.gz: f44765e378f1860f5a239cc58169c724bc164c9eada457241a7e70f8cfcbe8ef898e2357d0dfa6981f1a6b3b170f9852a5afdb06e0dee935f7deea0489e568c2
-  data.tar.gz: f1227ada19e9a7ccb9825bb9665ec8f7c57be8afc4b05e9f8dd35c07d8da46f92cfb9cebdb74d5b7e5ef3fe87e3a549e14f039ba4412e4f373706e6e4535a318
+  metadata.gz: 9057f8f5bdbb694a2673c47773db75d2d99a0f3383043908b51152f3f6279a4aabae9f4436dffeebd31e6882d684ca9f505f7a30e5bf1942de89787199a07589
+  data.tar.gz: 39b6503f4ac13bf8abbaae9352ea6b2355bf34f3210dfd2cd99d87413a39a606f389f39236cafca0143aa94621f8bb0be5835fb34c08027cca0d0c2a7ac6feac

data/README.md

@@ -34,7 +34,7 @@ An even more convenient way is to use the `syncs_to_dexie` macro (more info [bel
 
 ```ruby
 class Notification < ApplicationRecord
-  syncs_to_dexie via: UserChannel, to: :user
+  syncs_to_dexie via: -> { UserChannel[user] }
 end
 ```
 
@@ -133,7 +133,15 @@ The full query chain is serialized as JSON and sent over ActionCable. The JS cli
 
 ### `syncs_to_dexie` — automatic model syncing
 
-Add to any ActiveRecord model. Just provide the channel class and the broadcast target.
+Add to any ActiveRecord model. The simplest approach: pass a Proc to `via` that returns a scoped channel.
+
+```ruby
+class Message < ApplicationRecord
+  syncs_to_dexie via: -> { UserChannel[current_user] }
+end
+```
+
+You can also pass a channel class with `to:` to have DexieCable handle the scoping:
 
 ```ruby
 class Message < ApplicationRecord
@@ -161,8 +169,8 @@ Internally, `syncs_to_dexie` sets up the following ActiveRecord callbacks:
 
 | Option | Default | Description |
 |---|---|---|
-| `via:` | *(required)* | A DexieCable channel class |
-| `to:` | *(none)* | The stream target passed to `broadcast_to`. Symbol → calls `send`. String → used as-is. Proc → evaluated in record context. Returns a single recipient or collection. |
+| `via:` | *(required)* | A DexieCable channel class, or a Proc that returns a channel or scoped channel (e.g. `-> { UserChannel[current_user] }`) |
+| `to:` | *(none)* | The stream target passed to `broadcast_to`. Symbol → calls `send`. String → used as-is. Proc → evaluated in record context. Returns a single recipient or collection. Only used when `via` is a channel class. |
 | `table:` | model's `table_name` | Override the Dexie table name. A Proc is evaluated in the record's context. |
 | `only:` | `[:create, :update, :destroy]` | Limit which events trigger a sync |
 | `with:` | `:as_json_for_dexie` | Method name (Symbol) or Proc for serializing records |
@@ -173,11 +181,9 @@ You can combine multiple `syncs_to_dexie` declarations, each with different cond
 
 ```ruby
 class Message < ApplicationRecord
-  syncs_to_dexie via: UserChannel, to: -> { sender },
+  syncs_to_dexie via: -> { UserChannel[current_user] }
+  syncs_to_dexie via: -> { BoardChannel[board] },
                  if: :published?
-
-  syncs_to_dexie via: AdminChannel,
-                 unless: -> { draft? }
 end
 ```
 
@@ -188,14 +194,14 @@ Override `as_json_for_dexie` in your model, or use the `with` option to specify
 ```ruby
 class Message < ApplicationRecord
   # Using the default as_json_for_dexie override:
-  syncs_to_dexie via: UserChannel, to: :sender
+  syncs_to_dexie via: -> { UserChannel[current_user] }
 
   def as_json_for_dexie
     super.merge(room_name: room.name)
   end
 
   # Or use a custom serializer method:
-  syncs_to_dexie via: AdminChannel, to: :admin,
+  syncs_to_dexie via: AdminChannel,
                  with: :admin_payload
 
   def admin_payload

data/lib/dexiecable/active_record_ext.rb

@@ -9,17 +9,19 @@ module DexieCable
       # DexieCable channel.
       #
       #   class Message < ApplicationRecord
-      #     syncs_to_dexie via: UserChannel, to: :sender
-      #     syncs_to_dexie via: UserChannel, to: "global_feed"
-      #     syncs_to_dexie via: UserChannel, to: -> { conversation.users }
+      #     syncs_to_dexie via: -> { UserChannel[current_user] }
       #     syncs_to_dexie via: PublicChannel
+      #     syncs_to_dexie via: UserChannel, to: :user
+      #     syncs_to_dexie via: UserChannel, to: -> { conversation.users }
+      #     syncs_to_dexie via: -> { tenant_channel }
       #   end
       #
-      # @param via     [Class] A DexieCable channel class. When +to+
+      # @param via     [Class, Proc] A DexieCable channel class, or a Proc
+      #                  evaluated in record context that returns a channel
+      #                  class or a scoped channel (e.g.
+      #                  +-> { UserChannel[current_user] }+). When +to+
       #                  is given, each recipient is mapped through
       #                  +via[to]+ to produce scoped channels.
-      #                  Without +to+, +via+ is used directly as an
-      #                  unscoped channel.
       # @param to      [Proc, Symbol, String] A Proc evaluated in record
       #                  context, a Symbol to call via +send+, or a String
       #                  used directly as the stream name for +broadcast_to+.
@@ -80,11 +82,12 @@ module DexieCable
     private
 
     def resolve_channel(via, to = nil)
+      channel = via.is_a?(Proc) ? instance_exec(&via) : via
       if to
         recipients = resolve_recipient(to)
-        Array(recipients).map { |r| via[r] }
+        Array(recipients).map { |r| channel[r] }
       else
-        via
+        channel
       end
     end
 

data/lib/dexiecable/version.rb

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

metadata

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