toolpath 0.1.5

Types, builders, and query operations for Toolpath provenance documents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

//! Graph traversal and query operations for Toolpath documents.

use crate::types::Step;
use std::collections::{HashMap, HashSet};

/// Walk the parent chain from `head_id`, returning all ancestor step IDs (inclusive).
///
/// # Examples
///
/// ```
/// use toolpath::v1::{Step, query};
///
/// let s1 = Step::new("s1", "human:alex", "2026-01-29T10:00:00Z")
///     .with_raw_change("f.rs", "@@");
/// let s2 = Step::new("s2", "agent:claude", "2026-01-29T10:01:00Z")
///     .with_parent("s1")
///     .with_raw_change("f.rs", "@@");
/// let s3 = Step::new("s3", "human:alex", "2026-01-29T10:02:00Z")
///     .with_parent("s2")
///     .with_raw_change("f.rs", "@@");
///
/// let anc = query::ancestors(&[s1, s2, s3], "s3");
/// assert_eq!(anc.len(), 3);
/// assert!(anc.contains("s1"));
/// assert!(anc.contains("s2"));
/// assert!(anc.contains("s3"));
/// ```
pub fn ancestors(steps: &[Step], head_id: &str) -> HashSet<String> {
    let step_map: HashMap<&str, &Step> = steps.iter().map(|s| (s.step.id.as_str(), s)).collect();
    let mut result = HashSet::new();
    let mut stack = vec![head_id];

    while let Some(id) = stack.pop() {
        if result.insert(id.to_string())
            && let Some(step) = step_map.get(id)
        {
            for parent in &step.step.parents {
                stack.push(parent);
            }
        }
    }

    result
}

/// Steps not on the path to `head_id` — abandoned branches.
///
/// # Examples
///
/// ```
/// use toolpath::v1::{Step, query};
///
/// let s1 = Step::new("s1", "human:alex", "2026-01-29T10:00:00Z")
///     .with_raw_change("f.rs", "@@");
/// // Two competing branches off s1:
/// let s2 = Step::new("s2", "agent:claude", "2026-01-29T10:01:00Z")
///     .with_parent("s1")
///     .with_raw_change("f.rs", "@@");
/// let abandoned = Step::new("s2a", "agent:claude", "2026-01-29T10:01:30Z")
///     .with_parent("s1")
///     .with_raw_change("f.rs", "@@");
/// let s3 = Step::new("s3", "human:alex", "2026-01-29T10:02:00Z")
///     .with_parent("s2")
///     .with_raw_change("f.rs", "@@");
///
/// let steps = vec![s1, s2, abandoned, s3];
/// let dead = query::dead_ends(&steps, "s3");
/// assert_eq!(dead.len(), 1);
/// assert_eq!(dead[0].step.id, "s2a");
/// ```
pub fn dead_ends<'a>(steps: &'a [Step], head_id: &str) -> Vec<&'a Step> {
    let active = ancestors(steps, head_id);
    steps
        .iter()
        .filter(|s| !active.contains(&s.step.id))
        .collect()
}

/// Filter steps by actor prefix (e.g., `"human:"`, `"agent:claude"`).
///
/// # Examples
///
/// ```
/// use toolpath::v1::{Step, query};
///
/// let steps = vec![
///     Step::new("s1", "human:alex", "2026-01-29T10:00:00Z"),
///     Step::new("s2", "agent:claude", "2026-01-29T10:01:00Z"),
///     Step::new("s3", "tool:rustfmt", "2026-01-29T10:02:00Z"),
///     Step::new("s4", "human:bob", "2026-01-29T10:03:00Z"),
/// ];
///
/// let humans = query::filter_by_actor(&steps, "human:");
/// assert_eq!(humans.len(), 2);
/// assert_eq!(humans[0].step.id, "s1");
/// assert_eq!(humans[1].step.id, "s4");
/// ```
pub fn filter_by_actor<'a>(steps: &'a [Step], prefix: &str) -> Vec<&'a Step> {
    steps
        .iter()
        .filter(|s| s.step.actor.starts_with(prefix))
        .collect()
}

/// Steps that touch a given artifact (by key in the change map).
pub fn filter_by_artifact<'a>(steps: &'a [Step], artifact: &str) -> Vec<&'a Step> {
    steps
        .iter()
        .filter(|s| s.change.contains_key(artifact))
        .collect()
}

/// Steps whose timestamp falls within [start, end] (ISO 8601 string comparison).
pub fn filter_by_time_range<'a>(steps: &'a [Step], start: &str, end: &str) -> Vec<&'a Step> {
    steps
        .iter()
        .filter(|s| {
            let ts = s.step.timestamp.as_str();
            ts >= start && ts <= end
        })
        .collect()
}

/// All artifact URLs mentioned across all steps.
pub fn all_artifacts(steps: &[Step]) -> HashSet<&str> {
    steps
        .iter()
        .flat_map(|s| s.change.keys().map(|k| k.as_str()))
        .collect()
}

