y-rb 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a9ebdfd28929fbb58e3ec0f62f896686ef4994155918b283b874ee6030ad22f
-  data.tar.gz: 56f75134bb052ce9fc1a2debb98c15785d82fde4f4c8467d48c414efed9c9d4c
+  metadata.gz: 816615480d692a2f998ac5d420e4d64ee578a5d351a556ca9e3cf7f93ffaf83f
+  data.tar.gz: dc86328ef38d28fd5320e5ccec4f437e56c0efe8be1e9d5ecd1a74f41eb74df7
 SHA512:
-  metadata.gz: b968afaeb2a96f9442d19cf938f4cd40d08683eac2665639489673b8b5ca8d2379a26301b99305355cc188c01021b511bde08fc10ebb0a2e365fb6ec01e0b77f
-  data.tar.gz: 16d635047a01168e8b4b53ce4af22803e4a4542a1aab872a4c305b7491e037f8118efe12a4c75543646960c5531f86f20f6cd9ab7e9e49d14b81437a71a1d094
+  metadata.gz: 34a045a974e65d8418c76beb9dafdab4c7adb21e48bdd5404b5191480bb62499b5a080b2bae51219b75445caf24bfa1e292576aec833f9f51832c66beae2b3e7
+  data.tar.gz: fb0fc2e505c889bfb38a15acbdea44dc18c947f19887e453a993973b5ae523a8dac7dd94605b777b9a10da18350614734ec43f6fe877485c75247d3206c40935

data/.rustfmt.toml

@@ -61,7 +61,6 @@ use_field_init_shorthand = false
 force_explicit_abi = true
 condense_wildcard_suffixes = false
 color = "Auto"
-required_version = "1.4.37"
 unstable_features = false
 disable_all_formatting = false
 skip_children = false

data/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "y-rb"
-version = "0.1.0"
+version = "0.1.2"
 authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
 edition = "2021"
 homepage = "https://github.com/y-crdt/yrb"
@@ -9,9 +9,8 @@ repository = "https://github.com/y-crdt/yrb"
 [dependencies]
 lazy_static = "1.4.0"
 rutie = "0.8.4"
-yrs = "0.9.1"
-lib0 = "0.9.1" # must match yrs version
-cross = "0.2.1" # https://github.com/cross-rs/cross/issues/615
+yrs = "0.10.1"
+lib0 = "0.10.1" # must match yrs version
 
 [lib]
 name = "y_rb"

data/docs/release.md

@@ -0,0 +1,9 @@
+# Release
+
+## Steps
+
+1. Make sure CI is green
+2. Update version in `Cargo.toml`
+3. Update version in `lib/y/version.rb`
+4. Create a tag matching the version `git tag -a v0.1.1 -m "Release version v0.1.1"` 
+5. Push tag to GitLab repo

data/lib/y/doc.rb

@@ -16,6 +16,9 @@ module Y
   #   remote_map = remote.get_map("my_map")
   #   pp remote_map.to_h #=> {hello: "world"}
   class Doc
+    ZERO_STATE = [0].freeze
+    private_constant :ZERO_STATE
+
     # Commit current transaction
     #
     # This is a convenience method that invokes {Y::Transaction#commit} on the
@@ -42,7 +45,7 @@ module Y
     #
     # @param [::Array<Int>] state The state to create the diff against
     # @return [::Array<Int>] Binary encoded diff
-    def diff(state)
+    def diff(state = ZERO_STATE)
       ydoc_encode_diff_v1(state)
     end
 

data/lib/y/version.rb

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

data/src/lib.rs

