taskchampion-rb 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b267de15e0004e931e2a46f37f9014afe8fdc52e58e675190dab990cb345e75
-  data.tar.gz: 6a84efc5a165c428c67e6d50f3ce0b001eab4d3fde464ffed123d218aaf04033
+  metadata.gz: 494521791e308dacc686f45ef7ff87937a0038e46729092a4e145952971a5f56
+  data.tar.gz: ac3a7b7367b2d8565ac902981fb4c7a9ee45b7d0c825868b15591211debc733b
 SHA512:
-  metadata.gz: ff860c7dcb85bc6a04aced731b403072a03c3a222f869fec0a25af1436b14fb67e4df0a9dc5cfad4d829b1fe1f39936e6df07c90605eb859202ac8f80fc8a17f
-  data.tar.gz: d826c3704fec6432e872abe24423d92e04da810c0718ce0cc224dbddd780b2279b336c635bd1e285405bd4534710fbd9928bf4ee7c5f225f4118baade8315436
+  metadata.gz: 3d5c1e59e10ac46d98a8fc30d666dac904fcf2d14742c12713a16050a7a67d87c21e1a42ebaf7d25762541d0335c3c36ab2cf6a93bd3ed778046cd1a739840f4
+  data.tar.gz: 8f69921b628b5b1803a940584b05dd46abc854e50d9a3555646a141298a6c2a55008b2c8ca60b508fd53566bc6d0bd28a69f8caf76021e37a56e9fbf69bd362c

data/CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build and Development Commands
+
+### Building the gem
+```bash
+bundle install
+bundle exec rake compile  # Compiles the Rust extension
+```
+
+### Running tests
+```bash
+bundle exec rake test              # Run all tests
+bundle exec rake test TEST=test/test_replica.rb  # Run specific test file
+```
+
+### Linting
+```bash
+bundle exec rake rubocop           # Run RuboCop linter
+```
+
+### Publishing new version
+```bash
+rake publish[patch]  # Bump patch version and release
+rake publish[minor]  # Bump minor version and release
+rake publish[major]  # Bump major version and release
+```
+
+## Architecture Overview
+
+This is a Ruby gem that provides bindings to TaskChampion (Rust library) for task management. The architecture consists of:
+
+### Key Components
+
+1. **Rust Extension** (`ext/taskchampion/`)
+   - Written in Rust using Magnus for Ruby-Rust interop
+   - Entry point: `ext/taskchampion/src/lib.rs`
+   - Implements core classes: Replica, Task, WorkingSet, Operations, etc.
+   - Thread safety enforced via `thread_check.rs` - objects can only be accessed from their creation thread
+
+2. **Ruby Layer** (`lib/taskchampion.rb`)
+   - Thin wrapper that loads the Rust extension
+   - Extends WorkingSet and Replica classes with Ruby-specific convenience methods
+   - Maintains Ruby idioms (snake_case methods, `?` suffix for booleans)
+
+3. **Core Classes**
+   - `Replica`: Main database interface for task storage (in-memory or on-disk)
+   - `Task`: Individual task with properties and methods
+   - `Operations`: Collection of operations for batch changes
+   - `WorkingSet`: Active subset of tasks
+   - `DependencyMap`: Task dependency management
+   - Error hierarchy: Error → ThreadError, StorageError, ValidationError, ConfigError
+
+### Testing Structure
+- Uses Minitest framework
+- Tests organized in `test/unit/`, `test/integration/`, and `test/performance/`
+- Base test class: `TaskchampionTest` in `test/test_helper.rb`
+- Tests use temporary directories for file-based replicas
+
+### Ruby API Design Principles
+- Methods use snake_case (not get_/set_ prefixes)
+- Boolean methods end with `?`
+- Symbols for enums (`:pending`, `:completed`, `:read_only`)
+- `nil` instead of None
+- Keyword arguments for optional parameters

data/examples/pending_tasks.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'taskchampion'
+require 'securerandom'
+
+# Create an in-memory replica
+replica = Taskchampion::Replica.new_in_memory
+
+# Create several tasks with different statuses
+puts "Creating tasks..."
+
+# Create pending tasks
+3.times do |i|
+  ops = Taskchampion::Operations.new
+  task = replica.create_task(SecureRandom.uuid, ops)
+  task.set_description("Pending task #{i + 1}", ops)
+  task.set_status(Taskchampion::PENDING, ops)
+  replica.commit_operations(ops)
+  puts "  Created pending task: #{task.description}"
+end
+
+# Create completed tasks
+2.times do |i|
+  ops = Taskchampion::Operations.new
+  task = replica.create_task(SecureRandom.uuid, ops)
+  task.set_description("Completed task #{i + 1}", ops)
+  task.set_status(Taskchampion::COMPLETED, ops)
+  replica.commit_operations(ops)
+  puts "  Created completed task: #{task.description}"
+end
+
+# Create a deleted task
+ops = Taskchampion::Operations.new
+task = replica.create_task(SecureRandom.uuid, ops)
+task.set_description("Deleted task", ops)
+task.set_status(Taskchampion::DELETED, ops)
+replica.commit_operations(ops)
+puts "  Created deleted task: #{task.description}"
+
+puts "\n" + "=" * 50
+puts "Getting pending tasks..."
+puts "=" * 50
+
+# Use the pending_tasks method to get only pending tasks
+pending = replica.pending_tasks
+
+puts "\nFound #{pending.length} pending tasks:"
+pending.each_with_index do |task, index|
+  puts "  #{index + 1}. [#{task.uuid[0..7]}...] #{task.description}"
+  puts "     Status: #{task.status}"
+  puts "     Active: #{task.active?}"
+end
+
+puts "\n" + "=" * 50
+puts "For comparison, all_tasks returns #{replica.all_tasks.size} tasks total"

data/ext/taskchampion/src/replica.rs

@@ -260,6 +260,20 @@ impl Replica {
 
         Ok(tc_replica.num_undo_points().map_err(into_error)?)
     }
+
+    fn pending_tasks(&self) -> Result<RArray, Error> {
+        let mut tc_replica = self.0.get_mut()?;
+
+        let tc_tasks = tc_replica.pending_tasks().map_err(into_error)?;
+
+        let array = RArray::new();
+        for tc_task in tc_tasks {
+            let ruby_task = crate::task::Task::from_tc_task(tc_task);
+            array.push(ruby_task)?;
+        }
+
+        Ok(array)
+    }
 }
 
 pub fn init(module: &RModule) -> Result<(), Error> {
@@ -285,6 +299,7 @@ pub fn init(module: &RModule) -> Result<(), Error> {
     class.define_method("expire_tasks", method!(Replica::expire_tasks, 0))?;
     class.define_method("num_local_operations", method!(Replica::num_local_operations, 0))?;
     class.define_method("num_undo_points", method!(Replica::num_undo_points, 0))?;
+    class.define_method("pending_tasks", method!(Replica::pending_tasks, 0))?;
 
     Ok(())
 }

data/lib/taskchampion/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taskchampion-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tim Case
@@ -36,6 +36,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CLAUDE.md
 - Cargo.lock
 - Cargo.toml
 - README.md
@@ -48,6 +49,7 @@ files:
 - docs/plan.md
 - example.md
 - examples/basic_usage.rb
+- examples/pending_tasks.rb
 - examples/sync_workflow.rb
 - ext/taskchampion/Cargo.toml
 - ext/taskchampion/extconf.rb