face 0.1.0

Fold And Cluster Entries — a Unix-style CLI for grouping, paging, and summarizing structured command output.
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
//! Cluster drilling and pagination coverage.
//!
//! Acceptance: docs/design.md §6 (cluster addressing), §6.2
//! (`--cluster` flag forms), §6.3 (pagination), §7.2 (page block).

mod common;

use common::drive;

/// Build a JSONL string with `n` items in a single `kind:bug` cluster.
/// Each item carries an `idx` so tests can verify ordering on the page.
fn bug_jsonl(n: usize) -> String {
    let mut s = String::new();
    for i in 0..n {
        s.push_str(&format!("{{\"kind\":\"bug\",\"idx\":{i}}}\n"));
    }
    s
}

mod cluster_canonical {
    use super::drive;

    /// Acceptance: docs/design.md §6.1 — canonical comma form
    /// `--cluster axis:value` drills into the named cluster and
    /// populates the page block.
    #[test]
    fn drills_into_named_cluster() {
        let stdin = "{\"kind\":\"bug\",\"id\":1}\n\
                     {\"kind\":\"bug\",\"id\":2}\n\
                     {\"kind\":\"feat\",\"id\":3}\n";
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind:bug",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");

        let page = &v["page"];
        let cluster_id = page["cluster_id"]
            .as_str()
            .expect("page.cluster_id is a string when --cluster set: {v}");
        assert_eq!(
            cluster_id, "kind:bug",
            "page.cluster_id round-trips canonical form: {v}",
        );
        let items = page["items"].as_array().expect("page.items is array: {v}");
        assert!(
            !items.is_empty(),
            "page.items is non-empty for a populated cluster: {v}",
        );
        // Every item on the page should be a bug record.
        for item in items {
            assert_eq!(
                item["kind"].as_str(),
                Some("bug"),
                "page items are filtered to bug: {item}",
            );
        }
    }
}

mod cluster_structured {
    use super::drive;

    /// Acceptance: docs/design.md §6.2 — structured form
    /// `--cluster axis=value` is interchangeable with the canonical
    /// comma form. Same drill behavior, equivalent envelope.
    #[test]
    fn drills_via_structured_form() {
        let stdin = "{\"kind\":\"bug\",\"id\":1}\n\
                     {\"kind\":\"bug\",\"id\":2}\n\
                     {\"kind\":\"feat\",\"id\":3}\n";
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind=bug",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        let items = v["page"]["items"]
            .as_array()
            .expect("page.items is array: {v}");
        assert!(
            !items.is_empty(),
            "structured form populates the same page as canonical: {v}",
        );
        for item in items {
            assert_eq!(
                item["kind"].as_str(),
                Some("bug"),
                "page items are filtered to bug: {item}",
            );
        }
    }
}

mod cluster_ordinal {
    use super::drive;

    /// `--cluster 1` selects the first rendered top-level cluster,
    /// which gives users a quick drill path after reading the summary.
    #[test]
    fn drills_into_first_rendered_cluster_by_ordinal() {
        let stdin = "{\"kind\":\"bug\",\"id\":1}\n\
                     {\"kind\":\"bug\",\"id\":2}\n\
                     {\"kind\":\"feat\",\"id\":3}\n";
        let (code, stdout, stderr) = drive(
            &["face", "--by", "kind", "--cluster", "1", "--format=json"],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        assert_eq!(v["page"]["cluster_id"].as_str(), Some("kind:bug"));
        let items = v["page"]["items"]
            .as_array()
            .expect("page.items is array: {v}");
        assert_eq!(items.len(), 2, "first rendered cluster is kind:bug: {v}");
        for item in items {
            assert_eq!(item["kind"].as_str(), Some("bug"));
        }
    }

    /// For numeric bands, the first rendered cluster is the highest
    /// range. Drilling by ordinal must include the maximum value in
    /// that range even though bands are sorted descending.
    #[test]
    fn drills_into_first_numeric_band_by_ordinal() {
        let stdin = "{\"score\":0,\"id\":0}\n\
                     {\"score\":1,\"id\":1}\n\
                     {\"score\":2,\"id\":2}\n\
                     {\"score\":3,\"id\":3}\n";
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "score",
                "--strategy=bands=2",
                "--cluster",
                "1",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        let first_cluster_id = v["clusters"][0]["id"].as_str().expect("cluster id string");
        assert_eq!(v["page"]["cluster_id"].as_str(), Some(first_cluster_id));
        assert_eq!(v["page"]["total_items"].as_u64(), Some(2));
        let items = v["page"]["items"]
            .as_array()
            .expect("page.items is array: {v}");
        assert_eq!(items.len(), 2, "top band contains scores 2 and 3: {v}");
        assert!(
            items.iter().any(|item| item["score"].as_f64() == Some(3.0)),
            "top band includes the maximum score: {v}",
        );
    }
}

mod pagination {
    use super::{bug_jsonl, drive};

