dexiecable 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +24 -8
- data/lib/dexiecable/active_record_ext.rb +11 -6
- data/lib/dexiecable/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dc22d844e30147740e885b5959d13a6f42c47ff9551490f4b8e61701b1481676
|
|
4
|
+
data.tar.gz: 5d82c9e2f8453aa038db8b7eb5997134e56431da93a62ecb30190e5eebef63a2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 18eb395292b406e4f0cd690eafcf9dc68ac5b39cac89c459e0685c95e7cfe42bd551348c3146df1dcd596405b6198c15ecba41ba9e48abceee8068cd65f020ac
|
|
7
|
+
data.tar.gz: b2135050a6a827ac7e0c596ed64ad8d6d568ad6f18d278a6b8c819c464564a110396fc76c597985d1d4cc4e1be2ddd0b4aab1aa9b58fb4a5b1663509a9762a7d
|
data/README.md
CHANGED
|
@@ -100,18 +100,20 @@ Any Dexie.js write operation triggers an immediate broadcast:
|
|
|
100
100
|
# Single insert
|
|
101
101
|
UserChannel[current_user].table("messages").add(id: 1, text: "hello")
|
|
102
102
|
|
|
103
|
-
#
|
|
104
|
-
UserChannel[current_user]
|
|
105
|
-
.table("messages")
|
|
106
|
-
.where(:room_id).equals(room.id)
|
|
107
|
-
.bulkAdd(messages)
|
|
103
|
+
# Bulk insert
|
|
104
|
+
UserChannel[current_user].table("messages").bulkAdd(messages)
|
|
108
105
|
|
|
109
|
-
# Update
|
|
106
|
+
# Update (using modify)
|
|
110
107
|
UserChannel[current_user]
|
|
111
108
|
.table("messages")
|
|
112
109
|
.where(:id).equals(msg.id)
|
|
113
110
|
.modify(read: true)
|
|
114
111
|
|
|
112
|
+
# Update (using update)
|
|
113
|
+
UserChannel[current_user]
|
|
114
|
+
.table("messages")
|
|
115
|
+
.update(msg.id, text: "updated text")
|
|
116
|
+
|
|
115
117
|
# Delete
|
|
116
118
|
UserChannel[current_user]
|
|
117
119
|
.table("messages")
|
|
@@ -129,7 +131,7 @@ Add to any ActiveRecord model:
|
|
|
129
131
|
class Message < ApplicationRecord
|
|
130
132
|
syncs_to_dexie via: -> { UserChannel[sender] }
|
|
131
133
|
syncs_to_dexie via: -> { UserChannel[receiver] }
|
|
132
|
-
syncs_to_dexie via:
|
|
134
|
+
syncs_to_dexie via: RoomChannel['public']
|
|
133
135
|
end
|
|
134
136
|
```
|
|
135
137
|
|
|
@@ -143,9 +145,23 @@ end
|
|
|
143
145
|
|
|
144
146
|
| Option | Default | Description |
|
|
145
147
|
|---|---|---|
|
|
146
|
-
| `via:` | *(required)* | Proc (evaluated in record context),
|
|
148
|
+
| `via:` | *(required)* | Proc (evaluated in record context), or channel instance |
|
|
147
149
|
| `table:` | model's `table_name` | Override the Dexie table name. A Proc is evaluated in the record's context. |
|
|
148
150
|
| `only:` | `[:create, :update, :destroy]` | Limit which events trigger a sync |
|
|
151
|
+
| `if:` | *(none)* | Symbol (method name) or Proc — only sync when it returns truthy |
|
|
152
|
+
| `unless:` | *(none)* | Symbol (method name) or Proc — skip sync when it returns truthy |
|
|
153
|
+
|
|
154
|
+
You can combine multiple `syncs_to_dexie` declarations, each with different conditions:
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
class Message < ApplicationRecord
|
|
158
|
+
syncs_to_dexie via: -> { UserChannel[sender] },
|
|
159
|
+
if: :published?
|
|
160
|
+
|
|
161
|
+
syncs_to_dexie via: -> { AdminChannel },
|
|
162
|
+
unless: -> { draft? }
|
|
163
|
+
end
|
|
164
|
+
```
|
|
149
165
|
|
|
150
166
|
#### Customizing the synced payload
|
|
151
167
|
|
|
@@ -22,16 +22,21 @@ module DexieCable
|
|
|
22
22
|
# evaluated in the record's context.
|
|
23
23
|
# @param only [Array<Symbol>] Limit which lifecycle events sync.
|
|
24
24
|
# Default: [:create, :update, :destroy].
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
# @param if [Symbol, Proc] Only sync if the given method or proc
|
|
26
|
+
# returns truthy (evaluated in the record's context).
|
|
27
|
+
# @param unless [Symbol, Proc] Skip sync if the given method or proc
|
|
28
|
+
# returns truthy (evaluated in the record's context).
|
|
29
|
+
def syncs_to_dexie(via:, table: nil, only: nil, **options)
|
|
30
|
+
events = Array(only || %i[create update destroy])
|
|
31
|
+
conditions = options.slice(:if, :unless)
|
|
27
32
|
|
|
28
33
|
@dexie_sync_configs ||= []
|
|
29
|
-
@dexie_sync_configs << { via: via, table: table, only: events }
|
|
34
|
+
@dexie_sync_configs << { via: via, table: table, only: events, **conditions }
|
|
30
35
|
|
|
31
36
|
if events.include?(:destroy)
|
|
32
37
|
before_destroy :dexie_sync_before_destroy
|
|
33
38
|
|
|
34
|
-
after_commit on: :destroy do
|
|
39
|
+
after_commit on: :destroy, **conditions do
|
|
35
40
|
channel = resolve_channel(via)
|
|
36
41
|
next unless channel
|
|
37
42
|
channel.table(resolve_table(table)).delete(dexie_destroy_id)
|
|
@@ -39,7 +44,7 @@ module DexieCable
|
|
|
39
44
|
end
|
|
40
45
|
|
|
41
46
|
if events.include?(:create)
|
|
42
|
-
after_commit on: :create do
|
|
47
|
+
after_commit on: :create, **conditions do
|
|
43
48
|
channel = resolve_channel(via)
|
|
44
49
|
next unless channel
|
|
45
50
|
channel.table(resolve_table(table)).add(as_json_for_dexie)
|
|
@@ -47,7 +52,7 @@ module DexieCable
|
|
|
47
52
|
end
|
|
48
53
|
|
|
49
54
|
if events.include?(:update)
|
|
50
|
-
after_commit on: :update do
|
|
55
|
+
after_commit on: :update, **conditions do
|
|
51
56
|
channel = resolve_channel(via)
|
|
52
57
|
next unless channel
|
|
53
58
|
|
data/lib/dexiecable/version.rb
CHANGED