taskchampion-rb 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af337df10c1862b3fd09a7faf3c816820e1a7709158f21fd098897771a815746
-  data.tar.gz: 4ab0b0a8644bcf95d7bbcadc6827e37c1cbff28e3f72a5b0b0d6d0a1e0cc9aaa
+  metadata.gz: e01ec15c8492334e8b6722c2932bf4b39054c93d251cfd3baf18f64bb8a5cdf5
+  data.tar.gz: 2df70def10c1411d953300a02ac56e4d585189ee76ec3479d7fdf8b43fd05a38
 SHA512:
-  metadata.gz: '07279b71d2b721d5906bf583ea0107072ee92f77d836221a9f26cb9a0a419d87b9190838b668cb2c04a2e23f49caddd3751880ab3d5da2cbbffe8e4f2b32c094'
-  data.tar.gz: 54d070b62a1a529c9688b338ba920d51a4afe28b8c2ab6f9bb2ad0117c56bf59c58bb33d08336624b6d0f5124ae27ad840c54f524689bbce9e96c0c3233db575
+  metadata.gz: 0bf8ed1f3a1662f7dd5fbf1549e4749f3e9ed017ce39e31fae868c2a186519c609c2155a6c4b6cefc5a95cb544b89fbc64b5c8299c7c8a91a28a643e08f4a0a6
+  data.tar.gz: acaf8ab75fd4df5d116f70b9b20d9923de81de2363c8350649652a0ab79227694c9f6349f0b5ae412aef9e54c7928dc7845c8a7bbf0447fd603178bc1c4b155d

data/.ruby-version

@@ -1 +1 @@
-3.2.0
+3.3.9

data/CHANGELOG.md

@@ -1,5 +1,82 @@
 ## [Unreleased]
 
+- Drop support for Ruby 3.2 (reached EOL March 2026). Minimum supported
+  Ruby is now 3.3; CI tests 3.3, 3.4, and 3.5.
+- Enable the `bundled` feature of the `taskchampion` crate so SQLite is
+  compiled from source into the extension. Previously `default-features
+  = false` dropped `bundled`, making the build link against system
+  SQLite and fail with `cannot find -lsqlite3` on any host without
+  `libsqlite3-dev` installed.
+- Expand README build prerequisites: `clang`/`libclang-dev` (needed by
+  `rb-sys` bindgen) on Linux, `xcode-select --install` on macOS, and
+  note that the Rust toolchain is optional since `rb-sys` bootstraps
+  one.
+
+## [0.9.4] - 2026-07-11
+
+- Include the full cause chain in sync error messages. TaskChampion
+  wraps sync failures in an anyhow context, and the default `Display`
+  previously printed only the outermost line ("Failed to synchronize
+  with server"), hiding the real cause. `Error::Other` is now formatted
+  with anyhow's alternate format so the full chain (HTTP status,
+  connection errors, server rejections) reaches Ruby.
+- Add `server-gcp` feature flag, required for `ServerConfig::Gcp` used
+  by `sync_gcp`
+- Fix order-dependent annotation test
+
+## [0.9.3] - 2026-05-30
+
+- Add `Task#set_modified` method, consistent with `set_entry`
+- Move docs
+- Change taskchampion dependency to enable `server-sync` feature
+
+## [0.9.2] - 2026-05-22
+
+- Fix all Rust compiler warnings
+
+## [0.9.1] - 2026-05-22
+
+- Fix error mapping to use `taskchampion::Error` enum variants instead
+  of heuristic message-content matching. Adds
+  `Taskchampion::OutOfSyncError < SyncError` for the `OutOfSync`
+  sentinel, signaling an irrecoverable divergence that requires a full
+  re-sync rather than a retry
+
+## [0.9.0] - 2025-10-17
+
+- Add remove and update annotations support
+
+## [0.8.0] - 2025-09-24
+
+- Add undo/history functionality with operation tracking
+- Add `set_timestamp` and `get_timestamp` methods for custom date
+  fields
+- Fix RuboCop errors
+
+## [0.7.0] - 2025-08-18
+
+- Add `set_entry` method to `Task`
+- Fix RuboCop errors
+
+## [0.6.0] - 2025-08-14
+
+- Add pending task support to `Replica`
+
+## [0.5.0] - 2025-08-14
+
+- Implement `done` status handling
+
+Note: v0.4.0 was tagged against the same commit as v0.5.0 and carries
+no distinct changes; treat v0.5.0 as its replacement.
+
+## [0.3.0] - 2025-08-14
+
+- Rename gem to `taskchampion-rb`
+- Implement `TaskData`
+- Rename `tasks` to `all_tasks`
+- Support Windows and ARM builds
+- Drop support for Ruby versions below 3.2
+
 ## [0.2.0] - 2025-08-11
 
 - Enhanced error handling with contextual messages

