source-mesh-core 1.2.0

Rust dependency graph analysis, diagrams, and cycle reports
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

use anyhow::Result;
use anyhow::ensure;
use getset::CopyGetters;
use getset::Getters;

use crate::cycles::CycleAnalysis;
use crate::cycles::CycleGroupId;
use crate::cycles::validate_folder_analysis;
use crate::model::DependencyCount;
use crate::model::DependencyKind;
use crate::model::FolderGraph;
use crate::model::FolderNode;

/* getset parses visibility as one space-delimited token; the types limit these accessors to export. */
#[derive(CopyGetters)]
#[getset(get_copy = "pub(crate)")]
pub(in crate::export) struct IndexedEdge {
    source: usize,
    target: usize,
    weight: DependencyCount,
    kind: DependencyKind,
    cycle_group: Option<CycleGroupId>,
}

#[derive(CopyGetters, Getters)]
pub(in crate::export) struct IndexedGraph<'graph> {
    #[getset(get = "pub(crate)")]
    nodes: BTreeMap<&'graph str, usize>,
    #[getset(get = "pub(crate)")]
    edges: Vec<IndexedEdge>,
    #[getset(get_copy = "pub(crate)")]
    cycle_group_count: usize,
}

impl<'graph> IndexedGraph<'graph> {
    #[must_use]
    pub(in crate::export) fn new(graph: &'graph FolderGraph) -> Self {
        let indexed_nodes = graph.nodes().iter().enumerate().map(|(index, node)| (node.label().as_str(), index));
        let nodes: BTreeMap<_, _> = indexed_nodes.collect();
        let edges = graph.edges().iter().map(|(endpoints, &weight)| {
            let node_indices = (nodes.get(endpoints.source().label().as_str()), nodes.get(endpoints.target().label().as_str()));
            let (Some(&source), Some(&target)) = node_indices else {
                unreachable!("Validated folder graph endpoints must belong to its nodes");
            };
            IndexedEdge { source, target, weight, kind: endpoints.kind(), cycle_group: None }
        }).collect();
        Self { nodes, edges, cycle_group_count: 0 }
    }

    pub(in crate::export) fn with_cycles(graph: &'graph FolderGraph, cycles: Option<&CycleAnalysis<FolderNode>>) -> Result<Self> {
        if let Some(cycles) = cycles {
            validate_folder_analysis(cycles, graph)?;
        }
        let mut indexed_graph = Self::new(graph);
        if let Some(cycles) = cycles {
            indexed_graph.cycle_group_count = cycles.group_count();
            for (edge, indexed_edge) in graph.edges().keys().zip(&mut indexed_graph.edges) {
                indexed_edge.cycle_group = cycles.edge_group(edge);
            }
        }
        Ok(indexed_graph)
    }
}

#[derive(CopyGetters, Getters)]
pub(in crate::export) struct Folder<'graph> {
    #[getset(get_copy = "pub(crate)")]
    label: &'graph str,
    #[getset(get_copy = "pub(crate)")]
    display_label: &'graph str,
    #[getset(get_copy = "pub(crate)")]
    index: usize,
    #[getset(get_copy = "pub(crate)")]
    dependency: bool,
    #[getset(get = "pub(crate)")]
    children: Vec<usize>,
}

impl Folder<'_> {
    fn make_relative_to(&mut self, common_root: &str) {
        if common_root != "." {
            let relative = self.label.strip_prefix(common_root).and_then(|relative| relative.strip_prefix('/'));
            let Some(relative) = relative else {
                unreachable!("Constructed descendants must belong to their common root");
            };
            self.display_label = relative;
        }
    }
}

#[derive(Default)]
pub(in crate::export) struct Hierarchy<'graph> {
    folders: Vec<Folder<'graph>>,
    roots: Vec<usize>,
}

impl<'graph> Hierarchy<'graph> {
    const INDEX_INVARIANT: &'static str = "Hierarchy indices must reference constructed folders";

    pub(in crate::export) fn new(graph: &IndexedGraph<'graph>) -> Result<Self> {
        ensure!(
            graph.nodes.keys().all(|label| {
                *label == "." || label.split('/').all(|component| !matches!(component, "" | "." | ".."))
            }),
            "Grouped folder labels must be '.' or slash-separated relative paths without empty, '.' or '..' components"
        );
        Ok(Self::from_validated_labels(graph))
    }

