oxur-component 0.1.2

Enabling the creation of application components with lifecycle and dependency support
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

use petgraph::algo;
use petgraph::graphmap::DiGraphMap;
use crate::Component;

// The verb to use when thinking about the relationships between the dependency
// vertices is "depends upon." A component will declare the things it depends
// upon, and the direction of the graph is from component -> dep 1,
// component -> dep 2, etc.
//
// Great resources for reading up on petgraph:
// * https://timothy.hobbs.cz/rust-play/petgraph_review.html
// * https://timothy.hobbs.cz/rust-play/petgraph-internals.html
// * https://depth-first.com/articles/2020/02/03/graphs-in-rust-an-introduction-to-petgraph/

pub fn add_component(g: &mut DiGraphMap<&str, String>, c: &Component) {
    let comp_vert = g.add_node(c.name);
    for dep in c.dependencies.iter() {
        let dep_vert = g.add_node(dep);
        g.add_edge(comp_vert, dep_vert, format!("{} -> {}", c.name, dep));
    }
}

pub fn add_components(g: &mut DiGraphMap<&str, String>, cs: Vec<Component>) {
    for c in cs.iter() {
        add_component(g, c);
    }
}

pub fn sort<'a>(g: &DiGraphMap<&'a str, String>) -> Vec<&'a str> {
    match algo::toposort(g, Option::None) {
        Ok(sorted) => {
            sorted
                .iter()
                .rev()
                .map(| item: &&str | *item)
                .collect()
        },
        Err(e) => panic!("Cyclic dependency detected for {}", e.node_id()),
    }
}

//*************************************************************************//
//*   Tests   *************************************************************//
//*************************************************************************//

#[cfg(test)]
mod tests {
    use petgraph::Directed;
    use petgraph::graphmap::GraphMap;
    use super::*;

    #[test]
    fn new_test() {
        let mut g = GraphMap::<&str, String, Directed>::new();
        let deps = vec![
            Component{
                name: "myapp::components::comp1",
                dependencies: vec![
                    "myapp::components::comp2",
                    "myapp::components::comp3",
                    "myapp::components::comp4",
                ]
            },
            Component {
                name: "myapp::components::comp4",
                dependencies: vec!["myapp::components::comp5"],
            },
            Component {
                name: "myapp::components::comp5",
                dependencies: vec!["myapp::components::comp6"],
            },
            Component {
                name: "myapp::components::comp6",
                dependencies: vec!["myapp::components::comp7"],
            },
        ];
        add_components(&mut g, deps);
        println!("{:?}", g);
        let sorted = sort(&g);
        assert_eq!(*sorted.last().unwrap(), "myapp::components::comp1");
    }
}