dexiecable 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36154d26195467f83401235810a4bc86b3fec7402c7601aae8bf1bd1c4097406
-  data.tar.gz: eb647d275d24a875a65af6c2d428c057579dda3653f4567cad31de4b15ed610e
+  metadata.gz: 05e9525058173a0392999802c6243cac3eb5c0406a28cb405963a9069d20b098
+  data.tar.gz: 3394af2d34854137a4032dd672bb0e1ebc6073e907872b168a5e31e9ffea1daf
 SHA512:
-  metadata.gz: c50c143233dfaec03433d26779a6fe0ac0ed3e7e3e0ff4c4701651dee6c5fd4f7edef1b5f0fce319bd188cd1ee5d396363a6e8896dc2d6587ca14ed00ca5f247
-  data.tar.gz: 43c90cfbbf0230a4f74bd0c8a2b5cff21870d2fbe2f4dc4ab64809deeafd2460a39f33c708d84b00c9170c80e2eb2ece5d519b36ba9d06dada851a2a1479c88b
+  metadata.gz: 936fa88cb0cd6dc55665e9214d54064eb914863552bf8b84e58e1ca4d616751863f9572740ceb00c7b09503ed9996fe9ec52640a65279b2bc5249498d3671684
+  data.tar.gz: 1b9a73d2e21d3ac4e5138feeb1c13c958f9b4eccffeb7968c0f7fbc28a45cd24b8dff7f6ab4e2f976730536dcee3fc30758cae5aaa04c4bd8dd3940ec83b5ef6

data/README.md

@@ -5,7 +5,7 @@
 >
 > Full synchronization utilizing event streams will arrive in DexieCable 3.0.
 