data/Cargo.lock

@@ -890,6 +890,7 @@ version = "0.30.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2e99fb7a497b1e3339bc746195567ed8d3e24945ecd636e3619d20b9de9e9149"
 dependencies = [
+ "cc",
  "pkg-config",
  "vcpkg",
 ]

data/README.md

@@ -2,26 +2,34 @@
 
 Ruby bindings for TaskChampion, the task database that powers Taskwarrior.
 
-## Ruby Version Support (2025-08-12)
+## Ruby Version Support (2026-09-10)
 
-This gem supports Ruby 3.2 and later. We follow Ruby's end-of-life (EOL) schedule and drop support for Ruby versions that have reached EOL.
+This gem supports Ruby 3.3 and later. We follow Ruby's end-of-life (EOL) schedule and drop support for Ruby versions that have reached EOL.
 
-- **Ruby 3.2**: Supported (EOL: March 2026)
-- **Ruby 3.3**: Supported (Current stable)
-- **Ruby 3.4**: Supported
-- **Ruby 3.0-3.1**: Not supported (reached EOL)
+- **Ruby 3.3**: Supported
+- **Ruby 3.4**: Supported (Current stable)
+- **Ruby 3.5**: Supported
+- **Ruby 3.0-3.2**: Not supported (reached EOL)
 
 ## Installation
 
 ### Prerequisites
 
