y-rb 0.1.3 → 0.1.4.alpha.1

data/Rakefile

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
-require "rubocop/rake_task"
-require "thermite/tasks"
-
-RSpec::Core::RakeTask.new(:spec)
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
-
-desc "Compile the y-rb crate"
-task :compile do
-  # MacOS: ARM + x64
-  `cargo build --release --target=aarch64-apple-darwin`
-  `cargo build --release --target=x86_64-apple-darwin`
-
-  # Copy to target folder
-  `cp target/aarch64-apple-darwin/release/liby_rb.dylib target/release/`
-end
-
-task :clean do
-  `cargo clean`
-end
-
-task test: :spec
-
-task :docs do
-  `yard server --reload`
-end
-
-RuboCop::RakeTask.new
-
-YARD::Rake::YardocTask.new
-
-Thermite::Tasks.new

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "y/rb"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/build/Dockerfile

@@ -1,18 +0,0 @@
-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

@@ -1,105 +0,0 @@
-#!/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

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

data/docs/decisions.md

@@ -1,64 +0,0 @@
-# Decision log
-
-## 2022-05-12
-
-### Transactions do not always commit automatically
-
-In `yrs`, the lifetime of a transaction is determined automatically. This can
-lead to an interesting situation in Ruby, where we attach a listener to receive
-changes, never commit a transaction explicitly and where the transaction gets
-dropped automatically. I believe we still maintain a pointer to the transaction
-that no longer exists, and therefore we receive a segfault.
-
-## 2022-05-12
-
-### Add event-driven approach to receive changes
-
-It is not clear if this ends up being the final API to receive changes, but
-it is the one that is supported in one or the other way across all `yrs`
-implementations. It might be beneficial to add a synchronous API in the future,
-but this isn't supported right away. All common styles of closure like behavior
-are supported: `Proc`, `Lambda` and `Block`.
-
-## 2022-05-09
-
-### Supported operations on data types are either read-only or mutable
-
-In a meeting with the wider `y-crdt` group on May 6th, 2022, it became clear
-that the cost of creating a new instance of a data type is common operation in
-many languages (Python, Ruby, …), but it is not something we should to support.
-This pattern leads to all sort of problems, mostly because it contradicts the
-common usage pattern of replicating changes between two or more clients.
-
-Instead, the API should be explicit about this fact and should not make it too
-easy to do that.
-
-## 2022-05-06
-
-### Transactions are implicit by default
-
-The developer should not be exposed to transactions until they need to
-change the default logic in any way. If someone creates a structure and inserts,
-removes, this should be part of the same transaction until stated otherwise.
-
-### Synchronisation happens at the document level
-
-It might be interesting to sync at a more granular level, but for the sake of
-simplicity, the first iteration of this library will only support
-synchronization of the complete document.
-
-## 2022-05-05
-
-### No direct exposure of internal API
-
-The internal API (`y-crdt`) is subject to constant changes and does not
-necessarily offer an idiomatic Ruby interface. Therefore, the public API of
-`y-rb` does not follow the `y-crdt` API, but prefers familiar Ruby idioms when
-possible and might even require libraries where it makes sense (e.g. `nokogiri` for XML).
-
-### Rutie is a temporary dependency
-
-The Ruby<->Rust binding feels immature. But it is not the goal of this project
-to fix this immediately. The long-term vision is to replace this part by
-something more lightweight and opinionated that could be part of the Rust
-codebase of this project.

data/docs/examples.md

@@ -1,16 +0,0 @@
-# Examples
-
-> Usage patterns
-
-## Send a full document update to a client
-
-```ruby
-doc = Y::Doc.new
-text = doc.get_text("about")
-text << "My name is, my name is, my name is … Slim Shady"
-
-zero = Y::Doc.new
-update = doc.diff(zero.state)
-
-transfer update
-```

data/docs/release.md

@@ -1,36 +0,0 @@
-# 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/ext/Rakefile

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "thermite/tasks"
-
-project_dir = File.dirname(File.dirname(__FILE__))
-Thermite::Tasks.new(cargo_project_path: project_dir,
-                    ruby_project_path: project_dir)
-
-task default: %w[thermite:build]

data/lib/y/rb.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "rutie"
-require_relative "array"
-require_relative "doc"
-require_relative "map"
-require_relative "text"
-require_relative "transaction"
-require_relative "version"
-require_relative "xml"
-
-module Y
-  # 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__, "..")
-  )
-end

data/src/lib.rs

