lash-core 0.1.0-alpha.85

Sans-IO turn machine and runtime kernel for the lash agent runtime.
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

use std::sync::Arc;

use crate::PluginFactory;

#[derive(Clone, Default)]
pub struct PluginStack {
    factories: Vec<Arc<dyn PluginFactory>>,
}

impl PluginStack {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn from_factories(factories: impl IntoIterator<Item = Arc<dyn PluginFactory>>) -> Self {
        Self {
            factories: factories.into_iter().collect(),
        }
    }

    pub fn factories(&self) -> &[Arc<dyn PluginFactory>] {
        &self.factories
    }

    pub fn into_factories(self) -> Vec<Arc<dyn PluginFactory>> {
        self.factories
    }

    pub fn push(&mut self, plugin: Arc<dyn PluginFactory>) -> &mut Self {
        self.factories.push(plugin);
        self
    }

    pub fn extend(
        &mut self,
        plugins: impl IntoIterator<Item = Arc<dyn PluginFactory>>,
    ) -> &mut Self {
        self.factories.extend(plugins);
        self
    }

    pub fn remove(&mut self, id: &str) -> &mut Self {
        self.factories.retain(|plugin| plugin.id() != id);
        self
    }

    pub fn replace(&mut self, plugin: Arc<dyn PluginFactory>) -> &mut Self {
        let id = plugin.id();
        if let Some(slot) = self
            .factories
            .iter_mut()
            .find(|existing| existing.id() == id)
        {
            *slot = plugin;
        } else {
            self.factories.push(plugin);
        }
        self
    }

    pub fn retain(&mut self, keep: impl FnMut(&Arc<dyn PluginFactory>) -> bool) -> &mut Self {
        self.factories.retain(keep);
        self
    }

    pub fn configure(mut self, configure: impl FnOnce(&mut PluginStack)) -> Self {
        configure(&mut self);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::PluginSpec;
    use crate::plugin::StaticPluginFactory;

    fn factory(id: &'static str) -> Arc<dyn PluginFactory> {
        Arc::new(StaticPluginFactory::new(id, PluginSpec::new()))
    }

    fn ids(stack: &PluginStack) -> Vec<&'static str> {
        stack
            .factories()
            .iter()
            .map(|factory| factory.id())
            .collect()
    }

    #[test]
    fn construction_preserves_factory_order_and_identity() {
        let alpha = factory("alpha");
        let beta = factory("beta");

        let stack = PluginStack::from_factories([Arc::clone(&alpha), Arc::clone(&beta)]);

        assert_eq!(ids(&stack), vec!["alpha", "beta"]);
        assert!(Arc::ptr_eq(&stack.factories()[0], &alpha));
        assert!(Arc::ptr_eq(&stack.factories()[1], &beta));

        let factories = stack.into_factories();
        assert_eq!(
            factories
                .iter()
                .map(|factory| factory.id())
                .collect::<Vec<_>>(),
            vec!["alpha", "beta"]
        );
        assert!(Arc::ptr_eq(&factories[0], &alpha));
        assert!(Arc::ptr_eq(&factories[1], &beta));
    }

    #[test]
    fn mutators_apply_by_plugin_id_without_reordering_unrelated_plugins() {
        let alpha = factory("alpha");
        let beta_v1 = factory("beta");
        let beta_v2 = factory("beta");
        let gamma_v1 = factory("gamma");
        let gamma_v2 = factory("gamma");
        let delta = factory("delta");

        let mut stack = PluginStack::new();
        stack
            .push(Arc::clone(&alpha))
            .push(Arc::clone(&beta_v1))
            .extend([Arc::clone(&gamma_v1), Arc::clone(&delta)]);

        assert_eq!(ids(&stack), vec!["alpha", "beta", "gamma", "delta"]);

        stack.remove("beta");
        assert_eq!(ids(&stack), vec!["alpha", "gamma", "delta"]);
        assert!(
            stack
                .factories()
                .iter()
                .all(|factory| factory.id() != "beta")
        );

        stack.remove("missing");
        assert_eq!(ids(&stack), vec!["alpha", "gamma", "delta"]);

        stack.replace(Arc::clone(&gamma_v2));
        assert_eq!(ids(&stack), vec!["alpha", "gamma", "delta"]);
        assert!(Arc::ptr_eq(&stack.factories()[1], &gamma_v2));
        assert!(!Arc::ptr_eq(&stack.factories()[1], &gamma_v1));

        stack.replace(Arc::clone(&beta_v2));
        assert_eq!(ids(&stack), vec!["alpha", "gamma", "delta", "beta"]);
        assert!(Arc::ptr_eq(&stack.factories()[3], &beta_v2));

        stack.retain(|factory| factory.id() != "delta");
        assert_eq!(ids(&stack), vec!["alpha", "gamma", "beta"]);
        assert!(Arc::ptr_eq(&stack.factories()[0], &alpha));
    }

    #[test]
    fn configure_applies_the_closure_to_the_owned_stack() {
        let alpha_v1 = factory("alpha");
        let alpha_v2 = factory("alpha");
        let beta = factory("beta");
        let gamma = factory("gamma");

        let stack = PluginStack::new().configure(|stack| {
            stack
                .push(Arc::clone(&alpha_v1))
                .extend([Arc::clone(&beta), Arc::clone(&gamma)])
                .remove("beta")
                .replace(Arc::clone(&alpha_v2));
        });

        assert_eq!(ids(&stack), vec!["alpha", "gamma"]);
        assert!(Arc::ptr_eq(&stack.factories()[0], &alpha_v2));
        assert!(Arc::ptr_eq(&stack.factories()[1], &gamma));
    }
}