rustqual 1.2.5

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
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

//! Secondary analysis pass — everything after the primary IOSP and
//! complexity sweep: coupling, DRY, SRP, test quality, and structural
//! checks. Each per-dimension pass is a small helper that takes a shared
//! context plus the growing summary. The orchestrator
//! (`run_secondary_analysis`) walks the passes in dependency order and
//! gathers their outputs into one `SecondaryResults` bundle.

use crate::adapters::analyzers::iosp::FunctionAnalysis;
use crate::config::Config;
use crate::report::Summary;

use super::dry_suppressions;
use super::metrics::{
    self, apply_parameter_warnings, build_file_call_graph, compute_coupling, compute_srp,
    count_coupling_warnings, count_dry_findings, count_srp_warnings, mark_coupling_suppressions,
    mark_srp_suppressions, run_dry_detection, run_guarded_detection,
};
use super::structural_metrics::{
    compute_structural, count_structural_warnings, mark_structural_suppressions,
};
use super::tq_metrics::{compute_tq, count_tq_warnings, mark_tq_suppressions};
use crate::adapters::source::filesystem as discovery;

/// Results from coupling, DRY, SRP, TQ, and structural analysis passes.
pub(crate) struct SecondaryResults {
    pub(crate) coupling: Option<crate::adapters::analyzers::coupling::CouplingAnalysis>,
    pub(crate) duplicates: Vec<crate::adapters::analyzers::dry::functions::DuplicateGroup>,
    pub(crate) dead_code: Vec<crate::adapters::analyzers::dry::dead_code::DeadCodeWarning>,
    pub(crate) fragments: Vec<crate::adapters::analyzers::dry::fragments::FragmentGroup>,
    pub(crate) boilerplate: Vec<crate::adapters::analyzers::dry::boilerplate::BoilerplateFind>,
    pub(crate) wildcard_warnings:
        Vec<crate::adapters::analyzers::dry::wildcards::WildcardImportWarning>,
    pub(crate) repeated_matches:
        Vec<crate::adapters::analyzers::dry::match_patterns::RepeatedMatchGroup>,
    pub(crate) srp: Option<crate::adapters::analyzers::srp::SrpAnalysis>,
    pub(crate) tq: Option<crate::adapters::analyzers::tq::TqAnalysis>,
    pub(crate) structural: Option<crate::adapters::analyzers::structural::StructuralAnalysis>,
}

/// Inputs the secondary passes share: parsed workspace, config,
/// pre-computed suppression + cfg-test indexes, and the primary pass's
/// IOSP results. Bundled to keep per-pass signatures narrow.
pub(crate) struct SecondaryContext<'a> {
    pub(crate) parsed: &'a [(String, String, syn::File)],
    pub(crate) config: &'a Config,
    pub(crate) all_results: &'a [FunctionAnalysis],
    pub(crate) suppression_lines:
        &'a std::collections::HashMap<String, Vec<crate::findings::Suppression>>,
    pub(crate) cfg_test_files: &'a std::collections::HashSet<String>,
}

/// Run coupling, DRY, SRP, and TQ analysis passes, updating summary counts.
/// Integration: orchestrates detection sub-functions, no logic.
pub(crate) fn run_secondary_analysis(
    ctx: &SecondaryContext<'_>,
    summary: &mut Summary,
) -> SecondaryResults {
    let api_lines = discovery::collect_api_lines(ctx.parsed);
    let test_helper_lines = discovery::collect_test_helper_lines(ctx.parsed);
    let annotation_lines = metrics::AnnotationLines {
        api: &api_lines,
        test_helper: &test_helper_lines,
    };

    let coupling = run_coupling_pass(ctx, summary);
    let (dry, repeated_matches) = run_dry_pass(ctx, &annotation_lines, summary);
    metrics::count_sdp_violations(coupling.as_ref(), &ctx.config.coupling, summary);

    let srp = run_srp_pass(ctx, summary);
    let tq = run_tq_pass(ctx, &annotation_lines, &dry.dead_code, summary);
    let structural = run_structural_pass(ctx, summary);

    SecondaryResults {
        coupling,
        duplicates: dry.duplicates,
        dead_code: dry.dead_code,
        fragments: dry.fragments,
        boilerplate: dry.boilerplate,
        wildcard_warnings: dry.wildcard_warnings,
        repeated_matches,
        srp,
        tq,
        structural,
    }
}

