rgx-cli 0.12.7

A terminal regex tester with real-time matching, multi-engine support, and plain-English explanations
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
use crossterm::event::{KeyCode, KeyEvent, KeyEventKind, KeyEventState, KeyModifiers};
use ratatui::{backend::TestBackend, Terminal};
use rgx::app::App;
use rgx::engine::{EngineFlags, EngineKind};
use rgx::input::handler::handle_help_key;
use rgx::ui::{self, build_lengths_of_help_pages};

fn create_test_terminal() -> Terminal<TestBackend> {
    let backend = TestBackend::new(80, 24);
    Terminal::new(backend).unwrap()
}

fn press_key(code: KeyCode) -> KeyEvent {
    KeyEvent {
        code,
        modifiers: KeyModifiers::empty(),
        kind: KeyEventKind::Press,
        state: KeyEventState::empty(),
    }
}

#[test]
fn render_empty_state() {
    let mut terminal = create_test_terminal();
    let app = App::new(EngineKind::RustRegex, EngineFlags::default());
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn render_with_pattern() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123 world 456");
    app.set_pattern(r"\d+");
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
    assert_eq!(app.matches.len(), 2);
}

#[test]
fn render_with_error() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_pattern(r"(unclosed");
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
    assert!(app.error.is_some());
}

#[test]
fn render_with_captures() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("user@example.com");
    app.set_pattern(r"(\w+)@(\w+)\.(\w+)");
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
    assert_eq!(app.matches.len(), 1);
    assert_eq!(app.matches[0].captures.len(), 3);
}

#[test]
fn render_help_overlay() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.overlay.help = true;
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn engine_switching() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123");
    app.set_pattern(r"\d+");
    assert_eq!(app.matches.len(), 1);

    app.switch_engine();
    assert_eq!(app.engine_kind, EngineKind::FancyRegex);
    assert_eq!(app.matches.len(), 1);
}

#[test]
fn flag_toggles() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("Hello HELLO hello");
    app.set_pattern("hello");
    assert_eq!(app.matches.len(), 1); // only lowercase match

    app.flags.toggle_case_insensitive();
    app.recompute();
    assert_eq!(app.matches.len(), 3); // all match now
}

#[test]
fn match_display_shows_results() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("user@example");
    app.set_pattern(r"(\w+)@(\w+)");

    // Verify match data exists
    assert_eq!(app.matches.len(), 1);
    assert_eq!(app.matches[0].text, "user@example");
    assert_eq!(app.matches[0].captures.len(), 2);

    // Render and check that match text appears in the buffer
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
    let buffer = terminal.backend().buffer().clone();
    let buffer_text: String = buffer
        .content()
        .iter()
        .map(|cell| cell.symbol().chars().next().unwrap_or(' '))
        .collect();
    assert!(
        buffer_text.contains("Match 1"),
        "Buffer should contain 'Match 1' but got: {buffer_text}"
    );
}

#[test]
fn multiline_test_string_renders() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello\nworld");
    app.set_pattern(r"\w+");

    // Should find matches on both lines
    assert_eq!(app.matches.len(), 2);
    assert_eq!(app.matches[0].text, "hello");
    assert_eq!(app.matches[1].text, "world");

    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn narrow_terminal_layout() {
    // Test that narrow terminals don't crash
    let backend = TestBackend::new(40, 24);
    let mut terminal = Terminal::new(backend).unwrap();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("test");
    app.set_pattern(r"\w+");
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn render_with_replacement() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123 world 456");
    app.set_pattern(r"\d+");
    app.set_replacement("[NUM]");

    assert!(app.replace_result.is_some());
    let result = app.replace_result.as_ref().unwrap();
    assert_eq!(result.output, "hello [NUM] world [NUM]");

    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn render_empty_replacement() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123");
    app.set_pattern(r"\d+");
    // No replacement set
    assert!(app.replace_result.is_none());
}

#[test]
fn panel_cycling_includes_replace() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    assert_eq!(app.focused_panel, 0);
    app.focused_panel = (app.focused_panel + 1) % 5;
    assert_eq!(app.focused_panel, 1);
    app.focused_panel = (app.focused_panel + 1) % 5;
    assert_eq!(app.focused_panel, 2); // replace panel
    app.focused_panel = (app.focused_panel + 1) % 5;
    assert_eq!(app.focused_panel, 3); // matches
    app.focused_panel = (app.focused_panel + 1) % 5;
    assert_eq!(app.focused_panel, 4); // explanation
    app.focused_panel = (app.focused_panel + 1) % 5;
    assert_eq!(app.focused_panel, 0); // back to regex
}

#[test]
fn replacement_with_named_groups() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("2024-01");
    app.set_pattern(r"(?P<y>\d{4})-(?P<m>\d{2})");
    app.set_replacement("${m}/${y}");

    assert!(app.replace_result.is_some());
    let result = app.replace_result.as_ref().unwrap();
    assert_eq!(result.output, "01/2024");
}

#[test]
fn replacement_clears_on_empty_template() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123");
    app.set_pattern(r"\d+");
    app.set_replacement("[NUM]");
    assert!(app.replace_result.is_some());

    app.set_replacement("");
    assert!(app.replace_result.is_none());
}

// --- Phase 2 tests ---

#[test]
fn undo_redo_regex_editor() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello 123");
    app.regex_editor.insert_char('\\');
    app.regex_editor.insert_char('d');
    app.regex_editor.insert_char('+');
    app.recompute();
    assert_eq!(app.matches.len(), 1);

    app.regex_editor.undo();
    app.recompute();
    // Pattern is now "\d" — still matches
    assert_eq!(app.regex_editor.content(), "\\d");

    app.regex_editor.redo();
    app.recompute();
    assert_eq!(app.regex_editor.content(), "\\d+");
}

#[test]
fn pattern_history_navigation() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("abc 123 def 456");

    // Commit first pattern
    app.set_pattern(r"\d+");
    app.commit_pattern_to_history();

    // Commit second pattern
    app.set_pattern(r"\w+");
    app.commit_pattern_to_history();

    assert_eq!(app.history.entries.len(), 2);

    // Navigate back
    app.set_pattern("current");
    app.history_prev();
    assert_eq!(app.regex_editor.content(), r"\w+");

    app.history_prev();
    assert_eq!(app.regex_editor.content(), r"\d+");

    // Navigate forward
    app.history_next();
    assert_eq!(app.regex_editor.content(), r"\w+");

    // Past end restores temp
    app.history_next();
    assert_eq!(app.regex_editor.content(), "current");
}

#[test]
fn pattern_history_dedup() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_pattern(r"\d+");
    app.commit_pattern_to_history();
    app.commit_pattern_to_history(); // same pattern, should dedup
    assert_eq!(app.history.entries.len(), 1);
}

#[test]
fn match_selection_navigation() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("aa bb cc");
    app.set_pattern(r"\w+");
    assert_eq!(app.matches.len(), 3);

    // Start at match 0, no capture
    assert_eq!(app.selection.match_index, 0);
    assert_eq!(app.selection.capture_index, None);

    // Navigate down through matches (no captures here)
    app.select_match_next();
    assert_eq!(app.selection.match_index, 1);

    app.select_match_next();
    assert_eq!(app.selection.match_index, 2);

    // Can't go past last match
    app.select_match_next();
    assert_eq!(app.selection.match_index, 2);

    // Navigate back up
    app.select_match_prev();
    assert_eq!(app.selection.match_index, 1);

    app.select_match_prev();
    assert_eq!(app.selection.match_index, 0);

    // Can't go before first match
    app.select_match_prev();
    assert_eq!(app.selection.match_index, 0);
}

#[test]
fn match_selection_with_captures() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("user@example");
    app.set_pattern(r"(\w+)@(\w+)");
    assert_eq!(app.matches.len(), 1);
    assert_eq!(app.matches[0].captures.len(), 2);

    // Start at match 0
    assert_eq!(app.selection.match_index, 0);
    assert_eq!(app.selection.capture_index, None);

    // Next goes to first capture
    app.select_match_next();
    assert_eq!(app.selection.match_index, 0);
    assert_eq!(app.selection.capture_index, Some(0));

    // Next goes to second capture
    app.select_match_next();
    assert_eq!(app.selection.match_index, 0);
    assert_eq!(app.selection.capture_index, Some(1));

    // Prev goes back to first capture
    app.select_match_prev();
    assert_eq!(app.selection.capture_index, Some(0));

    // Prev goes back to match header
    app.select_match_prev();
    assert_eq!(app.selection.capture_index, None);
}

#[test]
fn selection_resets_on_rematch() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("aa bb");
    app.set_pattern(r"\w+");
    app.select_match_next();
    assert_eq!(app.selection.match_index, 1);

    // Changing test string resets selection
    app.set_test_string("aa bb cc");
    assert_eq!(app.selection.match_index, 0);
    assert_eq!(app.selection.capture_index, None);
}

#[test]
fn help_pages_render() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.overlay.help = true;

    // Page 0 (default)
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();

    // Page 1
    app.overlay.help_page = 1;
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();

    // Page 2
    app.overlay.help_page = 2;
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn help_page_clamped() {
    let mut terminal = create_test_terminal();
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.overlay.help = true;
    app.overlay.help_page = 99; // out of bounds, should clamp
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn multiline_flag_matching() {
    let mut app = App::new(
        EngineKind::RustRegex,
        EngineFlags {
            multi_line: true,
            ..Default::default()
        },
    );
    app.set_test_string("line1\nno match\nline42");
    app.set_pattern(r"^line\d+$");
    assert_eq!(app.matches.len(), 2);
    assert_eq!(app.matches[0].text, "line1");
    assert_eq!(app.matches[1].text, "line42");
}

#[test]
fn dotall_flag_matching() {
    let mut app = App::new(
        EngineKind::RustRegex,
        EngineFlags {
            dot_matches_newline: true,
            ..Default::default()
        },
    );
    app.set_test_string("a\nb");
    app.set_pattern("a.b");
    assert_eq!(app.matches.len(), 1);
    assert_eq!(app.matches[0].text, "a\nb");
}

#[test]
fn whitespace_visualization_toggle() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    assert!(!app.show_whitespace);
    app.show_whitespace = true;
    assert!(app.show_whitespace);

    // Rendering with whitespace mode should not panic
    let mut terminal = create_test_terminal();
    app.set_test_string("hello world\nfoo bar");
    app.set_pattern(r"\w+");
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn compute_layout_does_not_panic() {
    use ratatui::layout::Rect;
    // Wide terminal
    let _ = ui::compute_layout(Rect::new(0, 0, 120, 40));
    // Narrow terminal
    let _ = ui::compute_layout(Rect::new(0, 0, 40, 20));
    // Tiny terminal
    let _ = ui::compute_layout(Rect::new(0, 0, 10, 10));
}

#[test]
fn test_empty_state_render() {
    let mut terminal = create_test_terminal();
    let app = App::new(EngineKind::RustRegex, EngineFlags::default());
    // No pattern, no test string — should render without panic
    assert!(app.regex_editor.content().is_empty());
    assert!(app.test_editor.content().is_empty());
    assert!(app.matches.is_empty());
    assert!(app.error.is_none());
    terminal.draw(|frame| ui::render(frame, &app)).unwrap();
}

#[test]
fn test_replace_invalid_capture_ref() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.set_test_string("hello world");
    app.set_pattern(r"(\w+) (\w+)");
    // $99 references a non-existent group — should not panic
    app.set_replacement("$99");
    assert!(app.replace_result.is_some());
    let result = app.replace_result.as_ref().unwrap();
    // $99 is parsed as $9 then literal '9', $9 doesn't exist so nothing
    // The output should just not crash
    assert!(!result.output.is_empty() || result.output.is_empty());
}

#[test]
fn upper_scroll_bound() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.overlay.help = true;
    app.help_scroll_offset = 0;
    let before = app.help_scroll_offset;
    handle_help_key(&mut app, press_key(KeyCode::Up));
    assert_eq!(app.help_scroll_offset, before);
}

#[test]
fn scroll_up_decrements_offset() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.overlay.help = true;
    app.help_scroll_offset = 5;
    handle_help_key(&mut app, press_key(KeyCode::Up));
    assert_eq!(app.help_scroll_offset, 4);
}

#[test]
fn scroll_lower_bound() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());

    app.overlay.help = true;
    let bound_checker = |app: &mut App| {
        let max_scroll = app.help_page_max_scroll();
        app.help_scroll_offset = max_scroll;

        // Test Lower Bound: Press 'j' at max index => should clip at max_scroll
        // Simulate pressing 3 times beyond the max_scroll
        for _ in 0..3 {
            handle_help_key(app, press_key(KeyCode::Down));
        }
        assert_eq!(
            app.help_scroll_offset, max_scroll,
            "Scroll offset should be bounded by max_scroll"
        );
    };

    // Page 0
    bound_checker(&mut app);

    // Page 1
    handle_help_key(&mut app, press_key(KeyCode::Char('l')));
    bound_checker(&mut app);

    // Page 2
    handle_help_key(&mut app, press_key(KeyCode::Char('l')));
    bound_checker(&mut app);
}

#[test]
fn scroll_offset_reset() {
    let mut app = App::new(EngineKind::RustRegex, EngineFlags::default());
    app.help_scroll_offset = 5;
    handle_help_key(&mut app, press_key(KeyCode::Left));
    assert_eq!(
        app.help_scroll_offset, 0,
        "Scroll offset does not reset on page change"
    );
    app.help_scroll_offset = 5;
    handle_help_key(&mut app, press_key(KeyCode::Esc));
    assert_eq!(
        app.help_scroll_offset, 0,
        "Scroll offset does not reset on close"
    );
}

#[test]
fn scroll_help_pages_length_check() {
    let length_hashmap = build_lengths_of_help_pages();
    // For now it only checks all EngineKinds inside ::all()
    for engine in EngineKind::all() {
        let page_lengths_of_engine = length_hashmap.get(&engine);
        match page_lengths_of_engine {
            Some(vec) => {
                assert!(
                    vec.iter().all(|&x| x > crate::ui::HELP_PAGE_PADDING),
                    "Page has no content for the engine {:?}",
                    engine
                );
            }
            None => {
                panic!(
                    "Engine {:?} was not found in the page lengths hashmap",
                    engine
                );
            }
        }
    }
}