pmat 3.11.0

PMAT - Zero-config AI context generation and code quality toolkit (CLI, MCP, HTTP)
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

    // TDD RED phase - Tests for collect_files_recursive (22 cognitive complexity)
    #[tokio::test]
    async fn test_collect_files_recursive_empty_directory() {
        let detector = SATDDetector::new();
        let temp_dir = tempfile::tempdir().expect("internal error");
        let empty_dir = temp_dir.path().join("empty");
        std::fs::create_dir(&empty_dir).expect("internal error");

        let mut files = Vec::new();
        detector
            .collect_files_recursive(&empty_dir, &mut files)
            .await
            .expect("internal error");

        assert_eq!(files.len(), 0);
    }

    #[tokio::test]
    async fn test_collect_files_recursive_with_source_files() {
        let detector = SATDDetector::new();
        let temp_dir = tempfile::tempdir().expect("internal error");
        let project_root = temp_dir.path();

        // Create source files
        std::fs::write(project_root.join("main.rs"), "fn main() {}").expect("internal error");
        std::fs::write(project_root.join("lib.py"), "def func(): pass").expect("internal error");
        std::fs::write(project_root.join("script.js"), "console.log('hello');")
            .expect("internal error");
        std::fs::write(project_root.join("readme.txt"), "Not a source file")
            .expect("internal error");

        let mut files = Vec::new();
        detector
            .collect_files_recursive(project_root, &mut files)
            .await
            .expect("internal error");

        assert_eq!(files.len(), 3); // Only source files
        assert!(files
            .iter()
            .any(|f| f.file_name().expect("internal error") == "main.rs"));
        assert!(files
            .iter()
            .any(|f| f.file_name().expect("internal error") == "lib.py"));
        assert!(files
            .iter()
            .any(|f| f.file_name().expect("internal error") == "script.js"));
        assert!(!files
            .iter()
            .any(|f| f.file_name().expect("internal error") == "readme.txt"));
    }

    #[tokio::test]
    async fn test_collect_files_recursive_skips_excluded_directories() {
        let detector = SATDDetector::new();
        let temp_dir = tempfile::tempdir().expect("internal error");
        let project_root = temp_dir.path();

        // Create source files in excluded directories
        std::fs::create_dir_all(project_root.join("target/debug")).expect("internal error");
        std::fs::create_dir_all(project_root.join("node_modules/lib")).expect("internal error");
        std::fs::create_dir_all(project_root.join(".git/hooks")).expect("internal error");
        std::fs::create_dir_all(project_root.join("src")).expect("internal error");

        std::fs::write(project_root.join("target/debug/main.rs"), "fn main() {}")
            .expect("internal error");
        std::fs::write(
            project_root.join("node_modules/lib/index.js"),
            "console.log('test');",
        )
        .expect("internal error");
        std::fs::write(project_root.join(".git/hooks/pre-commit.sh"), "#!/bin/bash")
            .expect("internal error");
        std::fs::write(project_root.join("src/lib.rs"), "pub fn test() {}")
            .expect("internal error");

        let mut files = Vec::new();
        detector
            .collect_files_recursive(project_root, &mut files)
            .await
            .expect("internal error");

        assert_eq!(files.len(), 1); // Only src/lib.rs should be found
        assert!(files.iter().any(|f| f.ends_with("src/lib.rs")));
    }

    #[tokio::test]
    async fn test_collect_files_recursive_skips_test_files() {
        let detector = SATDDetector::new();
        let temp_dir = tempfile::tempdir().expect("internal error");
        let project_root = temp_dir.path();

        // Create test files and regular files
        std::fs::create_dir_all(project_root.join("src")).expect("internal error");
        std::fs::create_dir_all(project_root.join("tests")).expect("internal error");

        std::fs::write(project_root.join("src/lib.rs"), "pub fn func() {}")
            .expect("internal error");
        std::fs::write(project_root.join("src/main_test.rs"), "fn test_main() {}")
            .expect("internal error");
        std::fs::write(
            project_root.join("tests/integration.rs"),
            "#[test] fn test() {}",
        )
        .expect("internal error");

        let mut files = Vec::new();
        detector
            .collect_files_recursive(project_root, &mut files)
            .await
            .expect("internal error");

        // Should only find lib.rs, not test files
        assert_eq!(files.len(), 1);
        assert!(files.iter().any(|f| f.ends_with("src/lib.rs")));
        assert!(!files.iter().any(|f| f.to_string_lossy().contains("test")));
    }

    #[tokio::test]
    async fn test_collect_files_recursive_nested_directories() {
        let detector = SATDDetector::new();
        let temp_dir = tempfile::tempdir().expect("internal error");
        let project_root = temp_dir.path();

        // Create nested directory structure
        std::fs::create_dir_all(project_root.join("src/utils/helpers")).expect("internal error");
        std::fs::create_dir_all(project_root.join("src/models")).expect("internal error");

        std::fs::write(project_root.join("src/main.rs"), "fn main() {}").expect("internal error");
        std::fs::write(project_root.join("src/utils/mod.rs"), "pub mod helpers;")
            .expect("internal error");
        std::fs::write(
            project_root.join("src/utils/helpers/string.rs"),
            "pub fn trim() {}",
        )
        .expect("internal error");
        std::fs::write(
            project_root.join("src/models/user.rs"),
            "pub struct User {}",
        )
        .expect("internal error");

        let mut files = Vec::new();
        detector
            .collect_files_recursive(project_root, &mut files)
            .await
            .expect("internal error");

        assert_eq!(files.len(), 4);
        assert!(files.iter().any(|f| f.ends_with("main.rs")));
        assert!(files.iter().any(|f| f.ends_with("mod.rs")));
        assert!(files.iter().any(|f| f.ends_with("string.rs")));
        assert!(files.iter().any(|f| f.ends_with("user.rs")));
    }

    /// RED TEST: Toyota Way - Stop the Line
    /// Markdown headers (### Security, ## Security, # Security) should NOT be flagged as SATD
    /// Found bug: changelog_manager.rs line 133 "### Security" flagged as Critical Security SATD
    #[tokio::test]
    async fn test_markdown_headers_not_flagged_as_satd() {
        let detector = SATDDetector::new();
        let temp_dir = TempDir::new().expect("internal error");

        // Test case 1: CHANGELOG template with ### Security header
        let changelog_template = r#"
# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased]

### Added

### Changed

### Deprecated

### Removed

### Fixed

### Security
"#;

        let changelog_file = temp_dir.path().join("CHANGELOG.md");
        fs::write(&changelog_file, changelog_template).expect("internal error");

        // Test case 2: Rust code with CHANGELOG template string literal
        let changelog_manager_code = r###"
const CHANGELOG_TEMPLATE: &str = r#"
### Added

### Security
"#;
"###;
        let manager_file = temp_dir
            .path()
            .join("changelog_manager")
            .with_extension("rs");
        fs::write(&manager_file, changelog_manager_code).expect("internal error");

        let result = detector
            .analyze_project(temp_dir.path(), false)
            .await
            .expect("internal error");

        // RED: This will FAIL initially - markdown headers are currently detected as SATD
        // Expected: 0 Security SATD items (markdown headers should be filtered)
        // Actual: 2 Security SATD items (false positives)
        let security_count = result
            .items
            .iter()
            .filter(|item| matches!(item.category, DebtCategory::Security))
            .count();

        assert_eq!(
            security_count, 0,
            "Markdown headers like ### Security should NOT be flagged as SATD. Found {} false positives",
            security_count
        );
    }

    /// RED TEST: Bug tracking ID references should NOT be flagged as SATD
    /// Real-world patterns from codebase:
    /// - "BUG-012: Apply language override if specified"
    /// - "BUG-064 FIX: Uses atomic write operations"
    /// - "Bug: Previously used walkdir directly"
    /// - "PMAT-BUG-001: TypeScript detection must work"
    #[tokio::test]
    async fn test_bug_tracking_ids_not_flagged_as_satd() {
        let detector = SATDDetector::new();
        let temp_dir = TempDir::new().expect("internal error");

        // Test case 1: Bug tracking IDs (like JIRA tickets)
        let bug_tracking_code = r#"
    // BUG-012: Apply language override if specified
    let override_opts = LanguageOverride {
        language,
        languages,
    };

    // BUG-064 FIX: Uses atomic write operations to prevent file corruption
    fn atomic_write(path: &Path, content: &str) -> Result<()> {
        Ok(())
    }

    // PMAT-BUG-001: TypeScript class methods must be extracted
    // Root cause: JavaScriptAnalyzer uses regex/heuristic parsing
    fn extract_methods() {}
"#;
        let tracking_file = temp_dir.path().join("tracking").with_extension("rs");
        fs::write(&tracking_file, bug_tracking_code).expect("internal error");

        // Test case 2: Fixed bug descriptions
        let fixed_bug_code = r#"
    // Bug: Previously used walkdir directly, bypassing ignore file support
    let discovery_config = FileDiscoveryConfig {
        respect_gitignore: true,
    };

    // CRITICAL FIX: Use ProjectFileDiscovery instead of WalkDir
    // This ensures .pmatignore and .paimlignore files are respected
    // Bug: Previously used walkdir directly
    fn use_project_discovery() {}
"#;
        let fixed_file = temp_dir.path().join("fixed").with_extension("rs");
        fs::write(&fixed_file, fixed_bug_code).expect("internal error");

        // Test case 3: Bug-related functionality descriptions
        let functionality_code = r#"
// Bug fix patterns
fn extract_patterns() {
    // This describes functionality for detecting bug fix commits
}

// Extract bug fix claims
fn analyze_commits() {
    // Extracting bug information from commit messages
}

/// Computes volume, difficulty, effort, programming time, and bug estimates
fn halstead_metrics() {}
"#;
        let functionality_file = temp_dir.path().join("functionality").with_extension("rs");
        fs::write(&functionality_file, functionality_code).expect("internal error");

        let result = detector
            .analyze_project(temp_dir.path(), false)
            .await
            .expect("internal error");

        // All these comments describe bug tracking IDs, fixed bugs, or bug-related functionality
        // They are NOT self-admitted technical debt (TODO/FIXME for future work)
        let defect_count = result
            .items
            .iter()
            .filter(|item| matches!(item.category, DebtCategory::Defect))
            .count();

        assert_eq!(
            defect_count, 0,
            "Bug tracking IDs and fixed bug descriptions should NOT be flagged as SATD. Found {} false positives",
            defect_count
        );
    }