tokmd-format 1.10.0

Output formatting and serialization (Markdown, JSON, CSV) for tokmd.
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
//! Deep tests for diff computation: DiffRow construction, DiffReceipt,
//! self-diff, added-only, removed-only, mixed changes, zero-change,
//! large diff, schema version, determinism, and JSON validity.

use serde_json::Value;
use tokmd_format::{compute_diff_rows, compute_diff_totals, create_diff_receipt};
use tokmd_types::{
    ChildrenMode, DiffReceipt, DiffRow, DiffTotals, LangReport, LangRow, SCHEMA_VERSION, Totals,
};

// =============================================================================
// Helpers
// =============================================================================

fn make_lang_row(lang: &str, code: usize, lines: usize, files: usize) -> LangRow {
    LangRow {
        lang: lang.to_string(),
        code,
        lines,
        files,
        bytes: code * 40,
        tokens: code * 3,
        avg_lines: lines.checked_div(files).unwrap_or(0),
    }
}

fn make_report(rows: Vec<LangRow>) -> LangReport {
    let total = Totals {
        code: rows.iter().map(|r| r.code).sum(),
        lines: rows.iter().map(|r| r.lines).sum(),
        files: rows.iter().map(|r| r.files).sum(),
        bytes: rows.iter().map(|r| r.bytes).sum(),
        tokens: rows.iter().map(|r| r.tokens).sum(),
        avg_lines: 0,
    };
    LangReport {
        rows,
        total,
        with_files: false,
        children: ChildrenMode::Collapse,
        top: 0,
    }
}

fn empty_report() -> LangReport {
    make_report(vec![])
}

// =============================================================================
// Self-diff: same input twice
// =============================================================================

#[test]
fn self_diff_produces_no_rows() {
    let report = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let rows = compute_diff_rows(&report, &report);
    // Identical reports produce no diff rows (zero-delta rows are filtered out)
    assert!(rows.is_empty(), "self-diff should produce no rows");
}

#[test]
fn self_diff_totals_all_zero_deltas() {
    let report = make_report(vec![make_lang_row("Rust", 500, 700, 10)]);
    let rows = compute_diff_rows(&report, &report);
    let totals = compute_diff_totals(&rows);
    assert_eq!(totals.delta_code, 0);
    assert_eq!(totals.delta_lines, 0);
    assert_eq!(totals.delta_files, 0);
    assert_eq!(totals.delta_bytes, 0);
    assert_eq!(totals.delta_tokens, 0);
}

#[test]
fn self_diff_produces_empty_result() {
    let report = make_report(vec![make_lang_row("Rust", 500, 700, 10)]);
    let rows = compute_diff_rows(&report, &report);
    // Identical reports are filtered out (zero-delta rows excluded)
    assert!(rows.is_empty(), "self-diff should produce empty rows");
}

// =============================================================================
// Added-only diff: new languages appear
// =============================================================================

#[test]
fn added_only_diff_shows_new_language() {
    let from = empty_report();
    let to = make_report(vec![make_lang_row("Rust", 100, 150, 3)]);
    let rows = compute_diff_rows(&from, &to);
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].lang, "Rust");
    assert_eq!(rows[0].old_code, 0);
    assert_eq!(rows[0].new_code, 100);
    assert_eq!(rows[0].delta_code, 100);
}

#[test]
fn added_only_totals_match_new_report() {
    let from = empty_report();
    let to = make_report(vec![
        make_lang_row("Rust", 100, 150, 3),
        make_lang_row("TOML", 20, 25, 2),
    ]);
    let rows = compute_diff_rows(&from, &to);
    let totals = compute_diff_totals(&rows);
    assert_eq!(totals.new_code, 120);
    assert_eq!(totals.old_code, 0);
    assert_eq!(totals.delta_code, 120);
}

// =============================================================================
// Removed-only diff: languages disappear
// =============================================================================

#[test]
fn removed_only_diff_shows_removed_language() {
    let from = make_report(vec![make_lang_row("Python", 200, 300, 5)]);
    let to = empty_report();
    let rows = compute_diff_rows(&from, &to);
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].lang, "Python");
    assert_eq!(rows[0].old_code, 200);
    assert_eq!(rows[0].new_code, 0);
    assert_eq!(rows[0].delta_code, -200);
}

