rustqual 0.4.4

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

use syn::spanned::Spanned;

use super::{is_self_field_access, single_return_expr, BoilerplateFind};
use crate::config::sections::BoilerplateConfig;

/// Minimum getter/setter methods to flag on one struct.
const MIN_GETTER_SETTER_COUNT: usize = 3;

/// Detect structs with many trivial getter/setter methods.
/// Operation: per-impl counting logic; helper calls in closures.
// qual:allow(complexity) reason: "getter/setter detection requires nested AST inspection"
pub(super) fn check_manual_getter_setter(
    parsed: &[(String, String, syn::File)],
    config: &BoilerplateConfig,
) -> Vec<BoilerplateFind> {
    pattern_guard!("BP-003", config);
    let mut findings = Vec::new();
    for (file, _, syntax) in parsed {
        for item in &syntax.items {
            let imp = if let syn::Item::Impl(imp) = item {
                imp
            } else {
                continue;
            };
            // Skip trait impls
            if imp.trait_.is_some() {
                continue;
            }
            let count = imp
                .items
                .iter()
                .filter(|i| {
                    if let syn::ImplItem::Fn(m) = i {
                        let is_getter = m.block.stmts.len() == 1
                            && m.sig.inputs.len() == 1
                            && {
                                // Body is &self.field or self.field
                                if let Some(expr) = single_return_expr(&m.block) {
                                    is_self_field_access(expr)
                                        || matches!(expr, syn::Expr::Reference(r) if is_self_field_access(&r.expr))
                                } else {
                                    false
                                }
                            };
                        let is_setter = m.block.stmts.len() == 1
                            && m.sig.inputs.len() == 2
                            && matches!(
                                &m.block.stmts[0],
                                syn::Stmt::Expr(syn::Expr::Assign(a), Some(_))
                                    if is_self_field_access(&a.left)
                            );
                        is_getter || is_setter
                    } else {
                        false
                    }
                })
                .count();
            if count >= MIN_GETTER_SETTER_COUNT {
                let struct_name = if let syn::Type::Path(tp) = &*imp.self_ty {
                    tp.path.segments.last().map(|s| s.ident.to_string())
                } else {
                    None
                };
                findings.push(BoilerplateFind {
                    pattern_id: "BP-003".to_string(),
                    file: file.clone(),
                    line: imp.self_ty.span().start().line,
                    struct_name,
                    description: format!(
                        "{count} trivial getter/setter methods — consider field visibility or accessor macros"
                    ),
                    suggestion: "Consider making fields pub or using a getter/setter derive macro"
                        .to_string(),
                });
            }
        }
    }
    findings
}