@@ -1,248 +0,0 @@
-mod util;
-mod yarray;
-mod ydoc;
-mod ymap;
-mod ytext;
-mod ytransaction;
-mod yxml;
-
-#[macro_use]
-extern crate rutie;
-
-use rutie::{Module, Object};
-
-module!(Y);
-
-#[allow(non_snake_case)]
-#[no_mangle]
-pub extern "C" fn Init_yrb() {
-    Module::new("Y").define(|module| {
-        module.define_nested_class("Array", None).define(|klass| {
-            klass.def_private("yarray_each", yarray::yarray_each);
-            klass.def_private("yarray_get", yarray::yarray_get);
-            klass.def_private("yarray_insert", yarray::yarray_insert);
-            klass.def_private(
-                "yarray_insert_range",
-                yarray::yarray_insert_range
-            );
-            klass.def_private("yarray_length", yarray::yarray_length);
-            klass.def_private("yarray_observe", yarray::yarray_observe);
-            klass.def_private("yarray_push_back", yarray::yarray_push_back);
-            klass.def_private("yarray_push_front", yarray::yarray_push_front);
-            klass.def_private("yarray_remove", yarray::yarray_remove);
-            klass.def_private(
-                "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);
-        });
-
-        module.define_nested_class("Doc", None).define(|klass| {
-            klass.def_self("new", ydoc::ydoc_new);
-            klass.def_private("ydoc_transact", ydoc::ydoc_transact);
-            klass.def_private("ydoc_encode_diff_v1", ydoc::ydoc_encode_diff_v1);
-        });
-
-        module.define_nested_class("Map", None).define(|klass| {
-            klass.def_private("ymap_clear", ymap::ymap_clear);
-            klass.def_private("ymap_contains", ymap::ymap_contains);
-            klass.def_private("ymap_each", ymap::ymap_each);
-            klass.def_private("ymap_get", ymap::ymap_get);
-            klass.def_private("ymap_insert", ymap::ymap_insert);
-            klass.def_private("ymap_observe", ymap::ymap_observe);
-            klass.def_private("ymap_remove", ymap::ymap_remove);
-            klass.def_private("ymap_size", ymap::ymap_size);
-            klass.def_private("ymap_to_h", ymap::ymap_to_hash);
-            klass.def_private("ymap_unobserve", ymap::ymap_unobserve);
-        });
-
-        module
-            .define_nested_class("SubscriptionID", None)
-            .define(|_klass| {});
-
-        module.define_nested_class("Text", None).define(|klass| {
-            klass.def_private("ytext_insert", ytext::ytext_insert);
-            klass.def_private("ytext_insert_embed", ytext::ytext_insert_embed);
-            klass.def_private(
-                "ytext_insert_embed_with_attrs",
-                ytext::ytext_insert_embed_with_attributes
-            );
-            klass.def_private(
-                "ytext_insert_with_attrs",
-                ytext::ytext_insert_with_attributes
-            );
-            klass.def_private("ytext_remove_range", ytext::ytext_remove_range);
-            klass.def_private("ytext_format", ytext::ytext_format);
-            klass.def_private("ytext_length", ytext::ytext_length);
-            klass.def_private("ytext_observe", ytext::ytext_observe);
-            klass.def_private("ytext_push", ytext::ytext_push);
-            klass.def_private("ytext_to_s", ytext::ytext_to_string);
-            klass.def_private("ytext_unobserve", ytext::ytext_unobserve);
-        });
-
-        module
-            .define_nested_class("Transaction", None)
-            .define(|klass| {
-                klass.def_private(
-                    "ytransaction_apply_update",
-                    ytransaction::ytransaction_apply_update
-                );
-                klass.def_private(
-                    "ytransaction_commit",
-                    ytransaction::ytransaction_commit
-                );
-                klass.def_private(
-                    "ytransaction_get_array",
-                    ytransaction::ytransaction_get_array
-                );
-                klass.def_private(
-                    "ytransaction_get_map",
-                    ytransaction::ytransaction_get_map
-                );
-                klass.def_private(
-                    "ytransaction_get_text",
-                    ytransaction::ytransaction_get_text
-                );
-                klass.def_private(
-                    "ytransaction_get_xml_element",
-                    ytransaction::ytransaction_get_xml_element
-                );
-                klass.def_private(
-                    "ytransaction_get_xml_text",
-                    ytransaction::ytransaction_get_xml_text
-                );
-                klass.def_private(
-                    "ytransaction_state_vector",
-                    ytransaction::ytransaction_state_vector
-                );
-            });
-
-        module
-            .define_nested_class("XMLElement", None)
-            .define(|klass| {
-                klass.def_private(
-                    "yxml_element_attributes",
-                    yxml::yxml_element_attributes
-                );
-                klass.def_private(
-                    "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
-                );
-                klass.def_private(
-                    "yxml_element_insert_attribute",
-                    yxml::yxml_element_insert_attribute
-                );
-                klass.def_private(
-                    "yxml_element_insert_element",
-                    yxml::yxml_element_insert_element
-                );
-                klass.def_private(
-                    "yxml_element_insert_text",
-                    yxml::yxml_element_insert_text
-                );
-                klass.def_private(
-                    "yxml_element_next_sibling",
-                    yxml::yxml_element_next_sibling
-                );
-                klass.def_private(
-                    "yxml_element_observe",
-                    yxml::yxml_element_observe
-                );
-                klass.def_private(
-                    "yxml_element_parent",
-                    yxml::yxml_element_parent
-                );
-                klass.def_private(
-                    "yxml_element_prev_sibling",
-                    yxml::yxml_element_prev_sibling
-                );
-                klass.def_private(
-                    "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
-                );
-                klass.def_private(
-                    "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
-                );
-                klass.def_private(
-                    "yxml_element_remove_attribute",
-                    yxml::yxml_element_remove_attribute
-                );
-                klass.def_private(
-                    "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
-                );
-                klass.def_private(
-                    "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
-            );
-            klass.def_private("yxml_text_format", yxml::yxml_text_format);
-            klass.def_private(
-                "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
-            );
-            klass.def_private(
-                "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
-            );
-            klass.def_private(
-                "yxml_text_insert_with_attrs",
-                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
-            );
-            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
-            );
-            klass.def_private("yxml_text_push", yxml::yxml_text_push);
-            klass.def_private(
-                "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);
-        });
-    });
-}