sinktools 0.1.0

Extra sink adaptors and helpers.
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
//! Comprehensive unit tests for all sink adaptors using direct constructors.

use std::cell::RefCell;
use std::rc::Rc;

use sinktools::sink::SinkExt;
use sinktools::*;

/// Helper function to create a collecting sink using Rc<RefCell<Vec<T>>>
fn create_collecting_sink<T: Clone + 'static>() -> (
    impl Sink<T, Error = std::convert::Infallible>,
    Rc<RefCell<Vec<T>>>,
) {
    let collected = Rc::new(RefCell::new(Vec::new()));
    let collected_clone = collected.clone();

    let sink = for_each(move |item: T| {
        collected_clone.borrow_mut().push(item);
    });

    (sink, collected)
}

#[tokio::test]
async fn test_map_adaptor() {
    let (sink, collected) = create_collecting_sink();
    let mut map_sink = map(|x: i32| x * 2, sink);

    // Send some values through the map
    map_sink.send(1).await.unwrap();
    map_sink.send(2).await.unwrap();
    map_sink.send(3).await.unwrap();
    drop(map_sink);

    // Collect results
    assert_eq!(&[2, 4, 6], &**collected.borrow());
}

#[tokio::test]
async fn test_filter_adaptor() {
    let (sink, collected) = create_collecting_sink();
    let mut filter_sink = filter(|x: &i32| *x % 2 == 0, sink);

    // Send values, only evens should pass through
    filter_sink.send(1).await.unwrap();
    filter_sink.send(2).await.unwrap();
    filter_sink.send(3).await.unwrap();
    filter_sink.send(4).await.unwrap();
    filter_sink.send(5).await.unwrap();
    filter_sink.send(6).await.unwrap();
    drop(filter_sink);

    assert_eq!(&[2, 4, 6], &**collected.borrow());
}

#[tokio::test]
async fn test_filter_map_adaptor() {
    let (sink, collected) = create_collecting_sink();
    let mut filter_map_sink = filter_map(
        |x: i32| {
            if x % 2 == 0 { Some(x * 10) } else { None }
        },
        sink,
    );

    // Send values, only evens should pass through and be multiplied by 10
    filter_map_sink.send(1).await.unwrap();
    filter_map_sink.send(2).await.unwrap();
    filter_map_sink.send(3).await.unwrap();
    filter_map_sink.send(4).await.unwrap();
    filter_map_sink.send(5).await.unwrap();
    drop(filter_map_sink);

    assert_eq!(&[20, 40], &**collected.borrow());
}

#[tokio::test]
async fn test_inspect_adaptor() {
    let inspected = Rc::new(RefCell::new(Vec::new()));
    let inspected_clone = inspected.clone();

    let (sink, collected) = create_collecting_sink();
    let mut inspect_sink = inspect(
        move |x: &i32| {
            inspected_clone.borrow_mut().push(*x);
        },
        sink,
    );

    // Send values
    inspect_sink.send(1).await.unwrap();
    inspect_sink.send(2).await.unwrap();
    inspect_sink.send(3).await.unwrap();
    drop(inspect_sink);

    // Both inspected and collected should have the same values
    assert_eq!(&[1, 2, 3], &**inspected.borrow());
    assert_eq!(&[1, 2, 3], &**collected.borrow());
}

#[tokio::test]
async fn test_flat_map_adaptor() {
    let (sink, collected) = create_collecting_sink();
    let mut flat_map_sink = flat_map(|x: i32| vec![x, x + 10, x + 20], sink);

    // Send values, each should expand to 3 values
    flat_map_sink.send(1).await.unwrap();
    flat_map_sink.send(2).await.unwrap();
    drop(flat_map_sink);

    assert_eq!(&[1, 11, 21, 2, 12, 22], &**collected.borrow());
}

#[tokio::test]
async fn test_flatten_adaptor() {
    let (sink, collected) = create_collecting_sink();
    let mut flatten_sink = flatten::<Vec<i32>, _>(sink);

    // Send vectors that should be flattened
    flatten_sink.send(vec![1, 2, 3]).await.unwrap();
    flatten_sink.send(vec![4, 5]).await.unwrap();
    flatten_sink.send(vec![6]).await.unwrap();
    flatten_sink.send(vec![]).await.unwrap(); // Empty vector
    flatten_sink.send(vec![7, 8, 9]).await.unwrap();
    drop(flatten_sink);

    assert_eq!(&[1, 2, 3, 4, 5, 6, 7, 8, 9], &**collected.borrow());
}

#[tokio::test]
async fn test_for_each_adaptor() {
    let processed = Rc::new(RefCell::new(Vec::new()));
    let processed_clone = processed.clone();

    let mut for_each_sink = for_each(move |x: i32| {
        processed_clone.borrow_mut().push(x * 2);
    });

    // Send values
    for_each_sink.send(1).await.unwrap();
    for_each_sink.send(2).await.unwrap();
    for_each_sink.send(3).await.unwrap();
    drop(for_each_sink);

    assert_eq!(&[2, 4, 6], &**processed.borrow());
}

