y-rb 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10cd525c4f285fedd7ea5460790a0515bd15227d49606a8c283b313b9fdd233c
-  data.tar.gz: 8645608ebd5f936cb3eb11e16a1e8b6fde1874881990b7cd18eb1f1624d5f2af
+  metadata.gz: 8640afd442488a57ecdf9c2e84f1f8fb707f533aebdc537a7b6d647635e50000
+  data.tar.gz: 173e07d6489afc556269c7740a42c9b741a477b04c10996e6c1a0669e9f51597
 SHA512:
-  metadata.gz: 7b36dda334a509d2123430871c47f713852eea552f804db174c2ca2089b6184dacfe6c30641d0693bb4e58897c9659fc99279607498ffe3be44863b369d7080b
-  data.tar.gz: 3fe5990b463b06da580ada4705e011c84579e5b07eb5565bd15ca80b25a184ef6fac78db423a240521aa9c60313c08ef59e927ef3705897b84b4eacbce97b772
+  metadata.gz: 51eb175d76d66ae8401e2f9f7384d2460e9e629a954ca3d8013374f7c89ac9c75f91830ce7286bb1942b0c3106901ed04f3051f37c6255ef1cb928566329864e
+  data.tar.gz: 6f426990929b829c1e39054bfbcb373c983e30e56c9de402c7ce8f14f67d5d302666c5fa0b0527b95b8b8ff98fcaedaed28235887ac1050329b6e777f44dec92

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,7 +1,7 @@
 [package]
 name = "y-rb"
-version = "0.1.0"
-authors = ["Hannes Moser <box@hannesmoser.at>"]
+version = "0.1.3"
+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"
@@ -9,9 +9,17 @@ repository = "https://github.com/y-crdt/yrb"
 [dependencies]
 lazy_static = "1.4.0"
 rutie = "0.8.4"
-yrs = "0.7.1"
-lib0 = "0.7.1"
-cross = "0.2.1"
+yrs = "0.10.1"
+lib0 = "0.10.1" # must match yrs version
+
+[target.aarch64-unknown-linux-musl.dependencies]
+rutie = {version="0.8.4", features=["no-link"]}
+
+[target.x86_64-unknown-linux-musl.dependencies]
+rutie = {version="0.8.4", features=["no-link"]}
+
+[target.aarch64-unknown-linux-gnu.dependencies]
+rutie = {version="0.8.4", features=["no-link"]}
 
 [lib]
 name = "y_rb"

data/Cross.toml

@@ -1,2 +1,17 @@
 [build]
-xargo = true
+
+[build.dockerfile]
+file = "./build/Dockerfile"
+
+[build.env]
+passthrough = [
+    "RUBY_VERSION"
+]
+
+[target.aarch64-apple-darwin]
+
+[target.x86_64-apple-darwin]
+
+[target.x86_64-unknown-linux-gnu]
+
+[target.x86_64-unknown-linux-musl]

data/Gemfile

@@ -8,6 +8,6 @@ gemspec
 gem "github-markup"
 gem "redcarpet"
 gem "rspec", "~> 3.11.0"
-gem "rubocop", "~> 1.21"
-gem "rubocop-rspec", "~> 2.10.0"
+gem "rubocop", "~> 1.31"
+gem "rubocop-rspec", "~> 2.12.1"
 gem "yard"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    y-rb (0.1.0)
+    y-rb (0.1.3)
       rake (~> 13.0)
       rutie (~> 0.0.4)
       thermite (~> 0)
