y-rb 0.4.0-x86_64-linux-musl → 0.4.2-x86_64-linux-musl

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75efa5e3a0379f2a6d352e502d08e6c2bf2371a6dba205a94dce682741def0e1
-  data.tar.gz: 6d0903436bf61bd37d52b7d825f5f6bed1bd10ea9cc2800c06422635d0ed86c0
+  metadata.gz: 747457cfb21e66da374a352cbd29d99a4d7c5741ebc971eeff82a197ada4b8ce
+  data.tar.gz: 542ff3efa50da67d1e9a912f5a7c1596895967b7aff83936fc7fdd39f7dbfa08
 SHA512:
-  metadata.gz: 663c9b035f642d081be3f1e5ec6ab07831a2946ac5aefa625bb1d809ee3571f2c465eee3ed5f27c2e124359f0438fd431d28ee0bc9c91a7f8332a6010657db37
-  data.tar.gz: 9b1aade846cee16436cecc0b986b63cee9aa5f3d014094d461b839397028421f47fc113cf812ac0f5cbd05575e91fe1c14615d5b64040ddbaf66495ab7d0812b
+  metadata.gz: c08cd2c80ac6bd44e330f0edc8ec1ee99c678ec1ec3c5b7200cdeba26d7c06f8697728571417b764c236fdff06f60aff9b35fa730ca94c8fdd3c0df043093780
+  data.tar.gz: d56c3ce5b6b2d18120849a039b4c715a4b2a5b26edaf04499783b3951a804295ea8dfe2cc57a1f62e2eac7bb17bb7cb2c7a54fad2d717c75f7e0c797101edfdf

data/ext/yrb/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yrb"
-version = "0.4.0"
+version = "0.4.2"
 authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
 edition = "2021"
 homepage = "https://github.com/y-crdt/yrb"
@@ -8,12 +8,12 @@ repository = "https://github.com/y-crdt/yrb"
 
 [dependencies]
 lib0 = "0.14.1" # must match yrs version
-magnus = { version = "0.4.3" }
-thiserror = "1.0.37"
+magnus = { git = "https://github.com/matsadler/magnus", rev = "a51ccaf01d82e9e1a981e4f3fbaca35100513b08" }
+thiserror = "1.0.38"
 yrs = "0.14.1"
 
 [dev-dependencies]
-magnus = { version = "0.4.3", features = ["embed"] }
+magnus = { git = "https://github.com/matsadler/magnus", rev = "a51ccaf01d82e9e1a981e4f3fbaca35100513b08", features = ["embed"] }
 
 [lib]
 name = "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/utils.rs

@@ -1,7 +1,7 @@
 use crate::yvalue::YValue;
 use lib0::any::Any;
 use magnus::r_hash::ForEach::Continue;
-use magnus::{Error, RHash, RString, Symbol, Value};
+use magnus::{exception, Error, RHash, RString, Symbol, Value};
 use std::rc::Rc;
 use yrs::types::Attrs;
 
@@ -27,7 +27,10 @@ pub(crate) fn map_rhash_to_attrs(hash: RHash) -> Result<Attrs, Error> {
     });
 
     if result.is_err() {
-        return Err(Error::runtime_error("could not map hash to attrs"));
+        return Err(Error::new(
+            exception::runtime_error(),
+            "could not map hash to attrs",
+        ));
     }
 
     Ok(a)

data/ext/yrb/src/yawareness.rs

@@ -1,6 +1,5 @@
 use crate::awareness::{Awareness, AwarenessUpdate, Event};
-use magnus::block::Proc;
-use magnus::{Error, Value};
+use magnus::{block::Proc, exception, Error, Value};
 use std::borrow::Borrow;
 use std::cell::RefCell;
 use std::collections::HashMap;