#[test]
fn removed_only_totals_show_negative_delta() {
    let from = make_report(vec![make_lang_row("Python", 200, 300, 5)]);
    let to = empty_report();
    let rows = compute_diff_rows(&from, &to);
    let totals = compute_diff_totals(&rows);
    assert!(totals.delta_code < 0);
    assert_eq!(totals.delta_code, -200);
}

// =============================================================================
// Mixed changes: additions, removals, modifications
// =============================================================================

#[test]
fn mixed_diff_shows_all_languages() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let to = make_report(vec![
        make_lang_row("Rust", 600, 800, 12),
        make_lang_row("Go", 100, 150, 3),
    ]);
    let rows = compute_diff_rows(&from, &to);
    let langs: Vec<&str> = rows.iter().map(|r| r.lang.as_str()).collect();
    assert!(langs.contains(&"Rust"), "modified language should appear");
    assert!(langs.contains(&"Python"), "removed language should appear");
    assert!(langs.contains(&"Go"), "added language should appear");
}

#[test]
fn mixed_diff_deltas_correct() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let to = make_report(vec![
        make_lang_row("Rust", 600, 800, 12),
        make_lang_row("Go", 100, 150, 3),
    ]);
    let rows = compute_diff_rows(&from, &to);
    let rust_row = rows
        .iter()
        .find(|r| r.lang == "Rust")
        .expect("operation must succeed");
    assert_eq!(rust_row.delta_code, 100);

    let python_row = rows
        .iter()
        .find(|r| r.lang == "Python")
        .expect("operation must succeed");
    assert_eq!(python_row.delta_code, -200);

    let go_row = rows
        .iter()
        .find(|r| r.lang == "Go")
        .expect("operation must succeed");
    assert_eq!(go_row.delta_code, 100);
}

// =============================================================================
// Zero-change diff: both empty
// =============================================================================

#[test]
fn zero_change_diff_empty_reports() {
    let from = empty_report();
    let to = empty_report();
    let rows = compute_diff_rows(&from, &to);
    assert!(
        rows.is_empty(),
        "empty-to-empty diff should produce no rows"
    );
}

#[test]
fn zero_change_diff_totals_all_zero() {
    let rows: Vec<DiffRow> = vec![];
    let totals = compute_diff_totals(&rows);
    assert_eq!(totals, DiffTotals::default());
}

// =============================================================================
// Large diff
// =============================================================================

#[test]
fn large_diff_many_languages() {
    let from_rows: Vec<LangRow> = (0..50)
        .map(|i| make_lang_row(&format!("Lang{i}"), i * 10, i * 15, i.max(1)))
        .collect();
    let to_rows: Vec<LangRow> = (25..75)
        .map(|i| make_lang_row(&format!("Lang{i}"), i * 12, i * 18, i.max(1)))
        .collect();
    let from = make_report(from_rows);
    let to = make_report(to_rows);
    let rows = compute_diff_rows(&from, &to);

    // Should contain all unique languages from both
    assert!(rows.len() >= 50, "should have at least 50 unique languages");
    assert!(rows.len() <= 75, "should have at most 75 unique languages");

    // Verify totals are consistent
    let totals = compute_diff_totals(&rows);
    assert_eq!(
        totals.delta_code,
        totals.new_code as i64 - totals.old_code as i64
    );
}

// =============================================================================
// DiffReceipt construction
// =============================================================================

#[test]
fn diff_receipt_schema_version_matches_constant() {
    let receipt = create_diff_receipt("from.json", "to.json", vec![], DiffTotals::default());
    assert_eq!(receipt.schema_version, SCHEMA_VERSION);
}

#[test]
fn diff_receipt_mode_is_diff() {
    let receipt = create_diff_receipt("a", "b", vec![], DiffTotals::default());
    assert_eq!(receipt.mode, "diff");
}

#[test]
fn diff_receipt_sources_preserved() {
    let receipt = create_diff_receipt(
        "run1/receipt.json",
        "run2/receipt.json",
        vec![],
        DiffTotals::default(),
    );
    assert_eq!(receipt.from_source, "run1/receipt.json");
    assert_eq!(receipt.to_source, "run2/receipt.json");
}