/// All actor strings across all steps.
pub fn all_actors(steps: &[Step]) -> HashSet<&str> {
    steps.iter().map(|s| s.step.actor.as_str()).collect()
}

/// Build an ID → Step lookup map.
pub fn step_index(steps: &[Step]) -> HashMap<&str, &Step> {
    steps.iter().map(|s| (s.step.id.as_str(), s)).collect()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::Step;

    fn make_step(id: &str, actor: &str, parents: &[&str], artifacts: &[&str]) -> Step {
        let mut step = Step::new(id, actor, "2026-01-29T10:00:00Z");
        for p in parents {
            step = step.with_parent(*p);
        }
        for a in artifacts {
            step = step.with_raw_change(*a, "@@");
        }
        step
    }

    #[test]
    fn test_ancestors_linear() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["f.rs"]),
            make_step("s2", "agent:b", &["s1"], &["f.rs"]),
            make_step("s3", "human:a", &["s2"], &["g.rs"]),
        ];

        let anc = ancestors(&steps, "s3");
        assert_eq!(anc.len(), 3);
        assert!(anc.contains("s1"));
        assert!(anc.contains("s2"));
        assert!(anc.contains("s3"));
    }

    #[test]
    fn test_ancestors_with_fork() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["f.rs"]),
            make_step("s2", "agent:b", &["s1"], &["f.rs"]),
            make_step("s2a", "agent:b", &["s1"], &["f.rs"]), // dead end
            make_step("s3", "human:a", &["s2"], &["g.rs"]),
        ];

        let anc = ancestors(&steps, "s3");
        assert_eq!(anc.len(), 3);
        assert!(!anc.contains("s2a"));
    }

    #[test]
    fn test_dead_ends() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["f.rs"]),
            make_step("s2", "agent:b", &["s1"], &["f.rs"]),
            make_step("s2a", "agent:b", &["s1"], &["f.rs"]), // dead end
            make_step("s3", "human:a", &["s2"], &["g.rs"]),
        ];

        let dead = dead_ends(&steps, "s3");
        assert_eq!(dead.len(), 1);
        assert_eq!(dead[0].step.id, "s2a");
    }

    #[test]
    fn test_filter_by_actor() {
        let steps = vec![
            make_step("s1", "human:alex", &[], &["f.rs"]),
            make_step("s2", "agent:claude", &["s1"], &["f.rs"]),
            make_step("s3", "tool:rustfmt", &["s2"], &["f.rs"]),
            make_step("s4", "human:bob", &["s3"], &["f.rs"]),
        ];

        assert_eq!(filter_by_actor(&steps, "human:").len(), 2);
        assert_eq!(filter_by_actor(&steps, "agent:").len(), 1);
        assert_eq!(filter_by_actor(&steps, "tool:").len(), 1);
    }

    #[test]
    fn test_filter_by_artifact() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["src/main.rs"]),
            make_step("s2", "agent:b", &["s1"], &["src/lib.rs"]),
            make_step("s3", "human:a", &["s2"], &["src/main.rs", "src/lib.rs"]),
        ];

        assert_eq!(filter_by_artifact(&steps, "src/main.rs").len(), 2);
        assert_eq!(filter_by_artifact(&steps, "src/lib.rs").len(), 2);
    }

    #[test]
    fn test_filter_by_time_range() {
        let steps = vec![
            Step::new("s1", "human:a", "2026-01-29T10:00:00Z"),
            Step::new("s2", "human:a", "2026-01-29T12:00:00Z"),
            Step::new("s3", "human:a", "2026-01-29T14:00:00Z"),
        ];

        let filtered = filter_by_time_range(&steps, "2026-01-29T11:00:00Z", "2026-01-29T13:00:00Z");
        assert_eq!(filtered.len(), 1);
        assert_eq!(filtered[0].step.id, "s2");
    }

    #[test]
    fn test_all_artifacts() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["a.rs", "b.rs"]),
            make_step("s2", "human:a", &["s1"], &["b.rs", "c.rs"]),
        ];

        let arts = all_artifacts(&steps);
        assert_eq!(arts.len(), 3);
        assert!(arts.contains("a.rs"));
        assert!(arts.contains("b.rs"));
        assert!(arts.contains("c.rs"));
    }

    #[test]
    fn test_all_actors() {
        let steps = vec![
            make_step("s1", "human:alex", &[], &["f.rs"]),
            make_step("s2", "agent:claude", &["s1"], &["f.rs"]),
            make_step("s3", "human:alex", &["s2"], &["f.rs"]),
        ];

        let actors = all_actors(&steps);
        assert_eq!(actors.len(), 2);
        assert!(actors.contains("human:alex"));
        assert!(actors.contains("agent:claude"));
    }

    #[test]
    fn test_step_index() {
        let steps = vec![
            make_step("s1", "human:a", &[], &["f.rs"]),
            make_step("s2", "human:a", &["s1"], &["f.rs"]),
        ];

        let idx = step_index(&steps);
        assert_eq!(idx.len(), 2);
        assert_eq!(idx["s1"].step.actor, "human:a");
    }
}