    #[must_use]
    fn from_validated_labels(graph: &IndexedGraph<'graph>) -> Self {
        let mut hierarchy = Self::default();
        if graph.nodes.is_empty() {
            return hierarchy;
        }
        let mut indices = graph.nodes.clone();
        hierarchy.folders = graph.nodes.iter().map(|(&label, &index)| {
            Folder { label, display_label: label, index, dependency: true, children: Vec::new() }
        }).collect();
        for &label in graph.nodes.keys() {
            let mut ancestor = label;
            while ancestor != "." {
                ancestor = parent_label(ancestor);
                if let Entry::Vacant(entry) = indices.entry(ancestor) {
                    let index = hierarchy.folders.len();
                    entry.insert(index);
                    hierarchy.folders.push(Folder {
                        label: ancestor,
                        display_label: ancestor,
                        index,
                        dependency: false,
                        children: Vec::new(),
                    });
                }
            }
        }
        for (&label, &index) in &indices {
            if label != "." {
                let Some(&parent) = indices.get(parent_label(label)) else {
                    unreachable!("Every constructed folder must have an ancestor entry");
                };
                hierarchy.folder_mut(parent).children.push(index);
            }
        }
        let Some(&root) = indices.get(".") else {
            unreachable!("A nonempty hierarchy must contain its constructed root");
        };
        hierarchy.remove_common_root(root);
        hierarchy
    }

    #[must_use]
    pub(in crate::export) fn folder(&self, index: usize) -> &Folder<'graph> {
        let Some(folder) = self.folders.get(index) else {
            unreachable!("{}", Self::INDEX_INVARIANT);
        };
        folder
    }

    fn folder_mut(&mut self, index: usize) -> &mut Folder<'graph> {
        let Some(folder) = self.folders.get_mut(index) else {
            unreachable!("{}", Self::INDEX_INVARIANT);
        };
        folder
    }

    pub(in crate::export) fn roots(&self) -> impl DoubleEndedIterator<Item = &Folder<'graph>> {
        self.roots.iter().map(|&index| self.folder(index))
    }

    pub(in crate::export) fn events(&self) -> impl Iterator<Item = FolderEvent<'_, 'graph>> {
        let mut work: Vec<_> = self.roots().rev().map(FolderEvent::Enter).collect();
        std::iter::from_fn(move || {
            let event = work.pop()?;
            if let FolderEvent::Enter(folder) = event && !folder.children.is_empty() {
                work.push(FolderEvent::Leave);
                work.extend(folder.children.iter().rev().map(|&index| FolderEvent::Enter(self.folder(index))));
            }
            Some(event)
        })
    }

    fn remove_common_root(&mut self, mut index: usize) {
        let mut common_root = ".";
        loop {
            let folder = self.folder_mut(index);
            let children = std::mem::take(&mut folder.children);
            if children.is_empty() {
                folder.make_relative_to(common_root);
                self.roots.push(index);
                return;
            }
            common_root = folder.label;
            if folder.dependency {
                self.roots.push(index);
            }
            if let &[child] = children.as_slice() {
                index = child;
            } else {
                let mut work = children.clone();
                while let Some(descendant_index) = work.pop() {
                    let descendant = self.folder_mut(descendant_index);
                    descendant.make_relative_to(common_root);
                    work.extend(&descendant.children);
                }
                self.roots.extend(children);
                return;
            }
        }
    }
}

pub(in crate::export) enum FolderEvent<'hierarchy, 'graph> {
    Enter(&'hierarchy Folder<'graph>),
    Leave,
}

