mechanomeld 0.1.1-aarch64-linux → 0.1.3-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a05490ff440fbbca11aff5c26701a00832e4cbfe3a9a8987787cccf68c1377
-  data.tar.gz: 4e5206b4597ae0ff0f4f1f35664f55d4574493b61570513876bc1b19548cc74a
+  metadata.gz: 263bc88b0ede409672a1e3c01793a41198ce6061d52a091349cc86454bc8285f
+  data.tar.gz: de34a739c48a0e7e81e2b381b3da327ac03df3e86f194aeb041255363705b74d
 SHA512:
-  metadata.gz: d833c0259cddf9c69713a99f72dc564ecf1b3b4e55ece452201c16fa9d7bf3484c6cb438bba8de1b423684ef0f817c1ffcb8bc25ae9087b4b11f1657a5e421a8
-  data.tar.gz: 9be601c6d4f4920f4cee1d79fe69bede69c2e11d80253ed0fd260caf7719f489141204cfccb681c37e7f9fb0e53cf79df27d9d0cde0a9f06a766fd4baa2aae35
+  metadata.gz: '05479a4338538dde5580f91ab9d1cefbf81763e6e08c7ad65906cbf825a2a080bc1c35abc8f5e36f19de3cabd2bf1ded154a256e72841bfcd7d4ddd71176b43e'
+  data.tar.gz: efe99639a8fe689644024a46d363508b213a46a8d47b00db8570f3df7e6e2a851928f3d2558cb486394a91a95e7735e840cbf7db78e1be09b6817bfd8f82cffe

data/CHANGELOG.md

@@ -5,32 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.1.1] - 2026-09-25
+## [0.1.3] - 2026-10-01
 
 ### Added
 
-- Document#load_incremental applies saved Automerge bytes into an existing document (d60a3eb)
-- Document.load_repo reads a document from automerge-repo's NodeFSStorageAdapter directory (d60a3eb)
-- Document#heads returns the document's change hashes as hex, matching JavaScript's Automerge.getHeads (d60a3eb)
-- Document#includes_heads?(heads) reports whether a document is at or past a set of heads (d60a3eb)
-- Mechanomeld::SyncState, the per-peer sync state, with encode and decode for persistence (eea3a51)
-- Document#generate_sync_message and #receive_sync_message, Automerge's per-document sync protocol (eea3a51)
+- Document#up_to_date_with?(heads), the plain-language name for includes_heads?, which stays as an alias (9c1baa6)
 
-### Changed
-
-- releases also publish an x86_64-linux-musl platform gem (159dd59)
-
-## [0.1.0] - 2026-09-17
+## [0.1.2] - 2026-09-28
 
 ### Added
 
-- Initial release
-- Mechanomeld::Counter, Timestamp, Uint, Bytes, and Text value classes (6df6951)
-- Mechanomeld::Document.load reads documents saved by JavaScript Automerge (c7d31d8)
-- Document#get, #[], and #to_h read values by path (c7d31d8)
-- Document#keys and #length for maps, lists, and text (1d80c0b)
-- Mechanomeld::Document.new(actor_id:) creates an empty document (bccb69c)
-- Document#put, #[]=, #delete, and #save (bccb69c)
-- Document#commit(message:, timestamp:) and #rollback (a8ef491)
-- Document#change commits a block and rolls back if it raises (a8ef491)
-- Mechanomeld::Document.from builds a committed document from a Hash (a8ef491)
+- Document#diff(from_heads, to_heads = heads) returns Automerge's patches between two versions of a document, as Hashes (9c9bf6d)

data/README.md

