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
//! Context-aware analyzer wrapper that integrates context detection

use crate::analyzers::Analyzer;
use crate::context::rules::DebtPattern;
use crate::context::{
    detect_file_type, ContextDetector, ContextRuleEngine, FileType, FunctionContext, RuleAction,
};
use crate::core::{
    ast::{Ast, RustAst},
    DebtItem, DebtType, FileMetrics, Language, Priority,
};
use anyhow::Result;
use std::path::{Path, PathBuf};
use std::sync::RwLock;
use syn::visit::Visit;

/// Wrapper that adds context-awareness to any analyzer
pub struct ContextAwareAnalyzer {
    /// The underlying analyzer
    inner: Box<dyn Analyzer>,
    /// Context rule engine
    rule_engine: RwLock<ContextRuleEngine>,
    /// Whether context awareness is enabled
    enabled: bool,
}

impl ContextAwareAnalyzer {
    /// Create a new context-aware analyzer
    pub fn new(inner: Box<dyn Analyzer>) -> Self {
        Self {
            inner,
            rule_engine: RwLock::new(ContextRuleEngine::new()),
            enabled: true,
        }
    }

    /// Enable or disable context awareness
    pub fn set_enabled(&mut self, enabled: bool) {
        self.enabled = enabled;
    }

    /// Process a debt item based on the rule action
    fn process_rule_action(
        &self,
        action: RuleAction,
        item: &mut DebtItem,
        pattern: &DebtPattern,
        context: &FunctionContext,
    ) -> bool {
        match action {
            RuleAction::Allow | RuleAction::Skip => false,
            RuleAction::Warn => {
                item.priority = adjust_priority(item.priority, -2);
                self.add_context_note(item, pattern, context);
                true
            }
            RuleAction::ReduceSeverity(n) => {
                item.priority = adjust_priority(item.priority, -n);
                self.add_context_note(item, pattern, context);
                true
            }
            RuleAction::Deny => true,
        }
    }

    /// Add context note to debt item message
    fn add_context_note(
        &self,
        item: &mut DebtItem,
        pattern: &DebtPattern,
        context: &FunctionContext,
    ) {
        if let Some(reason) = self
            .rule_engine
            .write()
            .unwrap()
            .get_reason(pattern, context)
        {
            item.message = format!("{} (Context: {})", item.message, reason);
        }
    }

    /// Process debt items for Rust code
    fn process_rust_items(
        &self,
        metrics: &mut FileMetrics,
        rust_ast: &RustAst,
        file_type: FileType,
    ) {
        let mut detector = ContextDetector::new(file_type);
        detector.visit_file(&rust_ast.file);

        metrics.debt_items.retain_mut(|item| {
            let context = detector
                .get_context_for_line(item.line)
                .cloned()
                .unwrap_or_else(|| FunctionContext::new().with_file_type(file_type));

            let pattern = debt_type_to_pattern(&item.debt_type, &item.message);
            let action = self
                .rule_engine
                .write()
                .unwrap()
                .evaluate(&pattern, &context);

            self.process_rule_action(action, item, &pattern, &context)
        });
    }

    /// Process debt items for non-Rust code
    fn process_non_rust_items(&self, metrics: &mut FileMetrics, file_type: FileType) {
        let context = FunctionContext::new().with_file_type(file_type);

        metrics.debt_items.retain_mut(|item| {
            let pattern = debt_type_to_pattern(&item.debt_type, &item.message);
            let action = self
                .rule_engine
                .write()
                .unwrap()
                .evaluate(&pattern, &context);

            self.process_rule_action(action, item, &pattern, &context)
        });
    }

    /// Filter debt items based on context rules
    fn filter_debt_items(&self, mut metrics: FileMetrics, ast: &Ast, path: &Path) -> FileMetrics {
        if !self.enabled {
            return metrics;
        }

        let file_type = detect_file_type(path);

        if let Ast::Rust(rust_ast) = ast {
            self.process_rust_items(&mut metrics, rust_ast, file_type);
        } else {
            self.process_non_rust_items(&mut metrics, file_type);
        }

        metrics
    }
}

