rustqual 0.5.1

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

use crate::config::StructuralConfig;
use crate::findings::Dimension;

use super::{StructuralMetadata, StructuralWarning, StructuralWarningKind};

/// Detect single-implementation traits: non-pub trait with exactly 1 impl.
/// Operation: compares trait definitions against impl counts.
pub(crate) fn detect_sit(
    warnings: &mut Vec<StructuralWarning>,
    meta: &StructuralMetadata,
    config: &StructuralConfig,
) {
    if !config.check_sit {
        return;
    }
    meta.trait_defs.iter().for_each(|(trait_name, info)| {
        // Skip pub traits (may have external impls)
        if info.is_pub {
            return;
        }
        // Skip marker traits (no methods)
        if info.method_count == 0 {
            return;
        }
        let impl_count = meta
            .trait_impls
            .get(trait_name)
            .map(|v| v.len())
            .unwrap_or(0);
        if impl_count == 1 {
            let (impl_type, _) = &meta.trait_impls[trait_name][0];
            warnings.push(StructuralWarning {
                file: info.file.clone(),
                line: 1,
                name: trait_name.clone(),
                kind: StructuralWarningKind::SingleImplTrait {
                    impl_type: impl_type.clone(),
                },
                dimension: Dimension::Srp,
                suppressed: false,
            });
        }
    });
}

#[cfg(test)]
mod tests {
    use super::super::collect_metadata;
    use super::*;

    fn detect_from(source: &str) -> Vec<StructuralWarning> {
        let syntax = syn::parse_file(source).expect("test source");
        let parsed = vec![("lib.rs".to_string(), source.to_string(), syntax)];
        let meta = collect_metadata(&parsed);
        let config = StructuralConfig::default();
        let mut warnings = Vec::new();
        detect_sit(&mut warnings, &meta, &config);
        warnings
    }

    #[test]
    fn test_single_impl_flagged() {
        let w = detect_from(
            "trait Drawable { fn draw(&self); } struct Circle; impl Drawable for Circle { fn draw(&self) {} }",
        );
        assert_eq!(w.len(), 1);
        assert!(matches!(
            w[0].kind,
            StructuralWarningKind::SingleImplTrait { .. }
        ));
        assert_eq!(w[0].name, "Drawable");
    }

    #[test]
    fn test_multiple_impls_not_flagged() {
        let w = detect_from(
            "trait Drawable { fn draw(&self); } struct Circle; struct Square; impl Drawable for Circle { fn draw(&self) {} } impl Drawable for Square { fn draw(&self) {} }",
        );
        assert!(w.is_empty());
    }

    #[test]
    fn test_pub_trait_excluded() {
        let w = detect_from(
            "pub trait Drawable { fn draw(&self); } struct Circle; impl Drawable for Circle { fn draw(&self) {} }",
        );
        assert!(w.is_empty());
    }

    #[test]
    fn test_marker_trait_excluded() {
        let w = detect_from("trait Marker {} struct Circle; impl Marker for Circle {}");
        assert!(w.is_empty());
    }

    #[test]
    fn test_zero_impls_not_flagged() {
        let w = detect_from("trait Drawable { fn draw(&self); }");
        assert!(w.is_empty());
    }

    #[test]
    fn test_disabled_check() {
        let syntax =
            syn::parse_file("trait D { fn d(&self); } struct C; impl D for C { fn d(&self) {} }")
                .expect("test source");
        let parsed = vec![("lib.rs".to_string(), String::new(), syntax)];
        let meta = collect_metadata(&parsed);
        let config = StructuralConfig {
            check_sit: false,
            ..StructuralConfig::default()
        };
        let mut warnings = Vec::new();
        detect_sit(&mut warnings, &meta, &config);
        assert!(warnings.is_empty());
    }
}