kimun 0.20.0

Code metrics tool — health score, complexity, duplication, hotspots, ownership
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

use std::io::Write;
use std::path::PathBuf;

use tempfile::tempdir;

use super::analyzer::SmellKind;
use crate::walk::{ExcludeFilter, WalkConfig};

#[test]
fn finds_long_function_with_correct_count() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("example.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn long_func() {{").unwrap();
    // 55 body lines > default 50
    for i in 0..55 {
        writeln!(f, "    let x{i} = {i};").unwrap();
    }
    writeln!(f, "}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap().unwrap();

    assert!(
        result.total >= 1,
        "expected at least 1 smell, got {}",
        result.total
    );
    let long_fns: Vec<_> = result
        .smells
        .smells
        .iter()
        .filter(|s| s.kind == SmellKind::LongFunction)
        .collect();
    assert_eq!(long_fns.len(), 1);
    assert!(long_fns[0].detail.contains("long_func"));
}

#[test]
fn finds_todo_debt_in_comments() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("debt.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn main() {{").unwrap();
    writeln!(f, "    // TODO: fix this").unwrap();
    writeln!(f, "    // FIXME: also broken").unwrap();
    writeln!(f, "    let x = 1;").unwrap();
    writeln!(f, "}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap().unwrap();

    let todos: Vec<_> = result
        .smells
        .smells
        .iter()
        .filter(|s| s.kind == SmellKind::TodoDebt)
        .collect();
    assert_eq!(todos.len(), 2);
    assert!(todos[0].detail.contains("TODO"));
    assert!(todos[1].detail.contains("FIXME"));
}

#[test]
fn finds_long_params_single_line() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("params.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn many(a: i32, b: i32, c: i32, d: i32, e: i32) {{").unwrap();
    writeln!(f, "    let x = a;").unwrap();
    writeln!(f, "}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap().unwrap();

    let params: Vec<_> = result
        .smells
        .smells
        .iter()
        .filter(|s| s.kind == SmellKind::LongParameterList)
        .collect();
    assert_eq!(params.len(), 1);
    assert!(params[0].detail.contains("5 params"));
}

#[test]
fn finds_long_params_multiline() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("multiline.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn process(").unwrap();
    writeln!(f, "    a: i32,").unwrap();
    writeln!(f, "    b: i32,").unwrap();
    writeln!(f, "    c: i32,").unwrap();
    writeln!(f, "    d: i32,").unwrap();
    writeln!(f, "    e: i32,").unwrap();
    writeln!(f, ") {{").unwrap();
    writeln!(f, "    let x = a;").unwrap();
    writeln!(f, "}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap().unwrap();

    let params: Vec<_> = result
        .smells
        .smells
        .iter()
        .filter(|s| s.kind == SmellKind::LongParameterList)
        .collect();
    assert_eq!(params.len(), 1, "multi-line signature should be detected");
    assert!(params[0].detail.contains("5 params"));
}

#[test]
fn no_smells_for_clean_file() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("clean.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn add(a: i32, b: i32) -> i32 {{").unwrap();
    writeln!(f, "    a + b").unwrap();
    writeln!(f, "}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap();
    assert!(result.is_none(), "clean file should have no smells");
}

#[test]
fn json_output_runs_without_error() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("test.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn small() {{}}").unwrap();

    let filter = crate::walk::ExcludeFilter::default();
    let cfg = crate::walk::WalkConfig::new(dir.path(), true, &filter);
    let result = super::run(&cfg, true, 20, 50, 4, None);
    assert!(result.is_ok());
}

#[test]
fn doc_comments_with_use_not_false_positive() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("doc.rs");

    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "/// use std::io::Read;").unwrap();
    writeln!(f, "/// use tokio::runtime::Runtime;").unwrap();
    writeln!(f, "fn main() {{}}").unwrap();

    let spec = crate::loc::language::detect(&file).unwrap();
    let result = super::analyze_file(&file, spec, 50, 4).unwrap();
    // Should not detect commented-out code for doc comments with `use`
    if let Some(ref metrics) = result {
        let commented: Vec<_> = metrics
            .smells
            .smells
            .iter()
            .filter(|s| s.kind == SmellKind::CommentedOutCode)
            .collect();
        assert!(
            commented.is_empty(),
            "doc comments with `use` should not trigger commented-out code detection"
        );
    }
}

#[test]
fn run_on_files_with_smell() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("big.rs");
    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn big() {{").unwrap();
    for i in 0..55 {
        writeln!(f, "    let x{i} = {i};").unwrap();
    }
    writeln!(f, "}}").unwrap();

    let result = super::run_on_files(&[file], false, 20, 50, 4, None);
    assert!(result.is_ok());
}

#[test]
fn run_on_files_empty_list() {
    let result = super::run_on_files(&[], false, 20, 50, 4, None);
    assert!(result.is_ok());
}

#[test]
fn run_on_files_skips_unknown_extension() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("data.xyz");
    std::fs::write(&file, "hello world").unwrap();

    let result = super::run_on_files(&[file], false, 20, 50, 4, None);
    assert!(result.is_ok());
}

#[test]
fn run_on_files_json_empty() {
    let result = super::run_on_files(&[], true, 20, 50, 4, None);
    assert!(result.is_ok());
}

#[test]
fn run_on_files_nonexistent_path_skips() {
    let paths = vec![PathBuf::from("/nonexistent/path/fake.rs")];
    let result = super::run_on_files(&paths, false, 20, 50, 4, None);
    assert!(
        result.is_ok(),
        "nonexistent files should be skipped, not panic"
    );
}

#[test]
fn run_on_files_github_format_with_smells() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("big.rs");
    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn big() {{").unwrap();
    for i in 0..55 {
        writeln!(f, "    let x{i} = {i};").unwrap();
    }
    writeln!(f, "}}").unwrap();

    let result = super::run_on_files(&[file], false, 20, 50, 4, Some("github"));
    assert!(result.is_ok(), "github format should succeed");
}

#[test]
fn run_on_files_json_format_via_format_param() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("big2.rs");
    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn big() {{").unwrap();
    for i in 0..55 {
        writeln!(f, "    let x{i} = {i};").unwrap();
    }
    writeln!(f, "}}").unwrap();

    let result = super::run_on_files(&[file], false, 20, 50, 4, Some("json"));
    assert!(result.is_ok(), "json format param should succeed");
}

#[test]
fn run_on_files_empty_json_format() {
    // json=false but format=Some("json") with empty list → print_json([])
    let result = super::run_on_files(&[], false, 20, 50, 4, Some("json"));
    assert!(result.is_ok());
}

#[test]
fn run_github_format_with_smells() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("big3.rs");
    let mut f = std::fs::File::create(&file).unwrap();
    writeln!(f, "fn big() {{").unwrap();
    for i in 0..55 {
        writeln!(f, "    let x{i} = {i};").unwrap();
    }
    writeln!(f, "}}").unwrap();

    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), true, &filter);
    let result = super::run(&cfg, false, 20, 50, 4, Some("github"));
    assert!(result.is_ok(), "run github format should succeed");
}

#[test]
fn analyze_file_returns_none_for_unsupported_language() {
    let dir = tempdir().unwrap();
    let file = dir.path().join("data.json");
    std::fs::write(&file, "{\"key\": \"value\"}\n").unwrap();
    let spec = crate::loc::language::detect(&file).unwrap();
    // JSON has no function detection markers → returns None
    let result = super::analyze_file(&file, spec, 50, 4).unwrap();
    assert!(result.is_none(), "JSON should have no markers, return None");
}