pmat 3.15.0

PMAT - Zero-config AI context generation and code quality toolkit (CLI, MCP, HTTP)
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

/// Toyota Way: Extract Method - Format quality gate results as `JUnit` XML (complexity ≤8)
/// Creates JUnit-compatible XML output for CI/CD integration
#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub fn format_qg_as_junit(violations: &[QualityViolation]) -> Result<String> {
    use std::fmt::Write;
    let mut output = String::new();

    // XML header and test suite opening
    writeln!(&mut output, r#"<?xml version="1.0" encoding="UTF-8"?>"#)?;
    writeln!(&mut output, r#"<testsuites name="Quality Gate">"#)?;
    writeln!(
        &mut output,
        r#"  <testsuite name="Quality Checks" tests="{}" failures="{}">"#,
        violations.len(),
        violations.len()
    )?;

    // Generate test cases for each violation
    for violation in violations {
        write_junit_test_case(&mut output, violation)?;
    }

    // Close XML structure
    writeln!(&mut output, r"  </testsuite>")?;
    writeln!(&mut output, r"</testsuites>")?;
    Ok(output)
}

/// Toyota Way: Extract Method - Write single `JUnit` test case (complexity ≤3)
fn write_junit_test_case(
    output: &mut String,
    violation: &QualityViolation,
) -> Result<(), std::fmt::Error> {
    use std::fmt::Write;

    writeln!(
        output,
        r#"    <testcase name="{}" classname="{}">"#,
        violation.message, violation.check_type
    )?;
    writeln!(
        output,
        r#"      <failure message="{}" type="{}"/>"#,
        violation.message, violation.severity
    )?;
    writeln!(output, r"    </testcase>")?;
    Ok(())
}

/// Format project-wide quality gate output
#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub fn format_project_output(
    results: &QualityGateResults,
    violations: &[QualityViolation],
    format: QualityGateOutputFormat,
) -> Result<String> {
    match format {
        QualityGateOutputFormat::Json => Ok(serde_json::to_string_pretty(&json!({
            "passed": results.passed,
            "results": results,
            "violations": violations,
        }))?),
        QualityGateOutputFormat::Summary
        | QualityGateOutputFormat::Markdown
        | QualityGateOutputFormat::Detailed
        | QualityGateOutputFormat::Human => Ok(format_project_summary(results, violations)),
        QualityGateOutputFormat::Junit => format_qg_as_junit(violations),
    }
}

/// Format project summary
fn format_project_summary(results: &QualityGateResults, violations: &[QualityViolation]) -> String {
    let mut output = String::new();

    output.push_str("# Quality Gate Results\n\n");

    if results.passed {
        output.push_str("## ✅ PASSED\n\n");
    } else {
        output.push_str("## ❌ FAILED\n\n");
    }

    output.push_str(&format!(
        "Total violations: {}\n\n",
        results.total_violations
    ));

    if violations.is_empty() {
        output.push_str("No violations found.\n");
    } else {
        output.push_str("## Violations by Type\n\n");
        let grouped = group_violations_by_type(violations);
        output.push_str(&format_violations_markdown(&grouped));
    }

    output
}

/// Group violations by type
fn group_violations_by_type(
    violations: &[QualityViolation],
) -> HashMap<String, Vec<&QualityViolation>> {
    let mut grouped = HashMap::new();
    for violation in violations {
        grouped
            .entry(violation.check_type.clone())
            .or_insert_with(Vec::new)
            .push(violation);
    }
    grouped
}

/// Format violations as markdown
fn format_violations_markdown(grouped: &HashMap<String, Vec<&QualityViolation>>) -> String {
    let mut output = String::new();

    for (check_type, violations) in grouped {
        output.push_str(&format!(
            "### {} ({} violation{})\n\n",
            check_type,
            violations.len(),
            if violations.len() == 1 { "" } else { "s" }
        ));

        for violation in violations {
            if let Some(line) = violation.line {
                output.push_str(&format!(
                    "- **{}:{}**: {}\n",
                    violation.file, line, violation.message
                ));
            } else {
                output.push_str(&format!(
                    "- **{}**: {}\n",
                    violation.file, violation.message
                ));
            }
        }
        output.push('\n');
    }

    output
}