dexiecable 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353c08fde431ac528532ebc11a99911154654988345d6c7fdddb479269a65194
-  data.tar.gz: ec8e1ab7b1d4f0ea74cc8da8346337cee2b9f82192de966ccc653aedd5f96a38
+  metadata.gz: 4ad9a4f94d6491f661821d79ac6a8fa3c36527927f8fb0916eee26c87294ebdf
+  data.tar.gz: d50524564c23e50423e186edd1ed5883d9a4e1575fc687d9d80036fcac6201ec
 SHA512:
-  metadata.gz: c1fabe1bc7d3aa4f16855ffc9f3d1dff472c0488b8b2959745b02225bd5503c3b9e43ea2cc253bc306c742633b5e85da4400b760072d5776f2e925d66cac0529
-  data.tar.gz: 0d3c51e4d95f3848c244a0793cd77c2de817646ebef18c79705a42d2cfb4f5e729bbbbf8de466b1cc9f04e79d3f392a1c096f8968746a0c49077b00dee44d502
+  metadata.gz: 017f3a4b81fe35bbc8fc17ad5b22cd8a0400ce3e4a14aa20942a517f8030c1cbf08c67b1e590b090726f20dd67c5b71869319fa568b07e01ebdc320867a829be
+  data.tar.gz: 9ccd364a0a6a6b1960bcd5c9af17475b5e972dbfc2ee839bb86d9cb3bf69fedfeb3ccbc20b471e9d6dfe42f9e458f59f32cdd158d1f2c5f6f40f1b022e41f9d8

data/README.md

@@ -100,18 +100,20 @@ Any Dexie.js write operation triggers an immediate broadcast:
 # Single insert
 UserChannel[current_user].table("messages").add(id: 1, text: "hello")
 
-# Filtered bulk insert
-UserChannel[current_user]
-  .table("messages")
-  .where(:room_id).equals(room.id)
-  .bulkAdd(messages)
+# Bulk insert
+UserChannel[current_user].table("messages").bulkAdd(messages)
 
-# Update
+# Update (using modify)
 UserChannel[current_user]
   .table("messages")
   .where(:id).equals(msg.id)
   .modify(read: true)
 
+# Update (using update)
+UserChannel[current_user]
+  .table("messages")
+  .update(msg.id, text: "updated text")
+
 # Delete
 UserChannel[current_user]
   .table("messages")
@@ -127,9 +129,11 @@ Add to any ActiveRecord model:
 
 ```ruby
 class Message < ApplicationRecord
+  # Sync to a single user.
   syncs_to_dexie via: -> { UserChannel[sender] }
-  syncs_to_dexie via: -> { UserChannel[receiver] }
-  syncs_to_dexie via: PublicChannel  # broadcast to all connected clients
+
+  # Sync to all participants of a conversation.
+  syncs_to_dexie via: -> { conversation.participants.map { |u| UserChannel[u] } }
 end
 ```
 
@@ -143,9 +147,23 @@ end
 
 | Option | Default | Description |
 |---|---|---|
-| `via:` | *(required)* | Proc (evaluated in record context), channel class, or channel instance |
+| `via:` | *(required)* | Proc (evaluated in record context), a channel, or an array of channels |
 | `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 |
+| `unless:` | *(none)* | Symbol (method name) or Proc — skip sync when it returns truthy |
+
+You can combine multiple `syncs_to_dexie` declarations, each with different conditions:
+
+```ruby
+class Message < ApplicationRecord
+  syncs_to_dexie via: -> { UserChannel[sender] },
+                 if: :published?
+
+  syncs_to_dexie via: -> { AdminChannel },
+                 unless: -> { draft? }
+end
+```
 
 #### Customizing the synced payload
 

data/lib/dexiecable/active_record_ext.rb

@@ -14,45 +14,53 @@ module DexieCable
       #     syncs_to_dexie via: PublicChannel
       #   end
       #
-      # @param via    [Proc, DexieCable] Proc evaluated in record context,
-      #                 must return a channel (responds to +table+). A channel
-      #                 class/instance can also be passed directly. Skipped if nil.
+      # @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].
-      def syncs_to_dexie(via:, table: nil, only: nil)
-        events = Array(only || %i[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)
+        events     = Array(only || %i[create update destroy])
+        conditions = options.slice(:if, :unless)
 
         @dexie_sync_configs ||= []
-        @dexie_sync_configs << { via: via, table: table, only: events }
+        @dexie_sync_configs << { via: via, table: table, only: events, **conditions }
 
         if events.include?(:destroy)
           before_destroy :dexie_sync_before_destroy
 
-          after_commit on: :destroy do
-            channel = resolve_channel(via)
-            next unless channel
-            channel.table(resolve_table(table)).delete(dexie_destroy_id)
+          after_commit on: :destroy, **conditions do
+            Array(resolve_channel(via)).each do |channel|
+              next unless channel
+              channel.table(resolve_table(table)).delete(dexie_destroy_id)
+            end
           end
         end
 
         if events.include?(:create)
-          after_commit on: :create do
-            channel = resolve_channel(via)
-            next unless channel
-            channel.table(resolve_table(table)).add(as_json_for_dexie)
+          after_commit on: :create, **conditions do
+            Array(resolve_channel(via)).each do |channel|
+              next unless channel
+              channel.table(resolve_table(table)).add(as_json_for_dexie)
+            end
           end
         end
 
         if events.include?(:update)
-          after_commit on: :update do
-            channel = resolve_channel(via)
-            next unless channel
+          after_commit on: :update, **conditions do
+            Array(resolve_channel(via)).each do |channel|
+              next unless channel
 
-            changes = as_json_for_dexie.slice(*saved_changes.keys)
-            channel.table(resolve_table(table)).update(id, changes)
+              changes = as_json_for_dexie.slice(*saved_changes.keys)
+              channel.table(resolve_table(table)).update(id, changes)
+            end
           end
         end
       end

data/lib/dexiecable/version.rb

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

metadata

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