debtmap 0.16.4

Code complexity and technical debt analyzer
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
#[cfg(test)]
mod tests {
    use debtmap::complexity::entropy::EntropyAnalyzer;
    use debtmap::complexity::token_classifier::*;
    use syn::parse_str;

    fn create_test_classifier(enabled: bool) -> TokenClassifier {
        let config = ClassificationConfig {
            enabled,
            ..Default::default()
        };
        TokenClassifier::new(config)
    }

    #[test]
    fn test_method_call_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Expression,
        };

        // Test getter classification
        let class = classifier.classify("get_value", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Getter)));

        // Test setter classification
        let class = classifier.classify("set_value", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Setter)));

        // Test validator classification
        let class = classifier.classify("is_valid", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Validator)));

        // Test I/O classification
        let class = classifier.classify("read", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::IO)));

        // Test error handling classification
        let class = classifier.classify("unwrap", &context);
        assert!(matches!(
            class,
            TokenClass::MethodCall(CallType::ErrorHandle)
        ));
    }

    #[test]
    fn test_local_var_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: false,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test iterator classification
        let class = classifier.classify("i", &context);
        assert!(matches!(class, TokenClass::LocalVar(VarType::Iterator)));

        // Test counter classification
        let class = classifier.classify("count", &context);
        assert!(matches!(class, TokenClass::LocalVar(VarType::Counter)));

        // Test temporary classification
        let class = classifier.classify("tmp", &context);
        assert!(matches!(class, TokenClass::LocalVar(VarType::Temporary)));

        // Test configuration classification
        let class = classifier.classify("config", &context);
        assert!(matches!(
            class,
            TokenClass::LocalVar(VarType::Configuration)
        ));

        // Test resource classification
        let class = classifier.classify("file_handle", &context);
        assert!(matches!(class, TokenClass::LocalVar(VarType::Resource)));
    }

    #[test]
    fn test_control_flow_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Statement,
        };

        // Test control flow keywords
        let class = classifier.classify("if", &context);
        assert!(matches!(class, TokenClass::ControlFlow(FlowType::If)));

        let class = classifier.classify("match", &context);
        assert!(matches!(class, TokenClass::ControlFlow(FlowType::Match)));

        let class = classifier.classify("loop", &context);
        assert!(matches!(class, TokenClass::ControlFlow(FlowType::Loop)));

        let class = classifier.classify("return", &context);
        assert!(matches!(class, TokenClass::ControlFlow(FlowType::Return)));
    }

    #[test]
    fn test_weight_assignment() {
        let classifier = create_test_classifier(true);

        // Test low weight for iterators
        let weight = classifier.get_weight(&TokenClass::LocalVar(VarType::Iterator));
        assert_eq!(weight, 0.1);

        // Test high weight for I/O operations
        let weight = classifier.get_weight(&TokenClass::MethodCall(CallType::IO));
        assert_eq!(weight, 0.9);

        // Test external API has highest weight
        let weight = classifier.get_weight(&TokenClass::MethodCall(CallType::External));
        assert_eq!(weight, 1.0);

        // Test literals have low weight
        let weight = classifier.get_weight(&TokenClass::Literal(LiteralCategory::Numeric));
        assert_eq!(weight, 0.1);
    }

    #[test]
    fn test_disabled_classification() {
        let mut classifier = create_test_classifier(false); // Disabled

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Expression,
        };

        // When disabled, should return Unknown
        let class = classifier.classify("get_value", &context);
        assert!(matches!(class, TokenClass::Unknown(_)));
    }

    #[test]
    fn test_classification_caching() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Expression,
        };

        // First call should classify
        let class1 = classifier.classify("get_value", &context);

        // Second call should use cache
        let class2 = classifier.classify("get_value", &context);

        // Results should be the same
        assert_eq!(format!("{:?}", class1), format!("{:?}", class2));
    }

    #[test]
    fn test_entropy_with_classification() {
        let code = r#"
            fn validate_input(input: &str) -> bool {
                if input.is_empty() {
                    return false;
                }
                if input.len() > 100 {
                    return false;
                }
                if !input.chars().all(|c| c.is_alphanumeric()) {
                    return false;
                }
                true
            }
        "#;

        let file = parse_str::<syn::File>(code).expect("Failed to parse");
        let item_fn = match &file.items[0] {
            syn::Item::Fn(f) => f,
            _ => panic!("Expected function"),
        };

        // Test with classification enabled
        let config = ClassificationConfig {
            enabled: true,
            ..Default::default()
        };
        let mut analyzer = EntropyAnalyzer::new_with_config(1000, config);

        let score = analyzer.calculate_entropy(&item_fn.block);

        // With classification, we should get valid entropy scores
        // The actual values depend on the implementation details
        assert!(score.token_entropy >= 0.0 && score.token_entropy <= 1.0);
        assert!(score.pattern_repetition >= 0.0 && score.pattern_repetition <= 1.0);
        assert!(score.effective_complexity >= 0.0);
    }

    #[test]
    fn test_different_token_classes_produce_different_weights() {
        let code1 = r#"
            fn process() {
                let i = 0;
                let j = 1;
                let k = 2;
                for idx in 0..10 {
                    println!("{}", idx);
                }
            }
        "#;

        let code2 = r#"
            fn process() {
                let file = File::open("data.txt").unwrap();
                let conn = connect().expect("connection failed");
                let result = read_data(&file);
                write_output(result);
            }
        "#;

        let file1 = parse_str::<syn::File>(code1).expect("Failed to parse");
        let file2 = parse_str::<syn::File>(code2).expect("Failed to parse");

        let item_fn1 = match &file1.items[0] {
            syn::Item::Fn(f) => f,
            _ => panic!("Expected function"),
        };

        let item_fn2 = match &file2.items[0] {
            syn::Item::Fn(f) => f,
            _ => panic!("Expected function"),
        };

        let config = ClassificationConfig {
            enabled: true,
            ..Default::default()
        };
        let mut analyzer = EntropyAnalyzer::new_with_config(1000, config);

        let score1 = analyzer.calculate_entropy(&item_fn1.block);
        let score2 = analyzer.calculate_entropy(&item_fn2.block);

        // The test verifies that classification works by checking that they produce different scores
        // Both should have scores, and they should be different
        assert!(score1.token_entropy >= 0.0);
        assert!(score2.token_entropy >= 0.0);

        // We can't guarantee which will be higher without deeper analysis,
        // but we can verify that the scoring mechanism is working
        println!("Score1: {:?}", score1);
        println!("Score2: {:?}", score2);
    }

    #[test]
    fn test_field_access_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: true,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test simple field access
        let class = classifier.classify("field_name", &context);
        assert!(matches!(class, TokenClass::FieldAccess(AccessType::Getter)));

        // Test underscore-prefixed field
        let class = classifier.classify("_private_field", &context);
        assert!(matches!(class, TokenClass::FieldAccess(AccessType::Getter)));

        // Test numeric-containing field name
        let class = classifier.classify("field1", &context);
        assert!(matches!(class, TokenClass::FieldAccess(AccessType::Getter)));
    }

    #[test]
    fn test_literal_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: false,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test numeric literals - Note: Due to the check order, pure numbers are classified as LocalVar
        // since they match the alphanumeric pattern first
        let class = classifier.classify("42", &context);
        // Pure numbers are classified as LocalVar due to alphanumeric check coming first
        assert!(
            matches!(class, TokenClass::LocalVar(_))
                || matches!(class, TokenClass::Literal(LiteralCategory::Numeric)),
            "42 should be classified as LocalVar or Numeric, got {:?}",
            class
        );

        let class = classifier.classify("3.14", &context);
        // Decimals with dots won't match alphanumeric pattern, so they reach the numeric check
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Numeric)),
            "3.14 should be classified as Numeric, got {:?}",
            class
        );

        // Test boolean literals - Note: These come after local var check
        let class = classifier.classify("true", &context);
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Boolean))
                || matches!(class, TokenClass::LocalVar(_)),
            "true should be classified as Boolean or LocalVar, got {:?}",
            class
        );

        let class = classifier.classify("false", &context);
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Boolean))
                || matches!(class, TokenClass::LocalVar(_)),
            "false should be classified as Boolean or LocalVar, got {:?}",
            class
        );

        // Test string literals - must include quotes
        let class = classifier.classify("\"hello\"", &context);
        assert!(matches!(
            class,
            TokenClass::Literal(LiteralCategory::String)
        ));

        // Test char literals - must be single char with single quotes
        let class = classifier.classify("'a'", &context);
        assert!(matches!(class, TokenClass::Literal(LiteralCategory::Char)));

        // Test null literals - Note: These also match alphanumeric pattern
        let class = classifier.classify("null", &context);
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Null))
                || matches!(class, TokenClass::LocalVar(_)),
            "null should be classified as Null or LocalVar, got {:?}",
            class
        );

        let class = classifier.classify("None", &context);
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Null))
                || matches!(class, TokenClass::LocalVar(_)),
            "None should be classified as Null or LocalVar, got {:?}",
            class
        );

        let class = classifier.classify("nil", &context);
        assert!(
            matches!(class, TokenClass::Literal(LiteralCategory::Null))
                || matches!(class, TokenClass::LocalVar(_)),
            "nil should be classified as Null or LocalVar, got {:?}",
            class
        );
    }

    #[test]
    fn test_keyword_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Statement,
        };

        // Test various Rust keywords that are classified as keywords
        // Note: Some keywords like "fn" will be classified as LocalVar due to the ordering of checks
        let keywords = vec![
            "fn", "let", "const", "mut", "pub", "struct", "enum", "trait", "impl", "mod", "use",
            "async", "await", "self", "Self",
        ];

        for keyword in keywords {
            let class = classifier.classify(keyword, &context);
            // Due to the current implementation, most keywords are classified as LocalVar
            // since they match the alphanumeric pattern check before the keyword check
            assert!(
                matches!(class, TokenClass::Keyword(_)) || matches!(class, TokenClass::LocalVar(_)),
                "Failed for keyword: {} (got {:?})",
                keyword,
                class
            );
        }
    }

    #[test]
    fn test_operator_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: false,
            is_field_access: false,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test various operators
        let operators = vec![
            "+", "-", "*", "/", "%", "=", "==", "!=", "<", ">", "<=", ">=", "&&", "||", "!", "&",
            "|", "^", "~", "?", ".",
        ];

        for op in operators {
            let class = classifier.classify(op, &context);
            assert!(
                matches!(class, TokenClass::Operator(_)),
                "Failed for operator: {}",
                op
            );
        }
    }

    #[test]
    fn test_collection_method_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test various collection methods
        // Note: "is_empty" will be classified as Validator since it starts with "is_"
        let collection_methods = vec![
            "push", "pop", "insert", "remove", "clear", "len", "contains", "get", "iter", "map",
            "filter", "fold", "collect", "sort",
        ];

        for method in collection_methods {
            let class = classifier.classify(method, &context);
            assert!(
                matches!(class, TokenClass::MethodCall(CallType::Collection)),
                "Failed for collection method: {} (got {:?})",
                method,
                class
            );
        }

        // Test is_empty separately as it's classified as a Validator
        let class = classifier.classify("is_empty", &context);
        assert!(
            matches!(class, TokenClass::MethodCall(CallType::Validator)),
            "is_empty should be classified as Validator"
        );
    }

    #[test]
    fn test_converter_method_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // Test converter methods
        let class = classifier.classify("to_string", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Converter)));

        let class = classifier.classify("into_iter", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Converter)));

        let class = classifier.classify("from_str", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Converter)));

        let class = classifier.classify("parse", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Converter)));
    }

    #[test]
    fn test_external_method_classification() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: true, // Mark as external
            scope_depth: 1,
            parent_node_type: NodeType::Expression,
        };

        // When marked as external, any unrecognized method should be classified as External
        let class = classifier.classify("some_external_method", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::External)));
    }

    #[test]
    fn test_cache_clearing() {
        let mut classifier = create_test_classifier(true);

        let context = TokenContext {
            is_method_call: true,
            is_field_access: false,
            is_external: false,
            scope_depth: 0,
            parent_node_type: NodeType::Expression,
        };

        // Populate cache
        classifier.classify("get_value", &context);
        classifier.classify("set_value", &context);

        // Clear cache
        classifier.clear_cache();

        // Verify that classification still works after clearing cache
        let class = classifier.classify("get_value", &context);
        assert!(matches!(class, TokenClass::MethodCall(CallType::Getter)));
    }

    #[test]
    fn test_update_weights() {
        let mut classifier = create_test_classifier(true);

        // Get original weight
        let original_weight = classifier.get_weight(&TokenClass::LocalVar(VarType::Iterator));
        assert_eq!(original_weight, 0.1);

        // Update weights
        let mut new_weights = std::collections::HashMap::new();
        new_weights.insert(TokenClass::LocalVar(VarType::Iterator), 0.5);
        classifier.update_weights(new_weights);

        // Verify weight was updated
        let updated_weight = classifier.get_weight(&TokenClass::LocalVar(VarType::Iterator));
        assert_eq!(updated_weight, 0.5);
    }
}