rufl 0.1.3

A powerful util function library for rust
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
use super::event::Event;
use super::subscriber::Subscriber;
use std::collections::HashMap;

/// # Event Bus
///
/// The event bus is a central hub for all events.
/// It is responsible for managing all subscribers and publishing events
/// related to the event bus.
///
/// ## Fields
///
/// * `events` - A vec of events grouped by their name that have been published to the event bus.
///
/// * `subscribers` - A vec of subscribers grouped by an event name.
///
/// ## Methods
///
/// * `publish` - Publishes an event to the event bus, and calls each listener's handle method
///
/// * `subscribe` - Subscribes a listener to the event bus.
///
/// * `subscribe_all` - Subscribes a vec of listeners to the event bus.
///
/// * `unsubscribe` - unubscribes a listener to the event bus.
///
/// * `clear` - Clears all events from the event bus.
///
/// # Examples
///
/// ```
/// use rufl::eventbus::{Event, EventBus, Subscriber};
///
///
/// let mut event_bus = EventBus::new();
/// event_bus.subscribe("foo", Box::new(MySubscriber1::new()))
///          .subscribe("foo", Box::new(MySubscriber2::new()));
///
/// let result = event_bus
///            .register("foo", Event::new("hello".to_string()))
///            .publish();
///     
/// //MySubscriber2 will run first because its priority is higher than MySubscriber1
/// assert_eq!(Ok(()), result);
///
/// #[derive(Clone, Copy)]
/// struct MySubscriber1 {}
///
/// impl MySubscriber1 {
///     const NAME: &'static str = "MySubscriber1";
///
///     pub fn new() -> Self {
///         MySubscriber1 {}
///     }
/// }
///
/// impl Subscriber for MySubscriber1 {
///     fn id(&self) -> String {
///         "subscriber1".to_string()
///     }
///
///     fn priority(&self) -> usize {
///         2
///     }
///
///     fn handle_before(&mut self, _event: &mut Event) -> Result<(), String> {
///        println!("MySubscriber1 handle_before: ");
///        Ok(())
///     }
///
///     fn handle_event(&mut self, event: &mut Event) -> Result<(), String> {
///        match event.get_data::<String>() {
///            Some(value) => {
///                println!("{} received event message: {}", MySubscriber1::NAME, value);
///                Ok(())
///            }
///            None => {
///                let message = format!("{} received error message", MySubscriber1::NAME);
///                    Err(message)
///                }
///            }
///        }
///
///    fn handle_after(&self, _event: &Event) -> Result<(), String> {
///       println!("MySubscriber1 handle_after: ");
///       Ok(())
///    }
/// }
/// #[derive(Clone, Copy)]
/// struct MySubscriber2 {}
///
/// impl MySubscriber2 {
///   const NAME: &'static str = "MySubscriber2";
///
///   pub fn new() -> Self {
///       MySubscriber2 {}
///   }
/// }
///
/// impl Subscriber for MySubscriber2 {
///     fn id(&self) -> String {
///         "subscriber2".to_string()
///     }
///
///     fn priority(&self) -> usize {
///         1
///     }
///
///     fn handle_before(&mut self, _event: &mut Event) -> Result<(), String> {
///        println!("MySubscriber2 handle_before: ");
///            Ok(())
///        }
///
///     fn handle_event(&mut self, event: &mut Event) -> Result<(), String> {
///        match event.get_data::<String>() {
///            Some(value) => {
///                println!("{} received event message: {}", MySubscriber2::NAME, value);
///                Ok(())
///            }
///            None => {
///                let message = format!("{} received error message", MySubscriber2::NAME);
///                    Err(message)
///                }
///            }
///        }
///
///        fn handle_after(&self, _event: &Event) -> Result<(), String> {
///            println!("MySubscriber2 handle_after: ");
///            Ok(())
///        }
///    }
/// ```
pub struct EventBus {
    events: HashMap<String, Vec<Box<Event>>>,
    subscribers: HashMap<String, Vec<Box<dyn Subscriber>>>,
}