    /// Acceptance: docs/design.md §6.3 — `--per-page` defaults to 20.
    /// On a 50-item cluster, page 1 carries 20 items and the page
    /// block reports `total_items=50`.
    #[test]
    fn default_per_page_caps_at_20() {
        let stdin = bug_jsonl(50);
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind:bug",
                "--format=json",
            ],
            &stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        let page = &v["page"];
        let items = page["items"].as_array().expect("page.items is array: {v}");
        assert_eq!(items.len(), 20, "default per-page is 20: {v}");
        assert_eq!(
            page["total_items"].as_u64(),
            Some(50),
            "page.total_items reflects the full cluster: {v}",
        );
    }

    /// Acceptance: docs/design.md §6.3 — `--page=2` returns items
    /// 21–40 with the default per-page of 20.
    #[test]
    fn explicit_page_2() {
        let stdin = bug_jsonl(50);
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind:bug",
                "--page=2",
                "--format=json",
            ],
            &stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        let items = v["page"]["items"]
            .as_array()
            .expect("page.items is array: {v}");
        assert_eq!(items.len(), 20, "page 2 with default per-page=20: {v}");
        assert_eq!(
            v["page"]["page"].as_u64(),
            Some(2),
            "page.page reports the requested page: {v}",
        );
        assert_eq!(
            v["page"]["total_items"].as_u64(),
            Some(50),
            "page.total_items reflects the full cluster: {v}",
        );
    }

    /// Acceptance: docs/design.md §6.3 — last page is partial when
    /// `total % per_page != 0`. With 50 items and per-page 20,
    /// page 3 has 10 items.
    #[test]
    fn last_page_partial() {
        let stdin = bug_jsonl(50);
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind:bug",
                "--page=3",
                "--per-page=20",
                "--format=json",
            ],
            &stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable JSON envelope");
        let items = v["page"]["items"]
            .as_array()
            .expect("page.items is array: {v}");
        assert_eq!(
            items.len(),
            10,
            "last page is partial (50 items, per_page=20): {v}",
        );
        assert_eq!(
            v["page"]["per_page"].as_u64(),
            Some(20),
            "page.per_page echoes the request: {v}",
        );
    }
}

mod strategy_membership {
    use super::drive;

    /// Prefix cluster labels are derived from path segments, so drilling
    /// must test prefix membership instead of raw string equality.
    #[test]
    fn prefix_cluster_drills_by_prefix_membership() {
        let stdin = "{\"path\":\"src/cli.rs\",\"id\":1}\n\
                     {\"path\":\"src/lib.rs\",\"id\":2}\n\
                     {\"path\":\"docs/design.md\",\"id\":3}\n";
        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "path",
                "--strategy=prefix=1",
                "--cluster",
                "path:src",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        let items = v["page"]["items"].as_array().expect("page.items array");
        assert_eq!(items.len(), 2, "src prefix has two records: {v}");
        for item in items {
            let path = item["path"].as_str().expect("path is string");
            assert!(
                path.starts_with("src/"),
                "drilled item is under src/: {item}"
            );
        }
    }

