rustqual 1.6.0

Comprehensive Rust code quality analyzer — seven dimensions: IOSP, Complexity, DRY, SRP, Coupling, Test Quality, Architecture
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

use crate::adapters::analyzers::structural::slm::*;
use crate::adapters::analyzers::structural::{StructuralWarning, StructuralWarningKind};

fn detect_in(source: &str) -> Vec<StructuralWarning> {
    super::detect_single(source, detect_slm)
}

#[test]
fn selfless_method_in_cfg_test_file_excluded() {
    // SLM must skip whole test files (here a `#![cfg(test)]` companion),
    // not only inline `#[cfg(test)] mod`.
    let w = detect_in("#![cfg(test)]\nstruct S; impl S { fn foo(&self) -> i32 { 42 } }");
    assert!(
        w.is_empty(),
        "selfless method in a #![cfg(test)] file must be excluded: {} warning(s)",
        w.len()
    );
}

#[test]
fn cfg_test_attr_impl_method_excluded() {
    // An item-level `#[cfg(test)]` impl is test code even in a production file;
    // its methods must not trip SLM (consistent with whole cfg-test files).
    let w = detect_in("struct S; #[cfg(test)] impl S { fn foo(&self) -> i32 { 42 } }");
    assert!(
        w.is_empty(),
        "a #[cfg(test)] impl method must be excluded from SLM: {} warning(s)",
        w.len()
    );
}

#[test]
fn cfg_test_attr_method_excluded() {
    // `#[cfg(test)]` directly on an impl METHOD makes that method test code even
    // in a regular production impl — it must not trip SLM.
    let w = detect_in("struct S; impl S { #[cfg(test)] fn foo(&self) -> i32 { 42 } }");
    assert!(
        w.is_empty(),
        "a #[cfg(test)] method must be excluded from SLM: {} warning(s)",
        w.len()
    );
}

#[test]
fn test_selfless_method_flagged() {
    let w = detect_in("struct S; impl S { fn foo(&self) -> i32 { 42 } }");
    assert_eq!(w.len(), 1);
    assert!(matches!(w[0].kind, StructuralWarningKind::SelflessMethod));
}

#[test]
fn test_self_field_access_not_flagged() {
    let w = detect_in("struct S { x: i32 } impl S { fn foo(&self) -> i32 { self.x } }");
    assert!(w.is_empty());
}

#[test]
fn test_self_method_call_not_flagged() {
    let w = detect_in("struct S; impl S { fn foo(&self) -> String { self.to_string() } }");
    assert!(w.is_empty());
}

#[test]
fn test_trait_impl_excluded() {
    let w = detect_in(
        "trait T { fn foo(&self) -> i32; } struct S; impl T for S { fn foo(&self) -> i32 { 42 } }",
    );
    assert!(w.is_empty());
}

#[test]
fn test_no_receiver_not_flagged() {
    let w = detect_in("struct S; impl S { fn new() -> Self { S } }");
    assert!(w.is_empty());
}

#[test]
fn test_empty_body_not_flagged() {
    let w = detect_in("struct S; impl S { fn foo(&self) {} }");
    assert!(w.is_empty());
}

#[test]
fn test_stub_body_not_flagged() {
    let w = detect_in("struct S; impl S { fn foo(&self) { todo!() } }");
    assert!(w.is_empty());
}

#[test]
fn test_mut_self_selfless_flagged() {
    let w = detect_in("struct S; impl S { fn foo(&mut self) -> i32 { 42 } }");
    assert_eq!(w.len(), 1);
}

#[test]
fn test_matches_macro_self_not_flagged() {
    let w = detect_in(
        "struct S { x: bool } impl S { fn foo(&self) -> bool { matches!(self, S { x: true }) } }",
    );
    assert!(
        w.is_empty(),
        "matches!(self, ...) should count as self reference"
    );
}

#[test]
fn test_self_in_macro_arg_not_flagged() {
    // A method whose ONLY self-reference is a macro argument (here `format!`)
    // genuinely uses self — it must not trip SLM. `syn::visit` treats a macro
    // body as an opaque token stream, so the `SelfRefChecker` has to scan macro
    // tokens for `self` (it special-cases only `matches!` today → false positive).
    let w = detect_in(
        "struct S { name: String } impl S { fn label(&self) -> String { format!(\"[{}]\", self.name) } }",
    );
    assert!(
        w.is_empty(),
        "self inside a macro arg (format!) must count as a self reference: {} warning(s)",
        w.len()
    );
}