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
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

use crate::handlers::check::index::CheckIndex;
use crate::handlers::check::references::{check_ideation_target, check_scoped_reference};
use provenance_core::{Contribution, DispositionRecord, ProposalCard, ScopeId, SynthesisPacket};
use provenance_store::state_store::StateStore;

pub(super) struct Records {
    contributions: Vec<Contribution>,
    synthesis_packets: Vec<SynthesisPacket>,
    proposal_cards: Vec<ProposalCard>,
    dispositions: Vec<DispositionRecord>,
}

impl Records {
    pub(super) fn load(store: &StateStore, scope_id: &ScopeId) -> anyhow::Result<Self> {
        store.validate_ideation_scope(scope_id)?;
        Ok(Self {
            contributions: store.list_contributions(scope_id)?,
            synthesis_packets: store.list_synthesis_packets(scope_id)?,
            proposal_cards: store.list_proposal_cards(scope_id)?,
            dispositions: store.list_dispositions(scope_id)?,
        })
    }

    pub(super) fn validate_scope_ownership(
        &self,
        loaded_scope_id: &ScopeId,
        findings: &mut Vec<String>,
    ) {
        macro_rules! check_records {
            ($records:expr, $record_type:literal) => {
                for record in $records {
                    super::check_scope_ownership(
                        loaded_scope_id,
                        &record.scope_id,
                        $record_type,
                        &record.id,
                        findings,
                    );
                }
            };
        }

        check_records!(&self.contributions, "contribution");
        check_records!(&self.synthesis_packets, "synthesis packet");
        check_records!(&self.proposal_cards, "proposal");
        check_records!(&self.dispositions, "disposition");
    }

    pub(super) fn add_to(&self, index: &mut CheckIndex) {
        for proposal in &self.proposal_cards {
            index.add_node(&proposal.scope_id, "proposal", &proposal.id);
        }
    }

    pub(super) fn validate(
        &self,
        index: &CheckIndex,
        scope_id: &ScopeId,
        dangling: &mut Vec<String>,
    ) {
        for contribution in &self.contributions {
            check_ideation_target(
                index,
                dangling,
                scope_id,
                &format!("contribution {}", contribution.id.as_str()),
                &contribution.target,
            );
        }
        for synthesis_packet in &self.synthesis_packets {
            check_ideation_target(
                index,
                dangling,
                scope_id,
                &format!("synthesis packet {}", synthesis_packet.id.as_str()),
                &synthesis_packet.target,
            );
        }
        for proposal in &self.proposal_cards {
            let owner = format!("proposal {}", proposal.id.as_str());
            check_ideation_target(
                index,
                dangling,
                scope_id,
                &owner,
                &proposal.traceability.target,
            );
            for source_id in &proposal.traceability.source_ids {
                check_scoped_reference(
                    index,
                    dangling,
                    scope_id,
                    &owner,
                    "source_id",
                    "source",
                    source_id,
                );
            }
            if let Some(duplicate_of) = &proposal.duplicate_of {
                check_scoped_reference(
                    index,
                    dangling,
                    scope_id,
                    &owner,
                    "duplicate_of",
                    "proposal",
                    duplicate_of,
                );
            }
            if let Some(superseded_by) = &proposal.superseded_by {
                check_scoped_reference(
                    index,
                    dangling,
                    scope_id,
                    &owner,
                    "superseded_by",
                    "proposal",
                    superseded_by,
                );
            }
        }
        for disposition in &self.dispositions {
            check_scoped_reference(
                index,
                dangling,
                scope_id,
                &format!("disposition {}", disposition.id.as_str()),
                "proposal",
                "proposal",
                &disposition.proposal_id,
            );
        }
    }
}