debtmap 0.16.3

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

/// Test for detecting self method calls within impl blocks
use debtmap::analyzers::rust_call_graph::extract_call_graph_multi_file;
use std::path::PathBuf;

#[test]
fn test_self_method_call_detection() {
    // Create a simple test case that mirrors the UnifiedAnalysis pattern
    let code = r#"
struct TestStruct {
    data: Vec<String>,
}

impl TestStruct {
    pub fn caller_method(&self) -> String {
        let result = self.helper_method();
        result
    }

    fn helper_method(&self) -> String {
        self.data.join(",")
    }
}
"#;

    let ast = syn::parse_str(code).expect("Failed to parse code");
    let file_path = PathBuf::from("src/test.rs");

    let call_graph = extract_call_graph_multi_file(&[(ast, file_path.clone())]);

    // Check that helper_method exists in the graph
    let helper_func = call_graph
        .get_all_functions()
        .find(|f| f.name.contains("helper_method"))
        .expect("helper_method should exist in call graph");

    println!("Helper function: {:?}", helper_func);

    // Check that helper_method has at least one caller
    let callers = call_graph.get_callers(helper_func);
    println!("Callers of helper_method: {}", callers.len());
    for caller in &callers {
        println!(
            "  Caller: {} at {}:{}",
            caller.name,
            caller.file.display(),
            caller.line
        );
    }

    assert!(
        !callers.is_empty(),
        "helper_method should have at least one caller (caller_method), but has 0 callers"
    );

    // Verify the caller is caller_method
    let has_caller_method = callers.iter().any(|c| c.name.contains("caller_method"));
    assert!(
        has_caller_method,
        "caller_method should be in the list of callers"
    );
}

#[test]
fn test_unified_analysis_get_debt_type_key_pattern() {
    // Simplified version of the UnifiedAnalysis pattern
    let code = r#"
enum DebtItem {
    Function(FunctionDebt),
    File(FileDebt),
}

struct FunctionDebt {
    name: String,
}

struct FileDebt {
    path: String,
}

struct UnifiedAnalysis {
    items: Vec<DebtItem>,
}

impl UnifiedAnalysis {
    pub fn get_tiered_display(&self) -> Vec<String> {
        let mut results = Vec::new();

        for item in &self.items {
            let debt_type = self.get_debt_type_key(&item);
            results.push(debt_type);
        }

        results
    }

    fn get_debt_type_key(&self, item: &DebtItem) -> String {
        match item {
            DebtItem::Function(func) => format!("Function: {}", func.name),
            DebtItem::File(file) => format!("File: {}", file.path),
        }
    }
}
"#;

    let ast = syn::parse_str(code).expect("Failed to parse code");
    let file_path = PathBuf::from("src/priority/mod.rs");

    let call_graph = extract_call_graph_multi_file(&[(ast, file_path.clone())]);

    println!("\n=== ALL FUNCTIONS IN GRAPH ===");
    for func in call_graph.get_all_functions() {
        println!(
            "Function: {} at {}:{}",
            func.name,
            func.file.display(),
            func.line
        );
    }

    // Find get_debt_type_key
    let debt_type_key_func = call_graph
        .get_all_functions()
        .find(|f| f.name.contains("get_debt_type_key"))
        .expect("get_debt_type_key should exist in call graph");

    println!("\n=== TARGET FUNCTION ===");
    println!(
        "Function: {} at {}:{}",
        debt_type_key_func.name,
        debt_type_key_func.file.display(),
        debt_type_key_func.line
    );

    // Check callers
    let callers = call_graph.get_callers(debt_type_key_func);
    println!("\n=== CALLERS ===");
    println!("Number of callers: {}", callers.len());
    for caller in &callers {
        println!(
            "  Caller: {} at {}:{}",
            caller.name,
            caller.file.display(),
            caller.line
        );
    }

    assert!(
        !callers.is_empty(),
        "get_debt_type_key should have at least one caller (get_tiered_display), but has {} callers",
        callers.len()
    );

    // Verify get_tiered_display is the caller
    let has_tiered_display = callers
        .iter()
        .any(|c| c.name.contains("get_tiered_display"));
    assert!(
        has_tiered_display,
        "get_tiered_display should be in the list of callers for get_debt_type_key"
    );
}