capability-skeleton 0.1.0

A Rust library for managing and building complex hierarchical tree structures such as skill trees. Supports serialization, error handling, and deep tree metrics.
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

// ---------------- [ File: capability-skeleton/src/build_node_level_map.rs ]
crate::ix!();

/// A local BFS returning node_id => level, skipping unconnected nodes.
#[instrument(level = "trace", skip(skel))]
pub fn build_node_level_map(skel: &Skeleton) -> HashMap<u16, u8> {
    trace!("Building node->level map with BFS for Skeleton.");

    let mut visited = HashSet::new();
    let mut map = HashMap::<u16, u8>::new();
    let mut queue = VecDeque::new();

    if let Some(rid) = skel.root_id() {
        // rid is a u16, so we can push it directly with level=0
        queue.push_back((*rid, 0u8));
    } else {
        debug!("No root => empty map");
        return map;
    }

    while let Some((nid, lvl)) = queue.pop_front() {
        // If we’ve visited nid before, skip
        if !visited.insert(nid) {
            continue;
        }
        // Insert into the map
        map.insert(nid, lvl);

        // Find the node with ID == nid
        if let Some(node) = skel.nodes().iter().find(|n| n.id() == nid) {
            // For each child, push => BFS
            for &child_id in node.child_ids() {
                let next_lvl = lvl.saturating_add(1);
                queue.push_back((child_id, next_lvl));
            }
        }
    }

    trace!("Finished BFS => discovered {} connected nodes", map.len());
    map
}

#[cfg(test)]
mod build_node_level_map_assessment {
    use super::*;

    fn make_node(id: u16, child_ids: &[u16]) -> SkeletonNode {
        let k = if child_ids.is_empty() {
            NodeKind::LeafHolder
        } else {
            NodeKind::Dispatch
        };
        SkeletonNodeBuilder::default()
            .id(id)
            .child_ids(child_ids.to_vec())
            .name(format!("Node_{id}"))
            .original_key(format!("Node_{id}"))
            .build(k)
            .unwrap()
    }

    #[traced_test]
    fn check_empty_skeleton() {
        let skel = SkeletonBuilder::default().build().unwrap();
        let map = build_node_level_map(&skel);
        assert!(map.is_empty());
    }

    #[traced_test]
    fn check_single_node() {
        let node0 = make_node(0, &[]);
        let skel = SkeletonBuilder::default()
            .nodes(vec![node0])
            .root_id(Some(0))
            .build()
            .unwrap();
        let map = build_node_level_map(&skel);
        assert_eq!(map.len(), 1);
        assert_eq!(map.get(&0), Some(&0u8));
    }

    #[traced_test]
    fn check_linear_chain() {
        let n0 = make_node(0, &[1]);
        let n1 = make_node(1, &[2]);
        let n2 = make_node(2, &[]);
        let skel = SkeletonBuilder::default()
            .nodes(vec![n0, n1, n2])
            .root_id(Some(0))
            .build()
            .unwrap();
        let map = build_node_level_map(&skel);
        assert_eq!(map.get(&0), Some(&0u8));
        assert_eq!(map.get(&1), Some(&1u8));
        assert_eq!(map.get(&2), Some(&2u8));
        assert_eq!(map.len(), 3);
    }

    #[traced_test]
    fn check_branching() {
        let n0 = make_node(0, &[1,2]);
        let n1 = make_node(1, &[3]);
        let n2 = make_node(2, &[]);
        let n3 = make_node(3, &[]);
        let skel = SkeletonBuilder::default()
            .nodes(vec![n0,n1,n2,n3])
            .root_id(Some(0))
            .build()
            .unwrap();
        let map = build_node_level_map(&skel);
        assert_eq!(map.get(&0), Some(&0u8));
        assert_eq!(map.get(&1), Some(&1u8));
        assert_eq!(map.get(&2), Some(&1u8));
        assert_eq!(map.get(&3), Some(&2u8));
    }

    #[traced_test]
    fn check_unconnected_nodes() {
        // root=0 => BFS sees 0,1 => doesn't see 2,3
        let n0 = make_node(0, &[1]);
        let n1 = make_node(1, &[]);
        let n2 = make_node(2, &[3]);
        let n3 = make_node(3, &[]);
        let skel = SkeletonBuilder::default()
            .nodes(vec![n0,n1,n2,n3])
            .root_id(Some(0))
            .build()
            .unwrap();

        let map = build_node_level_map(&skel);
        assert_eq!(map.len(), 2);
        assert_eq!(map.get(&0), Some(&0u8));
        assert_eq!(map.get(&1), Some(&1u8));
    }

    #[traced_test]
    fn check_cycle_doesnt_loop() {
        // 0->1, 1->0
        let n0 = make_node(0, &[1]);
        let n1 = make_node(1, &[0]);
        let skel = SkeletonBuilder::default()
            .nodes(vec![n0,n1])
            .root_id(Some(0))
            .build()
            .unwrap();

        let map = build_node_level_map(&skel);
        assert_eq!(map.len(), 2);
        assert_eq!(map.get(&0), Some(&0u8));
        assert_eq!(map.get(&1), Some(&1u8));
    }
}