@@ -9,17 +9,28 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    github-markup (4.0.0)
+    github-markup (4.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
     minitar (0.9)
+    minitest (5.16.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
     redcarpet (3.5.1)
-    regexp_parser (2.3.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -34,19 +45,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.28.2)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
-    rubocop-rspec (2.10.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
     rutie (0.0.4)
     thermite (0.13.0)
@@ -54,20 +66,26 @@ GEM
       rake (>= 10)
       tomlrb (~> 1.2)
     tomlrb (1.3.0)
-    unicode-display_width (2.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  activesupport (~> 6.1.6.1)
   github-markup
+  minitar (~> 0.9)
   redcarpet
   rspec (~> 3.11.0)
-  rubocop (~> 1.21)
-  rubocop-rspec (~> 2.10.0)
+  rubocop (~> 1.31)
+  rubocop-rspec (~> 2.12.1)
   y-rb!
   yard
 

data/README.md

@@ -1,8 +1,5 @@
 # Yrb
 
-> Attention: This gem isn't published yet, but you can play around with it.
-> Feedback on the Ruby API is welcome 🙌.
-
 Yrb is a Ruby binding for Y-CRDT. It provides distributed data types that enable
 real-time collaboration between devices. Yrb can sync data with any other
 platform that has a Y-CRDT binding, allowing for seamless cross-domain
@@ -27,6 +24,15 @@ Or install it yourself as:
 
     $ gem install y-rb
 
+> **⚠ WARNING: Partial support for pre-built binaries.**  
+> `y-rb` comes with experimental pre-built binaries for a few platforms, but it
+> is not possible to support all targets right now. Please make sure there is an
+> archive that matches the OS, CPU architecture, and Ruby version. You can find
+> the assets listed with each [release](https://github.com/y-crdt/yrb/releases).
+>
+> If the platform is not listed, you need to add the latest stable Rust + Cargo
+> to your build dependencies in order for `y-rb` to install properly.
+
 ## Usage
 
 ```ruby
@@ -37,7 +43,7 @@ local_text = local.get_text("my text")
 # add some data to the text structure
 local_text.push("hello")  
   
-# create a remote doccument sharing the same text structure
+# create a remote document sharing the same text structure
 remote = Y::Doc.new 
 remote_text = remote.get_text("my text")  
 
@@ -54,7 +60,7 @@ remote.sync(update)
 puts remote_text.to_s == local_text.to_s # true  
 ```  
 
-More [examples](./docs/examples).
+More [examples](docs/examples.md).
 
 ## Development
 
@@ -86,7 +92,7 @@ open "http://0.0.0.0:8808/"
 
 ## Decision log
 
-For this `gem`, we maintain a [decision log](./docs/decisions.md). Please consult it
+For this `gem`, we maintain a [decision log](docs/decisions.md). Please consult it
 in case there is some ambiguity in terms of why certain implementation details
 look as they are. 
 

data/build/Dockerfile

@@ -0,0 +1,18 @@
+ARG CROSS_BASE_IMAGE
+FROM $CROSS_BASE_IMAGE
+
+ENV RUBY_VERSION=3.1.2
+
+RUN apt-get update -yq && apt-get install -yq build-essential gnupg2 openssl ruby ruby-dev
+RUN curl -sSL https://rvm.io/pkuczynski.asc | gpg2 --import -
+RUN curl -L https://get.rvm.io | bash -s stable
+RUN /bin/bash -l -c "rvm requirements"
+RUN /bin/bash -l -c "rvm install 3.1.2"
+RUN /bin/bash -l -c "rvm install 3.0.4"
+RUN /bin/bash -l -c "rvm install 2.7.6"
+RUN /bin/bash -l -c "rvm install 2.6.10"
+
+COPY build/entrypoint.sh /
+RUN chmod +x "/entrypoint.sh"
+
+ENTRYPOINT ["/entrypoint.sh"]

data/build/build.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+require "fileutils"
+require "minitar"
+require "zlib"
+
+require_relative "../lib/y/version"
+
+RUBIES = %w[2.6.10 2.7.6 3.0.4 3.1.2].freeze
+
+# darwin20 = mac os 11.x
+# darwin21 = mac os 12.x
+# darwin22 = mac os 13.x
+TARGETS = {
+  "aarch64-apple-darwin": {
+    cpu: "arm64",
+    os: "darwin21"
+  },
+  "aarch64-unknown-linux-gnu": {
+    cpu: "arm64",
+    os: "linux"
+  },
+  "aarch64-unknown-linux-musl": {
+    cpu: "arm64",
+    os: "linux-musl",
+    env: {
+      "RUSTFLAGS" => "\"-C target-feature=-crt-static\""
+    }
+  },
+  "x86_64-unknown-linux-gnu": {
+    cpu: "x86_64",
+    os: "linux"
+  },
+  "x86_64-unknown-linux-musl": {
+    cpu: "x86_64",
+    os: "linux-musl",
+    env: {
+      "RUSTFLAGS" => "\"-C target-feature=-crt-static\""
+    }
+  }
+}.freeze
+
+def build_lib(target, options, ruby_version) # rubocop:disable Metrics/MethodLength
+  env_vars = if !options.nil? && options.key?(:env)
+               target_env = target.to_s.underscore.upcase
+               options[:env]
+                 .map { |env, value| "CARGO_TARGET_#{target_env}_#{env}=#{value}" }
+                 .join(" ")
+             else
+               ""
+             end
+
+  cmd = [
+    "cargo clean",
+    "#{env_vars} RUBY_VERSION=#{ruby_version} cross build --target=#{target} --release"
+  ].join(" && ")
+
+  `#{cmd}`
+end
+
+def copy_lib(target)
+  path = "#{__dir__}/../target/#{target}/release"
+
+  file = Dir["#{path}/*{dylib,so}"].first
+
+  extension = File.extname(file)
+  dest = "#{path}/y_rb#{extension}"
+
+  FileUtils.cp(file, dest)
+
+  dest
+end
+
+# Build
+
+FileUtils.rm_rf "#{__dir__}/out"
+
+TARGETS.each do |target, options|
+  RUBIES.each do |ruby_version|
+    puts "Build: target=#{target}, ruby=#{ruby_version}"
+
+    version = Gem::Version.new(ruby_version)
+    version_segments = version.canonical_segments
+    ruby_version_string = "#{version_segments[0]}#{version_segments[1]}"
+
+    build_lib(target, options, ruby_version)
+    file = copy_lib(target)
+
+    raise "Build failed" if file.nil?
+
+    extension = File.extname(file)
+    dir = "#{__dir__}/out/y_rb-#{Y::VERSION}-ruby#{ruby_version_string}-#{options[:os]}-#{options[:cpu]}"
+    FileUtils.mkdir_p(dir)
+    FileUtils.cp(file, "#{dir}/y_rb#{extension}")
+
+    archive = "#{dir}/y_rb-#{Y::VERSION}-ruby#{ruby_version_string}-#{options[:os]}-#{options[:cpu]}.tar.gz"
+    Zlib::GzipWriter.open(archive) do |tgz|
+      Dir.chdir(dir) do
+        Archive::Tar::Minitar.pack(".", tgz)
+      end
+    end
+  end
+end

data/build/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+/bin/bash -l -c "rvm --default use $RUBY_VERSION" && exec "$@"

data/docs/release.md

@@ -0,0 +1,36 @@
+# 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 vx.x.x -m "Release version vx.x.x"` 
+5. Push tag to GitHub repo: `git push vx.x.x`
+6. Create a GitHub release (requires GitHub CLI): `gh release create vx.x.x ./build/out/*/*.gz`
+7. Package and upload gem: `gem build && gem push y-rb-x.x.x.gem`
+
+## Cross-compile binaries (to be released as assets on GitHub)
+
+There is a script in `./build` that automates a fair chunk of work, but it is
+not bulletproof. I mainly use it to compile for arm64 platforms on my machine,
+and then upload manually. Most binaries (especially x86) should come from CI.
+
+It also includes a workaround for Alpine (popular in Docker images) what usually
+requires to be a static lib.
+
+Run the following script. It produces a bunch of archives in `./build/out/`.
+You need to upload the produced assets manually after the GitHub release was
+created.
+
+```bash
+./build/build.rb
+```
+
+## Future work
+
+With this [PR](https://github.com/rubygems/rubygems/pull/5175) merged into
+rubygems, we will most likely be able to rely on the extension to manage builds
+for us in the future.
+
+Pre-build binaries are not verified, and are inherently a security concern.

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/rb.rb

@@ -10,7 +10,17 @@ require_relative "version"
 require_relative "xml"
 
 module Y
-  Rutie.new(:y_rb).init(
+  # support pre-built and local built libraries
+  lib_path = if Dir.exist?(File.join(__dir__, "..", "..", "target", "release"))
+               nil
+             else
+               File.join(__dir__, "..", "..")
+             end
+
+  Rutie.new(
+    :y_rb,
+    lib_path: lib_path
+  ).init(
     "Init_yrb",
     File.join(__dir__, "..")
   )

data/lib/y/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Y
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 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};

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,7 +52,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Yrs "wires" is a Rust port of the Yjs framework.
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.6.1
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ruby bindings for yrs. Yrs "wires" is a Rust port of the Yjs framework.
 email:
 - hmoser@gitlab.com
 - box@hannesmoser.at
@@ -61,7 +89,6 @@ extensions:
 - ext/Rakefile
 extra_rdoc_files: []
 files:
-- ".cargo/config.toml"
 - ".dockerignore"
 - ".editorconfig"
 - ".rspec"
@@ -77,9 +104,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/build.md
+- build/Dockerfile
+- build/build.rb
+- build/entrypoint.sh
 - docs/decisions.md
 - docs/examples.md
+- docs/release.md
 - ext/Rakefile
 - lib/y.rb
 - lib/y/array.rb
@@ -90,7 +120,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
@@ -99,14 +128,14 @@ files:
 - src/ytext.rs
 - src/ytransaction.rs
 - src/yxml.rs
-homepage: https://about.gitlab.com
+homepage: https://github.com/y-crdt/yrb
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://about.gitlab.com
-  source_code_uri: https://gitlab.com/gitlab-org/incubation-engineering/real-time-editing/y-rb
-  changelog_uri: https://gitlab.com/gitlab-org/incubation-engineering/real-time-editing/y-rb
+  homepage_uri: https://github.com/y-crdt/yrb
+  source_code_uri: https://github.com/y-crdt/yrb
+  documentation_uri: https://y-crdt.github.io/yrb/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/.cargo/config.toml

@@ -1,5 +0,0 @@
-[target.x86_64-apple-darwin]
-linker = "x86_64-apple-darwin14-clang"
-ar = "x86_64-apple-darwin14-ar"
-
-[target.aarch64-apple-darwin]

data/docs/build.md

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