tokmd-analysis 1.10.0

Analysis logic and enrichers for tokmd receipts.
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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
//! Additional deep tests for topic-cloud extraction.
//!
//! Covers serialization roundtrips, empty input, single/multi-language repos,
//! keyword frequency accumulation, module root stopwords, and edge cases.

use crate::topics::build_topic_clouds;
use tokmd_analysis_types::{TopicClouds, TopicTerm};
use tokmd_types::{ChildIncludeMode, ExportData, FileKind, FileRow};

// ── Helpers ─────────────────────────────────────────────────────

fn row(path: &str, module: &str, lang: &str, tokens: usize) -> FileRow {
    FileRow {
        path: path.to_string(),
        module: module.to_string(),
        lang: lang.to_string(),
        kind: FileKind::Parent,
        code: 10,
        comments: 0,
        blanks: 0,
        lines: 10,
        bytes: 100,
        tokens,
    }
}

fn export(rows: Vec<FileRow>, roots: &[&str]) -> ExportData {
    ExportData {
        rows,
        module_roots: roots.iter().map(|r| r.to_string()).collect(),
        module_depth: 1,
        children: ChildIncludeMode::Separate,
    }
}

fn overall_terms(data: &ExportData) -> Vec<String> {
    build_topic_clouds(data)
        .overall
        .iter()
        .map(|e| e.term.clone())
        .collect()
}

// ── 1. Empty export produces empty topic clouds ─────────────────

#[test]
fn empty_export_produces_empty_clouds() {
    let data = export(vec![], &[]);
    let clouds = build_topic_clouds(&data);

    assert!(clouds.overall.is_empty());
    assert!(clouds.per_module.is_empty());
}

// ── 2. TopicClouds serialization roundtrip ──────────────────────