impl Analyzer for ContextAwareAnalyzer {
    fn parse(&self, content: &str, path: PathBuf) -> Result<Ast> {
        self.inner.parse(content, path)
    }

    fn analyze(&self, ast: &Ast) -> FileMetrics {
        let metrics = self.inner.analyze(ast);

        // Apply context-aware filtering if we have the path
        if !metrics.path.as_os_str().is_empty() {
            let path = metrics.path.clone();
            self.filter_debt_items(metrics, ast, &path)
        } else {
            metrics
        }
    }

    fn language(&self) -> Language {
        self.inner.language()
    }
}

/// Convert a debt type to a debt pattern for rule matching
fn debt_type_to_pattern(debt_type: &DebtType, _message: &str) -> DebtPattern {
    // All debt types are mapped directly to DebtPattern::DebtType
    DebtPattern::DebtType(debt_type.clone())
}

/// Adjust priority based on severity adjustment
fn adjust_priority(priority: Priority, adjustment: i32) -> Priority {
    if adjustment == -999 {
        // Special case: effectively disable
        return Priority::Low;
    }

    let current = match priority {
        Priority::Critical => 4,
        Priority::High => 3,
        Priority::Medium => 2,
        Priority::Low => 1,
    };

    let new = (current + adjustment).clamp(1, 4);

    match new {
        4 => Priority::Critical,
        3 => Priority::High,
        2 => Priority::Medium,
        _ => Priority::Low,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::{ComplexityMetrics, DebtItem};
    use std::path::PathBuf;

    #[test]
    fn test_adjust_priority() {
        assert_eq!(adjust_priority(Priority::High, -1), Priority::Medium);
        assert_eq!(adjust_priority(Priority::Medium, -2), Priority::Low);
        assert_eq!(adjust_priority(Priority::Low, -1), Priority::Low);
        assert_eq!(adjust_priority(Priority::Critical, -999), Priority::Low);
    }

    #[test]
    fn test_adjust_priority_edge_cases() {
        // Test positive adjustments (should be clamped)
        assert_eq!(adjust_priority(Priority::High, 1), Priority::Critical);
        assert_eq!(adjust_priority(Priority::Critical, 1), Priority::Critical);

        // Test extreme negative adjustments
        assert_eq!(adjust_priority(Priority::Critical, -10), Priority::Low);

        // Test no adjustment
        assert_eq!(adjust_priority(Priority::Medium, 0), Priority::Medium);
    }

    #[test]
    fn test_debt_type_to_pattern_other_types() {
        // Test Todo debt type
        let pattern =
            debt_type_to_pattern(&DebtType::Todo { reason: None }, "Implement this feature");
        assert_eq!(
            pattern,
            DebtPattern::DebtType(DebtType::Todo { reason: None })
        );

        // Test Fixme debt type
        let pattern = debt_type_to_pattern(&DebtType::Fixme { reason: None }, "Fix this bug");
        assert_eq!(
            pattern,
            DebtPattern::DebtType(DebtType::Fixme { reason: None })
        );

        // Test CodeSmell debt type
        let pattern = debt_type_to_pattern(
            &DebtType::CodeSmell { smell_type: None },
            "Code smell detected",
        );
        assert_eq!(
            pattern,
            DebtPattern::DebtType(DebtType::CodeSmell { smell_type: None })
        );

        // Test Complexity debt type
        let pattern = debt_type_to_pattern(
            &DebtType::Complexity {
                cyclomatic: 10,
                cognitive: 8,
            },
            "High cyclomatic complexity",
        );
        assert_eq!(
            pattern,
            DebtPattern::DebtType(DebtType::Complexity {
                cyclomatic: 10,
                cognitive: 8
            })
        );

        // Test Duplication debt type
        let pattern = debt_type_to_pattern(
            &DebtType::Duplication {
                instances: 2,
                total_lines: 20,
            },
            "Duplicate code detected",
        );
        assert_eq!(
            pattern,
            DebtPattern::DebtType(DebtType::Duplication {
                instances: 2,
                total_lines: 20
            })
        );
    }

    #[test]
    fn test_process_rule_action_allow() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // RuleAction::Allow should filter out the item
        let keep = analyzer.process_rule_action(RuleAction::Allow, &mut item, &pattern, &context);
        assert!(!keep, "Allow action should filter out the item");
    }

    #[test]
    fn test_process_rule_action_skip() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // RuleAction::Skip should filter out the item
        let keep = analyzer.process_rule_action(RuleAction::Skip, &mut item, &pattern, &context);
        assert!(!keep, "Skip action should filter out the item");
    }

    #[test]
    fn test_process_rule_action_warn() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let original_priority = item.priority;
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // RuleAction::Warn should reduce severity by 2 and keep the item
        let keep = analyzer.process_rule_action(RuleAction::Warn, &mut item, &pattern, &context);
        assert!(keep, "Warn action should keep the item");
        assert_eq!(
            item.priority,
            adjust_priority(original_priority, -2),
            "Priority should be reduced by 2"
        );
    }

    #[test]
    fn test_process_rule_action_reduce_severity() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let original_priority = item.priority;
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // RuleAction::ReduceSeverity should reduce by specified amount
        let keep = analyzer.process_rule_action(
            RuleAction::ReduceSeverity(3),
            &mut item,
            &pattern,
            &context,
        );
        assert!(keep, "ReduceSeverity action should keep the item");
        assert_eq!(
            item.priority,
            adjust_priority(original_priority, -3),
            "Priority should be reduced by 3"
        );
    }

    #[test]
    fn test_process_rule_action_deny() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let original_priority = item.priority;
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // RuleAction::Deny should keep the item unchanged
        let keep = analyzer.process_rule_action(RuleAction::Deny, &mut item, &pattern, &context);
        assert!(keep, "Deny action should keep the item");
        assert_eq!(
            item.priority, original_priority,
            "Priority should be unchanged"
        );
    }

    #[test]
    fn test_add_context_note() {
        let analyzer = create_test_analyzer();
        let mut item = create_test_debt_item();
        let pattern = DebtPattern::DebtType(DebtType::Todo { reason: None });
        let context = FunctionContext::new();

        // Test adding context note
        analyzer.add_context_note(&mut item, &pattern, &context);
        // Note: Without a configured rule engine with reasons, this won't modify the message
        // but the method should still execute without errors
    }

    #[test]
    fn test_filter_debt_items_disabled() {
        let mut analyzer = create_test_analyzer();
        analyzer.set_enabled(false);

        let metrics = create_test_metrics();
        let ast = Ast::Unknown;
        let path = Path::new("test.rs");

        let result = analyzer.filter_debt_items(metrics.clone(), &ast, path);
        assert_eq!(
            result.debt_items.len(),
            metrics.debt_items.len(),
            "Should not filter when disabled"
        );
    }

    // Helper functions for testing
    fn create_test_analyzer() -> ContextAwareAnalyzer {
        struct MockAnalyzer;
        impl Analyzer for MockAnalyzer {
            fn parse(&self, _content: &str, _path: PathBuf) -> Result<Ast> {
                Ok(Ast::Unknown)
            }
            fn analyze(&self, _ast: &Ast) -> FileMetrics {
                create_test_metrics()
            }
            fn language(&self) -> Language {
                Language::Rust
            }
        }

        ContextAwareAnalyzer::new(Box::new(MockAnalyzer))
    }

    fn create_test_debt_item() -> DebtItem {
        DebtItem {
            id: "test-item".to_string(),
            debt_type: DebtType::Todo { reason: None },
            message: "Test debt item".to_string(),
            line: 42,
            column: Some(0),
            priority: Priority::Medium,
            file: PathBuf::from("test.rs"),
            context: None,
        }
    }

    fn create_test_metrics() -> FileMetrics {
        FileMetrics {
            path: PathBuf::from("test.rs"),
            language: Language::Rust,
            complexity: ComplexityMetrics::default(),
            debt_items: vec![create_test_debt_item()],
            dependencies: vec![],
            duplications: vec![],
            total_lines: 0,
            module_scope: None,
            classes: None,
        }
    }
}