reratui-hooks 0.2.0

React-inspired hooks for state management and side effects in Reratui TUI applications
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
//! Tests for the mouse hook

use super::*;
use crate::{
    event::set_current_event,
    state::use_state,
    test_utils::{with_component_id, with_test_isolate},
};
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers, MouseButton, MouseEvent, MouseEventKind};
use parking_lot::Mutex;
use std::sync::{Arc, LazyLock};

// Test mutex to prevent parallel test execution
static TEST_MUTEX: LazyLock<Mutex<()>> = LazyLock::new(|| Mutex::new(()));

#[test]
fn test_use_mouse_basic() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let called = Arc::new(Mutex::new(false));
        let captured_mouse = Arc::new(Mutex::new(None));

        let called_clone = called.clone();
        let mouse_clone = captured_mouse.clone();

        // Set a mouse click event
        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 5,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseTest", |_ctx| {
            use_mouse(move |mouse| {
                *called_clone.lock() = true;
                *mouse_clone.lock() = Some(mouse);
            });
        });

        assert!(*called.lock(), "Callback should have been called");
        let captured = captured_mouse.lock().unwrap();
        assert_eq!(captured.column, 10, "Should capture correct column");
        assert_eq!(captured.row, 5, "Should capture correct row");
    });
}

#[test]
fn test_use_mouse_no_event() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        set_current_event(None);

        let called = Arc::new(Mutex::new(false));
        let called_clone = called.clone();

        with_component_id("MouseNoEventTest", |_ctx| {
            use_mouse(move |_| {
                *called_clone.lock() = true;
            });
        });

        assert!(
            !*called.lock(),
            "Callback should not be called without event"
        );
    });
}

#[test]
fn test_use_mouse_ignores_non_mouse_events() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let called = Arc::new(Mutex::new(false));
        let called_clone = called.clone();

        // Set a keyboard event (not mouse)
        let key_event = KeyEvent::new(KeyCode::Char('a'), KeyModifiers::NONE);
        set_current_event(Some(Arc::new(Event::Key(key_event))));

        with_component_id("MouseIgnoreTest", |_ctx| {
            use_mouse(move |_| {
                *called_clone.lock() = true;
            });
        });

        assert!(
            !*called.lock(),
            "Callback should not be called for non-mouse events"
        );
    });
}

#[test]
fn test_use_mouse_with_state() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 20,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseStateTest", |_ctx| {
            let (count, set_count) = use_state(|| 0);

            use_mouse({
                let set_count = set_count.clone();
                move |_| {
                    set_count.update(|c| *c + 1);
                }
            });

            assert_eq!(count.get(), 1, "State should be updated");
        });
    });
}

#[test]
fn test_use_mouse_click_detection() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let click_type = Arc::new(Mutex::new(String::new()));
        let click_clone = click_type.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 15,
            row: 8,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseClickTest", |_ctx| {
            use_mouse(move |mouse| match mouse.kind {
                MouseEventKind::Down(MouseButton::Left) => {
                    *click_clone.lock() = "left_down".to_string()
                }
                MouseEventKind::Down(MouseButton::Right) => {
                    *click_clone.lock() = "right_down".to_string()
                }
                MouseEventKind::Up(_) => *click_clone.lock() = "up".to_string(),
                _ => {}
            });
        });

        assert_eq!(*click_type.lock(), "left_down", "Should detect left click");
    });
}

#[test]
fn test_use_mouse_movement() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let position = Arc::new(Mutex::new((0u16, 0u16)));
        let pos_clone = position.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Moved,
            column: 42,
            row: 24,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseMoveTest", |_ctx| {
            use_mouse(move |mouse| {
                if matches!(mouse.kind, MouseEventKind::Moved) {
                    *pos_clone.lock() = (mouse.column, mouse.row);
                }
            });
        });

        assert_eq!(*position.lock(), (42, 24), "Should track mouse movement");
    });
}

#[test]
fn test_use_mouse_scroll() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let scroll_direction = Arc::new(Mutex::new(String::new()));
        let scroll_clone = scroll_direction.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::ScrollDown,
            column: 0,
            row: 0,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseScrollTest", |_ctx| {
            use_mouse(move |mouse| {
                let dir = match mouse.kind {
                    MouseEventKind::ScrollUp => "up",
                    MouseEventKind::ScrollDown => "down",
                    MouseEventKind::ScrollLeft => "left",
                    MouseEventKind::ScrollRight => "right",
                    _ => "none",
                };
                *scroll_clone.lock() = dir.to_string();
            });
        });

        assert_eq!(
            *scroll_direction.lock(),
            "down",
            "Should detect scroll direction"
        );
    });
}

