y-rb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816615480d692a2f998ac5d420e4d64ee578a5d351a556ca9e3cf7f93ffaf83f
-  data.tar.gz: dc86328ef38d28fd5320e5ccec4f437e56c0efe8be1e9d5ecd1a74f41eb74df7
+  metadata.gz: 8640afd442488a57ecdf9c2e84f1f8fb707f533aebdc537a7b6d647635e50000
+  data.tar.gz: 173e07d6489afc556269c7740a42c9b741a477b04c10996e6c1a0669e9f51597
 SHA512:
-  metadata.gz: 34a045a974e65d8418c76beb9dafdab4c7adb21e48bdd5404b5191480bb62499b5a080b2bae51219b75445caf24bfa1e292576aec833f9f51832c66beae2b3e7
-  data.tar.gz: fb0fc2e505c889bfb38a15acbdea44dc18c947f19887e453a993973b5ae523a8dac7dd94605b777b9a10da18350614734ec43f6fe877485c75247d3206c40935
+  metadata.gz: 51eb175d76d66ae8401e2f9f7384d2460e9e629a954ca3d8013374f7c89ac9c75f91830ce7286bb1942b0c3106901ed04f3051f37c6255ef1cb928566329864e
+  data.tar.gz: 6f426990929b829c1e39054bfbcb373c983e30e56c9de402c7ce8f14f67d5d302666c5fa0b0527b95b8b8ff98fcaedaed28235887ac1050329b6e777f44dec92

data/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "y-rb"
-version = "0.1.2"
+version = "0.1.3"
 authors = ["Hannes Moser <box@hannesmoser.at>", "Hannes Moser <hmoser@gitlab.com>"]
 edition = "2021"
 homepage = "https://github.com/y-crdt/yrb"
@@ -12,6 +12,15 @@ rutie = "0.8.4"
 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"
 crate-type = ["cdylib"]

data/Cross.toml

@@ -0,0 +1,17 @@
+[build]
+
+[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.1)
+    y-rb (0.1.3)
       rake (~> 13.0)
       rutie (~> 0.0.4)
       thermite (~> 0)
@@ -9,10 +9,21 @@ 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.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)
@@ -34,7 +45,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.30.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -43,10 +55,10 @@ GEM
       rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.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

@@ -24,10 +24,14 @@ Or install it yourself as:
 
     $ gem install y-rb
 
-> **⚠ WARNING: Binary dependencies are not pre-built.**  
-> In an upcoming version we will address the issue of binaries not being
-> pre-built. Until then, you need to have the latest Rust + Cargo working on
-> your machine in order to 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
 
@@ -39,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")  
 

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

@@ -5,5 +5,32 @@
 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
+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/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.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Hannes Moser
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !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
@@ -68,6 +96,7 @@ files:
 - ".rustfmt.toml"
 - ".yardopts"
 - Cargo.toml
+- Cross.toml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -75,6 +104,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- build/Dockerfile
+- build/build.rb
+- build/entrypoint.sh
 - docs/decisions.md
 - docs/examples.md
 - docs/release.md
@@ -96,7 +128,6 @@ files:
 - src/ytext.rs
 - src/ytransaction.rs
 - src/yxml.rs
-- y-rb.gemspec
 homepage: https://github.com/y-crdt/yrb
 licenses:
 - MIT

data/y-rb.gemspec

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