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
//! Deep W68 tests for topic-cloud extraction.
//!
//! Covers: single-language repos, multi-language repos, TF-IDF scoring,
//! deterministic ordering, stopword filtering, edge cases (empty, single file),
//! module-level isolation, TOP_K truncation, and token weighting.

use crate::topics::build_topic_clouds;
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 child_row(path: &str, module: &str) -> FileRow {
    FileRow {
        path: path.to_string(),
        module: module.to_string(),
        lang: "Rust".to_string(),
        kind: FileKind::Child,
        code: 5,
        comments: 0,
        blanks: 0,
        lines: 5,
        bytes: 50,
        tokens: 25,
    }
}

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

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

// ── 1. Empty export produces empty 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. Single file single module ────────────────────────────────

#[test]
fn single_file_produces_topic() {
    let data = export(vec![row("auth/login_handler.rs", "auth", "Rust", 100)], &[]);
    let clouds = build_topic_clouds(&data);
    assert!(!clouds.overall.is_empty());
    let terms = overall_terms(&data);
    assert!(terms.contains(&"login".to_string()));
    assert!(terms.contains(&"handler".to_string()));
}

// ── 3. Stopwords are filtered ───────────────────────────────────

#[test]
fn stopwords_filtered_from_topics() {
    let data = export(
        vec![row("src/lib/mod/main/index.rs", "app", "Rust", 50)],
        &[],
    );
    let terms = overall_terms(&data);
    assert!(!terms.contains(&"src".to_string()));
    assert!(!terms.contains(&"lib".to_string()));
    assert!(!terms.contains(&"mod".to_string()));
    assert!(!terms.contains(&"main".to_string()));
    assert!(!terms.contains(&"index".to_string()));
}

// ── 4. File extensions are filtered ─────────────────────────────

#[test]
fn file_extensions_filtered() {
    let data = export(vec![row("utils/parser.rs", "utils", "Rust", 50)], &[]);
    let terms = overall_terms(&data);
    assert!(!terms.contains(&"rs".to_string()));
    assert!(terms.contains(&"parser".to_string()));
}

// ── 5. Module roots become stopwords ────────────────────────────

#[test]
fn module_roots_become_stopwords() {
    let data = export(
        vec![row("crates/auth/login.rs", "crates/auth", "Rust", 50)],
        &["crates"],
    );
    let terms = overall_terms(&data);
    assert!(!terms.contains(&"crates".to_string()));
    assert!(terms.contains(&"auth".to_string()));
}

// ── 6. Deterministic ordering across runs ───────────────────────

#[test]
fn topic_ordering_is_deterministic() {
    let rows = vec![
        row("api/routes/users.rs", "api", "Rust", 100),
        row("api/routes/orders.rs", "api", "Rust", 100),
        row("api/routes/products.rs", "api", "Rust", 100),
    ];
    let data = export(rows, &[]);
    let t1 = build_topic_clouds(&data);
    let t2 = build_topic_clouds(&data);

    let terms1: Vec<String> = t1.overall.iter().map(|t| t.term.clone()).collect();
    let terms2: Vec<String> = t2.overall.iter().map(|t| t.term.clone()).collect();
    assert_eq!(terms1, terms2);
}

// ── 7. Multi-module topics are isolated ─────────────────────────