#[test]
fn diff_receipt_tool_info_present() {
    let receipt = create_diff_receipt("a", "b", vec![], DiffTotals::default());
    assert_eq!(receipt.tool.name, "tokmd");
    assert!(!receipt.tool.version.is_empty());
}

#[test]
fn diff_receipt_generated_at_ms_nonzero() {
    let receipt = create_diff_receipt("a", "b", vec![], DiffTotals::default());
    assert!(receipt.generated_at_ms > 0);
}

// =============================================================================
// JSON output validity
// =============================================================================

#[test]
fn diff_receipt_json_valid() {
    let from = make_report(vec![make_lang_row("Rust", 500, 700, 10)]);
    let to = make_report(vec![make_lang_row("Rust", 600, 800, 12)]);
    let rows = compute_diff_rows(&from, &to);
    let totals = compute_diff_totals(&rows);
    let receipt = create_diff_receipt("from.json", "to.json", rows, totals);
    let json_str = serde_json::to_string_pretty(&receipt).expect("operation must succeed");
    let val: Value = serde_json::from_str(&json_str).expect("operation must succeed");

    assert_eq!(val["schema_version"], SCHEMA_VERSION);
    assert_eq!(val["mode"], "diff");
    assert!(val["diff_rows"].is_array());
    assert!(val["totals"].is_object());
    assert!(val["tool"].is_object());
}

#[test]
fn diff_receipt_json_has_all_required_keys() {
    let receipt = create_diff_receipt("a", "b", vec![], DiffTotals::default());
    let val: Value = serde_json::to_value(receipt).expect("operation must succeed");
    for key in &[
        "schema_version",
        "generated_at_ms",
        "tool",
        "mode",
        "from_source",
        "to_source",
        "diff_rows",
        "totals",
    ] {
        assert!(val.get(key).is_some(), "missing key: {key}");
    }
}

// =============================================================================
// Deterministic output
// =============================================================================

#[test]
fn diff_rows_deterministic_order() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
        make_lang_row("Go", 100, 150, 3),
    ]);
    let to = make_report(vec![
        make_lang_row("Go", 120, 180, 4),
        make_lang_row("Rust", 550, 750, 11),
        make_lang_row("Python", 210, 310, 5),
    ]);
    let rows1 = compute_diff_rows(&from, &to);
    let rows2 = compute_diff_rows(&from, &to);

    let langs1: Vec<&str> = rows1.iter().map(|r| r.lang.as_str()).collect();
    let langs2: Vec<&str> = rows2.iter().map(|r| r.lang.as_str()).collect();
    assert_eq!(langs1, langs2, "diff row order should be deterministic");
}

#[test]
fn diff_rows_sorted_alphabetically() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Go", 100, 150, 3),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let to = make_report(vec![
        make_lang_row("Rust", 550, 750, 11),
        make_lang_row("Go", 120, 180, 4),
        make_lang_row("Python", 210, 310, 5),
    ]);
    let rows = compute_diff_rows(&from, &to);
    let langs: Vec<&str> = rows.iter().map(|r| r.lang.as_str()).collect();
    let mut sorted = langs.clone();
    sorted.sort();
    assert_eq!(langs, sorted, "diff rows should be sorted by language name");
}

// =============================================================================
// DiffRow serde roundtrip
// =============================================================================

#[test]
fn diff_row_serde_roundtrip() {
    let row = DiffRow {
        lang: "Rust".to_string(),
        old_code: 100,
        new_code: 120,
        delta_code: 20,
        old_lines: 200,
        new_lines: 220,
        delta_lines: 20,
        old_files: 10,
        new_files: 11,
        delta_files: 1,
        old_bytes: 5000,
        new_bytes: 6000,
        delta_bytes: 1000,
        old_tokens: 250,
        new_tokens: 300,
        delta_tokens: 50,
    };
    let json = serde_json::to_string(&row).expect("operation must succeed");
    let back: DiffRow = serde_json::from_str(&json).expect("must parse valid JSON");
    assert_eq!(back, row);
}

