debtmap 0.16.6

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

//! Pure functions for classifying module types by file path.
//!
//! This module contains stateless, pure functions that determine
//! the module type based on directory structure and filename patterns.

use crate::risk::evidence::ModuleType;
use std::path::Path;

/// Determines the module type from a file path.
///
/// Classification priority:
/// 1. Test modules (paths containing `/tests/` or `_test.rs`)
/// 2. Directory-based classification (core, api, utils, infra, db)
/// 3. Filename-based fallback (mod.rs, lib.rs, main.rs)
pub fn classify_module_type(file: &Path) -> ModuleType {
    let path_str = file.to_string_lossy();

    if is_test_module(&path_str) {
        ModuleType::Test
    } else if let Some(module_type) = classify_by_directory(&path_str) {
        module_type
    } else {
        classify_by_filename(&path_str)
    }
}

/// Pure function to check if path is a test module.
pub fn is_test_module(path_str: &str) -> bool {
    path_str.contains("/tests/") || path_str.contains("_test.rs")
}

/// Pure function to classify module by directory structure.
pub fn classify_by_directory(path_str: &str) -> Option<ModuleType> {
    match () {
        _ if path_str.contains("/core/") || path_str.contains("/domain/") => Some(ModuleType::Core),
        _ if path_str.contains("/api/") || path_str.contains("/handlers/") => Some(ModuleType::Api),
        _ if path_str.contains("/utils/") || path_str.contains("/helpers/") => {
            Some(ModuleType::Util)
        }
        _ if path_str.contains("/infra/") || path_str.contains("/db/") => {
            Some(ModuleType::Infrastructure)
        }
        _ => None,
    }
}

/// Pure function to classify module by filename.
pub fn classify_by_filename(path_str: &str) -> ModuleType {
    match () {
        _ if path_str.ends_with("mod.rs") || path_str.ends_with("lib.rs") => ModuleType::Core,
        _ if path_str.contains("main.rs") => ModuleType::Infrastructure,
        _ => ModuleType::Util,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    #[test]
    fn test_is_test_module() {
        assert!(is_test_module("src/tests/foo.rs"));
        assert!(is_test_module("src/module_test.rs"));
        assert!(is_test_module("path/to/tests/bar.rs"));
        assert!(!is_test_module("src/main.rs"));
        assert!(!is_test_module("src/lib.rs"));
    }

    #[test]
    fn test_classify_by_directory() {
        assert_eq!(
            classify_by_directory("src/core/logic.rs"),
            Some(ModuleType::Core)
        );
        assert_eq!(
            classify_by_directory("src/domain/model.rs"),
            Some(ModuleType::Core)
        );
        assert_eq!(
            classify_by_directory("src/api/handler.rs"),
            Some(ModuleType::Api)
        );
        assert_eq!(
            classify_by_directory("src/handlers/route.rs"),
            Some(ModuleType::Api)
        );
        assert_eq!(
            classify_by_directory("src/utils/helper.rs"),
            Some(ModuleType::Util)
        );
        assert_eq!(
            classify_by_directory("src/helpers/format.rs"),
            Some(ModuleType::Util)
        );
        assert_eq!(
            classify_by_directory("src/infra/db.rs"),
            Some(ModuleType::Infrastructure)
        );
        assert_eq!(
            classify_by_directory("src/db/connection.rs"),
            Some(ModuleType::Infrastructure)
        );
        assert_eq!(classify_by_directory("src/other/file.rs"), None);
    }

    #[test]
    fn test_classify_by_filename() {
        assert_eq!(classify_by_filename("src/mod.rs"), ModuleType::Core);
        assert_eq!(classify_by_filename("src/lib.rs"), ModuleType::Core);
        assert_eq!(
            classify_by_filename("src/main.rs"),
            ModuleType::Infrastructure
        );
        assert_eq!(
            classify_by_filename("src/foo/main.rs"),
            ModuleType::Infrastructure
        );
        assert_eq!(classify_by_filename("src/something.rs"), ModuleType::Util);
    }

    #[test]
    fn test_classify_module_type_integration() {
        // Test modules should be identified
        assert_eq!(
            classify_module_type(&PathBuf::from("src/tests/test.rs")),
            ModuleType::Test
        );

        // Core modules from directory
        assert_eq!(
            classify_module_type(&PathBuf::from("src/core/engine.rs")),
            ModuleType::Core
        );

        // API modules
        assert_eq!(
            classify_module_type(&PathBuf::from("src/api/routes.rs")),
            ModuleType::Api
        );

        // Fallback to filename classification
        assert_eq!(
            classify_module_type(&PathBuf::from("src/main.rs")),
            ModuleType::Infrastructure
        );

        // Default to Util for unknown patterns
        assert_eq!(
            classify_module_type(&PathBuf::from("src/random/file.rs")),
            ModuleType::Util
        );
    }
}