dexiecable 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f0f439d4d0a6320b38ce77c0e188fdd590b592107c8a6c4b41f6d63d72c900
-  data.tar.gz: da0d7f54b972206adf4e07bbcec2660a597f4ac89c28865fc2a8974bc21ac38f
+  metadata.gz: dc22d844e30147740e885b5959d13a6f42c47ff9551490f4b8e61701b1481676
+  data.tar.gz: 5d82c9e2f8453aa038db8b7eb5997134e56431da93a62ecb30190e5eebef63a2
 SHA512:
-  metadata.gz: 22d044c313789238aaa192415a96d8795111078727745ed9ed1b26ce28d14016be02415ef9903eebcfc75fa6d1a4b0856c8eb4cebbdd7693c3b67984ba6a6dd1
-  data.tar.gz: 7fc66fe6550e35e92fc426ae01131bda13b9a83394c763d24b3c19a7a84670c974843ee47385b9c0298cdfa0e3e8c5507115d4565370fdcbc3eb589632898143
+  metadata.gz: 18eb395292b406e4f0cd690eafcf9dc68ac5b39cac89c459e0685c95e7cfe42bd551348c3146df1dcd596405b6198c15ecba41ba9e48abceee8068cd65f020ac
+  data.tar.gz: b2135050a6a827ac7e0c596ed64ad8d6d568ad6f18d278a6b8c819c464564a110396fc76c597985d1d4cc4e1be2ddd0b4aab1aa9b58fb4a5b1663509a9762a7d

data/README.md

@@ -1,6 +1,6 @@
 # DexieCable
 
-Run Dexie.js IndexedDB operations from your Rails ActionCable channels.
+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.
 
@@ -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")
@@ -129,7 +131,7 @@ Add to any ActiveRecord model:
 class Message < ApplicationRecord
   syncs_to_dexie via: -> { UserChannel[sender] }
   syncs_to_dexie via: -> { UserChannel[receiver] }
-  syncs_to_dexie via: PublicChannel  # broadcast to all connected clients
+  syncs_to_dexie via: RoomChannel['public']
 end
 ```
 
@@ -143,9 +145,23 @@ end
 
 | Option | Default | Description |
 |---|---|---|
-| `via:` | *(required)* | Proc (evaluated in record context), channel class, or channel instance |
-| `table:` | model's `table_name` | Override the Dexie table name |
+| `via:` | *(required)* | Proc (evaluated in record context), or channel instance |
+| `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

@@ -17,42 +17,47 @@ module DexieCable
       # @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 table  [String, Symbol] Override the Dexie table name
-      #                (defaults to the model's table_name).
+      # @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)
-        table_name = (table || self.table_name).to_s
+      # @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_name, 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
+          after_commit on: :destroy, **conditions do
             channel = resolve_channel(via)
             next unless channel
-            channel.table(table_name).delete(dexie_destroy_id)
+            channel.table(resolve_table(table)).delete(dexie_destroy_id)
           end
         end
 
         if events.include?(:create)
-          after_commit on: :create do
+          after_commit on: :create, **conditions do
             channel = resolve_channel(via)
             next unless channel
-            channel.table(table_name).add(as_json_for_dexie)
+            channel.table(resolve_table(table)).add(as_json_for_dexie)
           end
         end
 
         if events.include?(:update)
-          after_commit on: :update do
+          after_commit on: :update, **conditions do
             channel = resolve_channel(via)
             next unless channel
 
             changes = as_json_for_dexie.slice(*saved_changes.keys)
-            channel.table(table_name).update(id, changes)
+            channel.table(resolve_table(table)).update(id, changes)
           end
         end
       end
@@ -67,6 +72,14 @@ module DexieCable
       end
     end
 
+    def resolve_table(table)
+      case table
+      when Proc   then instance_exec(&table).to_s
+      when nil    then self.class.table_name
+      else table.to_s
+      end
+    end
+
     # Override in your model to customise the payload synced to Dexie.
     def as_json_for_dexie
       as_json

data/lib/dexiecable/version.rb

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

metadata

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