#[test]
fn diff_totals_default_is_all_zeros() {
    let t = DiffTotals::default();
    assert_eq!(t.old_code, 0);
    assert_eq!(t.new_code, 0);
    assert_eq!(t.delta_code, 0);
    assert_eq!(t.old_lines, 0);
    assert_eq!(t.new_lines, 0);
    assert_eq!(t.delta_lines, 0);
}

#[test]
fn diff_totals_serde_roundtrip() {
    let t = DiffTotals {
        old_code: 500,
        new_code: 600,
        delta_code: 100,
        old_lines: 700,
        new_lines: 800,
        delta_lines: 100,
        old_files: 10,
        new_files: 12,
        delta_files: 2,
        old_bytes: 20000,
        new_bytes: 24000,
        delta_bytes: 4000,
        old_tokens: 1500,
        new_tokens: 1800,
        delta_tokens: 300,
    };
    let json = serde_json::to_string(&t).expect("operation must succeed");
    let back: DiffTotals = serde_json::from_str(&json).expect("must parse valid JSON");
    assert_eq!(back, t);
}

// =============================================================================
// DiffReceipt serde roundtrip
// =============================================================================

#[test]
fn diff_receipt_serde_roundtrip() {
    let from = make_report(vec![make_lang_row("Rust", 500, 700, 10)]);
    let to = make_report(vec![make_lang_row("Rust", 600, 800, 12)]);
    let rows = compute_diff_rows(&from, &to);
    let totals = compute_diff_totals(&rows);
    let receipt = create_diff_receipt("from.json", "to.json", rows, totals);

    let json_str = serde_json::to_string(&receipt).expect("operation must succeed");
    let back: DiffReceipt = serde_json::from_str(&json_str).expect("operation must succeed");
    assert_eq!(back.schema_version, receipt.schema_version);
    assert_eq!(back.mode, receipt.mode);
    assert_eq!(back.from_source, receipt.from_source);
    assert_eq!(back.to_source, receipt.to_source);
    assert_eq!(back.diff_rows.len(), receipt.diff_rows.len());
    assert_eq!(back.totals, receipt.totals);
}

// =============================================================================
// Totals consistency
// =============================================================================

#[test]
fn diff_totals_delta_equals_new_minus_old() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let to = make_report(vec![
        make_lang_row("Rust", 600, 800, 12),
        make_lang_row("Go", 100, 150, 3),
    ]);
    let rows = compute_diff_rows(&from, &to);
    let totals = compute_diff_totals(&rows);
    assert_eq!(
        totals.delta_code,
        totals.new_code as i64 - totals.old_code as i64
    );
    assert_eq!(
        totals.delta_lines,
        totals.new_lines as i64 - totals.old_lines as i64
    );
    assert_eq!(
        totals.delta_files,
        totals.new_files as i64 - totals.old_files as i64
    );
    assert_eq!(
        totals.delta_bytes,
        totals.new_bytes as i64 - totals.old_bytes as i64
    );
    assert_eq!(
        totals.delta_tokens,
        totals.new_tokens as i64 - totals.old_tokens as i64
    );
}

// =============================================================================
// Row-level delta consistency
// =============================================================================

#[test]
fn each_diff_row_delta_equals_new_minus_old() {
    let from = make_report(vec![
        make_lang_row("Rust", 500, 700, 10),
        make_lang_row("Python", 200, 300, 5),
    ]);
    let to = make_report(vec![
        make_lang_row("Rust", 600, 800, 12),
        make_lang_row("Python", 180, 280, 4),
    ]);
    let rows = compute_diff_rows(&from, &to);
    for row in &rows {
        assert_eq!(
            row.delta_code,
            row.new_code as i64 - row.old_code as i64,
            "{}: delta_code mismatch",
            row.lang
        );
        assert_eq!(
            row.delta_lines,
            row.new_lines as i64 - row.old_lines as i64,
            "{}: delta_lines mismatch",
            row.lang
        );
        assert_eq!(
            row.delta_files,
            row.new_files as i64 - row.old_files as i64,
            "{}: delta_files mismatch",
            row.lang
        );
    }
}