@@ -40,15 +40,40 @@ doc = Mechanomeld::Document.load_repo("automerge-repo-data", "4NtRZtd6yUtzf8qmEp
 
 ### Heads
 
-`Document#heads` is the document's version: the change hashes JavaScript's `Automerge.getHeads(doc)` returns, as lowercase hex, so the two sides compare with `==`. `Document#includes_heads?(heads)` is true when every hash in `heads` is a change the document already contains, so `heads` is the same version or an older one.
+`Document#heads` is the document's version: the change hashes JavaScript's `Automerge.getHeads(doc)` returns, as lowercase hex, so the two sides compare with `==`. `Document#up_to_date_with?(heads)` is true when the document is at the version `heads` names, or a later one: every hash in `heads` is a change the document already contains. `includes_heads?` is the same method under its older name.
 
 ```ruby
-doc.heads                  # => ["9d434616e7af865757bad75cdebe4151bccf7e29214a71f2a65150846c2a4275"]
-doc.includes_heads?(heads) # => true when the document is at or past `heads`
+doc.heads                   # => ["9d434616e7af865757bad75cdebe4151bccf7e29214a71f2a65150846c2a4275"]
+doc.up_to_date_with?(heads) # => true when the document is at or past `heads`
 ```
 
 Both take hex. automerge-repo's `handle.heads()` returns base58 URL heads, which are not accepted; send `Automerge.getHeads(handle.doc())` from JavaScript instead. A hash that is not 32 bytes of hex raises `Mechanomeld::Error`; a well-formed hash the document does not have is simply not included. Like `save`, both commit any pending change first.
 
+### What changed between two versions
+
+`Document#diff(from_heads, to_heads = doc.heads)` is Automerge's diff: the patches that take the document from one version to another, as Hashes with String keys. Both arguments are hex heads as `Document#heads` returns them; `to_heads` defaults to the current heads, and `[]` as `from_heads` diffs from the empty document.
+
+```ruby
+before = doc.heads
+doc.change { |d| d[["scores", "bravo"]] = 7 }
+doc.diff(before)
+# => [{"action" => "put", "path" => ["scores", "bravo"], "value" => 7, "conflict" => false}]
+```
+
+Every patch has `"action"` and `"path"`. The path addresses the property the patch touches from the root, map keys as Strings and list indexes as Integers, as JavaScript's `Automerge.diff` reports it. The other keys depend on the action:
+
+| action | keys |
+|---|---|
+| `put` | `value`, `conflict` (true when this value won a concurrent write) |
+| `delete` | `index` and `length` when deleting from a list; nothing more for a map key |
+| `insert` | `values`, the elements inserted at `path`'s index, in order |
+| `splice_text` | `value`, the String spliced into a `Text` at `path`'s index |
+| `increment` | `value`, the amount a `Counter` changed by, which may be negative |
+| `conflict` | nothing more: a concurrent write now conflicts at `path` |
+| `mark` | `marks`, each `{"name", "value", "start", "end"}` on a `Text` |
+
+Putting or inserting a map, list, or `Text` yields the empty container (`{}`, `[]`, or `Mechanomeld::Text.new("")`); its contents follow as their own patches. Values use the same Ruby types as `get`. A head that is not hex, or that names a change the document does not contain, raises `Mechanomeld::Error`. Like `save`, `diff` commits any pending change first.
+
 ### Syncing with a peer
 
 `Document#generate_sync_message` and `Document#receive_sync_message` run Automerge's per-document sync protocol, so a Ruby document can exchange just the changes each side lacks with another Automerge peer: JavaScript's `Automerge.generateSyncMessage` / `receiveSyncMessage`, or another Ruby document. A `Mechanomeld::SyncState` tracks what one peer is known to have; keep one per peer for each document.

data/lib/mechanomeld/document.rb

@@ -2,8 +2,8 @@
 
 module Mechanomeld
   # Native methods (new, load, load_incremental, get, keys, length, put, delete, commit,
-  # rollback, save, heads, includes_heads?, generate_sync_message, receive_sync_message)
-  # are defined in ext/mechanomeld/src/document.rs.
+  # rollback, save, heads, up_to_date_with?, diff, generate_sync_message,
+  # receive_sync_message) are defined in ext/mechanomeld/src/document.rs.
   class Document
     def self.from(hash, actor_id: nil)
       raise ArgumentError, "Automerge document root must be a Hash" unless hash.is_a?(Hash)
@@ -40,6 +40,8 @@ module Mechanomeld
     end
     alias_method :to_hash, :to_h
 
+    alias_method :includes_heads?, :up_to_date_with?
+
     def change(message: nil, timestamp: nil)
       yield self
       commit(message: message, timestamp: timestamp)

data/lib/mechanomeld/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mechanomeld
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mechanomeld
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: aarch64-linux
 authors:
 - Jim Gay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-09-25 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies: []
 description: A native extension wrapping the Rust automerge crate so Ruby can load,
   read, create, and save Automerge documents shared with JavaScript.