@@ -23,7 +23,7 @@ pub extern "C" fn Init_yrb() {
             klass.def_private("yarray_insert", yarray::yarray_insert);
             klass.def_private(
                 "yarray_insert_range",
-                yarray::yarray_insert_range,
+                yarray::yarray_insert_range
             );
             klass.def_private("yarray_length", yarray::yarray_length);
             klass.def_private("yarray_observe", yarray::yarray_observe);
@@ -32,7 +32,7 @@ pub extern "C" fn Init_yrb() {
             klass.def_private("yarray_remove", yarray::yarray_remove);
             klass.def_private(
                 "yarray_remove_range",
-                yarray::yarray_remove_range,
+                yarray::yarray_remove_range
             );
             klass.def_private("yarray_to_a", yarray::yarray_to_a);
             klass.def_private("yarray_unobserve", yarray::yarray_unobserve);
@@ -66,11 +66,11 @@ pub extern "C" fn Init_yrb() {
             klass.def_private("ytext_insert_embed", ytext::ytext_insert_embed);
             klass.def_private(
                 "ytext_insert_embed_with_attrs",
-                ytext::ytext_insert_embed_with_attributes,
+                ytext::ytext_insert_embed_with_attributes
             );
             klass.def_private(
                 "ytext_insert_with_attrs",
-                ytext::ytext_insert_with_attributes,
+                ytext::ytext_insert_with_attributes
             );
             klass.def_private("ytext_remove_range", ytext::ytext_remove_range);
             klass.def_private("ytext_format", ytext::ytext_format);
@@ -86,35 +86,35 @@ pub extern "C" fn Init_yrb() {
             .define(|klass| {
                 klass.def_private(
                     "ytransaction_apply_update",
-                    ytransaction::ytransaction_apply_update,
+                    ytransaction::ytransaction_apply_update
                 );
                 klass.def_private(
                     "ytransaction_commit",
-                    ytransaction::ytransaction_commit,
+                    ytransaction::ytransaction_commit
                 );
                 klass.def_private(
                     "ytransaction_get_array",
-                    ytransaction::ytransaction_get_array,
+                    ytransaction::ytransaction_get_array
                 );
                 klass.def_private(
                     "ytransaction_get_map",
-                    ytransaction::ytransaction_get_map,
+                    ytransaction::ytransaction_get_map
                 );
                 klass.def_private(
                     "ytransaction_get_text",
-                    ytransaction::ytransaction_get_text,
+                    ytransaction::ytransaction_get_text
                 );
                 klass.def_private(
                     "ytransaction_get_xml_element",
-                    ytransaction::ytransaction_get_xml_element,
+                    ytransaction::ytransaction_get_xml_element
                 );
                 klass.def_private(
                     "ytransaction_get_xml_text",
-                    ytransaction::ytransaction_get_xml_text,
+                    ytransaction::ytransaction_get_xml_text
                 );
                 klass.def_private(
                     "ytransaction_state_vector",
-                    ytransaction::ytransaction_state_vector,
+                    ytransaction::ytransaction_state_vector
                 );
             });
 
@@ -123,123 +123,123 @@ pub extern "C" fn Init_yrb() {
             .define(|klass| {
                 klass.def_private(
                     "yxml_element_attributes",
-                    yxml::yxml_element_attributes,
+                    yxml::yxml_element_attributes
                 );
                 klass.def_private(
                     "yxml_element_first_child",
-                    yxml::yxml_element_first_child,
+                    yxml::yxml_element_first_child
                 );
                 klass.def_private("yxml_element_get", yxml::yxml_element_get);
                 klass.def_private(
                     "yxml_element_get_attribute",
-                    yxml::yxml_element_get_attribute,
+                    yxml::yxml_element_get_attribute
                 );
                 klass.def_private(
                     "yxml_element_insert_attribute",
-                    yxml::yxml_element_insert_attribute,
+                    yxml::yxml_element_insert_attribute
                 );
                 klass.def_private(
                     "yxml_element_insert_element",
-                    yxml::yxml_element_insert_element,
+                    yxml::yxml_element_insert_element
                 );
                 klass.def_private(
                     "yxml_element_insert_text",
-                    yxml::yxml_element_insert_text,
+                    yxml::yxml_element_insert_text
                 );
                 klass.def_private(
                     "yxml_element_next_sibling",
-                    yxml::yxml_element_next_sibling,
+                    yxml::yxml_element_next_sibling
                 );
                 klass.def_private(
                     "yxml_element_observe",
-                    yxml::yxml_element_observe,
+                    yxml::yxml_element_observe
                 );
                 klass.def_private(
                     "yxml_element_parent",
-                    yxml::yxml_element_parent,
+                    yxml::yxml_element_parent
                 );
                 klass.def_private(
                     "yxml_element_prev_sibling",
-                    yxml::yxml_element_prev_sibling,
+                    yxml::yxml_element_prev_sibling
                 );
                 klass.def_private(
                     "yxml_element_push_elem_back",
-                    yxml::yxml_element_push_elem_back,
+                    yxml::yxml_element_push_elem_back
                 );
                 klass.def_private(
                     "yxml_element_push_elem_front",
-                    yxml::yxml_element_push_elem_front,
+                    yxml::yxml_element_push_elem_front
                 );
                 klass.def_private(
                     "yxml_element_push_text_back",
-                    yxml::yxml_element_push_text_back,
+                    yxml::yxml_element_push_text_back
                 );
                 klass.def_private(
                     "yxml_element_push_text_front",
-                    yxml::yxml_element_push_text_front,
+                    yxml::yxml_element_push_text_front
                 );
                 klass.def_private(
                     "yxml_element_remove_attribute",
-                    yxml::yxml_element_remove_attribute,
+                    yxml::yxml_element_remove_attribute
                 );
                 klass.def_private(
                     "yxml_element_remove_range",
-                    yxml::yxml_element_remove_range,
+                    yxml::yxml_element_remove_range
                 );
                 klass.def_private("yxml_element_size", yxml::yxml_element_size);
                 klass.def_private("yxml_element_tag", yxml::yxml_element_tag);
                 klass.def_private(
                     "yxml_element_to_s",
-                    yxml::yxml_element_to_string,
+                    yxml::yxml_element_to_string
                 );
                 klass.def_private(
                     "yxml_element_unobserve",
-                    yxml::yxml_element_unobserve,
+                    yxml::yxml_element_unobserve
                 );
             });
 
         module.define_nested_class("XMLText", None).define(|klass| {
             klass.def_private(
                 "yxml_text_attributes",
-                yxml::yxml_text_attributes,
+                yxml::yxml_text_attributes
             );
             klass.def_private("yxml_text_format", yxml::yxml_text_format);
             klass.def_private(
                 "yxml_text_get_attribute",
-                yxml::yxml_text_get_attribute,
+                yxml::yxml_text_get_attribute
             );
             klass.def_private("yxml_text_insert", yxml::yxml_text_insert);
             klass.def_private(
                 "yxml_text_insert_attribute",
-                yxml::yxml_text_insert_attribute,
+                yxml::yxml_text_insert_attribute
             );
             klass.def_private(
                 "yxml_text_insert_embed",
-                yxml::yxml_text_insert_embed,
+                yxml::yxml_text_insert_embed
             );
             klass.def_private(
                 "yxml_text_insert_embed_with_attrs",
-                yxml::yxml_text_insert_embed_with_attributes,
+                yxml::yxml_text_insert_embed_with_attributes
             );
             klass.def_private(
                 "yxml_text_insert_with_attrs",
-                yxml::yxml_text_insert_with_attributes,
+                yxml::yxml_text_insert_with_attributes
             );
             klass.def_private("yxml_text_length", yxml::yxml_text_length);
             klass.def_private(
                 "yxml_text_next_sibling",
-                yxml::yxml_text_next_sibling,
+                yxml::yxml_text_next_sibling
             );
             klass.def_private("yxml_text_observe", yxml::yxml_text_observe);
             klass.def_private("yxml_text_parent", yxml::yxml_text_parent);
             klass.def_private(
                 "yxml_text_prev_sibling",
-                yxml::yxml_text_prev_sibling,
+                yxml::yxml_text_prev_sibling
             );
             klass.def_private("yxml_text_push", yxml::yxml_text_push);
             klass.def_private(
                 "yxml_text_remove_range",
-                yxml::yxml_text_remove_range,
+                yxml::yxml_text_remove_range
             );
             klass.def_private("yxml_text_to_s", yxml::yxml_text_to_string);
             klass.def_private("yxml_text_unobserve", yxml::yxml_text_unobserve);

data/src/util.rs

@@ -4,7 +4,7 @@ use crate::yxml::{XML_ELEMENT_WRAPPER, XML_TEXT_WRAPPER};
 use lib0::any::Any;
 use rutie::{
     AnyException, AnyObject, Array, Boolean, Exception, Fixnum, Float, Hash,
-    Integer, Module, NilClass, Object, RString, Symbol,
+    Integer, Module, NilClass, Object, RString, Symbol
 };
 use std::borrow::Borrow;
 use std::collections::HashMap;
@@ -49,14 +49,12 @@ pub(crate) fn map_any_type_to_ruby(input: &Any) -> AnyObject {
                 let key = Symbol::new(k.as_ref());
                 let val = map_any_type_to_ruby(v);
                 h.store(key, val);
-                ()
             });
             h.to_any_object()
         }
     }
 }
 
-// This function gets reported as unused.
 pub(crate) fn map_yrs_value_to_ruby(value: Value) -> AnyObject {
     match value {
         Value::Any(v) => map_any_type_to_ruby(v.borrow()),
@@ -75,12 +73,12 @@ pub(crate) fn map_yrs_value_to_ruby(value: Value) -> AnyObject {
             .wrap_data(x, &*XML_ELEMENT_WRAPPER),
         Value::YXmlText(x) => Module::from_existing("Y")
             .get_nested_class("XMLText")
-            .wrap_data(x, &*XML_TEXT_WRAPPER),
+            .wrap_data(x, &*XML_TEXT_WRAPPER)
     }
 }
 
 pub(crate) fn map_ruby_type_to_rust(
-    input: AnyObject,
+    input: AnyObject
 ) -> Result<Any, AnyException> {
     if let Ok(_v) = input.try_convert_to::<NilClass>() {
         return Ok(Any::Null);
@@ -107,7 +105,7 @@ pub(crate) fn map_ruby_type_to_rust(
 
     Err(AnyException::new(
         "TypeError",
-        Some("cannot map input type"),
+        Some("cannot map input type")
     ))
 }
 

data/src/yarray.rs

@@ -2,7 +2,7 @@ use crate::util::{map_ruby_type_to_rust, map_yrs_value_to_ruby};
 use crate::ytransaction::{YTransaction, TRANSACTION_WRAPPER};
 use rutie::{
     AnyObject, Array as RArray, Fixnum, Hash, Integer, NilClass, Object, Proc,
-    Symbol, VM,
+    Symbol, VM
 };
 use yrs::types::{Change, Value};
 use yrs::{Array, SubscriptionId};

data/src/ydoc.rs

@@ -26,10 +26,16 @@ methods!(
         let mut doc: &Doc = rtself.get_data_mut(&*DOC_WRAPPER);
         let state_vector_encoded: Vec<u8> =
             convert_array_to_vecu8(state_vector.unwrap());
-        let sv = &StateVector::decode_v1(state_vector_encoded.as_slice());
 
-        let update = doc.encode_state_as_update_v1(sv);
+        let result = &StateVector::decode_v1(state_vector_encoded.as_slice());
+        let sv = match result {
+            Ok(sv) => sv,
+            Err(error) => {
+                panic!("decoding the state vector failed: {:?}", error)
+            }
+        };
 
+        let update = doc.encode_state_as_update_v1(sv);
         convert_vecu8_to_array(update)
     }
 );

data/src/ymap.rs

@@ -3,7 +3,7 @@ use crate::ytransaction::{YTransaction, TRANSACTION_WRAPPER};
 use lib0::any::Any;
 use rutie::{
     AnyObject, Array, Boolean, Class, Fixnum, Hash, Integer, NilClass, Object,
-    Proc, RString, Symbol, VM,
+    Proc, RString, Symbol, VM
 };
 use std::rc::Rc;
 use yrs::types::EntryChange;

data/src/ytext.rs

@@ -1,11 +1,11 @@
 use crate::util::{
     map_attrs_to_hash, map_hash_to_attrs, map_ruby_type_to_rust,
-    map_yrs_value_to_ruby,
+    map_yrs_value_to_ruby
 };
 use crate::ytransaction::{YTransaction, TRANSACTION_WRAPPER};
 use rutie::{
     AnyObject, Fixnum, Hash, Integer, NilClass, Object, Proc, RString, Symbol,
-    VM,
+    VM
 };
 use yrs::types::Delta;
 use yrs::{SubscriptionId, Text};

data/src/ytransaction.rs

@@ -31,7 +31,8 @@ methods!(
         let u = convert_array_to_vecu8(update.unwrap());
 
         let transaction = rtself.get_data_mut(&*TRANSACTION_WRAPPER);
-        transaction.apply_update(Update::decode_v1(u.as_slice()));
+        let update = Update::decode_v1(u.as_slice()).unwrap();
+        transaction.apply_update(update);
 
         NilClass::new()
     },

data/src/yxml.rs

@@ -1,11 +1,11 @@
 use crate::util::{
     map_attrs_to_hash, map_hash_to_attrs, map_ruby_type_to_rust,
-    map_yrs_value_to_ruby,
+    map_yrs_value_to_ruby
 };
 use crate::ytransaction::{YTransaction, TRANSACTION_WRAPPER};
 use rutie::{
     AnyObject, Array as RArray, Fixnum, Hash, Integer, Module, NilClass,
-    Object, Proc, RString, Symbol, VM,
+    Object, Proc, RString, Symbol, VM
 };
 use yrs::types::xml::Attributes;
 use yrs::types::{Change, Delta};

data/y-rb.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/y/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name = "y-rb"
+  spec.version = Y::VERSION
+  spec.authors = ["Hannes Moser"]
+  spec.email = %w[hmoser@gitlab.com box@hannesmoser.at]
+
+  spec.summary = "Ruby bindings for yrs"
+  spec.description = "Ruby bindings for yrs. Yrs \"wires\" is a Rust port of the Yjs framework."
+  spec.homepage = "https://github.com/y-crdt/yrb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/y-crdt/yrb"
+  spec.metadata["documentation_uri"] = "https://y-crdt.github.io/yrb/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "rutie", "~> 0.0.4"
+  spec.add_dependency "thermite", "~> 0"
+
+  spec.extensions << "ext/Rakefile"
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -68,7 +68,6 @@ files:
 - ".rustfmt.toml"
 - ".yardopts"
 - Cargo.toml
-- Cross.toml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -76,9 +75,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/build.md
 - docs/decisions.md
 - docs/examples.md
+- docs/release.md
 - ext/Rakefile
 - lib/y.rb
 - lib/y/array.rb
@@ -89,7 +88,6 @@ files:
 - lib/y/transaction.rb
 - lib/y/version.rb
 - lib/y/xml.rb
-- lib/y_rb.so
 - src/lib.rs
 - src/util.rs
 - src/yarray.rs
@@ -98,6 +96,7 @@ files:
 - src/ytext.rs
 - src/ytransaction.rs
 - src/yxml.rs
+- y-rb.gemspec
 homepage: https://github.com/y-crdt/yrb
 licenses:
 - MIT

data/Cross.toml

@@ -1,4 +0,0 @@
-[build]
-xargo = true
-
-[target.x86_64-unknown-linux-gnu]

data/docs/build.md

@@ -1 +0,0 @@
-# Build Instructions