-1. Ruby 3.2 or later
-2. Rust toolchain (install from https://rustup.rs/)
+1. Ruby 3.3 or later
+2. A C compiler and `clang`/`libclang` development headers — `rb-sys` runs
+   libclang over Ruby's headers to generate FFI bindings during `rake compile`.
+   - **Debian/Ubuntu:** `sudo apt install clang libclang-dev`
+   - **macOS:** `xcode-select --install`
+3. Rust toolchain (optional — if `cargo` is not found, `rb-sys` bootstraps its
+   own rustup + toolchain during the build). To install it yourself:
 
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
 
+> SQLite is compiled from source into the extension (the `bundled` feature), so
+> no system SQLite / `libsqlite3-dev` is required.
+
 ### Building from source
 
 ```bash

data/docs/post_upstream_fix_migration.md

@@ -0,0 +1,147 @@
+# Migration plan: once the upstream `taskchampion` sync-error fix lands
+
+## Context
+
+`Replica::sync()` in the upstream `taskchampion` crate currently routes
+every sync failure through `anyhow::Context`, which erases the typed
+`Error` variant (`Database`, `Server`, `OutOfSync`, `Usage`) and
+re-boxes it as the catch-all `Error::Other` — regardless of what
+actually failed. See `upstream_issue_draft.md` at the root of this
+checkout of `~/Sites/reference/taskchampion` for the full writeup filed
+against `GothenburgBitFactory/taskchampion`.
+
+This document tracks what changes in `taskchampion-rb` once that
+upstream issue is fixed and released (or once we point at a patched
+fork, whichever comes first).
+
+## What does *not* need to change
+
+`ext/taskchampion/src/error.rs`'s `map_taskchampion_error` already has
+the correct match arms:
+
+```rust
+match error {
+    Error::Database(msg) => Error::new(storage_error(), msg),
+    Error::Server(msg)   => Error::new(sync_error(), msg),
+    Error::OutOfSync     => Error::new(out_of_sync_error(), "..."),
+    Error::Usage(msg)    => Error::new(validation_error(), msg),
+    Error::Other(err)    => Error::new(storage_error(), format!("{err:#}")),
+}
+```
+
+These arms have been correct since `0.9.1` ("Fix error mapping to use
+enum variants") — they've simply been dead code for sync failures
+specifically, because `Replica::sync()` never handed them a real
+`Server`/`OutOfSync` value to match against. No changes needed here.
+
+## What does need to change
+
+### 1. Bump the pinned crate dependency
+
+`ext/taskchampion/Cargo.toml`:
+
+```toml
+taskchampion = { version = "2.0", default-features = false, features = ["server-sync", "server-gcp"] }
+```
+
+Once the fix ships in a crates.io release, bump `"2.0"` to whatever
+version includes it. If we go the fork route first (patch applied
+locally, upstream PR still pending review), point at the fork instead:
+
+```toml
+taskchampion = { git = "https://github.com/<you>/taskchampion", branch = "preserve-sync-error-variant", default-features = false, features = ["server-sync", "server-gcp"] }
+```
+
+Swap back to the crates.io version once/if the PR merges and releases.
+
+Run `cargo update -p taskchampion` (or `bundle exec rake compile`,
+which will pull in the new `Cargo.lock` resolution) and recompile.
+
+### 2. This is a breaking change for consumers — bump to 0.10.0
+
+`Taskchampion::StorageError` and `Taskchampion::SyncError` are
+**siblings** under `Taskchampion::Error`, not superclass/subclass:
+
+```
+Taskchampion::Error
+├── Taskchampion::StorageError
+└── Taskchampion::SyncError
+    └── Taskchampion::OutOfSyncError
+```
+
+Today, every `sync_to_remote`/`sync_to_local`/`sync_to_gcp` failure
+raises `StorageError`. After this fix, connection/network/out-of-sync
+failures will raise `SyncError` or `OutOfSyncError` instead. Any
+consumer code doing `rescue Taskchampion::StorageError` specifically
+around a sync call — expecting it to catch sync failures — will
+silently stop catching them.
+
+Per semver for a pre-1.0 gem, this warrants a **minor** version bump
+(`0.9.4` → `0.10.0`), not a jump to `1.0.0`. See the CHANGELOG entry
+below.
+
+### 3. Update `docs/TaskchampionRbErrors.md`
+
+This file already documents `SyncError`/`OutOfSyncError` as reachable
+via `Error::Server`/`Error::OutOfSync` — that documentation is
+currently aspirational/inaccurate for sync failures specifically. Once
+the fix lands, it becomes correct; no wording changes should be
+needed, but re-verify the examples still match actual raised messages
+(the message text may shift slightly depending on how the upstream fix
+formats the wrapped context — see caveat below).
+
+### 4. Verify existing tests still pass, add classification coverage
+
+Existing tests are already forward-compatible:
+
+- `test/integration/test_sync_operations.rb:150`
+  (`test_sync_error_handling`) asserts
+  `Taskchampion::StorageError, Taskchampion::SyncError` (either) — no
+  change needed.
+- `test/integration/test_sync_operations.rb`
+  (`test_remote_sync_error_includes_underlying_cause`, added in
+  `61130f5`) asserts the base `Taskchampion::Error` and matches on
+  message content — no change needed, but re-run it: the exact message
+  format may shift if the upstream fix wraps the inner message
+  differently than our expectation
+  (`"Failed to synchronize with server: <cause>"`).
+
+Add new coverage once the fix lands:
+
+- A test that a genuinely out-of-sync replica (server has diverged,
+  e.g. by resetting the sync server's storage under a replica that has
+  already synced) raises `Taskchampion::OutOfSyncError` specifically,
+  not just `StorageError`/`SyncError`.
+- A test that a connection failure (as in the existing
+  `test_remote_sync_error_includes_underlying_cause`) raises
+  `Taskchampion::SyncError` specifically, not `StorageError`.
+
+### 5. CHANGELOG entry
+
+Add to `[Unreleased]` (or a new `[0.10.0]` section once released):
+
+```markdown
+## [0.10.0] - YYYY-MM-DD
+
+### Changed
+- **Breaking:** sync failures now raise `Taskchampion::SyncError` or
+  `Taskchampion::OutOfSyncError` instead of `Taskchampion::StorageError`,
+  now that upstream `taskchampion` preserves the typed error variant
+  through `Replica::sync()` instead of erasing it via `anyhow::Context`.
+  Code that rescues `Taskchampion::StorageError` specifically around a
+  sync call should rescue `Taskchampion::SyncError` (or the common
+  base `Taskchampion::Error`) instead.
+```
+
+## Downstream: bravo / wt_engine
+
+Once `taskchampion-rb` is bumped in `bravo`'s and `wt_engine`'s
+`Gemfile.lock`, `Wt::SyncEventProcessor`'s failure path
+(`engines/wt_engine/app/jobs/wt/sync_event_processor.rb`) and
+`Tc::Sync#with_rescue` (`engines/wt_engine/app/services/tc/sync.rb`)
+both use bare `rescue => e` / catch any `StandardError`, so they are
+unaffected by the exception-class change — no code changes required
+there. The benefit is purely in Sentry: `Taskchampion::OutOfSyncError`
+and `Taskchampion::SyncError` will appear as distinct issues/fingerprints
+instead of one generic `StorageError` bucket, without needing any
+message-string parsing to distinguish them.

data/ext/taskchampion/Cargo.toml

@@ -12,7 +12,9 @@ crate-type = ["cdylib"]
 [dependencies]
 magnus = { version = "0.7", features = ["rb-sys"] }
 rb-sys = "0.9.103"
-taskchampion = { version = "2.0", default-features = false, features = ["server-sync", "server-gcp"] }
+# `bundled` compiles SQLite from source into the extension so the build does not
+# depend on the host having libsqlite3-dev / a compatible system SQLite.
+taskchampion = { version = "2.0", default-features = false, features = ["bundled", "server-sync", "server-gcp"] }
 chrono = "0.4"
 uuid = "1.0"
 

data/ext/taskchampion/src/error.rs

@@ -58,6 +58,10 @@ pub fn map_taskchampion_error(error: taskchampion::Error) -> Error {
         taskchampion::Error::OutOfSync     => Error::new(out_of_sync_error(),
                                                  "Local replica is out of sync with the server"),
         taskchampion::Error::Usage(msg)    => Error::new(validation_error(), msg),
+        // anyhow's alternate format renders the full cause chain
+        // ("context: cause: root cause"), not just the top context line.
+        taskchampion::Error::Other(err)    => Error::new(storage_error(),
+                                                 format!("{err:#}")),
         _                                  => Error::new(storage_error(), error.to_string()),
     }
 }

data/lib/taskchampion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taskchampion
-  VERSION = "0.9.3"
+  VERSION = "0.9.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taskchampion-rb
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Tim Case
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-31 00:00:00.000000000 Z
+date: 2026-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -51,6 +51,7 @@ files:
 - docs/errors.md
 - docs/phase_3_plan.md
 - docs/plan.md
+- docs/post_upstream_fix_migration.md
 - example.md
 - examples/basic_usage.rb
 - examples/pending_tasks.rb
@@ -91,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby bindings for TaskChampion