#[test]
fn test_use_mouse_with_modifiers() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let has_ctrl = Arc::new(Mutex::new(false));
        let ctrl_clone = has_ctrl.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::CONTROL,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseModifiersTest", |_ctx| {
            use_mouse(move |mouse| {
                *ctrl_clone.lock() = mouse.modifiers.contains(KeyModifiers::CONTROL);
            });
        });

        assert!(*has_ctrl.lock(), "Should detect Ctrl modifier");
    });
}

#[test]
fn test_use_mouse_right_click() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let right_clicked = Arc::new(Mutex::new(false));
        let click_clone = right_clicked.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Right),
            column: 5,
            row: 5,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseRightClickTest", |_ctx| {
            use_mouse(move |mouse| {
                if matches!(mouse.kind, MouseEventKind::Down(MouseButton::Right)) {
                    *click_clone.lock() = true;
                }
            });
        });

        assert!(*right_clicked.lock(), "Should detect right click");
    });
}

#[test]
fn test_use_mouse_effect_event_pattern() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        // Verify that the callback sees the latest state
        let state_value = Arc::new(Mutex::new(0));
        let state_clone = state_value.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 0,
            row: 0,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseEffectEventTest", |_ctx| {
            let (count, set_count) = use_state(|| 0);

            // Update state before mouse handler runs
            set_count.set(99);

            use_mouse({
                let state = state_clone.clone();
                let count_val = count.get();
                move |_| {
                    *state.lock() = count_val;
                }
            });
        });

        // The callback should see the updated state value (99)
        assert_eq!(
            *state_value.lock(),
            99,
            "Callback should see latest state via effect event pattern"
        );
    });
}

// Tests for use_mouse_click
#[test]
fn test_use_mouse_click_left_button() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let clicked = Arc::new(Mutex::new(false));
        let position = Arc::new(Mutex::new((0u16, 0u16)));
        let clicked_clone = clicked.clone();
        let pos_clone = position.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 15,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseClickTest", |_ctx| {
            use_mouse_click(move |button, x, y| {
                if button == MouseButton::Left {
                    *clicked_clone.lock() = true;
                    *pos_clone.lock() = (x, y);
                }
            });
        });

        assert!(*clicked.lock(), "Left click should be detected");
        assert_eq!(*position.lock(), (15, 10), "Click position should match");
    });
}

#[test]
fn test_use_mouse_click_ignores_movement() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let called = Arc::new(Mutex::new(false));
        let called_clone = called.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Moved,
            column: 20,
            row: 20,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseClickIgnoreMovementTest", |_ctx| {
            use_mouse_click(move |_, _, _| {
                *called_clone.lock() = true;
            });
        });

        assert!(!*called.lock(), "Movement should not trigger click handler");
    });
}

#[test]
fn test_use_mouse_click_ignores_drag() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let called = Arc::new(Mutex::new(false));
        let called_clone = called.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Drag(MouseButton::Left),
            column: 25,
            row: 25,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseClickIgnoreDragTest", |_ctx| {
            use_mouse_click(move |_, _, _| {
                *called_clone.lock() = true;
            });
        });

        assert!(!*called.lock(), "Drag should not trigger click handler");
    });
}

#[test]
fn test_use_mouse_click_right_button() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let button_type = Arc::new(Mutex::new(None));
        let button_clone = button_type.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Right),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseClickRightTest", |_ctx| {
            use_mouse_click(move |button, _, _| {
                *button_clone.lock() = Some(button);
            });
        });

        assert_eq!(
            *button_type.lock(),
            Some(MouseButton::Right),
            "Right button should be detected"
        );
    });
}

// Tests for use_mouse_drag
#[test]
fn test_use_mouse_drag_start() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let drag_started = Arc::new(Mutex::new(false));
        let start_pos = Arc::new(Mutex::new((0u16, 0u16)));
        let started_clone = drag_started.clone();
        let pos_clone = start_pos.clone();

        let mouse_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 5,
            row: 5,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(mouse_event))));

        with_component_id("MouseDragStartTest", |_ctx| {
            use_mouse_drag(move |drag_info| {
                if drag_info.is_start {
                    *started_clone.lock() = true;
                    *pos_clone.lock() = drag_info.start;
                }
            });
        });

        assert!(*drag_started.lock(), "Drag should start");
        assert_eq!(*start_pos.lock(), (5, 5), "Start position should match");
    });
}

#[test]
fn test_use_mouse_drag_movement() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let drag_moving = Arc::new(Mutex::new(false));
        let current_pos = Arc::new(Mutex::new((0u16, 0u16)));

        // First, start drag
        let down_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 5,
            row: 5,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(down_event))));

        let moving_clone = drag_moving.clone();
        let pos_clone = current_pos.clone();
        with_component_id("MouseDragMovementTest", |_ctx| {
            use_mouse_drag(move |drag_info| {
                if !drag_info.is_start && !drag_info.is_end {
                    *moving_clone.lock() = true;
                    *pos_clone.lock() = drag_info.current;
                }
            });
        });

        // Then drag
        let drag_event = MouseEvent {
            kind: MouseEventKind::Drag(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(drag_event))));

        let moving_clone = drag_moving.clone();
        let pos_clone = current_pos.clone();
        with_component_id("MouseDragMovementTest", |_ctx| {
            use_mouse_drag(move |drag_info| {
                if !drag_info.is_start && !drag_info.is_end {
                    *moving_clone.lock() = true;
                    *pos_clone.lock() = drag_info.current;
                }
            });
        });

        assert!(*drag_moving.lock(), "Drag movement should be detected");
        assert_eq!(
            *current_pos.lock(),
            (10, 10),
            "Current position should match"
        );
    });
}

#[test]
fn test_use_mouse_drag_end() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let drag_ended = Arc::new(Mutex::new(false));

        // Start drag first
        let down_event = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 5,
            row: 5,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(down_event))));

        let ended_clone = drag_ended.clone();
        with_component_id("MouseDragEndTest", |_ctx| {
            use_mouse_drag(move |drag_info| {
                if drag_info.is_end {
                    *ended_clone.lock() = true;
                }
            });
        });

        // End drag
        let up_event = MouseEvent {
            kind: MouseEventKind::Up(MouseButton::Left),
            column: 15,
            row: 15,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(up_event))));

        let ended_clone = drag_ended.clone();
        with_component_id("MouseDragEndTest", |_ctx| {
            use_mouse_drag(move |drag_info| {
                if drag_info.is_end {
                    *ended_clone.lock() = true;
                }
            });
        });

        assert!(*drag_ended.lock(), "Drag should end");
    });
}

// Tests for use_double_click
#[test]
fn test_use_double_click_detected() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let double_clicked = Arc::new(Mutex::new(false));

        // First click
        let first_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(first_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        // Second click (immediately after, within window)
        let second_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(second_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        assert!(*double_clicked.lock(), "Double-click should be detected");
    });
}

#[test]
fn test_use_double_click_different_position() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let double_clicked = Arc::new(Mutex::new(false));

        // First click at (10, 10)
        let first_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(first_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickDifferentPosTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        // Second click at different position (20, 20)
        let second_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 20,
            row: 20,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(second_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickDifferentPosTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        assert!(
            !*double_clicked.lock(),
            "Different position should not trigger double-click"
        );
    });
}

#[test]
fn test_use_double_click_different_button() {
    let _lock = TEST_MUTEX.lock();
    with_test_isolate(|| {
        let double_clicked = Arc::new(Mutex::new(false));

        // First click with left button
        let first_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Left),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(first_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickDifferentButtonTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        // Second click with right button
        let second_click = MouseEvent {
            kind: MouseEventKind::Down(MouseButton::Right),
            column: 10,
            row: 10,
            modifiers: KeyModifiers::NONE,
        };
        set_current_event(Some(Arc::new(Event::Mouse(second_click))));

        let clicked_clone = double_clicked.clone();
        with_component_id("DoubleClickDifferentButtonTest", |_ctx| {
            use_double_click(std::time::Duration::from_millis(500), move |_, _, _| {
                *clicked_clone.lock() = true;
            });
        });

        assert!(
            !*double_clicked.lock(),
            "Different button should not trigger double-click"
        );
    });
}