automerge-rb 0.1.1-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a0b190bc2d03786af7b242b20f2efe2dc9056e7ff8fd30ed25267885e0deee8
+  data.tar.gz: 8ba9b83bc8590d5f530ad50107a3b53234ef1529d1ae7dd9f9925b8b947177ed
+SHA512:
+  metadata.gz: f70478ec216bb954f9ecd103ce2cf379967f1111bd38c2b1c15aa543af24edfe9ba9b1eb08b41e63e1ffff155ac35e37509fc7f5f4b725ee009533f7162c7c98
+  data.tar.gz: 07cb3f7d6321edaaa4156a3a8f92c0522546078155b4b6ab0282070a8300b52a8e42b1eb92715fd4f21dffded1bfd0dedc7ed85ced8df1ec2cbf46632869fb90

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Automerge Ruby contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,175 @@
+# automerge-rb
+
+Ruby bindings for the upstream Automerge Rust core.
+
+## Install
+
+```sh
+gem install automerge-rb
+```
+
+Precompiled native gems are published for the following platforms, so end users
+do **not** need Rust or a C toolchain installed:
+
+- `arm64-darwin` (Apple Silicon macOS)
+- `x86_64-darwin` (Intel macOS)
+- `x86_64-linux` (glibc)
+- `aarch64-linux` (glibc)
+- `x64-mingw-ucrt` (Windows)
+
+Each native gem ships a fat binary covering Ruby 3.0–3.4. RubyGems auto-selects
+the matching artifact for the host's platform and Ruby ABI at install time.
+
+On any other platform `gem install automerge-rb` falls back to building from
+source, which requires Rust (1.89+) and a C compiler. The source build also
+runs whenever you set `--platform=ruby` explicitly.
+
+## Build from source
+
+```sh
+bundle exec rake compile
+```
+
+The Automerge checkout currently requires Rust 1.89 or newer. If your default
+toolchain is older, install one with:
+
+```sh
+rustup toolchain install 1.89.0
+```
+
+The extension builds the Rust core in release mode by default. Use
+`AUTOMERGE_RB_DEBUG=1 bundle exec rake compile` for a faster local debug build.
+
+By default `extconf.rb` skips the Rust step if a prebuilt
+`lib/automerge/<ruby-abi>/automerge_ext.<dlext>` already exists (i.e. inside a
+native gem); set `AUTOMERGE_SOURCE_DIR` to point at a different Automerge Rust
+workspace if you want to recompile from a custom checkout.
+
+## Cross-compiling native gems
+
+Maintainers can build the published binary set with rake-compiler-dock:
+
+```sh
+bundle exec rake gem:native
+```
+
+This invokes the same docker-backed cross toolchain that the release workflow
+uses, producing `pkg/automerge-rb-<version>-<platform>.gem` for every supported
+platform.
+
+## Test alignment
+
+The default test suite includes Ruby ports of upstream Automerge C/Rust
+conformance cases and binary fixture checks:
+
+```sh
+bundle exec rake test
+```
+
+To also run the vendored upstream Rust core test suite, use:
+
+```sh
+bundle exec rake test:upstream_core
+```
+
+To run the upstream C API suite, install CMake and cmocka, then use:
+
+```sh
+bundle exec rake test:upstream_c
+```
+
+For a full local gate, run all three:
+
+```sh
+bundle exec rake conformance
+```
+
+If multiple Rust toolchains are installed, the Rake tasks prefer
+`AUTOMERGE_RB_RUST_TOOLCHAIN` and otherwise use `1.89.0` when present so `cargo`
+and `rustc` stay on the same toolchain.
+
+## Usage
+
+```ruby
+require "automerge"
+
+doc = Automerge.from("cards" => [])
+doc.insert(["cards"], 0, "title" => "Rewrite everything in Ruby", "done" => false)
+doc.change(message: "Add card")
+
+bytes = doc.save
+loaded = Automerge.load(bytes)
+loaded.to_h
+```
+
+The Ruby API is path-oriented. A path is an array of map keys and list indexes:
+
+```ruby
+doc.put(["cards", 0, "done"], true)
+doc.get(["cards", 0, "done"]) #=> true
+```
+
+Supported Automerge-specific scalar wrappers:
+
+```ruby
+Automerge::Counter.new(1)
+Automerge::Timestamp.new(1_735_689_600_000)
+Automerge::Bytes.new("\x00\x01".b)
+Automerge::Text.new("mutable text")
+Automerge::Uint.new(42)
+```
+
+Implemented document operations include:
+
+- map/list/text reads and writes through path arrays
+- commits, empty changes, rollback, actor IDs, heads, and forks
+- save/load, incremental save/load, change lookup, missing deps, and applying changes
+- merge conflict reads with `get_all`
+- the stateful sync protocol with `SyncState`
+- text cursors and text marks
+
+## Historical reads
+
+Every read accepts an optional `heads:` keyword argument naming a vector of
+change hashes (typically returned by `Document#heads`). When supplied, the read
+resolves against that historical snapshot instead of the current HEAD:
+
+```ruby
+doc = Automerge.init
+doc.put(["k"], "v1"); doc.commit
+h1 = doc.heads
+doc.put(["k"], "v2"); doc.commit
+
+doc.get(["k"])               #=> "v2"
+doc.get(["k"], heads: h1)    #=> "v1"
+doc.keys([], heads: h1)      #=> ["k"]
+doc.length(["list"], heads: h1)
+doc.cursor_position(["text"], cursor, heads: h1)
+doc.marks(["text"], heads: h1)
+doc.get_all(["k"], heads: h1)
+```
+
+## Change metadata
+
+`Automerge.decode_change(bytes)` unpacks a change-bytes blob (from
+`Document#change_by_hash` or `Document#get_changes`) into a hash describing the
+change. Useful for audit logs and replication tooling:
+
+```ruby
+hash = doc.commit(message: "Add card", timestamp: Time.now.to_i)
+meta = Automerge.decode_change(doc.change_by_hash(hash))
+meta[:message]    # => "Add card"
+meta[:actor_id]   # => "deadbeef"
+meta[:timestamp]  # => 1735689600
+meta[:seq]        # => 4
+meta[:deps]       # => [<change hash>, ...]
+meta[:empty]      # => false
+```
+
+## Thread safety
+
+`Automerge::Document` instances are not thread-safe. Two threads sharing the
+same `Document` must coordinate externally; concurrent mutations or even
+concurrent reads against an in-progress writer will trigger undefined behavior
+in the underlying Rust core. Sharing across threads is safe only after a
+`save`/`load` round-trip or `fork` produces independent documents.

