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

//! Shared fixtures for the report-reporter unit tests.
//!
//! Every reporter test (json, github, baseline, root, suggestions, html,
//! text, sarif, …) needs the same two builders: a single `FunctionAnalysis`
//! with sane defaults and an `AnalysisResult` wrapping a set of results with
//! the standard summary / projection. Keeping them here means one source of
//! truth, reachable from every `report::*::tests` module, instead of a copy
//! per test file.

use crate::adapters::analyzers::iosp::{
    compute_severity, CallOccurrence, Classification, FunctionAnalysis, LogicOccurrence,
};
use crate::report::{AnalysisResult, Summary};

/// A `Violation` classification with one logic location (`logic_kind` at
/// line 1) and one own-call location (`call_name` at line 2) — the shape
/// the reporter tests use to exercise violation rendering.
pub(crate) fn violation(logic_kind: &str, call_name: &str) -> Classification {
    Classification::Violation {
        has_logic: true,
        has_own_calls: true,
        logic_locations: vec![LogicOccurrence {
            kind: logic_kind.into(),
            line: 1,
        }],
        call_locations: vec![CallOccurrence {
            name: call_name.into(),
            line: 2,
        }],
    }
}

/// A `FunctionAnalysis` for `name` with the given classification and all
/// warning/metric fields defaulted (file `test.rs`, line 1, no complexity).
pub(crate) fn make_result(name: &str, classification: Classification) -> FunctionAnalysis {
    let severity = compute_severity(&classification);
    FunctionAnalysis {
        name: name.to_string(),
        file: "test.rs".to_string(),
        line: 1,
        classification,
        parent_type: None,
        suppressed: false,
        complexity: None,
        qualified_name: name.to_string(),
        severity,
        cognitive_warning: false,
        cyclomatic_warning: false,
        nesting_depth_warning: false,
        function_length_warning: false,
        unsafe_warning: false,
        error_handling_warning: false,
        complexity_suppressed: false,
        own_calls: vec![],
        parameter_count: 0,
        is_trait_impl: false,
        is_test: false,
        effort_score: None,
    }
}

/// Wrap `results` in an `AnalysisResult` with the standard summary and the
/// IOSP projection populated (other finding dimensions left empty).
pub(crate) fn make_analysis(results: Vec<FunctionAnalysis>) -> AnalysisResult {
    let summary = Summary::from_results(&results);
    let data = crate::app::projection::project_data(&results, None);
    let findings = crate::domain::AnalysisFindings {
        iosp: crate::app::projection::project_iosp(&results),
        ..Default::default()
    };
    AnalysisResult {
        results,
        summary,
        findings,
        data,
    }
}