y-rb 0.4.1-x86_64-linux → 0.4.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625ee4d664574fa20124c4b7da2d69bb40a38775241e7321b55f64d18fac155f
-  data.tar.gz: 58fee255060b68927efbc2776216ed5c37845dc1261ff2b09a8814c39b108583
+  metadata.gz: 2e2867da7ccb49016b2c1a35121d6cd1dfd7ae2a6863c8bf30b8ca6177faffec
+  data.tar.gz: fd403a5fd504aec33f37d9730fffd29ac5426004ce650168b7d19b5693a025f3
 SHA512:
-  metadata.gz: 8c384f11abcc6b08cc5ad0bb3d2080782e0412f3a3d66b36ffb38d38cb44de2454d940078a7628219af54207e261f3dc57a8b100595073433c6d1bfecb02dbd4
-  data.tar.gz: b3817ae413528d04716edc3f86942974012a42400541b0466555d0d475ac04d27b4e95d40f204cbf61e919d2c36732c1b9237302ed687aa782d5d70e38606f0b
+  metadata.gz: c9c59a868d7d8e8648bb1efda3cd25e5a698032161d10cb1ed09396db5e1158cf78422f65b636e9136199c855d070df9e8c8dd2ca1d1d4cc27c76a77184ca473
+  data.tar.gz: 83463c869e6dc3ca717cac6430057e3b12f5913adb6da7464b10c23fa2e67e2b8ff53c28975b140328bf1ec00873e9698b2a9681cba638aba320f6f8cb002fa2

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-linux
 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