#[test]
fn per_module_topics_isolated() {
    let data = export(
        vec![
            row("auth/login.rs", "auth", "Rust", 50),
            row("auth/token.rs", "auth", "Rust", 50),
            row("billing/invoice.rs", "billing", "Rust", 50),
            row("billing/payment.rs", "billing", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let auth_terms: Vec<String> = clouds
        .per_module
        .get("auth")
        .unwrap()
        .iter()
        .map(|t| t.term.clone())
        .collect();
    let billing_terms: Vec<String> = clouds
        .per_module
        .get("billing")
        .unwrap()
        .iter()
        .map(|t| t.term.clone())
        .collect();

    assert!(auth_terms.contains(&"login".to_string()));
    assert!(auth_terms.contains(&"token".to_string()));
    assert!(billing_terms.contains(&"invoice".to_string()));
    assert!(billing_terms.contains(&"payment".to_string()));
    // Cross-module terms should not leak
    assert!(!auth_terms.contains(&"invoice".to_string()));
    assert!(!billing_terms.contains(&"login".to_string()));
}

// ── 8. Child rows are excluded ──────────────────────────────────

#[test]
fn child_rows_excluded_from_topics() {
    let data = export(
        vec![
            row("app/server.rs", "app", "Rust", 50),
            child_row("app/embedded.js", "app"),
        ],
        &[],
    );
    let terms = overall_terms(&data);
    assert!(terms.contains(&"server".to_string()));
    assert!(!terms.contains(&"embedded".to_string()));
}

// ── 9. Score is positive for valid terms ────────────────────────

#[test]
fn scores_are_positive() {
    let data = export(vec![row("core/engine.rs", "core", "Rust", 100)], &[]);
    let clouds = build_topic_clouds(&data);
    for term in &clouds.overall {
        assert!(term.score > 0.0, "score should be positive: {:?}", term);
    }
}

// ── 10. TF field equals token weight sum ────────────────────────

#[test]
fn tf_reflects_token_weight() {
    let data = export(
        vec![
            row("api/handler.rs", "api", "Rust", 100),
            row("api/handler_utils.rs", "api", "Rust", 200),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let handler_term = clouds
        .overall
        .iter()
        .find(|t| t.term == "handler")
        .expect("handler term should exist");
    // handler appears in both files, tf = weight(file1) + weight(file2) = 100 + 200
    assert_eq!(handler_term.tf, 300);
}

// ── 11. DF counts files where term appears ──────────────────────

#[test]
fn df_counts_files_where_term_appears() {
    let data = export(
        vec![
            row("api/handler.rs", "api", "Rust", 50),
            row("api/handler_v2.rs", "api", "Rust", 50),
            row("core/handler.rs", "core", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let handler_term = clouds
        .overall
        .iter()
        .find(|t| t.term == "handler")
        .expect("handler term should exist");
    // "handler" appears in 3 files (df incremented per file)
    assert_eq!(handler_term.df, 3);
}

// ── 12. TOP_K truncation (max 8 terms per module) ───────────────

#[test]
fn top_k_truncation_per_module() {
    let rows: Vec<FileRow> = (0..20)
        .map(|i| row(&format!("mod/term{i}.rs"), "mod", "Rust", 50))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);
    let mod_terms = clouds.per_module.get("mod").unwrap();
    assert!(
        mod_terms.len() <= 8,
        "per-module should be truncated to TOP_K=8"
    );
}

// ── 13. TOP_K truncation on overall ─────────────────────────────

#[test]
fn top_k_truncation_overall() {
    let rows: Vec<FileRow> = (0..20)
        .map(|i| row(&format!("mod/term{i}.rs"), "mod", "Rust", 50))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);
    assert!(
        clouds.overall.len() <= 8,
        "overall should be truncated to TOP_K=8"
    );
}

// ── 14. Multi-language repo ─────────────────────────────────────

#[test]
fn multi_language_repo_produces_topics() {
    let data = export(
        vec![
            row("frontend/app/dashboard.tsx", "frontend", "TypeScript", 200),
            row("backend/api/controller.py", "backend", "Python", 150),
            row("infra/deploy/terraform.tf", "infra", "HCL", 80),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    assert!(clouds.per_module.contains_key("frontend"));
    assert!(clouds.per_module.contains_key("backend"));
    assert!(clouds.per_module.contains_key("infra"));
    assert!(!clouds.overall.is_empty());
}

// ── 15. Underscore and hyphen splitting ─────────────────────────

#[test]
fn underscores_and_hyphens_split_tokens() {
    let data = export(
        vec![row("utils/rate-limiter_config.rs", "utils", "Rust", 50)],
        &[],
    );
    let terms = overall_terms(&data);
    assert!(terms.contains(&"rate".to_string()));
    assert!(terms.contains(&"limiter".to_string()));
    assert!(terms.contains(&"config".to_string()));
}

// ── 16. Backslash paths normalized ──────────────────────────────

#[test]
fn backslash_paths_normalized() {
    let data = export(
        vec![row("utils\\crypto\\hash.rs", "utils", "Rust", 50)],
        &[],
    );
    let terms = overall_terms(&data);
    assert!(terms.contains(&"crypto".to_string()));
    assert!(terms.contains(&"hash".to_string()));
}

// ── 17. Higher token weight increases score ─────────────────────

#[test]
fn higher_token_weight_increases_score() {
    let data = export(
        vec![
            row("a/heavy.rs", "a", "Rust", 10000),
            row("a/light.rs", "a", "Rust", 1),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let heavy = clouds
        .overall
        .iter()
        .find(|t| t.term == "heavy")
        .expect("heavy");
    let light = clouds
        .overall
        .iter()
        .find(|t| t.term == "light")
        .expect("light");
    assert!(
        heavy.score > light.score,
        "heavy ({}) should score higher than light ({})",
        heavy.score,
        light.score
    );
}

// ── 18. Overall scores sorted descending ────────────────────────

#[test]
fn overall_scores_sorted_descending() {
    let rows: Vec<FileRow> = (0..10)
        .map(|i| row(&format!("mod/widget{i}.rs"), "mod", "Rust", (i + 1) * 10))
        .collect();
    let data = export(rows, &[]);
    let clouds = build_topic_clouds(&data);
    for pair in clouds.overall.windows(2) {
        assert!(
            pair[0].score >= pair[1].score
                || (pair[0].score == pair[1].score && pair[0].term <= pair[1].term),
            "overall not sorted: {:?} vs {:?}",
            pair[0],
            pair[1]
        );
    }
}

// ── 19. Per-module scores sorted descending ─────────────────────

#[test]
fn per_module_scores_sorted_descending() {
    let data = export(
        vec![
            row("api/auth.rs", "api", "Rust", 100),
            row("api/cache.rs", "api", "Rust", 200),
            row("api/db.rs", "api", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let api_terms = clouds.per_module.get("api").unwrap();
    for pair in api_terms.windows(2) {
        assert!(
            pair[0].score >= pair[1].score
                || (pair[0].score == pair[1].score && pair[0].term <= pair[1].term),
            "per-module not sorted: {:?} vs {:?}",
            pair[0],
            pair[1]
        );
    }
}

// ── 20. IDF boosts rare terms with equal per-module TF ──────────

#[test]
fn idf_boosts_rare_terms_same_tf() {
    // Both terms appear in 1 file each within same module.
    // "rare" appears in 1 file (df=1), "spread" in 2 files (df=2).
    // Same module means same module_count=1 for scoring.
    // Use per-module to compare terms with same tf but different df.
    let data = export(
        vec![
            row("mod_a/rare.rs", "mod_a", "Rust", 50),
            row("mod_a/spread.rs", "mod_a", "Rust", 50),
            row("mod_b/spread.rs", "mod_b", "Rust", 50),
        ],
        &[],
    );
    let clouds = build_topic_clouds(&data);
    let mod_a = clouds.per_module.get("mod_a").unwrap();
    let rare = mod_a.iter().find(|t| t.term == "rare").expect("rare");
    let spread = mod_a.iter().find(|t| t.term == "spread").expect("spread");
    // rare has df=1, spread has df=2; same tf within mod_a => rare has higher IDF
    assert!(
        rare.score > spread.score,
        "rare ({}) should score higher than spread ({}) in same module due to IDF",
        rare.score,
        spread.score
    );
}