mechanomeld 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ff6a2f602dc4e7a849a437f26c3d67194da8508f17b093bb8b807b9832ad5e
-  data.tar.gz: 45cb8059e7b6f004f4ae95db489cd203b1d97ba35840ae559a7185c8e493ca5c
+  metadata.gz: 401645183c5b387c8f7ebd914db2d8ff1014c03f86fb65b9d994153510f7482f
+  data.tar.gz: d660d41f97da18bd39e4306e131b4c19d70e809e8da17236f7a4251efa1cf177
 SHA512:
-  metadata.gz: 7e7b6c9ad63929ec97f7513fd556d8a8860de99530fd67db5055bc169543dc9ae297a5998c325e9bee3f40a0d20eb4f92310fabf2b072e0c8b4a1723a5e35bbe
-  data.tar.gz: d8a0eb87b94e31175ce1e409e6535a33825bd3789f4c4233706f9eed0e5a34ddefa52813aa1053e00af80f087161f58f30fe2f453f58cc1c4faab957ae54d649
+  metadata.gz: 3bb7618d943ad8c284dbc328fe2156599b8a2c39a5a7e218bc2650f076fc16468e7994cab92209c5bfb790e6248969a2616a94967f41ddcdbac03879f54ce9fa
+  data.tar.gz: 65bf168075b5a415b4bd582ab98f474913188106fdba093f5811d1b1d57b94a050dd1a1eff1e542cc566c35c9081da749a11ee3aa05997bdc8ced485fcd40672

data/CHANGELOG.md

@@ -5,23 +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.2] - 2026-09-28
+## [0.1.3] - 2026-10-01
 
 ### Added
 
-- Document#diff(from_heads, to_heads = heads) returns Automerge's patches between two versions of a document, as Hashes (9c9bf6d)
+- Document#up_to_date_with?(heads), the plain-language name for includes_heads?, which stays as an alias (9c1baa6)
 
-## [0.1.1] - 2026-09-25
+## [0.1.2] - 2026-09-28
 
 ### 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)
-
-### Changed
-
-- releases also publish an x86_64-linux-musl platform gem (159dd59)
+- Document#diff(from_heads, to_heads = heads) returns Automerge's patches between two versions of a document, as Hashes (9c9bf6d)

data/README.md

@@ -40,11 +40,11 @@ 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.

data/ext/mechanomeld/src/document.rs

@@ -193,9 +193,10 @@ impl Document {
         Ok(ruby.ary_from_iter(heads.iter().map(ChangeHash::to_string)))
     }
 
-    /// `doc.includes_heads?(heads)`: whether every hex change hash in `heads` is a
-    /// change this document already contains.
-    pub fn includes_heads(ruby: &Ruby, rb_self: &Self, heads: Vec<String>) -> Result<bool, Error> {
+    /// `doc.up_to_date_with?(heads)`: whether this document is at the version `heads`
+    /// names, or a later one: every hex change hash in `heads` is a change it already
+    /// contains. Ruby also exposes it as `includes_heads?`.
+    pub fn up_to_date_with(ruby: &Ruby, rb_self: &Self, heads: Vec<String>) -> Result<bool, Error> {
         let hashes = heads
             .iter()
             .map(|hex| change_hash(ruby, hex))

data/ext/mechanomeld/src/lib.rs

@@ -28,7 +28,7 @@ fn init(ruby: &Ruby) -> Result<(), Error> {
     class.define_method("rollback", method!(Document::rollback, 0))?;
     class.define_method("save", method!(Document::save, 0))?;
     class.define_method("heads", method!(Document::heads, 0))?;
-    class.define_method("includes_heads?", method!(Document::includes_heads, 1))?;
+    class.define_method("up_to_date_with?", method!(Document::up_to_date_with, 1))?;
     class.define_method("diff", method!(Document::diff, -1))?;
     class.define_method(
         "generate_sync_message",

data/lib/mechanomeld/document.rb

@@ -2,7 +2,7 @@
 
 module Mechanomeld
   # Native methods (new, load, load_incremental, get, keys, length, put, delete, commit,
-  # rollback, save, heads, includes_heads?, diff, generate_sync_message,
+  # 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)
@@ -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.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mechanomeld
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jim Gay