dexiecable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ad9a4f94d6491f661821d79ac6a8fa3c36527927f8fb0916eee26c87294ebdf
-  data.tar.gz: d50524564c23e50423e186edd1ed5883d9a4e1575fc687d9d80036fcac6201ec
+  metadata.gz: 8d99eb3ba3c4e24ad9e780707ae8f9a1d7d49dad075e38350851d47a215920ca
+  data.tar.gz: 4e9922d041d377b10377db9a2673980523690fe2790f48d4ce04c15b361941dc
 SHA512:
-  metadata.gz: 017f3a4b81fe35bbc8fc17ad5b22cd8a0400ce3e4a14aa20942a517f8030c1cbf08c67b1e590b090726f20dd67c5b71869319fa568b07e01ebdc320867a829be
-  data.tar.gz: 9ccd364a0a6a6b1960bcd5c9af17475b5e972dbfc2ee839bb86d9cb3bf69fedfeb3ccbc20b471e9d6dfe42f9e458f59f32cdd158d1f2c5f6f40f1b022e41f9d8
+  metadata.gz: 88434bc692480d1624a68d06fd1a8f6d1ada2ecaf59f023fa5168008a14bdcc5c9517e5dfa5e199a33e8053f3d0c5faf41eac8bab80756ad87b392f9f707247b
+  data.tar.gz: 3e44885987108b69e7160925fcb5908ac5dafa981557dac7ec46caf2e4faa83efdb777950a9011eb01d5692f6c3dd1241ecfef2d9fd7b74a2c8f2aa35ca29f60

data/README.md