#[test]
fn topic_clouds_serialization_roundtrip() {
    let data = export(
        vec![
            row("auth/login.rs", "auth", "Rust", 50),
            row("auth/token.rs", "auth", "Rust", 100),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let json = serde_json::to_string_pretty(&clouds).unwrap();
    let back: TopicClouds = serde_json::from_str(&json).unwrap();

    assert_eq!(clouds.overall.len(), back.overall.len());
    assert_eq!(clouds.per_module.len(), back.per_module.len());
    for (orig, deser) in clouds.overall.iter().zip(back.overall.iter()) {
        assert_eq!(orig.term, deser.term);
        assert!((orig.score - deser.score).abs() < 1e-10);
        assert_eq!(orig.tf, deser.tf);
        assert_eq!(orig.df, deser.df);
    }
}

// ── 3. TopicTerm serialization roundtrip ────────────────────────

#[test]
fn topic_term_serialization_roundtrip() {
    let term = TopicTerm {
        term: "widget".to_string(),
        score: 42.5,
        tf: 10,
        df: 3,
    };
    let json = serde_json::to_string(&term).unwrap();
    let back: TopicTerm = serde_json::from_str(&json).unwrap();

    assert_eq!(back.term, "widget");
    assert!((back.score - 42.5).abs() < 1e-10);
    assert_eq!(back.tf, 10);
    assert_eq!(back.df, 3);
}

// ── 4. Single language repo has correct per-module entries ──────

#[test]
fn single_language_repo_has_module_entries() {
    let data = export(
        vec![
            row("core/engine.rs", "core", "Rust", 100),
            row("core/parser.rs", "core", "Rust", 200),
            row("utils/helper.rs", "utils", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    assert!(clouds.per_module.contains_key("core"));
    assert!(clouds.per_module.contains_key("utils"));
    assert_eq!(clouds.per_module.len(), 2);
}

// ── 5. Multi-language repo: terms from all languages ────────────

#[test]
fn multi_language_repo_extracts_terms_from_all_languages() {
    let data = export(
        vec![
            row("backend/api_handler.rs", "backend", "Rust", 100),
            row("frontend/component_view.js", "frontend", "JavaScript", 100),
            row("scripts/deploy_tool.py", "scripts", "Python", 100),
        ],
        &[],
    );
    let terms = overall_terms(&data);

    assert!(terms.contains(&"api".to_string()) || terms.contains(&"handler".to_string()));
    assert!(terms.contains(&"component".to_string()) || terms.contains(&"view".to_string()));
    assert!(terms.contains(&"deploy".to_string()) || terms.contains(&"tool".to_string()));
}

// ── 6. Child rows are excluded from topic extraction ────────────

#[test]
fn child_rows_excluded() {
    let rows = vec![
        row("mod/feature.rs", "mod", "Rust", 100),
        FileRow {
            path: "mod/embedded.js".to_string(),
            module: "mod".to_string(),
            lang: "JavaScript".to_string(),
            kind: FileKind::Child,
            code: 10,
            comments: 0,
            blanks: 0,
            lines: 10,
            bytes: 100,
            tokens: 50,
        },
    ];
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);

    // "embedded" should not appear since it's a Child row
    let all_terms: Vec<String> = clouds.overall.iter().map(|t| t.term.clone()).collect();
    assert!(
        !all_terms.contains(&"embedded".to_string()),
        "child rows should be excluded from topic extraction"
    );
}

// ── 7. Module roots are treated as stopwords ────────────────────

#[test]
fn module_roots_are_stopwords() {
    let data = export(
        vec![row("myproject/auth/login.rs", "myproject/auth", "Rust", 50)],
        &["myproject"],
    );
    let terms = overall_terms(&data);

    assert!(
        !terms.contains(&"myproject".to_string()),
        "module roots should be stopwords: {terms:?}"
    );
}

// ── 8. Weight proportional to token count ───────────────────────

#[test]
fn higher_token_count_produces_higher_tf() {
    let data = export(
        vec![
            row("m/heavy_feature.rs", "m", "Rust", 1000),
            row("m/light_feature.rs", "m", "Rust", 10),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let m_terms = clouds.per_module.get("m").expect("module 'm'");

    let heavy = m_terms.iter().find(|t| t.term == "heavy");
    let light = m_terms.iter().find(|t| t.term == "light");

    if let (Some(h), Some(l)) = (heavy, light) {
        assert!(
            h.tf > l.tf,
            "heavy ({}) should have higher tf than light ({})",
            h.tf,
            l.tf
        );
    }
}

// ── 9. Zero-token file uses weight of 1 ─────────────────────────

#[test]
fn zero_token_file_uses_minimum_weight() {
    let data = export(vec![row("m/empty_weight.rs", "m", "Rust", 0)], &[]);
    let clouds = build_topic_clouds(&data);
    let m_terms = clouds.per_module.get("m").expect("module 'm'");

    // With weight clamped to max(tokens, 1) = 1, terms should still exist
    let empty_term = m_terms.iter().find(|t| t.term == "empty");
    if let Some(t) = empty_term {
        assert_eq!(t.tf, 1, "zero-token file should use weight of 1");
    }
}

// ── 10. Overall terms sorted by score desc ──────────────────────

#[test]
fn overall_terms_sorted_by_score_descending() {
    let data = export(
        vec![
            row("a/feature_one.rs", "a", "Rust", 100),
            row("b/feature_two.rs", "b", "Rust", 200),
            row("c/feature_three.rs", "c", "Rust", 300),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    for window in clouds.overall.windows(2) {
        assert!(
            window[0].score >= window[1].score
                || (window[0].score - window[1].score).abs() < f64::EPSILON,
            "overall terms not sorted by score desc: {} < {}",
            window[0].score,
            window[1].score
        );
    }
}

// ── 11. Per-module terms sorted by score desc ───────────────────

#[test]
fn per_module_terms_sorted_by_score_descending() {
    let rows: Vec<FileRow> = (0..15)
        .map(|i| row(&format!("m/item{i}_feature.rs"), "m", "Rust", (i + 1) * 50))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);

    for terms in clouds.per_module.values() {
        for window in terms.windows(2) {
            assert!(
                window[0].score >= window[1].score
                    || (window[0].score - window[1].score).abs() < f64::EPSILON,
                "per-module terms not sorted by score desc"
            );
        }
    }
}

// ── 12. TOP_K=8 limit applied per module ────────────────────────

#[test]
fn top_k_limit_applied_per_module() {
    let rows: Vec<FileRow> = (0..30)
        .map(|i| row(&format!("m/term{i}.rs"), "m", "Rust", (i + 1) * 10))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);

    let m_terms = clouds.per_module.get("m").expect("module 'm'");
    assert!(
        m_terms.len() <= 8,
        "per-module terms should be capped at TOP_K=8, got {}",
        m_terms.len()
    );
}

// ── 13. TOP_K=8 limit applied to overall ────────────────────────

#[test]
fn top_k_limit_applied_to_overall() {
    let rows: Vec<FileRow> = (0..30)
        .map(|i| row(&format!("m/term{i}.rs"), "m", "Rust", (i + 1) * 10))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);

    assert!(
        clouds.overall.len() <= 8,
        "overall terms should be capped at TOP_K=8, got {}",
        clouds.overall.len()
    );
}

// ── 14. IDF calculation: ln((N+1)/(df+1)) + 1 ──────────────────

#[test]
fn idf_formula_correctness() {
    // 3 modules, term appears in 1 module
    let data = export(
        vec![
            row("a/unique_term.rs", "a", "Rust", 100),
            row("b/other.rs", "b", "Rust", 100),
            row("c/another.rs", "c", "Rust", 100),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    let unique = clouds.overall.iter().find(|t| t.term == "unique");
    if let Some(u) = unique {
        // IDF = ln((3+1)/(1+1)) + 1 = ln(2) + 1 ≈ 1.693
        // TF = weight_for_row = 100 tokens
        // Score = 100 * (ln(2) + 1) ≈ 169.3
        let expected_idf = (4.0_f64 / 2.0).ln() + 1.0;
        let expected_score = 100.0 * expected_idf;
        assert!(
            (u.score - expected_score).abs() < 0.1,
            "expected score ~{expected_score}, got {}",
            u.score
        );
    }
}

// ── 15. Determinism across multiple runs ────────────────────────

#[test]
fn multiple_runs_produce_identical_results() {
    let data = export(
        vec![
            row("api/handler.rs", "api", "Rust", 100),
            row("api/router.rs", "api", "Rust", 200),
            row("db/query.rs", "db", "Rust", 150),
            row("db/migration.rs", "db", "Rust", 50),
        ],
        &[],
    );

    let results: Vec<TopicClouds> = (0..5).map(|_| build_topic_clouds(&data)).collect();

    for i in 1..5 {
        assert_eq!(results[0].overall.len(), results[i].overall.len());
        for (a, b) in results[0].overall.iter().zip(results[i].overall.iter()) {
            assert_eq!(a.term, b.term);
            assert!((a.score - b.score).abs() < f64::EPSILON);
            assert_eq!(a.tf, b.tf);
            assert_eq!(a.df, b.df);
        }
    }
}

// ── 16. Paths with only stopwords produce no terms ──────────────

#[test]
fn path_with_only_stopwords_produces_no_terms() {
    let data = export(
        vec![row("src/lib/mod/index.rs", "src/lib", "Rust", 50)],
        &[],
    );
    let terms = overall_terms(&data);

    // All segments are stopwords: src, lib, mod, index, rs
    assert!(
        terms.is_empty(),
        "path with only stopwords should produce no terms: {terms:?}"
    );
}

// ── 17. Score always positive for valid terms ───────────────────

#[test]
fn score_always_positive() {
    let data = export(
        vec![
            row("a/widget.rs", "a", "Rust", 100),
            row("b/gadget.rs", "b", "Rust", 200),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    for term in &clouds.overall {
        assert!(
            term.score > 0.0,
            "score should be positive for '{}'",
            term.term
        );
    }
    for terms in clouds.per_module.values() {
        for term in terms {
            assert!(
                term.score > 0.0,
                "per-module score should be positive for '{}'",
                term.term
            );
        }
    }
}

// ── 18. TF is always positive ───────────────────────────────────

#[test]
fn tf_always_positive() {
    let data = export(
        vec![
            row("m/feature.rs", "m", "Rust", 1),
            row("n/another.rs", "n", "Rust", 1),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    for term in &clouds.overall {
        assert!(term.tf > 0, "tf should be positive for '{}'", term.term);
    }
}

// ── 19. DF is at least 1 for any present term ───────────────────

#[test]
fn df_at_least_one() {
    let data = export(
        vec![
            row("a/widget.rs", "a", "Rust", 100),
            row("b/gadget.rs", "b", "Rust", 200),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    for term in &clouds.overall {
        assert!(term.df >= 1, "df should be >= 1 for '{}'", term.term);
    }
}

// ── 20. Many modules with same term: df tracks file count ───────

#[test]
fn df_tracks_file_count_across_modules() {
    let rows: Vec<FileRow> = (0..10)
        .map(|i| {
            row(
                &format!("mod_{i}/shared_widget.rs"),
                &format!("mod_{i}"),
                "Rust",
                50,
            )
        })
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);

    let shared = clouds.overall.iter().find(|t| t.term == "shared");
    if let Some(s) = shared {
        assert_eq!(s.df, 10, "shared term should have df=10 across 10 files");
    }
}

// ── 21. Unicode path segments are lowercased ────────────────────

#[test]
fn unicode_path_segments_lowercased() {
    let data = export(
        vec![row("UPPER/CamelCase_Feature.rs", "UPPER", "Rust", 50)],
        &[],
    );
    let terms = overall_terms(&data);

    for term in &terms {
        assert_eq!(*term, term.to_lowercase(), "'{term}' should be lowercase");
    }
}

// ── 22. Empty path segments ignored ─────────────────────────────

#[test]
fn empty_path_segments_ignored() {
    let data = export(
        vec![row(
            "///double//slash///file.rs",
            "///double//slash",
            "Rust",
            50,
        )],
        &[],
    );
    let terms = overall_terms(&data);

    for term in &terms {
        assert!(!term.is_empty(), "empty terms should not appear");
    }
}

// ── 23. Single file with many terms truncated by TOP_K ──────────

#[test]
fn single_file_many_segments_truncated() {
    // Path with many unique segments (>8)
    let data = export(
        vec![row(
            "alpha/bravo/charlie/delta/echo/foxtrot/golf/hotel/india/juliet/kilo.rs",
            "alpha/bravo",
            "Rust",
            50,
        )],
        &[],
    );
    let clouds = build_topic_clouds(&data);

    assert!(
        clouds.overall.len() <= 8,
        "should be capped at TOP_K=8 even with many path segments, got {}",
        clouds.overall.len()
    );
}

// ── 24. Per-module and overall agree on single-module data ──────

#[test]
fn single_module_overall_matches_per_module() {
    let data = export(
        vec![
            row("m/alpha_feature.rs", "m", "Rust", 100),
            row("m/beta_feature.rs", "m", "Rust", 200),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let overall = &clouds.overall;
    let per_mod = clouds.per_module.get("m").expect("module 'm'");

    // With single module, overall and per_module should have same terms
    assert_eq!(overall.len(), per_mod.len());
    for (o, p) in overall.iter().zip(per_mod.iter()) {
        assert_eq!(o.term, p.term);
        assert!((o.score - p.score).abs() < f64::EPSILON);
    }
}

// ── 25. Serialization roundtrip preserves per_module keys ───────

#[test]
fn serialization_preserves_per_module_keys() {
    let data = export(
        vec![
            row("alpha/widget.rs", "alpha", "Rust", 50),
            row("beta/gadget.rs", "beta", "Rust", 50),
            row("gamma/tool.rs", "gamma", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let json = serde_json::to_string(&clouds).unwrap();
    let back: TopicClouds = serde_json::from_str(&json).unwrap();

    let orig_keys: Vec<&String> = clouds.per_module.keys().collect();
    let back_keys: Vec<&String> = back.per_module.keys().collect();
    assert_eq!(orig_keys, back_keys);
}