-DexieCable gives your ActionCable channel 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`](#syncs_to_dexie--automatic-model-syncing) ActiveRecord macro for automatic change syncing.
+DexieCable gives your ActionCable channel 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`](#syncs_to_dexie-automatic-model-streaming) ActiveRecord macro for automatic change syncing.
 
 Push Dexie table updates to a client from anywhere on the server:
 
@@ -18,7 +18,7 @@ class NotificationsController < ApplicationController
 end
 ```
 
-Or sync model changes automatically with the `syncs_to_dexie` macro (more info [below](#syncs_to_dexie--automatic-model-syncing))
+Or sync model changes automatically with the `syncs_to_dexie` macro (more info [below](#syncs_to_dexie-automatic-model-streaming))
 
 ```ruby
 class Notification < ApplicationRecord
@@ -114,7 +114,7 @@ const stopStreaming = subscription.addStream(userStream);
 stopStreaming(); // equivalent to subscription.removeStream(userStream)
 ```
 
-`addStream`/`removeStream` perform `add_stream`/`remove_stream` on `DexieChannel`, which verifies the token and then `stream_from`/`stop_stream_from` the decoded identifier. `removeAllStreams()` performs `remove_all_streams`, stopping every current stream — handy on logout:
+`addStream`/`removeStream` perform `add_stream`/`remove_stream` on `DexieChannel`, which verifies the token and then `stream_from`/`stop_stream_from` the decoded identifier. `removeAllStreams()` performs `remove_all_streams`, stopping every current stream. Handy on logout:
 
 ```js
 subscription.removeAllStreams();
@@ -161,11 +161,11 @@ Pass params from the client when adding a stream:
 subscription.addStream(userStream, { last_seq_id: 100 });
 ```
 
-`subscribed_to` runs after the stream is opened, and `table(...)` transmits to just this subscriber — so the snapshot arrives before any live mutation. Custom actions are triggered like any ActionCable action: `subscription.perform("mark_as_read", { id: 42 })`.
+`subscribed_to` runs after the stream is opened, and `table(...)` transmits to just this subscriber, so the snapshot arrives before any live mutation. Custom actions are triggered like any ActionCable action: `subscription.perform("mark_as_read", { id: 42 })`.
 
 #### Public streams
 
-For data that's public (a global feed, announcements, etc.), skip the signature. Use a string target — it's namespaced under `public:` automatically:
+For data that's public (a global feed, announcements, etc.), skip the signature. Use a string target. It's namespaced under `public:` automatically:
 
 ```ruby
 DexieChannel["feed"].table("announcements").add(announcement)
@@ -176,11 +176,11 @@ class Announcement < ApplicationRecord
 end
 ```
 
-Then subscribe by name — no token required:
+Then subscribe by name. No token required:
 
 ```js
-const stopPublicStream = subscription.addPublicStream("feed");
-stopPublicStream(); // equivalent to subscription.removePublicStream("feed")
+const stopPublicStream = subscription.addStream("feed");
+stopPublicStream(); // equivalent to subscription.removeStream("feed")
 ```
 
 Public streams are namespaced under `public:`, so this path can never reach a signed (private) stream.
@@ -222,7 +222,7 @@ DexieChannel[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 streaming
+### `syncs_to_dexie`: automatic model streaming
 
 Add to any ActiveRecord model. Optionally provide the broadcast target.
 
@@ -231,7 +231,7 @@ class Message < ApplicationRecord
   # Calls send(:receiver), then broadcasts: DexieChannel.broadcast_to(receiver, ...)
   syncs_to_dexie via: :receiver
 
-  # String = public stream (subscribe via addPublicStream("public"))
+  # String = public stream (subscribe via addStream("public"))
   syncs_to_dexie via: "public"
 
   # Procs are also supported. If an array is returned, multiple broadcasts are made
@@ -263,8 +263,8 @@ Internally, `syncs_to_dexie` sets up the following ActiveRecord callbacks:
 | `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 |
 | `with:` | `:as_json_for_dexie` | Method name (Symbol) or Proc for serializing records |
-| `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 |
+| `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:
 

data/lib/dexiecable/concern.rb

@@ -20,7 +20,7 @@ module DexieCable
   #
   #   subscribe(db)                 # subscribes to "DexieChannel"
   #   subscription.addStream(DexieChannel.stream_token_for(current_user))
-  #   subscription.addPublicStream("feed")
+  #   subscription.addStream("feed") # plain strings are public streams
   #
   extend ActiveSupport::Concern
 
@@ -73,38 +73,35 @@ module DexieCable
 
   def add_stream(data)
     record = resolve_subscribe_target(data["stream"])
-    return unless record
-
-    stream_for record
     params = data.except("action", "stream").with_indifferent_access
-    subscribed_to(record, params)
+
+    if record
+      stream_for record
+      subscribed_to(record, params)
+    else
+      name = data["stream"].to_s
+      return if name.blank?
+
+      stream_from public_stream_name(name)
+      subscribed_to(name, params)
+    end
   end
 
   def remove_stream(data)
     record = resolve_subscribe_target(data["stream"])
-    return unless record
 
-    stop_stream_from self.class.broadcasting_for(record)
+    if record
+      stop_stream_from self.class.broadcasting_for(record)
+    else
+      name = data["stream"].to_s
+      stop_stream_from public_stream_name(name) if name.present?
+    end
   end
 
   def remove_all_streams(_data)
     stop_all_streams
   end
 
-  def add_public_stream(data)
-    name = data["stream"].to_s
-    return if name.blank?
-
-    stream_from public_stream_name(name)
-    params = data.except("action", "stream").with_indifferent_access
-    subscribed_to(name, params)
-  end
-
-  def remove_public_stream(data)
-    name = data["stream"].to_s
-    stop_stream_from public_stream_name(name) if name.present?
-  end
-
   # Override to push initial data when a stream is added. +record+ is the
   # resolved target — a record for private streams, or the stream name for
   # public streams — and +params+ are any extra params sent from the client.

data/lib/dexiecable/version.rb

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

metadata

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