@@ -2,7 +2,7 @@
 
 Run [Dexie.js](https://dexie.org) IndexedDB operations from your Rails ActionCable channels.
 
-DexieCable augments ActionCable channels with 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` ActiveRecord macro for automatic change syncing.
+DexieCable augments ActionCable channels with 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_dexia` ActiveRecord macro for automatic change syncing.
 
 You can run any Dexie table update directly inside a channel:
 
@@ -29,11 +29,11 @@ class NotificationsController < ApplicationController
 end
 ```
 
-An even more convenient way is to use the `syncs_to_dexie` macro:
+An even more convenient way is to use the `syncs_to_dexia` macro:
 
 ```ruby
 class Notification < ApplicationRecord
-  syncs_to_dexie via: -> { UserChannel[user] }
+  syncs_to_dexia via: UserChannel, subject: :user
 end
 ```
 
@@ -47,7 +47,7 @@ Add to your `Gemfile`:
 gem "dexiecable"
 ```
 
-Then `bundle install`. The Railtie automatically extends `ActiveRecord::Base` with `syncs_to_dexie`.
+Then `bundle install`. The Railtie automatically extends `ActiveRecord::Base` with `syncs_to_dexia`.
 
 ### npm package
 
@@ -123,17 +123,21 @@ UserChannel[current_user]
 
 The full query chain is serialized as JSON and sent over ActionCable. The JS client replays every method call against the local Dexie database in order.
 
-### `syncs_to_dexie` — automatic model syncing
+### `syncs_to_dexia` — automatic model syncing
 
-Add to any ActiveRecord model:
+Add to any ActiveRecord model. `subject` is what gets passed to `broadcast_to` as the stream target:
 
 ```ruby
 class Message < ApplicationRecord
-  # Sync to a single user.
-  syncs_to_dexie via: -> { UserChannel[sender] }
+  # Calls send(:receiver), then broadcasts: broadcast_to(receiver, ...)
+  syncs_to_dexia via: UserChannel, subject: :receiver
 
-  # Sync to all participants of a conversation.
-  syncs_to_dexie via: -> { conversation.participants.map { |u| UserChannel[u] } }
+  # String used directly: broadcast_to("global_feed", ...)
+  syncs_to_dexia via: UserChannel, subject: "global_feed"
+
+  # Procs are also supported. If an array is returned, multiple broadcasts are made
+  # conversation.users.each { |u| broadcast_to(u, ...) }
+  syncs_to_dexia via: UserChannel, subject: -> { conversation.users }
 end
 ```
 
@@ -147,7 +151,8 @@ end
 
 | Option | Default | Description |
 |---|---|---|
-| `via:` | *(required)* | Proc (evaluated in record context), a channel, or an array of channels |
+| `via:` | *(required)* | A DexieCable channel class |
+| `subject:` | *(none)* | The stream target passed to `broadcast_to`. Symbol → calls `send`. String → used as-is. Proc → evaluated in record context. Returns a single subject or collection. |
 | `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 |
 | `if:` | *(none)* | Symbol (method name) or Proc — only sync when it returns truthy |
@@ -157,10 +162,10 @@ You can combine multiple `syncs_to_dexie` declarations, each with different cond
 
 ```ruby
 class Message < ApplicationRecord
-  syncs_to_dexie via: -> { UserChannel[sender] },
+  syncs_to_dexia via: UserChannel, subject: -> { sender },
                  if: :published?
 
-  syncs_to_dexie via: -> { AdminChannel },
+  syncs_to_dexia via: AdminChannel,
                  unless: -> { draft? }
 end
 ```
@@ -171,7 +176,7 @@ Override `as_json_for_dexie` in your model:
 
 ```ruby
 class Message < ApplicationRecord
-  syncs_to_dexie via: -> { UserChannel[sender] }
+  syncs_to_dexia via: UserChannel, subject: :sender
 
   def as_json_for_dexie
     super.merge(room_name: room.name)

data/lib/dexiecable/active_record_ext.rb

@@ -9,35 +9,43 @@ module DexieCable
       # DexieCable channel.
       #
       #   class Message < ApplicationRecord
-      #     syncs_to_dexie via: -> { UserChannel[sender] }
-      #     syncs_to_dexie via: -> { UserChannel[receiver] }
-      #     syncs_to_dexie via: PublicChannel
+      #     syncs_to_dexia via: UserChannel, subject: :sender
+      #     syncs_to_dexia via: UserChannel, subject: "global_feed"
+      #     syncs_to_dexia via: UserChannel, subject: -> { conversation.users }
+      #     syncs_to_dexia via: PublicChannel
       #   end
       #
-      # @param via    [Proc, DexieCable, Array<DexieCable>] Proc evaluated in
-      #                 record context, must return a channel (or array of
-      #                 channels) that responds to +table+. Skipped if nil.
-      # @param table  [String, Symbol, Proc] Override the Dexie table name
-      #                (defaults to the model's table_name). A Proc is
-      #                evaluated in the record's context.
-      # @param only   [Array<Symbol>] Limit which lifecycle events sync.
-      #                Default: [:create, :update, :destroy].
-      # @param if     [Symbol, Proc] Only sync if the given method or proc
-      #                returns truthy (evaluated in the record's context).
-      # @param unless [Symbol, Proc] Skip sync if the given method or proc
-      #                returns truthy (evaluated in the record's context).
-      def syncs_to_dexie(via:, table: nil, only: nil, **options)
+      # @param via     [Class] A DexieCable channel class. When +subject+
+      #                  is given, each subject is mapped through
+      #                  +via[subject]+ to produce scoped channels.
+      #                  Without +subject+, +via+ is used directly as an
+      #                  unscoped channel.
+      # @param subject [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+.
+      #                  Must return a single subject or collection of
+      #                  subjects.
+      # @param table   [String, Symbol, Proc] Override the Dexie table name
+      #                 (defaults to the model's table_name). A Proc is
+      #                 evaluated in the record's context.
+      # @param only    [Array<Symbol>] Limit which lifecycle events sync.
+      #                 Default: [:create, :update, :destroy].
+      # @param if      [Symbol, Proc] Only sync if the given method or proc
+      #                 returns truthy (evaluated in the record's context).
+      # @param unless  [Symbol, Proc] Skip sync if the given method or proc
+      #                 returns truthy (evaluated in the record's context).
+      def syncs_to_dexia(via:, subject: nil, table: nil, only: nil, **options)
         events     = Array(only || %i[create update destroy])
         conditions = options.slice(:if, :unless)
 
         @dexie_sync_configs ||= []
-        @dexie_sync_configs << { via: via, table: table, only: events, **conditions }
+        @dexie_sync_configs << { via: via, subject: subject, table: table, only: events, **conditions }
 
         if events.include?(:destroy)
           before_destroy :dexie_sync_before_destroy
 
           after_commit on: :destroy, **conditions do
-            Array(resolve_channel(via)).each do |channel|
+            Array(resolve_channel(via, subject)).each do |channel|
               next unless channel
               channel.table(resolve_table(table)).delete(dexie_destroy_id)
             end
@@ -46,7 +54,7 @@ module DexieCable
 
         if events.include?(:create)
           after_commit on: :create, **conditions do
-            Array(resolve_channel(via)).each do |channel|
+            Array(resolve_channel(via, subject)).each do |channel|
               next unless channel
               channel.table(resolve_table(table)).add(as_json_for_dexie)
             end
@@ -55,7 +63,7 @@ module DexieCable
 
         if events.include?(:update)
           after_commit on: :update, **conditions do
-            Array(resolve_channel(via)).each do |channel|
+            Array(resolve_channel(via, subject)).each do |channel|
               next unless channel
 
               changes = as_json_for_dexie.slice(*saved_changes.keys)
@@ -68,10 +76,20 @@ module DexieCable
 
     private
 
-    def resolve_channel(via)
-      case via
-      when Proc then instance_exec(&via)
-      else via
+    def resolve_channel(via, subject = nil)
+      if subject
+        subjects = resolve_subject(subject)
+        Array(subjects).map { |s| via[s] }
+      else
+        via
+      end
+    end
+
+    def resolve_subject(subject)
+      case subject
+      when Proc   then instance_exec(&subject)
+      when Symbol then send(subject)
+      else subject
       end
     end
 

data/lib/dexiecable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Stefan Buhrmester
@@ -39,7 +39,7 @@ dependencies:
         version: '7.0'
 description: DexieCable augments ActionCable channels with a query DSL that mirrors
   the Dexie.js API, letting you push database mutations from the server to the client
-  in real time. Includes an ActiveRecord macro (syncs_to_dexie) for automatic change
+  in real time. Includes an ActiveRecord macro (syncs_to_dexia) for automatic change
   syncing.
 email:
 - stefan@buhrmi.de