y-rb 0.5.0-x86_64-linux → 0.5.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd77db92508918fc11424cd830c80bfdecb435ba5623ebd0d0d8b9ed1adb7a37
-  data.tar.gz: a4b40ee84fde7646056ef81e67f8d7f978d43e1e22966f7a500633d014ca9381
+  metadata.gz: 4c36ec2ee90cc6540b5dd33bb266e3b3d836fb6fcfc0b1d84256ee5a49d0836a
+  data.tar.gz: 297f433fdcd8275a9f4085d2739835351be045a6a373a8bafd83df6ae50d24d2
 SHA512:
-  metadata.gz: '08253c1cac2a5a1935fafb64a2f8891356880623cbfa43772290e8ca33359fdd8df2d323a10ae3de15e8e784d4d65484a6df35ab6cb3986b5af342535bbdfacb'
-  data.tar.gz: 1f9cdc2910c11c06d3c76c8bed8b79227c6684a9a5f3e286762b858c4f3202a29cacbe1593141f849f1598d9dbc9c16f57c65ced7ebe874fef29fc30d2056112
+  metadata.gz: 1477b1b46cce45892169dba8fbfa275b7298d74dd0898fc331b31a027cf6cf075933a39caad7033313fd986343d4d1d80a2ee63d1fca391810cc12fa114fe886
+  data.tar.gz: b52cc424c1eb6a0020495dddf5955a630b13d2eb7bb7bfcd1c4c79a7bbd4afbc01e3deb530ce49dd39b84098d51e594666b59c7ef61456e095046070f4b7a77e

data/ext/yrb/Cargo.toml

@@ -1,20 +1,21 @@
 [package]
 name = "yrb"
-version = "0.5.0"
+version = "0.5.2"
 authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
 edition = "2021"
 homepage = "https://github.com/y-crdt/yrb"
 repository = "https://github.com/y-crdt/yrb"
 
 [dependencies]
-lib0 = "0.16.2" # must match yrs version
-magnus = { git = "https://github.com/matsadler/magnus", rev = "2c2024920a403daadbe23fe63270440dfac86288" }
-thiserror = "1.0.38"
-yrs = "0.16.2"
-y-sync = "0.2.0"
+lib0 = "0.16.9" # must match yrs version
+magnus = "0.5.4"
+thiserror = "1.0.41"
+yrs = "=0.16.9"
+y-sync = "=0.3.1"
+rb-sys = "0.9.79"
 
 [dev-dependencies]
-magnus = { git = "https://github.com/matsadler/magnus", rev = "2c2024920a403daadbe23fe63270440dfac86288", features = ["embed"] }
+magnus = { version = "0.5.4", features = ["embed"] }
 
 [lib]
 name = "yrb"

data/ext/yrb/src/lib.rs