data/lib/automerge/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Automerge
+  VERSION = "0.1.1"
+end
+

data/lib/automerge.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "automerge/version"
+
+module Automerge
+  class Error < StandardError; end
+
+  class Scalar
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def ==(other)
+      other.class == self.class && other.value == value
+    end
+  end
+
+  class Counter < Scalar; end
+  class Timestamp < Scalar; end
+  class Uint < Scalar; end
+
+  class Bytes < Scalar
+    def initialize(value)
+      @value = String(value).b
+    end
+  end
+
+  class Text < Scalar
+    def initialize(value = "")
+      @value = String(value)
+    end
+  end
+end
+
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require_relative "automerge/#{Regexp.last_match(1)}/automerge_ext"
+rescue LoadError
+  require_relative "automerge/automerge_ext"
+end
+
+module Automerge
+  class Document
+    def self.from(value = nil, **opts)
+      actor_id = opts.delete(:actor_id)
+      value = opts if value.nil? && !opts.empty?
+      doc = new(actor_id: actor_id)
+      unless value.is_a?(Hash)
+        raise ArgumentError, "Automerge document root must be a Hash"
+      end
+
+      value.each do |key, child|
+        doc.put([key], child)
+      end
+      doc.commit
+      doc
+    end
+
+    def [](path)
+      get(path)
+    end
+
+    def []=(path, value)
+      put(path, value)
+    end
+
+    def change(message: nil, timestamp: nil)
+      if block_given?
+        begin
+          yield self
+          commit(message, timestamp)
+        rescue Exception
+          rollback
+          raise
+        end
+      else
+        commit(message, timestamp)
+      end
+      self
+    end
+
+    def to_h
+      get([])
+    end
+
+    alias to_hash to_h
+
+    def sync_state
+      SyncState.new
+    end
+  end
+
+  def self.init(actor_id: nil)
+    Document.new(actor_id: actor_id)
+  end
+
+  def self.from(value = nil, **opts)
+    Document.from(value, **opts)
+  end
+
+  def self.load(bytes)
+    Document.load(bytes)
+  end
+
+  def self.decode_change(bytes)
+    Document.decode_change(bytes)
+  end
+end

data/rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "1.89.0"
+profile = "minimal"
+components = ["rustc", "cargo"]

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: automerge-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: x86_64-linux
+authors:
+- Automerge Ruby contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A production-oriented Ruby SDK for Automerge backed by the upstream Rust/C
+  core.
+email:
+- maintainers@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/automerge.rb
+- lib/automerge/3.0/automerge_ext.so
+- lib/automerge/3.1/automerge_ext.so
+- lib/automerge/3.2/automerge_ext.so
+- lib/automerge/3.3/automerge_ext.so
+- lib/automerge/3.4/automerge_ext.so
+- lib/automerge/version.rb
+- rust-toolchain.toml
+homepage: https://github.com/automerge/automerge
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/automerge/automerge
+  changelog_uri: https://github.com/automerge/automerge/blob/main/rust/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Automerge CRDT core
+test_files: []