loftspec 2.0.1

The Loft Specification Format: document model, identity, canonical bytes, hashing and conversion
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

//! `loft check` as a function (F-38): the tree read, then validated, then linted. A read
//! error stops it before the validator; an error in `spec/lint.yaml` stops it before the linter.
//! Every error and finding names the sites of the elements it concerns (RQ-158).

use std::fmt;

use crate::codec::{Files, LABELS, LINT, MANIFEST, ReadError, Site, Sites, SpecPath, read_sited};
use crate::conflict::ConflictOwner;
use crate::lint::{Finding, LintConfig, lint};
use crate::validate::{ValidationError, validate};

/// A validation error placed at the sites of the elements it names.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Placed {
    pub error: ValidationError,
    pub sites: Vec<Site>,
}

impl fmt::Display for Placed {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        for site in &self.sites {
            write!(formatter, "{site}: ")?;
        }
        self.error.fmt(formatter)
    }
}

/// What checking a tree finds.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Checked {
    /// The tree does not read; nothing else ran (RQ-137).
    Unread(Vec<ReadError>),
    /// The tree reads: its validation errors, the errors of its lint configuration, and the
    /// findings, which are none when the configuration is in error (AC-674).
    Read {
        invalid: Vec<Placed>,
        config: Vec<ReadError>,
        findings: Vec<Finding>,
    },
}

impl Checked {
    /// Whether the check found an error, as opposed to findings alone.
    #[must_use]
    pub fn has_errors(&self) -> bool {
        match self {
            Self::Unread(_) => true,
            Self::Read {
                invalid, config, ..
            } => !invalid.is_empty() || !config.is_empty(),
        }
    }

    /// The findings, which a tree that does not read has none of.
    #[must_use]
    pub fn findings(&self) -> &[Finding] {
        match self {
            Self::Unread(_) => &[],
            Self::Read { findings, .. } => findings,
        }
    }
}

/// Checks a `spec/` tree.
#[must_use]
pub fn check(files: &Files) -> Checked {
    let (document, sites) = match read_sited(files) {
        Ok(read) => read,
        Err(errors) => return Checked::Unread(errors),
    };
    let invalid = placed(validate(&document), &sites);
    let config = LintConfig::read(files.get(&SpecPath::new(LINT)).map(Vec::as_slice));
    let (config, findings) = match config {
        Ok(config) => (Vec::new(), lint(&document, &sites, &config)),
        Err(errors) => (errors, Vec::new()),
    };
    Checked::Read {
        invalid,
        config,
        findings,
    }
}

/// Validation errors, each placed at the sites of the elements it names.
pub(crate) fn placed(errors: Vec<ValidationError>, sites: &Sites) -> Vec<Placed> {
    errors
        .into_iter()
        .map(|error| place(error, sites))
        .collect()
}

fn place(error: ValidationError, sites: &Sites) -> Placed {
    let file = match &error {
        ValidationError::Conflict {
            owner: ConflictOwner::Manifest,
            ..
        } => Some(MANIFEST),
        ValidationError::Conflict {
            owner: ConflictOwner::Labels,
            ..
        } => Some(LABELS),
        _ => None,
    };
    let sites = file
        .map(|path| Site {
            path: SpecPath::new(path),
            location: None,
        })
        .into_iter()
        .chain(
            error
                .keys()
                .into_iter()
                .filter_map(|key| sites.get(key).cloned()),
        )
        .collect();
    Placed { error, sites }
}