/// Run coupling analysis + suppressions + warning count.
/// Integration: delegates compute + suppression + count.
fn run_coupling_pass(
    ctx: &SecondaryContext<'_>,
    summary: &mut Summary,
) -> Option<crate::adapters::analyzers::coupling::CouplingAnalysis> {
    let mut coupling = compute_coupling(ctx.parsed, ctx.config);
    mark_coupling_suppressions(coupling.as_mut(), ctx.suppression_lines);
    // Populate SDP violations AFTER suppressions are marked on metrics
    // so each violation inherits the correct `suppressed` state at
    // creation time (no separate mark pass needed).
    if let Some(ca) = coupling.as_mut() {
        crate::adapters::analyzers::coupling::populate_sdp_violations(ca);
    }
    count_coupling_warnings(coupling.as_mut(), &ctx.config.coupling, summary);
    coupling
}

/// Run DRY detection + inverse/exact/fragment/boilerplate/repeated-match suppressions.
/// Integration: delegates detection + per-category suppressions + count.
fn run_dry_pass(
    ctx: &SecondaryContext<'_>,
    annotation_lines: &metrics::AnnotationLines<'_>,
    summary: &mut Summary,
) -> (
    metrics::DryResults,
    Vec<crate::adapters::analyzers::dry::match_patterns::RepeatedMatchGroup>,
) {
    let mut dry = run_dry_detection(
        ctx.parsed,
        ctx.config,
        ctx.suppression_lines,
        annotation_lines,
        ctx.cfg_test_files,
    );
    dry_suppressions::mark_dry_suppressions(&mut dry.duplicates, ctx.suppression_lines);
    let inverse_lines = discovery::collect_inverse_lines(ctx.parsed);
    dry_suppressions::mark_inverse_suppressions(&mut dry.duplicates, &inverse_lines);
    dry_suppressions::mark_dry_suppressions(&mut dry.fragments, ctx.suppression_lines);
    dry_suppressions::mark_dry_suppressions(&mut dry.boilerplate, ctx.suppression_lines);
    use crate::adapters::analyzers::dry::match_patterns::detect_repeated_matches;
    let mut repeated_matches = run_guarded_detection(
        ctx.config.duplicates.detect_repeated_matches,
        |p, c| detect_repeated_matches(p, &c.duplicates),
        ctx.parsed,
        ctx.config,
    );
    dry_suppressions::mark_dry_suppressions(&mut repeated_matches, ctx.suppression_lines);
    count_dry_findings(&dry, &repeated_matches, summary);
    (dry, repeated_matches)
}

/// Run SRP analysis + parameter/struct suppressions + count.
/// Integration: delegates compute + parameter warnings + suppression + count.
fn run_srp_pass(
    ctx: &SecondaryContext<'_>,
    summary: &mut Summary,
) -> Option<crate::adapters::analyzers::srp::SrpAnalysis> {
    let file_call_graph = build_file_call_graph(ctx.all_results);
    let mut srp = compute_srp(ctx.parsed, ctx.config, &file_call_graph);
    apply_parameter_warnings(ctx.all_results, srp.as_mut(), &ctx.config.srp);
    mark_srp_suppressions(srp.as_mut(), ctx.suppression_lines);
    count_srp_warnings(srp.as_ref(), summary);
    srp
}

/// Run Test-Quality analysis + suppressions + count.
/// `annotation_lines` is threaded in from the shared collection above
/// so `compute_tq` doesn't re-scan every source file for the `qual:api`
/// and `qual:test_helper` markers that DRY already collected.
/// Integration: delegates scope build + compute + suppression + count.
fn run_tq_pass(
    ctx: &SecondaryContext<'_>,
    annotation_lines: &metrics::AnnotationLines<'_>,
    dead_code: &[crate::adapters::analyzers::dry::dead_code::DeadCodeWarning],
    summary: &mut Summary,
) -> Option<crate::adapters::analyzers::tq::TqAnalysis> {
    let mut tq = compute_tq(
        ctx.parsed,
        ctx.config,
        ctx.all_results,
        dead_code,
        annotation_lines,
    );
    mark_tq_suppressions(tq.as_mut(), ctx.suppression_lines);
    count_tq_warnings(tq.as_ref(), summary);
    tq
}

/// Run structural-binary checks + suppressions + count.
/// Integration: delegates compute + suppression + count.
fn run_structural_pass(
    ctx: &SecondaryContext<'_>,
    summary: &mut Summary,
) -> Option<crate::adapters::analyzers::structural::StructuralAnalysis> {
    let mut structural = compute_structural(ctx.parsed, ctx.config);
    mark_structural_suppressions(structural.as_mut(), ctx.suppression_lines);
    count_structural_warnings(structural.as_ref(), summary);
    structural
}