@@ -83,6 +83,8 @@ fn init() -> Result<(), Error> {
         .expect("cannot define singleton method: ydoc_new");
     ydoc.define_private_method("ydoc_encode_diff_v1", method!(YDoc::ydoc_encode_diff_v1, 2))
         .expect("cannot define private method: ydoc_encode_diff_v1");
+    ydoc.define_private_method("ydoc_encode_diff_v2", method!(YDoc::ydoc_encode_diff_v2, 2))
+        .expect("cannot define private method: ydoc_encode_diff_v2");
     ydoc.define_private_method(
         "ydoc_get_or_insert_array",
         method!(YDoc::ydoc_get_or_insert_array, 1),
@@ -154,6 +156,12 @@ fn init() -> Result<(), Error> {
             method!(YTransaction::ytransaction_apply_update, 1),
         )
         .expect("cannot define private method: ytransaction_apply_update");
+    ytransaction
+        .define_private_method(
+            "ytransaction_apply_update_v2",
+            method!(YTransaction::ytransaction_apply_update_v2, 1),
+        )
+        .expect("cannot define private method: ytransaction_apply_update_v2");
     ytransaction
         .define_private_method(
             "ytransaction_commit",
@@ -205,6 +213,12 @@ fn init() -> Result<(), Error> {
             method!(YTransaction::ytransaction_state_vector, 0),
         )
         .expect("cannot define private method: ytransaction_state_vector");
+    ytransaction
+        .define_private_method(
+            "ytransaction_state_vector_v2",
+            method!(YTransaction::ytransaction_state_vector_v2, 0),
+        )
+        .expect("cannot define private method: ytransaction_state_vector_v2");
 
     let ytext = module
         .define_class("Text", Default::default())

data/ext/yrb/src/utils.rs

@@ -2,7 +2,7 @@ use crate::yvalue::YValue;
 use lib0::any::Any;
 use magnus::r_hash::ForEach::Continue;
 use magnus::{exception, Error, RHash, RString, Symbol, Value};
-use std::rc::Rc;
+use std::sync::Arc;
 use yrs::types::Attrs;
 
 #[derive(Debug, Clone)]
@@ -18,7 +18,7 @@ pub(crate) fn map_rhash_to_attrs(hash: RHash) -> Result<Attrs, Error> {
     let mut a: Attrs = Default::default();
 
     let result = hash.foreach(|key: Value, value: Value| {
-        let k = Rc::from(key.to_string());
+        let k = Arc::from(key.to_string());
         let v = Any::from(YValue::from(value));
 
         a.insert(k, v);

data/ext/yrb/src/yattrs.rs

@@ -3,7 +3,7 @@ use lib0::any::Any;
 use magnus::r_hash::ForEach::Continue;
 use magnus::{RHash, Value};
 use std::ops::{Deref, DerefMut};
-use std::rc::Rc;
+use std::sync::Arc;
 use yrs::types::Attrs;
 
 pub(crate) struct YAttrs(pub(crate) Attrs);
@@ -23,7 +23,7 @@ impl From<RHash> for YAttrs {
                 let k = key.to_string();
                 let yvalue = YValue::from(value);
                 let avalue = Any::from(yvalue);
-                attrs.insert(Rc::from(k), avalue);
+                attrs.insert(Arc::from(k), avalue);
 
                 Ok(Continue)
             })

data/ext/yrb/src/yawareness.rs

@@ -2,7 +2,7 @@ use magnus::{block::Proc, exception, Error, Value};
 use std::borrow::Borrow;
 use std::cell::RefCell;
 use std::collections::HashMap;
-use y_sync::awareness::{Awareness, AwarenessUpdate, Event, Subscription};
+use y_sync::awareness::{Awareness, AwarenessUpdate, Event, UpdateSubscription};
 use yrs::block::ClientID;
 use yrs::updates::decoder::Decode;
 use yrs::updates::encoder::Encode;
@@ -138,14 +138,14 @@ impl From<&Event> for YAwarenessEvent {
 }
 
 #[magnus::wrap(class = "Y::AwarenessEvent")]
-pub(crate) struct YAwarenessSubscription(Subscription<Event>);
+pub(crate) struct YAwarenessSubscription(UpdateSubscription);
 
 unsafe impl Send for YAwarenessSubscription {}
 
 impl YAwarenessSubscription {}
 
-impl From<Subscription<Event>> for YAwarenessSubscription {
-    fn from(v: Subscription<Event>) -> Self {
+impl From<UpdateSubscription> for YAwarenessSubscription {
+    fn from(v: UpdateSubscription) -> Self {
         YAwarenessSubscription(v)
     }
 }

data/ext/yrb/src/ydoc.rs

@@ -10,6 +10,7 @@ use magnus::{exception::runtime_error, Error, Integer, RArray, Value};
 use std::borrow::Borrow;
 use std::cell::RefCell;
 use yrs::updates::decoder::Decode;
+use yrs::updates::encoder::{Encoder, EncoderV2};
 use yrs::{Doc, OffsetKind, Options, ReadTxn, StateVector, SubscriptionId, Transact};
 
 #[magnus::wrap(class = "Y::Doc")]
@@ -43,6 +44,21 @@ impl YDoc {
             .map_err(|_e| Error::new(runtime_error(), "cannot encode diff"))
     }
 
+    pub(crate) fn ydoc_encode_diff_v2(
+        &self,
+        transaction: &YTransaction,
+        state_vector: Vec<u8>,
+    ) -> Result<Vec<u8>, Error> {
+        let mut tx = transaction.transaction();
+        let tx = tx.as_mut().unwrap();
+        let mut encoder = EncoderV2::new();
+
+        StateVector::decode_v2(state_vector.borrow())
+            .map(|sv| tx.encode_diff(&sv, &mut encoder))
+            .map(|_| encoder.to_vec())
+            .map_err(|_e| Error::new(runtime_error(), "cannot encode diff"))
+    }
+
     pub(crate) fn ydoc_get_or_insert_array(&self, name: String) -> YArray {
         let array_ref = self.0.borrow().get_or_insert_array(name.as_str());
         YArray::from(array_ref)

data/ext/yrb/src/ytransaction.rs

@@ -38,6 +38,17 @@ impl YTransaction {
             .map(|u| self.transaction().as_mut().unwrap().apply_update(u))
     }
 
+    pub(crate) fn ytransaction_apply_update_v2(&self, update: Vec<u8>) -> Result<(), Error> {
+        Update::decode_v2(update.as_slice())
+            .map_err(|error| {
+                Error::new(
+                    exception::runtime_error(),
+                    format!("cannot decode update: {:?}", error),
+                )
+            })
+            .map(|u| self.transaction().as_mut().unwrap().apply_update(u))
+    }
+
     pub(crate) fn ytransaction_commit(&self) {
         self.transaction().as_mut().unwrap().commit();
     }
@@ -98,6 +109,14 @@ impl YTransaction {
             .encode_v1()
     }
 
+    pub(crate) fn ytransaction_state_vector_v2(&self) -> Vec<u8> {
+        self.transaction()
+            .as_ref()
+            .unwrap()
+            .state_vector()
+            .encode_v2()
+    }
+
     pub(crate) fn ytransaction_free(&self) {
         self.0.replace(None);
     }

data/lib/y/awareness.rb

@@ -25,19 +25,19 @@ module Y
   #   local_state = {
   #     editing: { field: "description", pos: 0 },
   #     name: "Hannes Moser"
-  #   }.to_json
+  #   }
   #
   #   awareness = Y::Awareness.new
   #   awareness.local_state = local_state
   #   awareness.diff # [1,227,245,175,195,11,1,65,123, …]
   #
   # @example Two connected clients
-  #   local_state_a = { name: "User A" }.to_json
+  #   local_state_a = { name: "User A" }
   #
   #   client_a = Y::Awareness.new
   #   client_a.local_state = local_state
   #
-  #   local_state_b = { name: "User B" }.to_json
+  #   local_state_b = { name: "User B" }
   #
   #   client_b = Y::Awareness.new
   #   client_b.local_state = local_state_b
@@ -85,7 +85,7 @@ module Y
     #   local_state = {
     #     editing: { field: "description", pos: 0 },
     #     name: "Hannes Moser"
-    #   }.to_json
+    #   }
     #
     #   awareness = Y::Awareness.new
     #   awareness.local_state = local_state
@@ -125,7 +125,7 @@ module Y
     #   local_state = {
     #     editing: { field: "description", pos: 0 },
     #     name: "Hannes Moser"
-    #   }.to_json
+    #   }
     #
     #   awareness = Y::Awareness.new
     #   awareness.local_state = local_state

data/lib/y/doc.rb

@@ -19,6 +19,9 @@ module Y
     ZERO_STATE = [0].freeze
     private_constant :ZERO_STATE
 
+    ZERO_STATE_V2 = [0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0].freeze
+    private_constant :ZERO_STATE_V2
+
     # 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.
     #
@@ -55,6 +58,16 @@ module Y
       current_transaction { |tx| ydoc_encode_diff_v1(tx, state) }
     end
 
+    # Create a v2 diff between this document and another document. The diff is
+    # created based on a state vector provided by the other document. It only
+    # returns the missing blocks, as binary encoded sequence.
+    #
+    # @param state [::Array<Integer>] The state to create the diff against
+    # @return [::Array<Integer>] Binary encoded diff
+    def diff_v2(state = ZERO_STATE_V2)
+      current_transaction { |tx| ydoc_encode_diff_v2(tx, state) }
+    end
+
     # Creates a full diff for the current document. It is similar to {#diff},
     # but does not take a state. Instead it creates an empty state and passes it
     # to the encode_diff function.
@@ -152,6 +165,14 @@ module Y
       current_transaction(&:state)
     end
 
+    # Creates a v2 state vector of this document. This can be used to compare
+    # the state of two documents with each other and to later on sync them.
+    #
+    # @return [::Array<Integer>] Binary encoded state vector
+    def state_v2
+      current_transaction(&:state_v2)
+    end
+
     # Synchronizes this document with the diff from another document
     #
     # @param diff [::Array<Integer>] Binary encoded update
@@ -160,6 +181,14 @@ module Y
       current_transaction { |tx| tx.apply(diff) }
     end
 
+    # Synchronizes this document with the v2 diff from another document
+    #
+    # @param diff [::Array<Integer>] Binary encoded update
+    # @return [void]
+    def sync_v2(diff)
+      current_transaction { |tx| tx.apply_v2(diff) }
+    end
+
     # Restores a specific document from an update that contains full state
     #
     # This is doing the same as {#sync}, but it exists to be explicit about
@@ -211,6 +240,17 @@ module Y
     # @return [Array<Integer>] Binary encoded update
     # @!visibility private
 
+    # @!method ydoc_encode_diff_v2(tx, state_vector)
+    #   Encodes the diff of current document state vs provided state in the v2
+    #   format
+    #
+    #   @example Create transaction on doc
+    #     doc = Y::Doc.new
+    #     tx = doc.ydoc_encode_diff_v2(other_state)
+    #
+    # @return [Array<Integer>] Binary encoded update
+    # @!visibility private
+
     # @!method ydoc_transact
     #   Creates a new transaction for the document
     #

data/lib/y/transaction.rb

@@ -22,6 +22,15 @@ module Y
       ytransaction_apply_update(update)
     end
 
+    # Applies the v2 encoded update on this document. This will bring the
+    # the document to the same state as the one the update is from.
+    #
+    # @param update [::Array<Integer>]
+    # @return [void]
+    def apply_v2(update)
+      ytransaction_apply_update_v2(update)
+    end
+
     # Commits transaction
     #
     # @return [void]
@@ -89,15 +98,29 @@ module Y
       xml_text
     end
 
-    # Return state vector for transaction
+    # Return a state vector for this transaction
     #
     # @return [::Array<Integer>]
     def state
       ytransaction_state_vector
     end
 
+    # Returns a v2 state vector for this transaction
+    #
+    # @return [::Array<Integer>]
+    def state_v2
+      ytransaction_state_vector_v2
+    end
+
     # @!method ytransaction_apply_update(update)
-    #   Returns or creates an array by name
+    #   Apply the encoded update within current transaction
+    #
+    # @param update [::Array<Integer>]
+    # @return [void]
+    # @!visibility private
+
+    # @!method ytransaction_apply_update_v2(update)
+    #   Apply the v2 encoded update within current transaction
     #
     # @param update [::Array<Integer>]
     # @return [void]
@@ -157,5 +180,10 @@ module Y
     #
     # @return [Array<Integer>]
     # @!visibility private
+
+    # @!method ytransaction_state_vector_v2
+    #
+    # @return [Array<Integer>]
+    # @!visibility private
   end
 end

data/lib/y/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: x86_64-linux
 authors:
 - Hannes Moser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.56
+        version: 0.9.71
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.56
+        version: 0.9.71
   force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -92,7 +92,6 @@ files:
 - ext/yrb/src/yxml_element.rs
 - ext/yrb/src/yxml_fragment.rs
 - ext/yrb/src/yxml_text.rs
-- lib/2.7/yrb.so
 - lib/3.0/yrb.so
 - lib/3.1/yrb.so
 - lib/3.2/yrb.so
@@ -123,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
   - - "<"
     - !ruby/object:Gem::Version
       version: 3.3.dev
@@ -131,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.21
+      version: 3.3.22
 requirements: []
 rubygems_version: 3.4.4
 signing_key: