inertia_cable 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 467488f15b5926bd5b36c68bf873f04d80a9d1d3196f05b8c610dd7e5bbfed1c
-  data.tar.gz: 3d26e273740a16678aea2b6491afe4af7463c7fa492974d2bdccc393787cdb09
+  metadata.gz: 77598665249ec9fc7f6d8fa69ad070661e2db15513a1720c83e937e318e4b828
+  data.tar.gz: 388cc18e32909027f18da2b65352859299120f18984e2a1e7f15fc1e3fff905a
 SHA512:
-  metadata.gz: 86b16433049aeedf34d478a398531666dec745556bdc21a2090e0d0023658a11aecab505a02ca7727f9e7d60442079a47e009e78cb778c01a37462b862578fc9
-  data.tar.gz: 3001e9c9acc8cfaf12d1287caf84700bf43fb4c4a7a28cbec30a9fa4a51ffdb890da1b856859bbe6a73d1ddcf504dd5e9feb23dabda698e61647ad8c5ca46dfc
+  metadata.gz: 4b9ae8be00c92656c2ce2787e2ec939028a3cebc77cb7c54adbc2acf4c673cebea5e828fae83e3e8f76bef7ee7c10e266de0eea3cdcce5ba3a3180f2705586ef
+  data.tar.gz: 16182946b7e2f836b14aed916c937762002052c8cab9c48617d47eb3599b42e4fcb35b307a1c7c93c59f1e3a08c5f8ef979b09db46a4431a365647a252d6a4b8

data/README.md

@@ -418,13 +418,24 @@ end
 
 Optionally coalesce rapid broadcasts using Rails cache. **Not used by default** — the client-side 100ms debounce handles most cases.
 
-Requires a shared cache store (Redis, Memcached, or SolidCache) in multi-process deployments.
+Server-side debounce is useful when a single operation triggers many model callbacks (e.g., bulk imports, cascading updates) and you want to reduce the number of ActionCable messages sent. The client-side debounce already coalesces rapid reloads into one, so server-side debounce is only needed when the volume of WebSocket messages itself is a concern.
+
+Requires a shared cache store (Redis, Memcached, or SolidCache) in multi-process deployments. `MemoryStore` (the Rails default) only works within a single process.
 
 ```ruby
-InertiaCable.debounce_delay = 0.5  # seconds (default)
+# Via the model DSL
+broadcasts_to :board, debounce: true        # uses InertiaCable.debounce_delay (0.5s)
+broadcasts_to :board, debounce: 1.0         # custom delay in seconds
+
+# Via instance methods
+post.broadcast_refresh_later_to(board, debounce: 2.0)
 
+# Direct usage
 InertiaCable::Debounce.broadcast("my_stream", payload)
 InertiaCable::Debounce.broadcast("my_stream", payload, delay: 2.0)
+
+# Configure the global default
+InertiaCable.debounce_delay = 0.5  # seconds (default)
 ```
 
 ---
@@ -475,6 +486,21 @@ end
 
 All three accept splat streamables: `assert_broadcasts_on(chat, :messages) { ... }`
 
+### Broadcast callbacks
+
+`InertiaCable.on_broadcast` registers a callback that fires for every broadcast (including debounced ones). The test helpers use this internally, but you can use it for custom instrumentation or logging:
+
+```ruby
+callback = ->(stream_name, payload) {
+  Rails.logger.info "[InertiaCable] #{payload[:type]} on #{stream_name}"
+}
+
+InertiaCable.on_broadcast(&callback)
+
+# Later, to unregister:
+InertiaCable.off_broadcast(&callback)
+```
+
 ---
 
 ## Configuration

data/lib/inertia_cable/debounce.rb

@@ -6,6 +6,7 @@ module InertiaCable
       return if Rails.cache.exist?(cache_key)
 
       Rails.cache.write(cache_key, true, expires_in: delay)
+      InertiaCable.broadcast_callbacks.each { |cb| cb.call(stream_name, payload) }
       ActionCable.server.broadcast(stream_name, payload)
     end
   end

data/lib/inertia_cable/version.rb

@@ -1,3 +1,3 @@
 module InertiaCable
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_cable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Cole Robertson