#[must_use]
fn parent_label(label: &str) -> &str {
    label.rsplit_once('/').map_or(".", |(parent, _)| parent)
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;
    use std::collections::BTreeSet;

    use claims::assert_ok;
    use claims::assert_some;
    use rstest::rstest;

    use super::FolderEvent;
    use super::Hierarchy;
    use super::IndexedGraph;
    use crate::model::DependencyCount;
    use crate::model::DependencyKind;
    use crate::model::FolderEdge;
    use crate::model::FolderGraph;
    use crate::model::FolderNode;
    use pretty_assertions::assert_eq;

    #[test]
    fn test_hierarchy_ancestors_and_original_node_identifiers() {
        let fixture = FolderGraph::new(
            BTreeSet::from([FolderNode::new("src/api/v1".into()), FolderNode::new("src/store".into())]),
            BTreeMap::from([(
                FolderEdge::new(
                    FolderNode::new("src/api/v1".into()),
                    FolderNode::new("src/store".into()),
                    DependencyKind::Production,
                ),
                DependencyCount::new(7),
            )]),
        );
        let fixture = assert_ok!(fixture, "Ancestor fixture must form a valid folder graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "Valid folder labels must form a hierarchy");
        let api = system_under_test.roots().next();
        let api = assert_some!(api, "Hierarchy must contain the API ancestor");
        let version = api.children.first();
        let version = assert_some!(version, "API ancestor must contain its v1 child");
        let version = system_under_test.folder(*version);
        let storage = system_under_test.roots().next_back();
        let storage = assert_some!(storage, "Hierarchy must contain the storage folder");
        let edge = indexed_graph.edges.first();
        let edge = assert_some!(edge, "Indexed graph must retain the original dependency");

        assert_eq!(system_under_test.roots.len(), 2, "Common root containers must be omitted");
        assert_eq!(
            (api.label, api.display_label, api.dependency),
            ("src/api", "api", false),
            "An ancestor below the common root must remain a relative container"
        );
        assert_eq!(
            (version.label, version.display_label, version.index, version.dependency),
            ("src/api/v1", "api/v1", 0, true),
            "Original v1 endpoint changed"
        );
        assert_eq!(
            (storage.label, storage.display_label, storage.index, storage.dependency),
            ("src/store", "store", 1, true),
            "Original storage endpoint changed"
        );
        assert_eq!(indexed_graph.edges.len(), 1, "Hierarchy changed the edge count");
        assert_eq!((edge.source, edge.target, edge.weight), (0, 1, DependencyCount::new(7)), "Hierarchy changed the dependency");
    }

    #[test]
    fn test_hierarchy_common_ancestor_dependencies() {
        let fixture = FolderGraph::new(
            [".", "src", "src/api", "src/api/v1", "src/api/v2"].map(String::from).map(FolderNode::new).into(),
            BTreeMap::from([
                (
                    FolderEdge::new(FolderNode::new("src".into()), FolderNode::new("src/api".into()), DependencyKind::Production),
                    DependencyCount::new(2),
                ),
                (
                    FolderEdge::new(
                        FolderNode::new("src/api".into()),
                        FolderNode::new("src/api/v1".into()),
                        DependencyKind::Production,
                    ),
                    DependencyCount::new(3),
                ),
                (
                    FolderEdge::new(
                        FolderNode::new("src/api/v2".into()),
                        FolderNode::new("src".into()),
                        DependencyKind::Production,
                    ),
                    DependencyCount::new(5),
                ),
            ]),
        );
        let fixture = assert_ok!(fixture, "Common-ancestor dependencies must form a valid folder graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "Common-ancestor dependencies must support hierarchy creation");

        assert_eq!(system_under_test.roots.len(), 5, "All original folders, including isolated ancestors, must remain");
        assert!(
            system_under_test.roots().all(|folder| folder.children.is_empty() && folder.dependency),
            "Common ancestors must become separate dependency leaves"
        );
        for (folder, (canonical, display)) in system_under_test.roots().zip([
            (".", "."),
            ("src", "src"),
            ("src/api", "src/api"),
            ("src/api/v1", "v1"),
            ("src/api/v2", "v2"),
        ]) {
            assert!(folder.label == canonical && folder.display_label == display, "Unexpected folder label: {}", folder.label);
            assert_eq!(indexed_graph.nodes.get(canonical), Some(&folder.index), "Dependency endpoint was renumbered");
        }
        assert_eq!(indexed_graph.edges.len(), fixture.edges().len(), "Dependencies were removed");
        for ((endpoints, weight), edge) in fixture.edges().iter().zip(&indexed_graph.edges) {
            assert!(
                indexed_graph.nodes.get(endpoints.source().label().as_str()) == Some(&edge.source)
                    && indexed_graph.nodes.get(endpoints.target().label().as_str()) == Some(&edge.target)
                    && *weight == edge.weight,
                "Dependency endpoint or weight changed"
            );
        }
    }

    #[rstest]
    #[case(".", ".")]
    #[case("src", "src")]
    #[case("src/api/v1", "v1")]
    fn test_hierarchy_single_folder(#[case] label: &str, #[case] display_label: &str) {
        let fixture = FolderGraph::new(
            BTreeSet::from([FolderNode::new(label.into())]),
            BTreeMap::from([(
                FolderEdge::new(FolderNode::new(label.into()), FolderNode::new(label.into()), DependencyKind::Production),
                DependencyCount::new(4),
            )]),
        );
        let fixture = assert_ok!(fixture, "Single self-dependent folder must form a valid graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "Single folder must form a hierarchy: {label}");
        let folder = system_under_test.roots().next();
        let folder = assert_some!(folder, "Hierarchy must retain the only folder");
        let edge = indexed_graph.edges.first();
        let edge = assert_some!(edge, "Indexed graph must retain the self-dependency");

        assert_eq!(system_under_test.roots.len(), 1, "The only source folder must remain visible");
        assert_eq!(
            (folder.label, folder.display_label, folder.index, folder.dependency),
            (label, display_label, 0, true),
            "The only source folder changed"
        );
        assert!(folder.children.is_empty(), "The only source folder retained redundant containers");
        assert_eq!((edge.source, edge.target, edge.weight), (0, 0, DependencyCount::new(4)), "Self-dependency changed");
    }

    #[test]
    fn test_hierarchy_multiple_top_level_folders() {
        let fixture = FolderGraph::new(
            BTreeSet::from([FolderNode::new("src/api".into()), FolderNode::new("tests/api".into())]),
            BTreeMap::new(),
        );
        let fixture = assert_ok!(fixture, "Independent top-level folders must form a valid graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "Independent top-level folders must form a hierarchy");

        assert_eq!(system_under_test.roots.len(), 2, "Independent top-level folders must remain separate");
        for (folder, expected_label) in system_under_test.roots().zip(["src", "tests"]) {
            assert!(
                folder.label == expected_label && folder.display_label == expected_label && !folder.dependency,
                "A top-level folder was removed or relabeled"
            );
            let child = folder.children.first();
            let child = assert_some!(child, "Top-level folder {expected_label} must have a descendant");
            let child = system_under_test.folder(*child);
            assert!(child.label == child.display_label && child.dependency, "Descendant without a common prefix was relabeled");
        }
    }

    #[test]
    fn test_hierarchy_common_prefix_components() {
        let fixture = FolderGraph::new(
            BTreeSet::from([FolderNode::new("src/api".into()), FolderNode::new("src/api_extra".into())]),
            BTreeMap::new(),
        );
        let fixture = assert_ok!(fixture, "Folders with a shared textual prefix must form a valid graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "Shared textual prefixes must support hierarchy creation");

        let display_labels: Vec<_> = system_under_test.roots().map(|folder| folder.display_label).collect();

        assert_eq!(display_labels, ["api", "api_extra"], "A textual prefix inside a folder component was removed");
    }

    #[test]
    fn test_hierarchy_empty_graph() {
        let fixture = FolderGraph::default();
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);
        let system_under_test = assert_ok!(system_under_test, "An empty graph must support hierarchy creation");

        assert!(system_under_test.roots.is_empty(), "An empty graph must have no hierarchy roots");
    }

    #[rstest]
    #[case("")]
    #[case("/src")]
    #[case("src/")]
    #[case("src//api")]
    #[case("src/./api")]
    #[case("src/../api")]
    fn test_hierarchy_path_preconditions(#[case] label: &str) {
        let fixture = FolderGraph::new(BTreeSet::from([FolderNode::new(label.into())]), BTreeMap::new());
        let fixture = assert_ok!(fixture, "Folder graph must accept labels before hierarchy path validation: {label:?}");
        let indexed_graph = IndexedGraph::new(&fixture);

        let system_under_test = Hierarchy::new(&indexed_graph);

        assert!(system_under_test.is_err(), "Invalid hierarchy path was accepted: {label}");
    }

    #[rstest]
    #[case(false)]
    #[case(true)]
    fn test_deep_hierarchy_traversal_and_destruction(#[case] common_prefix: bool) {
        const DEPTH: usize = 4096;
        const COMMON_PREFIX: &str = "common/";
        let prefix = if common_prefix { COMMON_PREFIX } else { "" };
        let fixture = FolderGraph::new(
            [format!("{prefix}{}leaf", "a/".repeat(DEPTH)), format!("{prefix}z")].map(FolderNode::new).into(),
            BTreeMap::new(),
        );
        let fixture = assert_ok!(fixture, "Deep folder paths must form a valid graph");
        let indexed_graph = IndexedGraph::new(&fixture);

        {
            let system_under_test = Hierarchy::new(&indexed_graph);
            let system_under_test = assert_ok!(system_under_test, "Deep hierarchy creation must not exhaust the stack");
            let mut depth: usize = 0;
            let mut maximum_depth = 0;
            let mut leaves = Vec::new();
            for event in system_under_test.events() {
                match event {
                    FolderEvent::Enter(folder) if folder.children.is_empty() => {
                        leaves.push(folder.index);
                    }
                    FolderEvent::Enter(_) => {
                        depth += 1;
                        maximum_depth = maximum_depth.max(depth);
                    }
                    FolderEvent::Leave => depth -= 1,
                }
            }

            assert_eq!(system_under_test.roots.len(), 2, "Separate roots must prevent deep-chain flattening");
            assert_eq!((maximum_depth, depth), (DEPTH, 0), "Traversal lost or unbalanced nested groups");
            assert_eq!(leaves, [0, 1], "Deep traversal changed endpoint order");
            assert!(
                system_under_test.events().all(|event| match event {
                    FolderEvent::Enter(folder) => !folder.display_label.starts_with(COMMON_PREFIX),
                    FolderEvent::Leave => true,
                }),
                "Deep relative-label traversal retained the common root"
            );
        }
    }
}