provenance-cli 0.2.1

Command-line interface for Provenance requirements traceability
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

use crate::handlers::ScopeExport;
use crate::wiki::links::LinkResolver;
use provenance_core::coverage::CoverageReport;
use provenance_core::{Edge, EdgeType, NodeType, Requirement, Source, StableId};
use provenance_store::cache::{GapItem, GraphQuery};
use std::cell::OnceCell;
use std::collections::BTreeMap;

pub(super) struct Assembler<'a> {
    pub(super) state: &'a ScopeExport,
    pub(super) resolver: &'a LinkResolver,
    pub(super) coverage: Option<&'a CoverageReport>,
    pub(super) gaps: &'a [GapItem],
    /// The same traversals gap policy runs on. The wiki reads decisions and
    /// produced rules through this rather than re-deriving them, so a page
    /// and its gap notices can never disagree about what the graph says.
    pub(super) query: GraphQuery<'a, 'a>,
    /// Rule id to the requirements that rule answers to, inverted from the
    /// forward traversal on first use. A rule page must not walk the graph
    /// backwards on its own: one walk, read in both directions.
    pub(super) rule_requirements: OnceCell<BTreeMap<&'a str, Vec<&'a Requirement>>>,
}

impl<'a> Assembler<'a> {
    pub(super) fn edges(&self) -> impl Iterator<Item = &'a Edge> {
        let scope = self.state.scope.as_str();
        self.state
            .edges
            .iter()
            .filter(move |edge| edge.scope_id.as_str() == scope)
    }

    /// Matches an edge by its full identity: type, kind, and id on both
    /// ends. Stable ids are not namespaced per record kind, so matching on
    /// `from_id`/`to_id` alone would let a `Source` and a `Resolution` that
    /// happen to share an id get cross-wired; `from_type`/`to_type` must be
    /// checked too.
    pub(super) fn edge_exists(
        &self,
        edge_type: EdgeType,
        from_type: NodeType,
        from_id: &StableId,
        to_type: NodeType,
        to_id: &StableId,
    ) -> bool {
        self.edges().any(|edge| {
            edge.edge_type == edge_type
                && edge.from_type == from_type
                && edge.from_id == *from_id
                && edge.to_type == to_type
                && edge.to_id == *to_id
        })
    }

    pub(super) fn find_requirement(&self, id: &StableId) -> Option<&'a Requirement> {
        self.state
            .requirements
            .iter()
            .find(|requirement| requirement.id == *id)
    }

    pub(super) fn find_source(&self, id: &StableId) -> Option<&'a Source> {
        self.state.sources.iter().find(|source| source.id == *id)
    }
}