impl EventBus {
    /// # New
    ///
    /// Creates a new event bus.
    pub fn new() -> Self {
        EventBus {
            events: HashMap::new(),
            subscribers: HashMap::new(),
        }
    }

    /// # Register
    ///
    /// Registers an event with the event bus.
    pub fn register(&mut self, event_name: &str, event: Event) -> &mut Self {
        if self.events.contains_key(event_name) {
            self.events
                .get_mut(event_name)
                .unwrap()
                .push(Box::new(event));
        } else {
            self.events
                .insert(event_name.to_string(), vec![Box::new(event)]);
        }

        self
    }

    /// # Subscribe
    ///
    /// Subscribes a listener to the event bus.
    pub fn subscribe(&mut self, event_name: &str, listener: Box<dyn Subscriber>) -> &mut Self {
        if self.subscribers.contains_key(event_name) {
            self.subscribers.get_mut(event_name).unwrap().push(listener);
        } else {
            self.subscribers
                .insert(event_name.to_string(), vec![listener]);
        }

        self.sort_subscribers_by_priority(event_name);

        self
    }

    /// # Subscribe all
    ///
    /// Subscribes a vec of listeners to the event bus.
    pub fn subscribe_all(
        &mut self,
        event_name: &str,
        listeners: Vec<Box<dyn Subscriber>>,
    ) -> &mut Self {
        if self.subscribers.contains_key(event_name) {
            for listener in listeners {
                self.subscribers.get_mut(event_name).unwrap().push(listener);
            }
        } else {
            self.subscribers.insert(event_name.to_string(), listeners);
        }

        self.sort_subscribers_by_priority(event_name);

        self
    }

    /// # Unsubscribe
    ///
    /// Unsubscribes a listener to the event bus.
    pub fn unsubscribe<T: Subscriber + 'static>(
        &mut self,
        event_name: &str,
        listener: T,
    ) -> &mut Self {
        if self.subscribers.contains_key(event_name) {
            let index = self
                .subscribers
                .get(event_name)
                .unwrap()
                .iter()
                .position(|item| *item.id() == listener.id())
                .unwrap();
            self.subscribers.get_mut(event_name).unwrap().remove(index);

            println!("123");
        }
        self
    }

    /// # Publish
    ///
    /// Publishes each event, and calls each listener by priority value. (lower priority value is high order)
    /// in listener's methods the order is: handle_before -> handle_event -> handle_after.
    pub fn publish(&mut self) -> Result<(), String> {
        for (event_name, mut events) in self.events.drain() {
            if self.subscribers.contains_key(&event_name) {
                for event in &mut events {
                    for listener in self.subscribers.get_mut(&event_name).unwrap().iter_mut() {
                        // handle before
                        match listener.handle_before(event) {
                            Err(event) => return Err(event),
                            _ => {}
                        }

                        // handle event
                        match listener.handle_event(event) {
                            Err(event) => return Err(event),
                            _ => {}
                        }
                        // handle after
                        match listener.handle_after(event) {
                            Err(event) => return Err(event),
                            _ => {}
                        }
                    }
                }
            }
        }

        Ok(())
    }

    /// # Clear
    ///
    /// Clears all events from the event bus.
    pub fn clear(&mut self) {
        self.events.clear();
    }

    fn sort_subscribers_by_priority(&mut self, event_name: &str) {
        if self.subscribers.contains_key(event_name) {
            self.subscribers
                .get_mut(event_name)
                .unwrap()
                .sort_by(|a, b| a.priority().cmp(&b.priority()))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{Event, EventBus, Subscriber};

    #[test]
    fn test_publish() {
        let mut event_bus = EventBus::new();

        let listener1 = TestSubscriber1::new();
        let listener2 = TestSubscriber2::new();
        let listeners: Vec<Box<dyn Subscriber>> = vec![Box::new(listener1), Box::new(listener2)];

        event_bus.subscribe_all("foo", listeners);

        let listener3 = TestSubscriber3::new();
        event_bus.subscribe("foo", Box::new(listener3));

        let result = event_bus
            .register("foo", Event::new("hello".to_string()))
            .publish();

        assert_eq!(Ok(()), result);

        event_bus.unsubscribe("foo", listener3);

        let result = event_bus
            .register("foo", Event::new("hello".to_string()))
            .publish();

        assert_eq!(Ok(()), result);
    }

    #[derive(Clone, Copy)]
    struct TestSubscriber1 {}

    impl TestSubscriber1 {
        const NAME: &'static str = "TestSubscriber1";

        pub fn new() -> Self {
            TestSubscriber1 {}
        }
    }

    impl Subscriber for TestSubscriber1 {
        fn id(&self) -> String {
            "subscriber1".to_string()
        }

        fn priority(&self) -> usize {
            2
        }

        fn handle_before(&mut self, _event: &mut Event) -> Result<(), String> {
            println!("TestSubscriber1 handle_before: ");
            Ok(())
        }

        fn handle_event(&mut self, event: &mut Event) -> Result<(), String> {
            match event.get_data::<String>() {
                Some(value) => {
                    println!(
                        "{} received string message: {}",
                        TestSubscriber1::NAME,
                        value
                    );
                    Ok(())
                }
                None => {
                    let message = format!("{} received unknown message", TestSubscriber1::NAME);
                    Err(message)
                }
            }
        }

        fn handle_after(&self, _event: &Event) -> Result<(), String> {
            println!("TestSubscriber1 handle_after: ");
            Ok(())
        }
    }

    #[derive(Clone, Copy)]
    struct TestSubscriber2 {}

    impl TestSubscriber2 {
        const NAME: &'static str = "TestSubscriber2";

        pub fn new() -> Self {
            TestSubscriber2 {}
        }
    }

    impl Subscriber for TestSubscriber2 {
        fn id(&self) -> String {
            "subscriber2".to_string()
        }

        fn priority(&self) -> usize {
            1
        }

        fn handle_before(&mut self, _event: &mut Event) -> Result<(), String> {
            println!("TestSubscriber2 handle_before: ");
            Ok(())
        }

        fn handle_event(&mut self, event: &mut Event) -> Result<(), String> {
            match event.get_data::<String>() {
                Some(value) => {
                    println!(
                        "{} received string message: {}",
                        TestSubscriber2::NAME,
                        value
                    );
                    Ok(())
                }
                None => {
                    let message = format!("{} received unknown message", TestSubscriber2::NAME);
                    Err(message)
                }
            }
        }

        fn handle_after(&self, _event: &Event) -> Result<(), String> {
            println!("TestSubscriber2 handle_after: ");
            Ok(())
        }
    }

    #[derive(Clone, Copy)]
    struct TestSubscriber3 {}

    impl TestSubscriber3 {
        const NAME: &'static str = "TestSubscriber3";

        pub fn new() -> Self {
            TestSubscriber3 {}
        }
    }

    impl Subscriber for TestSubscriber3 {
        fn id(&self) -> String {
            "subscriber3".to_string()
        }

        fn priority(&self) -> usize {
            3
        }

        fn handle_before(&mut self, _event: &mut Event) -> Result<(), String> {
            println!("TestSubscriber3 handle_before: ");
            Ok(())
        }

        fn handle_event(&mut self, event: &mut Event) -> Result<(), String> {
            match event.get_data::<String>() {
                Some(value) => {
                    println!(
                        "{} received string message: {}",
                        TestSubscriber3::NAME,
                        value
                    );
                    Ok(())
                }
                None => {
                    let message = format!("{} received unknown message", TestSubscriber3::NAME);
                    Err(message)
                }
            }
        }

        fn handle_after(&self, _event: &Event) -> Result<(), String> {
            println!("TestSubscriber3 handle_after: ");
            Ok(())
        }
    }
}