automerge-rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f89ea286a29332d054013fefdd8bc762fa088854af5ad885f1efc0c0b6fb56c
+  data.tar.gz: 79fbe467baa08edcdeb7c8e66c91c1f9e92c18162a3130dd7d7962d19fe396ab
+SHA512:
+  metadata.gz: e095d230fc1bc765fe99d5410d61cd95a56188f4ec82b39368d951c634f85543f11fb173fc937b31db1b0a6e529d1fe04024e51942d930fcba28330ba6937a8b
+  data.tar.gz: 237f6d5d0dae9e475e9853b7b8190ba0d475aa6ed6ba2c469fc3359325623e81e4e2eb018e80e38dc35ecbfdc1ed451d8d4de11746ac4211982ab6ab81ee1f25

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.