rustqual 1.4.1

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

//! `app::structural_metrics` — enable guard, suppression window (STRUCTURAL = 5)
//! and per-dimension warning counting.
use crate::adapters::analyzers::structural::{
    StructuralAnalysis, StructuralWarning, StructuralWarningKind,
};
use crate::app::structural_metrics::*;
use crate::config::Config;
use crate::findings::Dimension;
use crate::report::Summary;

fn warning(line: usize, dim: Dimension, suppressed: bool) -> StructuralWarning {
    StructuralWarning {
        file: "test.rs".to_string(),
        line,
        name: "m".to_string(),
        kind: StructuralWarningKind::SelflessMethod,
        dimension: dim,
        suppressed,
    }
}

#[test]
fn compute_structural_returns_some_when_enabled() {
    // Guards the `!config.structural.enabled` early-return.
    assert!(compute_structural(&[], &Config::default()).is_some());
}

fn struct_suppressed(w_line: usize, sup_line: usize, w_dim: Dimension, sup_dim: Dimension) -> bool {
    let mut analysis = StructuralAnalysis {
        warnings: vec![warning(w_line, w_dim, false)],
    };
    let sups = super::one_suppression(sup_line, sup_dim);
    mark_structural_suppressions(Some(&mut analysis), &sups);
    analysis.warnings[0].suppressed
}

#[test]
fn structural_suppression_window_and_dimension() {
    let s = Dimension::Srp;
    // same line, in window
    assert!(struct_suppressed(5, 5, s, s));
    // diff 5 == STRUCTURAL window
    assert!(struct_suppressed(6, 1, s, s));
    // diff 6 > window
    assert!(!struct_suppressed(7, 1, s, s));
    // in window but covers a different dimension (kills the `&& covers`)
    assert!(!struct_suppressed(5, 5, s, Dimension::Complexity));
    // diff 8 > window — kills `w.line - sup.line` `-`→`/` (10/2=5 ≤ 5)
    assert!(!struct_suppressed(10, 2, s, s));
    // suppression below the warning (kills the leading `&&` / underflow)
    assert!(!struct_suppressed(2, 5, s, s));
}

#[test]
fn count_structural_warnings_splits_by_dimension() {
    // SRP: 2 unsuppressed + 1 suppressed → 2. Coupling: 1 unsuppressed + 1
    // suppressed → 1. Distinct counts pin the `!suppressed` filter, both match
    // arms and their `+= 1`, and the function against being a no-op.
    let analysis = StructuralAnalysis {
        warnings: vec![
            warning(1, Dimension::Srp, false),
            warning(2, Dimension::Srp, false),
            warning(3, Dimension::Srp, true),
            warning(4, Dimension::Coupling, false),
            warning(5, Dimension::Coupling, true),
        ],
    };
    let mut summary = Summary::from_results(&[]);
    count_structural_warnings(Some(&analysis), &mut summary);
    assert_eq!(summary.structural_srp_warnings, 2);
    assert_eq!(summary.structural_coupling_warnings, 1);
}