cordance-advise 0.1.1

Cordance advisory engine. Deterministic doctrine checks against project state.
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

//! R-contracts-1 — every .schema.json must have a matching example fixture.

use camino::Utf8PathBuf;
use cordance_core::advise::{AdviseFinding, Severity};
use cordance_core::pack::CordancePack;
use cordance_core::source::SourceClass;

use super::AdviseRule;

pub struct RContracts1;

impl AdviseRule for RContracts1 {
    fn id(&self) -> &'static str {
        "R-contracts-1"
    }

    fn doctrine_anchor(&self) -> &'static str {
        "doctrine/principles/event-contracts.md"
    }

    fn check(&self, pack: &CordancePack) -> Vec<AdviseFinding> {
        let mut findings = Vec::new();

        let schemas: Vec<_> = pack
            .sources
            .iter()
            .filter(|r| {
                r.class == SourceClass::ProjectSchema && r.path.as_str().ends_with(".schema.json")
            })
            .collect();

        for schema in schemas {
            // Extract the stem from the schema path, e.g. "foo" from "contracts/foo.schema.json".
            let path_str = schema.path.as_str();
            let stem = path_str
                .rsplit('/')
                .next()
                .unwrap_or(path_str)
                .trim_end_matches(".schema.json");

            let has_fixture = pack
                .sources
                .iter()
                .any(|r| r.path.as_str() != path_str && r.path.as_str().contains(stem));

            if !has_fixture {
                findings.push(AdviseFinding {
                    id: self.id().into(),
                    severity: Severity::Warning,
                    summary: format!("Schema {path_str} has no example fixture."),
                    doctrine_anchor: Utf8PathBuf::from(self.doctrine_anchor()),
                    project_paths: vec![schema.path.clone()],
                    remediation: format!(
                        "Add a fixture file alongside the schema: {stem}.example.json or \
                         tests/{stem}.json."
                    ),
                });
            }
        }

        findings
    }
}