#[tokio::test]
async fn test_unzip_adaptor() {
    let (sink1, collected1) = create_collecting_sink();
    let (sink2, collected2) = create_collecting_sink();
    let mut unzip_sink = unzip(sink1, sink2);

    // Send tuples that should be unzipped
    unzip_sink.send((1, "a")).await.unwrap();
    unzip_sink.send((2, "b")).await.unwrap();
    unzip_sink.send((3, "c")).await.unwrap();
    drop(unzip_sink);

    assert_eq!(&[1, 2, 3], &**collected1.borrow());
    assert_eq!(&["a", "b", "c"], &**collected2.borrow());
}

#[tokio::test]
async fn test_send_iter() {
    let (sink, collected) = create_collecting_sink();

    let data = vec![1, 2, 3, 4, 5];
    let send_iter_future = send_iter(data, sink);

    send_iter_future.await.unwrap();

    assert_eq!(&[1, 2, 3, 4, 5], &**collected.borrow());
}

#[tokio::test]
async fn test_chained_adaptors() {
    let (sink, collected) = create_collecting_sink();

    // Chain multiple adaptors: filter -> inspect -> map -> sink
    // Building from inside out: sink <- map <- inspect <- filter
    let inspected = Rc::new(RefCell::new(Vec::new()));
    let inspected_clone = inspected.clone();

    let map_sink = map(|x: i32| x * 2, sink); // Last: Double the values that pass through
    let inspect_sink = inspect(
        move |x: &i32| {
            inspected_clone.borrow_mut().push(*x);
        },
        map_sink,
    ); // Second: Inspect values that pass the filter
    let mut chained_sink = filter(|x: &i32| *x > 2, inspect_sink); // First: Only values > 2

    // Send values
    chained_sink.send(1).await.unwrap(); // Filtered out (1 <= 2)
    chained_sink.send(2).await.unwrap(); // Filtered out (2 <= 2)
    chained_sink.send(3).await.unwrap(); // 3 > 2, inspected as 3, then doubled to 6
    chained_sink.send(4).await.unwrap(); // 4 > 2, inspected as 4, then doubled to 8
    drop(chained_sink);

    // Only values > 2 should be inspected (before doubling)
    assert_eq!(&[3, 4], &**inspected.borrow());
    // Those values should then be doubled and collected
    assert_eq!(&[6, 8], &**collected.borrow());
}

#[tokio::test]
async fn test_fanout() {
    let (sink1, collected1) = create_collecting_sink();
    let (sink2, collected2) = create_collecting_sink();

    let mut fanout_sink = SinkExt::fanout(sink1, sink2);

    // Send values that should go to both sinks
    fanout_sink.send(1).await.unwrap();
    fanout_sink.send(2).await.unwrap();
    fanout_sink.send(3).await.unwrap();
    drop(fanout_sink);

    // Both sinks should receive the same values
    assert_eq!(&[1, 2, 3], &**collected1.borrow());
    assert_eq!(&[1, 2, 3], &**collected2.borrow());
}

#[tokio::test]
async fn test_empty_inputs() {
    // Test adaptors with empty inputs
    let (sink, collected) = create_collecting_sink();

    // Test flatten with empty vector
    let mut flatten_sink = flatten::<Vec<i32>, _>(sink);
    flatten_sink.send(Vec::<i32>::new()).await.unwrap();
    drop(flatten_sink);

    assert_eq!(&[] as &[i32], &**collected.borrow());
}

#[tokio::test]
async fn test_error_handling() {
    // Test ForEach with error
    let mut error_sink = try_for_each(|x: i32| if x == 3 { Err("error on 3") } else { Ok(()) });

    // These should succeed
    error_sink.send(1).await.unwrap();
    error_sink.send(2).await.unwrap();

    // This should fail
    let result = error_sink.send(3).await;
    assert!(result.is_err());
}

#[tokio::test]
async fn test_complex_chain() {
    let (sink, collected) = create_collecting_sink();

    // Complex chain: flatten -> filter_map -> map -> filter
    // Building from inside out: sink <- filter <- map <- filter_map <- flatten
    let filter_sink = filter(|x: &i32| *x < 100, sink); // Only values < 100
    let map_sink = map(|x: i32| x + 1, filter_sink); // Add 1
    let filter_map_sink = filter_map(
        |x: i32| {
            // Double evens, filter odds
            if x % 2 == 0 { Some(x * 2) } else { None }
        },
        map_sink,
    );
    let mut complex_sink = flatten::<Vec<i32>, _>(filter_map_sink); // Flatten input vectors

    // Send nested data
    complex_sink.send(vec![1, 2, 3, 4]).await.unwrap();
    complex_sink.send(vec![5, 6]).await.unwrap();
    complex_sink.send(vec![]).await.unwrap();
    complex_sink.send(vec![7, 8, 9]).await.unwrap();
    drop(complex_sink);

    // Processing: [1,2,3,4,5,6,7,8,9] -> filter_map(even after +1) -> [4,8,12,16] -> +1 -> [5,9,13,17] -> filter(<100) -> [5,9,13,17]
    // Wait, let me trace this more carefully:
    // Input: [1,2,3,4,5,6,7,8,9] (flattened)
    // filter_map: keep evens and double -> [4, 8, 12, 16] (2*2, 4*2, 6*2, 8*2)
    // map +1: [5, 9, 13, 17]
    // filter <100: [5, 9, 13, 17] (all pass)
    assert_eq!(&[5, 9, 13, 17], &**collected.borrow());
}

