comindly_core/
view.rs

1//! What the apps show of an index — graph, contracts, ledger, conventions, dependencies — read once.
2
3use crate::conventions::Convention;
4use crate::graph::{CodeGraph, ContractView};
5use crate::ledger::Entry;
6use crate::manifests::InternalDep;
7use crate::model::{Edge, Symbol};
8
9pub use comindly_api::view::View;
10
11/// Everything the UI shows, loaded from an index.
12pub struct Data {
13    pub graph: CodeGraph,
14    pub symbols: Vec<Symbol>,
15    pub edges: Vec<Edge>,
16    pub contracts: Vec<ContractView>,
17    pub entries: Vec<Entry>,
18    /// Measured conventions; `manual` holds the team's changes to them.
19    pub conventions: Vec<Convention>,
20    pub manual: Vec<crate::conventions::Manual>,
21    pub deps: Vec<InternalDep>,
22    /// Index root for writing ledger reviews; `None` makes the UI read-only.
23    pub root: Option<String>,
24    /// Why the index could not be loaded (the UIs then start empty).
25    pub problem: Option<String>,
26    /// Each repository's recent history, to tell a record's own change from a later one.
27    pub logs: crate::index::RepoLogs,
28}
29
30impl Data {
31    /// Everything the UIs show, read from the index at `root`.
32    pub fn load(root: &str, verifier: &crate::signing::Verifier) -> anyhow::Result<Data> {
33        let dir = format!("{}/_graph", root.trim_end_matches('/'));
34        let (symbols, edges) = crate::index::read_graph_blocking(&dir)
35            .map_err(|e| anyhow::anyhow!("no index at {dir}: {e:#}"))?;
36        let mut conventions = match crate::index::read_facts_blocking(&dir) {
37            Ok(Some(facts)) => crate::conventions::mine(&symbols, &edges, &facts),
38            _ => Vec::new(),
39        };
40        conventions.extend(crate::index::read_recipes_blocking(&dir).unwrap_or_default());
41        let manual = crate::conventions::manual_blocking(root).unwrap_or_default();
42        let records = crate::ledger::all_blocking(root).unwrap_or_default();
43        let logs = crate::index::read_repo_logs_blocking(&dir).unwrap_or_default();
44        let mut entries = crate::ledger::derive(&records, &symbols, verifier);
45        crate::ledger::settle_notes(&mut entries, &records, &logs);
46        let packages = crate::index::read_packages_blocking(&dir).unwrap_or_default();
47        let findings = crate::checks::run(&entries, &symbols, &edges, &packages);
48        crate::checks::promote(&mut entries, &findings);
49        let deps = crate::manifests::internal(&packages);
50        let mut data = Data::from_view(View {
51            symbols: symbols.into(),
52            edges: edges.into(),
53            entries: entries.into(),
54            conventions: conventions.into(),
55            manual: manual.into(),
56            deps: deps.into(),
57            problem: None,
58        });
59        data.root = Some(root.to_string());
60        data.logs = logs;
61        Ok(data)
62    }
63
64    /// The UI's data from a transferred view; the graph and contracts are rebuilt. Read-only.
65    pub fn from_view(v: View<'_>) -> Data {
66        let (symbols, edges) = (v.symbols.into_owned(), v.edges.into_owned());
67        let graph = CodeGraph::build(&symbols, &edges);
68        Data {
69            contracts: graph.contracts(None, false),
70            graph,
71            symbols,
72            edges,
73            entries: v.entries.into_owned(),
74            conventions: v.conventions.into_owned(),
75            manual: v.manual.into_owned(),
76            deps: v.deps.into_owned(),
77            root: None,
78            problem: v.problem,
79            logs: Default::default(),
80        }
81    }
82
83    /// No index yet: an empty view of `root` that says why.
84    pub fn empty(root: &str, problem: String) -> Data {
85        Data {
86            graph: CodeGraph::build(&[], &[]),
87            symbols: Vec::new(),
88            edges: Vec::new(),
89            contracts: Vec::new(),
90            entries: Vec::new(),
91            conventions: Vec::new(),
92            manual: Vec::new(),
93            deps: Vec::new(),
94            root: Some(root.to_string()),
95            problem: Some(problem),
96            logs: Default::default(),
97        }
98    }
99
100    /// The index at `root`, or an empty view saying why it could not be read.
101    pub fn load_or_empty(root: &str, verifier: &crate::signing::Verifier) -> Data {
102        Data::load(root, verifier).unwrap_or_else(|e| Data::empty(root, format!("{e:#}")))
103    }
104}
comindly_core/view.rs

comindly_core/
view.rs
