deepwoken 0.3.11

A library for interacting with Deepwoken data in a more convenient format, with a few added utilities.
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

use std::collections::{BTreeSet, HashMap, HashSet, VecDeque};

use crate::req::Requirement;

pub struct ReqTree {
    // Keyed by name
    reqs: HashMap<String, Requirement>,
    // Stores a set of reqs that depend on the key
    dependents: HashMap<String, HashSet<String>>,
}

impl ReqTree {
    #[must_use]
    pub fn new() -> Self {
        Self {
            reqs: HashMap::new(),
            dependents: HashMap::new(),
        }
    }

    /// Insert a requirement
    pub fn insert(&mut self, req: Requirement) {
        let name = req.name_or_default();

        for prereq in &req.prereqs {
            self.dependents
                .entry(prereq.clone())
                .or_default()
                .insert(name.clone());
        }

        self.reqs.insert(name, req);
    }

    #[must_use]
    pub fn get(&self, name: &str) -> Option<&Requirement> {
        self.reqs.get(name)
    }

    #[must_use]
    /// Retrieve direct prereqs as names
    pub fn prereqs(&self, name: &str) -> Option<&BTreeSet<String>> {
        self.reqs.get(name).map(|r| &r.prereqs)
    }

    #[must_use]
    /// Retrieve direct dependents as names
    pub fn dependents(&self, name: &str) -> Option<&HashSet<String>> {
        self.dependents.get(name)
    }

    #[must_use]
    /// All transitive prereqs via BFS
    pub fn all_prereqs(&self, name: &str) -> HashSet<String> {
        let mut visited = HashSet::new();
        let mut queue = VecDeque::new();

        if let Some(req) = self.reqs.get(name) {
            queue.extend(req.prereqs.iter().cloned());
        }

        while let Some(current) = queue.pop_front() {
            if visited.insert(current.clone())
                && let Some(req) = self.reqs.get(&current)
            {
                queue.extend(req.prereqs.iter().cloned());
            }
        }

        visited
    }

    #[must_use]
    /// All transitive dependents via BFS
    pub fn all_dependents(&self, name: &str) -> HashSet<String> {
        let mut visited = HashSet::new();
        let mut queue = VecDeque::new();

        if let Some(deps) = self.dependents.get(name) {
            queue.extend(deps.iter().cloned());
        }

        while let Some(current) = queue.pop_front() {
            if visited.insert(current.clone())
                && let Some(deps) = self.dependents.get(&current)
            {
                queue.extend(deps.iter().cloned());
            }
        }

        visited
    }

    #[must_use]
    /// Check for any cycles (shoudl be invalid for deep anyways)
    pub fn find_cycle(&self) -> Option<Vec<String>> {
        let mut visited = HashSet::new();
        let mut stack = HashSet::new();
        let mut path = Vec::new();

        for name in self.reqs.keys() {
            if let Some(cycle) = self.cycle_visit(name, &mut visited, &mut stack, &mut path) {
                return Some(cycle);
            }
        }
        None
    }

    fn cycle_visit(
        &self,
        name: &str,
        visited: &mut HashSet<String>,
        stack: &mut HashSet<String>,
        path: &mut Vec<String>,
    ) -> Option<Vec<String>> {
        if stack.contains(name) {
            let idx = path.iter().position(|n| n == name).unwrap();

            return Some(path[idx..].to_vec());
        }
        if visited.contains(name) {
            return None;
        }

        visited.insert(name.to_string());
        stack.insert(name.to_string());
        path.push(name.to_string());

        if let Some(req) = self.reqs.get(name) {
            for prereq in &req.prereqs {
                if let Some(cycle) = self.cycle_visit(prereq, visited, stack, path) {
                    return Some(cycle);
                }
            }
        }

        stack.remove(name);
        path.pop();
        None
    }
}

impl Default for ReqTree {
    fn default() -> Self {
        Self::new()
    }
}