    /// Numeric band cluster labels are ranges, not raw score values.
    /// Drilling should use the cluster's stored min/max bounds.
    #[test]
    fn bands_cluster_drills_by_numeric_range() {
        let stdin = "{\"score\":0,\"id\":0}\n\
                     {\"score\":1,\"id\":1}\n\
                     {\"score\":2,\"id\":2}\n\
                     {\"score\":3,\"id\":3}\n";
        let (code, envelope, stderr) = drive(
            &[
                "face",
                "--by",
                "score",
                "--strategy=bands=2",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={envelope:?}");
        let v: serde_json::Value = serde_json::from_str(&envelope).expect("parseable envelope");
        let first_cluster = &v["clusters"][0];
        let cluster_id = first_cluster["id"].as_str().expect("cluster id string");
        let lower = first_cluster["value"]["min"].as_f64().expect("band min");
        let upper = first_cluster["value"]["max"].as_f64().expect("band max");
        let expected_total = first_cluster["total"].as_u64().expect("cluster total");

        let (code, stdout, stderr) = drive(
            &[
                "face",
                "--by",
                "score",
                "--strategy=bands=2",
                "--cluster",
                cluster_id,
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let drilled: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        let items = drilled["page"]["items"]
            .as_array()
            .expect("page.items array");
        assert_eq!(
            items.len() as u64,
            expected_total,
            "band drill returns every record in the cluster: {drilled}",
        );
        for item in items {
            let score = item["score"].as_f64().expect("score is numeric");
            assert!(
                (lower..=upper).contains(&score),
                "first rendered band is closed over the global maximum: {item}"
            );
        }
        assert!(
            items
                .iter()
                .any(|item| item["score"].as_f64() == Some(upper)),
            "highest rendered band includes the maximum value: {drilled}",
        );
    }
}

mod envelope_reprocessing {
    use super::drive;

    fn saved_summary_envelope() -> String {
        let stdin = "{\"kind\":\"bug\",\"id\":1}\n\
                     {\"kind\":\"bug\",\"id\":2}\n\
                     {\"kind\":\"feat\",\"id\":3}\n";
        let (code, stdout, stderr) = drive(&["face", "--by", "kind", "--format=json"], stdin);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        stdout
    }

    /// Acceptance: docs/design.md §9 — a saved JSON envelope is
    /// self-consumable and can be re-rendered without re-reading the
    /// original upstream records.
    #[test]
    fn saved_envelope_re_renders_to_markdown() {
        let envelope = saved_summary_envelope();
        let (code, stdout, stderr) = drive(&["face", "--format=markdown", "--verbose"], &envelope);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        assert!(stdout.starts_with("# face"), "markdown heading: {stdout:?}");
        assert!(
            stdout.contains("bug"),
            "saved clusters are rendered: {stdout:?}"
        );
        assert!(
            stderr.contains("from face envelope"),
            "provenance distinguishes re-processing: {stderr:?}",
        );
    }

    /// Acceptance: README "Save once, drill many" — `--cluster` on a
    /// saved summary envelope uses the envelope cache to populate the
    /// page with original records.
    #[test]
    fn saved_summary_envelope_drills_to_cached_items() {
        let envelope = saved_summary_envelope();
        let (code, stdout, stderr) = drive(
            &["face", "--cluster", "kind:bug", "--format=json"],
            &envelope,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        assert_eq!(v["result"]["input_total"].as_u64(), Some(2));
        assert_eq!(v["page"]["cluster_id"].as_str(), Some("kind:bug"));
        assert_eq!(v["page"]["total_items"].as_u64(), Some(2));
        let items = v["page"]["items"].as_array().expect("page.items array");
        assert_eq!(
            items.len(),
            2,
            "summary envelope has cached raw page items: {v}"
        );
        assert_eq!(items[0]["kind"].as_str(), Some("bug"));
        assert_eq!(items[1]["kind"].as_str(), Some("bug"));
    }

    /// Acceptance: README "Drill into a cluster" + "Save once, drill
    /// many" — when stdout is a pipe and no explicit format is passed,
    /// a saved-envelope drill emits original records as JSONL.
    #[test]
    fn saved_summary_envelope_auto_drill_emits_jsonl_items() {
        let envelope = saved_summary_envelope();
        let (code, stdout, stderr) = drive(&["face", "--cluster", "kind:bug"], &envelope);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let lines = stdout.lines().collect::<Vec<_>>();
        assert_eq!(
            lines.len(),
            2,
            "two cached bug records as JSONL: {stdout:?}"
        );
        for line in lines {
            let item: serde_json::Value = serde_json::from_str(line).expect("jsonl item");
            assert_eq!(item["kind"].as_str(), Some("bug"));
        }
    }

    /// Acceptance: README "Save once, drill many" — re-clustering a
    /// saved envelope should use the cached original records, not the
    /// cluster metadata rows.
    #[test]
    fn saved_summary_envelope_reclusters_cached_items() {
        let stdin = "{\"query\":\"TODO\",\"items\":[\
                     {\"kind\":\"bug\",\"tag\":\"ui\"},\
                     {\"kind\":\"bug\",\"tag\":\"backend\"},\
                     {\"kind\":\"feat\",\"tag\":\"ui\"}]}";
        let (code, envelope, stderr) = drive(&["face", "--by", "kind", "--format=json"], stdin);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={envelope:?}");

        let (code, stdout, stderr) =
            drive(&["face", "--within", "tag", "--format=json"], &envelope);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        assert_eq!(v["meta"]["query"].as_str(), Some("TODO"));
        let axes = v["result"]["axes"].as_array().expect("axes array");
        assert_eq!(
            axes.len(),
            2,
            "kind > tag reclustering from cached records: {v}"
        );
        assert_eq!(axes[1]["field"].as_str(), Some("tag"));
        let nested_tag = v["clusters"]
            .as_array()
            .expect("clusters array")
            .iter()
            .flat_map(|cluster| cluster["clusters"].as_array().into_iter().flatten())
            .any(|cluster| cluster["label"].as_str() == Some("ui"));
        assert!(
            nested_tag,
            "cached raw `tag` field is available for reclustering: {v}"
        );
    }

    /// The ordinal cluster shortcut also works when re-processing a
    /// saved envelope because the saved cluster list is the current
    /// rendered tree.
    #[test]
    fn saved_summary_envelope_drills_by_ordinal() {
        let envelope = saved_summary_envelope();
        let (code, stdout, stderr) = drive(&["face", "--cluster", "1", "--format=json"], &envelope);
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        assert_eq!(v["page"]["cluster_id"].as_str(), Some("kind:bug"));
        assert_eq!(v["page"]["total_items"].as_u64(), Some(2));
    }

    /// If the saved envelope already had a populated page for the same
    /// cluster, re-processing preserves those cached page items.
    #[test]
    fn saved_drilled_envelope_reuses_cached_page_items() {
        let stdin = "{\"kind\":\"bug\",\"id\":1}\n\
                     {\"kind\":\"bug\",\"id\":2}\n\
                     {\"kind\":\"feat\",\"id\":3}\n";
        let (code, envelope, stderr) = drive(
            &[
                "face",
                "--by",
                "kind",
                "--cluster",
                "kind:bug",
                "--format=json",
            ],
            stdin,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={envelope:?}");

        let (code, stdout, stderr) = drive(
            &["face", "--cluster", "kind:bug", "--format=json"],
            &envelope,
        );
        assert_eq!(code, 0, "stderr={stderr:?} stdout={stdout:?}");
        let v: serde_json::Value = serde_json::from_str(&stdout).expect("parseable envelope");
        let items = v["page"]["items"].as_array().expect("page.items array");
        assert_eq!(items.len(), 2, "cached page items survive: {v}");
        assert_eq!(items[0]["kind"].as_str(), Some("bug"));
        assert_eq!(items[1]["kind"].as_str(), Some("bug"));
    }
}