eave-api 0.1.9

Plugin API for the eave status bar
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

use crate::Widget;
use crate::erased::{Constructor, construct};

/// The widgets every plugin makes available, by the name `config.toml` uses.
/// Cheap to clone: names and function pointers.
#[derive(Default, Clone)]
pub struct Registry {
    widgets: Vec<(&'static str, Constructor)>,
}

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

    /// Makes `W` available as `widget = "<name>"` in the config.
    pub fn widget<W: Widget>(&mut self, name: &'static str) {
        self.widgets.push((name, construct::<W>));
    }

    #[doc(hidden)]
    pub fn get(&self, name: &str) -> Option<Constructor> {
        self.widgets
            .iter()
            .find(|(registered, _)| *registered == name)
            .map(|(_, constructor)| *constructor)
    }

    /// Names registered more than once. Two plugins claiming one name is a build error to report,
    /// not something to resolve silently.
    #[doc(hidden)]
    pub fn duplicates(&self) -> Vec<&'static str> {
        let mut names: Vec<_> = self.widgets.iter().map(|(name, _)| *name).collect();
        names.sort_unstable();
        let mut duplicates: Vec<_> = names
            .windows(2)
            .filter(|pair| pair[0] == pair[1])
            .map(|pair| pair[0])
            .collect();
        duplicates.dedup();
        duplicates
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ui::{Item, label};
    use crate::{Effect, Task};

    struct Dummy;

    impl Widget for Dummy {
        type Config = toml::Table;
        type Message = ();

        fn new(_: Self::Config) -> (Self, Task<()>) {
            (Self, Task::none())
        }

        fn update(&mut self, _: ()) -> Effect<()> {
            Effect::none()
        }

        fn item(&self) -> Item<()> {
            Item::new(label("dummy"))
        }
    }

    #[test]
    fn finds_and_reports_duplicates() {
        let mut registry = Registry::new();
        registry.widget::<Dummy>("a");
        registry.widget::<Dummy>("b");
        registry.widget::<Dummy>("a");
        assert!(registry.get("b").is_some());
        assert!(registry.get("c").is_none());
        assert_eq!(registry.duplicates(), ["a"]);
    }
}