@@ -25,12 +24,11 @@ impl YAwareness {
 
     pub(crate) fn yawareness_apply_update(&self, update: Vec<u8>) -> Result<(), Error> {
         AwarenessUpdate::decode_v1(update.as_slice())
-            .map_err(|_error| Error::runtime_error("cannot decode update"))
+            .map_err(|_error| Error::new(exception::runtime_error(), "cannot decode update"))
             .and_then(|value| {
-                self.0
-                    .borrow_mut()
-                    .apply_update(value)
-                    .map_err(|_error| Error::runtime_error("cannot apply awareness update"))
+                self.0.borrow_mut().apply_update(value).map_err(|_error| {
+                    Error::new(exception::runtime_error(), "cannot apply awareness update")
+                })
             })
     }
 
@@ -83,7 +81,12 @@ impl YAwareness {
             .borrow_mut()
             .update()
             .map(|update| update.encode_v1())
-            .map_err(|_error| Error::runtime_error("cannot create update for current state"))
+            .map_err(|_error| {
+                Error::new(
+                    exception::runtime_error(),
+                    "cannot create update for current state",
+                )
+            })
     }
 
     pub(crate) fn yawareness_update_with_clients(
@@ -95,7 +98,10 @@ impl YAwareness {
             .update_with_clients(clients)
             .map(|update| update.encode_v1())
             .map_err(|_error| {
-                Error::runtime_error("cannot create update for current state and given clients")
+                Error::new(
+                    exception::runtime_error(),
+                    "cannot create update for current state and given clients",
+                )
             })
     }
 }

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::{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>);
@@ -39,7 +41,7 @@ impl YDoc {
 
         StateVector::decode_v1(state_vector.borrow())
             .map(|sv| tx.encode_diff_v1(&sv))
-            .map_err(|_e| Error::runtime_error("cannot encode diff"))
+            .map_err(|_e| Error::new(exception::runtime_error(), "cannot encode diff"))
     }
 
     pub(crate) fn ydoc_get_or_insert_array(&self, name: String) -> YArray {
@@ -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/ext/yrb/src/ymap.rs

@@ -3,7 +3,7 @@ use crate::yvalue::YValue;
 use crate::YTransaction;
 use lib0::any::Any;
 use magnus::block::Proc;
-use magnus::{Error, RArray, RHash, Symbol, Value};
+use magnus::{exception, Error, RArray, RHash, Symbol, Value};
 use std::cell::RefCell;
 use yrs::types::{EntryChange, Value as YrsValue};
 use yrs::{Map, MapRef, Observable};
@@ -60,7 +60,8 @@ impl YMap {
         let tx = tx.as_mut().unwrap();
 
         match indifferent_hash_key(key) {
-            None => Err(Error::runtime_error(
+            None => Err(Error::new(
+                exception::runtime_error(),
                 "invalid key type, make sure it is either of type Symbol or String",
             )),
             Some(k) => {

data/ext/yrb/src/ytransaction.rs

@@ -4,7 +4,7 @@ use crate::ytext::YText;
 use crate::yxml_element::YXmlElement;
 use crate::yxml_fragment::YXmlFragment;
 use crate::yxml_text::YXmlText;
-use magnus::Error;
+use magnus::{exception, Error};
 use std::cell::{RefCell, RefMut};
 use yrs::updates::decoder::Decode;
 use yrs::updates::encoder::Encode;
@@ -29,7 +29,12 @@ impl<'doc> From<TransactionMut<'doc>> for YTransaction {
 impl YTransaction {
     pub(crate) fn ytransaction_apply_update(&self, update: Vec<u8>) -> Result<(), Error> {
         Update::decode_v1(update.as_slice())
-            .map_err(|error| Error::runtime_error(format!("cannot decode update: {:?}", error)))
+            .map_err(|error| {
+                Error::new(
+                    exception::runtime_error(),
+                    format!("cannot decode update: {:?}", error),
+                )
+            })
             .map(|u| self.transaction().as_mut().unwrap().apply_update(u))
     }
 

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.0"
+  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.0
+  version: 0.4.2
 platform: x86_64-linux-musl
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.50
+        version: 0.9.53
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.50
+        version: 0.9.53
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement