storyteller 1.0.1

Library focused on supporting user oriented output while supporting multiple output types (e.g. json, a progressbar, etc.)
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

// A sample implementation which collects the events it receives
extern crate core;

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use storyteller::{
    event_channel, ChannelEventListener, ChannelReporter, EventHandler, EventListener,
    EventReporter, FinishProcessing,
};

#[derive(Debug, Eq, PartialEq)]
struct MyEvent(usize);

// Caution: does only check whether `received` events match expected events
// Must also use `FinalizeHandler::finish_processing` to ensure panic's are caught.
struct CollectingHandler {
    expected_events: Vec<MyEvent>,
    nth: AtomicUsize,
}

impl CollectingHandler {
    fn new(expected: Vec<MyEvent>) -> Self {
        Self {
            expected_events: expected,
            nth: AtomicUsize::new(0),
        }
    }
}

impl EventHandler for CollectingHandler {
    type Event = MyEvent;

    fn handle(&self, event: Self::Event) {
        let nth = self.nth.load(Ordering::SeqCst);
        eprintln!("Test #{}", nth);

        let expected_event = self
            .expected_events
            .get(nth)
            .unwrap_or_else(|| panic!("No such expected value on index '{}'", nth));

        // compare
        assert_eq!(expected_event, &event);

        self.nth.fetch_add(1, Ordering::SeqCst);
    }

    fn finish(&self) {
        let received = self.nth.load(Ordering::SeqCst);
        let expected = self.expected_events.len();

        if received != expected {
            panic!(
                "Received '{}' events, but expected to receive '{}' events",
                received, expected
            );
        }
    }
}

#[test]
fn test() {
    let (event_sender, event_receiver) = event_channel::<MyEvent>();

    let reporter = ChannelReporter::new(event_sender);
    let listener = ChannelEventListener::new(event_receiver);

    let handler = CollectingHandler::new(vec![
        MyEvent(0),
        MyEvent(1),
        MyEvent(2),
        MyEvent(3),
        MyEvent(4),
    ]);

    let fin = listener.run_handler(Arc::new(handler));

    for i in 0..5 {
        reporter.report_event(MyEvent(i)).unwrap();
    }

    reporter.disconnect().unwrap();
    fin.finish_processing().unwrap();
}

#[yare::parameterized(
    to_few = { vec![ MyEvent(0), MyEvent(1), MyEvent(2), MyEvent(3), MyEvent(4), MyEvent(5)] },
    to_many = { vec![ MyEvent(0), MyEvent(1), MyEvent(2), MyEvent(3) ] },
    incorrect = { vec![ MyEvent(0), MyEvent(1), MyEvent(2), MyEvent(3), MyEvent(5), ] },
)]
#[should_panic]
fn expect_failure(expected_events: Vec<MyEvent>) {
    let (event_sender, event_receiver) = event_channel::<MyEvent>();

    let reporter = ChannelReporter::new(event_sender);
    let listener = ChannelEventListener::new(event_receiver);

    let handler = CollectingHandler::new(expected_events);

    let fin = listener.run_handler(Arc::new(handler));

    for i in 0..5 {
        reporter.report_event(MyEvent(i)).unwrap();
    }

    reporter.disconnect().unwrap();
    fin.finish_processing().unwrap();
}