#[cfg(feature = "variadics")]
#[tokio::test]
async fn test_demux_var_adaptor() {
    let (sink1, collected1) = create_collecting_sink();
    let (sink2, collected2) = create_collecting_sink();
    let (sink3, collected3) = create_collecting_sink();

    let sinks = (sink1, (sink2, (sink3, ())));
    let mut demux_sink = demux_var(sinks);

    // Send indexed items to different sinks
    demux_sink.send((0, 10)).await.unwrap(); // Goes to sink1
    demux_sink.send((1, 20)).await.unwrap(); // Goes to sink2
    demux_sink.send((2, 30)).await.unwrap(); // Goes to sink3
    demux_sink.send((0, 11)).await.unwrap(); // Goes to sink1
    demux_sink.send((1, 21)).await.unwrap(); // Goes to sink2
    drop(demux_sink);

    assert_eq!(&[10, 11], &**collected1.borrow());
    assert_eq!(&[20, 21], &**collected2.borrow());
    assert_eq!(&[30], &**collected3.borrow());
}

#[cfg(feature = "variadics")]
#[tokio::test]
#[should_panic(expected = "index out of bounds")]
async fn test_demux_var_out_of_bounds() {
    let (sink1, _) = create_collecting_sink();
    let (sink2, _) = create_collecting_sink();

    let sinks = (sink1, (sink2, ()));
    let mut demux_sink = demux_var(sinks);

    // This should panic - index 2 is out of bounds for 2 sinks
    demux_sink.send((2, 10)).await.unwrap();
}

#[tokio::test]
async fn test_filter_all_filtered_out() {
    let (sink, collected) = create_collecting_sink();
    let mut filter_sink = filter(|_: &i32| false, sink); // Filter out everything

    filter_sink.send(1).await.unwrap();
    filter_sink.send(2).await.unwrap();
    filter_sink.send(3).await.unwrap();
    drop(filter_sink);

    assert_eq!(&[] as &[i32], &**collected.borrow());
}

#[tokio::test]
async fn test_filter_map_all_none() {
    let (sink, collected) = create_collecting_sink();
    let mut filter_map_sink = filter_map(|_: i32| None::<i32>, sink);

    filter_map_sink.send(1).await.unwrap();
    filter_map_sink.send(2).await.unwrap();
    filter_map_sink.send(3).await.unwrap();
    drop(filter_map_sink);

    assert_eq!(&[] as &[i32], &**collected.borrow());
}

#[tokio::test]
async fn test_flat_map_empty_iterators() {
    let (sink, collected) = create_collecting_sink();
    let mut flat_map_sink = flat_map(|_: i32| Vec::<i32>::new(), sink);

    flat_map_sink.send(1).await.unwrap();
    flat_map_sink.send(2).await.unwrap();
    flat_map_sink.send(3).await.unwrap();
    drop(flat_map_sink);

    assert_eq!(&[] as &[i32], &**collected.borrow());
}

#[tokio::test]
async fn test_send_iter_empty() {
    let (sink, collected) = create_collecting_sink();

    let data: Vec<i32> = vec![];
    let send_iter_future = send_iter(data, sink);

    send_iter_future.await.unwrap();

    assert_eq!(&[] as &[i32], &**collected.borrow());
}

#[tokio::test]
async fn test_demux_map_basic() {
    let (sink1, collected1) = create_collecting_sink();
    let (sink2, collected2) = create_collecting_sink();
    let (sink3, collected3) = create_collecting_sink();

    let sinks = [("a", sink1), ("b", sink2), ("c", sink3)];
    let mut demux_sink = demux_map(sinks);

    // Send items to different sinks based on keys
    demux_sink.send(("a", 10)).await.unwrap();
    demux_sink.send(("b", 20)).await.unwrap();
    demux_sink.send(("c", 30)).await.unwrap();
    demux_sink.send(("a", 11)).await.unwrap();
    demux_sink.send(("b", 21)).await.unwrap();
    drop(demux_sink);

    assert_eq!(&[10, 11], &**collected1.borrow());
    assert_eq!(&[20, 21], &**collected2.borrow());
    assert_eq!(&[30], &**collected3.borrow());
}

#[tokio::test]
#[should_panic(expected = "`DemuxMap` missing key")]
async fn test_demux_map_missing_key() {
    let (sink, _) = create_collecting_sink();

    let sinks = [("existing", sink)];
    let mut demux_sink = demux_map(sinks);

    // This should panic because "missing" key doesn't exist
    demux_sink.send(("missing", 42)).await.unwrap();
}