y-rb 0.4.1-x86_64-darwin → 0.4.2-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e58287c9f9aba21b180ecc7b1d1059a2e89e80d4d3b7b4111a1649c23127bd2
-  data.tar.gz: d63b4313f205d0459cda44cced5a22be2aa4f36985ab51bdf8ccb6199a91dc8b
+  metadata.gz: 91ffbc9065f98d80686d4dee355709a3347c3adc3368e2f6f12fd9ee5b695fa0
+  data.tar.gz: 896f475bb9c26e5fb70a37f39155896436ed34478aea720bfb3b3ab7150b8891
 SHA512:
-  metadata.gz: 43063223f16e6ee0fae39c0faea87b767168589cb69e9eb1312e86730384772d7e19b46becb444bb12440f06eb067e6999cd26f99fa319622a0209ca83451f33
-  data.tar.gz: f2069bccfbdb7686caaf3a8c77f71f8c451ed2952408b016b2e78d517b270999f987411b946227ae1f5d49aca696f38b58f3f7b11020952f93c656cf8d7e89e6
+  metadata.gz: 06d0709dbbaed23ca3346d49cf4e158faa8d78c8d7fe652fc3afda9bcd9d015ec88728c6190157b1463ce2515a2382d51a627ccc599f89a548a863d62eccc188
+  data.tar.gz: a5c742a86eb5a0bc8c7c43d13cfc923df0eb83adc0b941cf20923f0a564235f59ab07110f1e5ee1b23a87b6631220305d703bd9e6d36e99abfe3f4618f745656

data/ext/yrb/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yrb"
-version = "0.4.1"
+version = "0.4.2"
 authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
 edition = "2021"
 homepage = "https://github.com/y-crdt/yrb"

data/ext/yrb/src/lib.rs

@@ -116,6 +116,9 @@ fn init() -> Result<(), Error> {
     ydoc.define_private_method("ydoc_transact", method!(YDoc::ydoc_transact, 0))
         .expect("cannot define private method: ydoc_transact");
 
+    ydoc.define_private_method("ydoc_observe_update", method!(YDoc::ydoc_observe_update, 1))
+        .expect("cannot define private method: ydoc_observe_update");
+
     let ymap = module
         .define_class("Map", Default::default())
         .expect("cannot define class Y::Map");

data/ext/yrb/src/ydoc.rs

@@ -5,11 +5,13 @@ use crate::yxml_element::YXmlElement;
 use crate::yxml_fragment::YXmlFragment;
 use crate::yxml_text::YXmlText;
 use crate::YTransaction;
-use magnus::{exception, Error, Integer, Value};
+use magnus::block::Proc;
+use magnus::exception::runtime_error;
+use magnus::{exception, Error, Integer, RArray, Value};
 use std::borrow::Borrow;
 use std::cell::RefCell;
 use yrs::updates::decoder::Decode;
-use yrs::{Doc, OffsetKind, Options, ReadTxn, StateVector, Transact};
+use yrs::{Doc, OffsetKind, Options, ReadTxn, StateVector, SubscriptionId, Transact};
 
 #[magnus::wrap(class = "Y::Doc")]
 pub(crate) struct YDoc(pub(crate) RefCell<Doc>);
@@ -75,4 +77,20 @@ impl YDoc {
         let transaction = doc.transact_mut();
         YTransaction::from(transaction)
     }
+
+    pub(crate) fn ydoc_observe_update(&self, block: Proc) -> Result<SubscriptionId, Error> {
+        self.0
+            .borrow()
+            .observe_update_v1(move |_tx, update_event| {
+                let update = update_event.update.to_vec();
+                let update = RArray::from_vec(update);
+
+                let args: (RArray,) = (update,);
+                block
+                    .call::<(RArray,), Value>(args)
+                    .expect("cannot call update block");
+            })
+            .map(|v| v.into())
+            .map_err(|err| Error::new(runtime_error(), err.to_string()))
+    }
 }

data/lib/y/doc.rb

@@ -19,6 +19,22 @@ module Y
     ZERO_STATE = [0].freeze
     private_constant :ZERO_STATE
 
+    # Attach a listener to document changes. If one of the data structures is
+    # changes, the block is called with the update as its only argument.
+    #
+    # @yield [update] Called when document is updated
+    # @yieldparam [Array<Integer>] update The encoded document updates
+
+    # Example: Attach listener to document changes
+    #   doc = described_class.new
+    #   doc.attach { |update| pp update }
+    #
+    #   text = doc.get_text("my text")
+    #   text << "1"
+    def attach(&block)
+      ydoc_observe_update(block)
+    end
+
     # Commit current transaction
     #
     # This is a convenience method that invokes {Y::Transaction#commit} on the
@@ -222,5 +238,11 @@ module Y
     #
     # @return [Y::XMLText]
     # @!visibility private
+
+    # @!method ydoc_observe_update(block)
+    #   Creates a subscription to observe changes to the document
+    # @param [Proc] block
+    # @return [Integer]
+    # @!visibility private
   end
 end

data/lib/y/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Y
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: x86_64-darwin
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake