rusty-rich 0.1.0

Rich text and beautiful formatting in the terminal — a Rust port of Python's Rich library
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
//! Spinner — animated spinner. Equivalent to Rich's `spinner.py`.

use std::time::Duration;

// ---------------------------------------------------------------------------
// Spinner frames
// ---------------------------------------------------------------------------

/// Predefined spinner animations (matching Rich's spinner set).
#[derive(Debug, Clone)]
pub struct SpinnerFrames {
    pub frames: &'static [&'static str],
    pub interval: f64, // seconds per frame
}

// ===========================================================================
// Classic / dots spinners
// ===========================================================================

pub const SPINNER_DOTS: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_LINE: SpinnerFrames = SpinnerFrames {
    frames: &["-", "\\", "|", "/"],
    interval: 0.1,
};

pub const SPINNER_DOTS2: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS3: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS4: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS5: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS6: SpinnerFrames = SpinnerFrames {
    frames: &[
        "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "",
        "", "", "", "", "", "", "",
    ],
    interval: 0.08,
};

pub const SPINNER_DOTS7: SpinnerFrames = SpinnerFrames {
    frames: &[
        "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "",
        "", "", "", "", "", "", "",
    ],
    interval: 0.08,
};

pub const SPINNER_DOTS8: SpinnerFrames = SpinnerFrames {
    frames: &[
        "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "",
        "", "", "", "", "", "", "", "", "", "", "", "",
    ],
    interval: 0.08,
};

pub const SPINNER_DOTS9: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS10: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_DOTS11: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_SIMPLE_DOTS: SpinnerFrames = SpinnerFrames {
    frames: &[".  ", ".. ", "...", " ..", "  .", "   "],
    interval: 0.2,
};

// ===========================================================================
// Icon / theme spinners
// ===========================================================================

pub const SPINNER_MOON: SpinnerFrames = SpinnerFrames {
    frames: &["🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"],
    interval: 0.08,
};

pub const SPINNER_SMILEY: SpinnerFrames = SpinnerFrames {
    frames: &["😄", "😝"],
    interval: 0.2,
};

// ===========================================================================
// New spinner styles (20+ from Python Rich)
// ===========================================================================

pub const SPINNER_ARC: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_ARROW: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_ARROW2: SpinnerFrames = SpinnerFrames {
    frames: &["⬆️", "↗️", "➡️", "↘️", "⬇️", "↙️", "⬅️", "↖️"],
    interval: 0.1,
};

pub const SPINNER_ARROW3: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_BOUNCING_BAR: SpinnerFrames = SpinnerFrames {
    frames: &["[    ]", "[=   ]", "[==  ]", "[=== ]", "[ ===]", "[  ==]", "[   =]", "[    ]"],
    interval: 0.15,
};

pub const SPINNER_BOUNCING_BALL: SpinnerFrames = SpinnerFrames {
    frames: &[
        "( ●    )", "(  ●   )", "(   ●  )", "(    ● )", "(     ●)", "(    ● )", "(   ●  )",
        "(  ●   )",
    ],
    interval: 0.15,
};

pub const SPINNER_CHRISTMAS: SpinnerFrames = SpinnerFrames {
    frames: &["🌲", "🎄"],
    interval: 0.4,
};

pub const SPINNER_CIRCLE: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_CLOCK: SpinnerFrames = SpinnerFrames {
    frames: &[
        "🕐", "🕑", "🕒", "🕓", "🕔", "🕕", "🕖", "🕗", "🕘", "🕙", "🕚", "🕛",
    ],
    interval: 0.1,
};

pub const SPINNER_EARTH: SpinnerFrames = SpinnerFrames {
    frames: &["🌍", "🌎", "🌏"],
    interval: 0.2,
};

pub const SPINNER_GRENADE: SpinnerFrames = SpinnerFrames {
    frames: &["،  💣  ", "۔  💣  ", " ﹒ 💣  "],
    interval: 0.1,
};

pub const SPINNER_GROW_HORIZONTAL: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_GROW_VERTICAL: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_HAMBURGER: SpinnerFrames = SpinnerFrames {
    frames: &["", "", ""],
    interval: 0.12,
};

pub const SPINNER_HEARTS: SpinnerFrames = SpinnerFrames {
    frames: &["🩷", "❤️", "🧡", "💛", "💚", "💙", "🩵", "💜", "🤎", "🖤", "🩶", "🤍"],
    interval: 0.12,
};

pub const SPINNER_MONKEY: SpinnerFrames = SpinnerFrames {
    frames: &["🐒", "🐒", "🐒", "🐒", "🙈", "🙉", "🙊", "🐒", "🐒", "🐒", "🐒"],
    interval: 0.15,
};

pub const SPINNER_NOISE: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

pub const SPINNER_PONG: SpinnerFrames = SpinnerFrames {
    frames: &[
        "▐⠂       ▌", "▐⠈       ▌", "▐ ⠂      ▌", "▐ ⠠      ▌",
        "▐  ⡀     ▌", "▐  ⠠     ▌", "▐   ⠂    ▌", "▐   ⠈    ▌",
        "▐    ⠂   ▌", "▐    ⠠   ▌", "▐     ⡀  ▌", "▐     ⠠  ▌",
        "▐      ⠂ ▌", "▐      ⠈ ▌", "▐       ⠂▌", "▐       ⠠▌",
        "▐       ⡀▌", "▐      ⠠ ▌", "▐      ⠂ ▌", "▐     ⠈  ▌",
        "▐     ⠂  ▌", "▐    ⠠   ▌", "▐    ⡀   ▌", "▐   ⠠    ▌",
        "▐   ⠂    ▌", "▐  ⠈     ▌", "▐  ⠂     ▌", "▐ ⠠      ▌",
        "▐ ⠂      ▌", "▐⠈       ▌",
    ],
    interval: 0.08,
};

pub const SPINNER_RUNNER: SpinnerFrames = SpinnerFrames {
    frames: &["🚶", "🏃", "🏃", "🏃", "🚶", "🚶"],
    interval: 0.15,
};

pub const SPINNER_SHARK: SpinnerFrames = SpinnerFrames {
    frames: &["🦈", "🌀", "🦈", "🌀", "🦈", "🌀"],
    interval: 0.15,
};

pub const SPINNER_TOGGLE: SpinnerFrames = SpinnerFrames {
    frames: &["", ""],
    interval: 0.2,
};

pub const SPINNER_TRIANGLE: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", ""],
    interval: 0.1,
};

pub const SPINNER_VERTICAL_BARS: SpinnerFrames = SpinnerFrames {
    frames: &["", "", "", "", "", "", "", "", "", "", "", "", "", "", ""],
    interval: 0.08,
};

/// Default spinner.
pub const DEFAULT_SPINNER: SpinnerFrames = SPINNER_DOTS;

// ===========================================================================
// Name-based lookup
// =========================================================================--

/// All known spinners mapped by name (lowercase) for runtime lookup.
pub const SPINNERS: &[(&str, &SpinnerFrames)] = &[
    ("arc", &SPINNER_ARC),
    ("arrow", &SPINNER_ARROW),
    ("arrow2", &SPINNER_ARROW2),
    ("arrow3", &SPINNER_ARROW3),
    ("bouncingBar", &SPINNER_BOUNCING_BAR),
    ("bouncingBall", &SPINNER_BOUNCING_BALL),
    ("christmas", &SPINNER_CHRISTMAS),
    ("circle", &SPINNER_CIRCLE),
    ("clock", &SPINNER_CLOCK),
    ("dots", &SPINNER_DOTS),
    ("dots2", &SPINNER_DOTS2),
    ("dots3", &SPINNER_DOTS3),
    ("dots4", &SPINNER_DOTS4),
    ("dots5", &SPINNER_DOTS5),
    ("dots6", &SPINNER_DOTS6),
    ("dots7", &SPINNER_DOTS7),
    ("dots8", &SPINNER_DOTS8),
    ("dots9", &SPINNER_DOTS9),
    ("dots10", &SPINNER_DOTS10),
    ("dots11", &SPINNER_DOTS11),
    ("earth", &SPINNER_EARTH),
    ("grenade", &SPINNER_GRENADE),
    ("growHorizontal", &SPINNER_GROW_HORIZONTAL),
    ("growVertical", &SPINNER_GROW_VERTICAL),
    ("hamburger", &SPINNER_HAMBURGER),
    ("hearts", &SPINNER_HEARTS),
    ("line", &SPINNER_LINE),
    ("monkey", &SPINNER_MONKEY),
    ("moon", &SPINNER_MOON),
    ("noise", &SPINNER_NOISE),
    ("pong", &SPINNER_PONG),
    ("runner", &SPINNER_RUNNER),
    ("shark", &SPINNER_SHARK),
    ("simpleDots", &SPINNER_SIMPLE_DOTS),
    ("smiley", &SPINNER_SMILEY),
    ("toggle", &SPINNER_TOGGLE),
    ("triangle", &SPINNER_TRIANGLE),
    ("verticalBars", &SPINNER_VERTICAL_BARS),
];

/// Get a spinner by name (case-insensitive).
///
/// Returns `None` if no spinner with the given name exists.
///
/// # Example
///
/// ```rust
/// use rusty_rich::get_spinner;
///
/// let s = get_spinner("arc").unwrap();
/// assert_eq!(s.frames.len(), 6);
/// ```
pub fn get_spinner(name: &str) -> Option<&'static SpinnerFrames> {
    // First try direct lowercase match
    for (key, spinner) in SPINNERS {
        if key.eq_ignore_ascii_case(name) {
            return Some(spinner);
        }
    }
    // Fallback: try stripping spaces and hyphens, matching lowercase
    let normalized: String = name.chars().filter(|c| !c.is_whitespace()).collect();
    let normalized = normalized.to_lowercase();
    for (key, spinner) in SPINNERS {
        let key_normalized: String = key.chars().filter(|c| !c.is_whitespace()).collect();
        let key_normalized = key_normalized.to_lowercase();
        if key_normalized == normalized {
            return Some(spinner);
        }
    }
    None
}

// ---------------------------------------------------------------------------
// Spinner
// ---------------------------------------------------------------------------

/// An animated spinner renderable.
#[derive(Debug, Clone)]
pub struct Spinner {
    pub frames: &'static [&'static str],
    pub interval: f64,
    /// Text displayed alongside the spinner.
    pub text: String,
    /// Style for the spinner.
    pub style: crate::style::Style,
}

impl Spinner {
    /// Create a new spinner.
    pub fn new(spinner: &'static SpinnerFrames) -> Self {
        Self {
            frames: spinner.frames,
            interval: spinner.interval,
            text: String::new(),
            style: crate::style::Style::new(),
        }
    }

    /// Builder: set the text.
    pub fn text(mut self, text: impl Into<String>) -> Self {
        self.text = text.into();
        self
    }

    /// Builder: set the style.
    pub fn style(mut self, style: crate::style::Style) -> Self {
        self.style = style;
        self
    }

    /// Get the frame at the given elapsed time.
    pub fn frame_at(&self, elapsed: Duration) -> &'static str {
        let idx = (elapsed.as_secs_f64() / self.interval) as usize % self.frames.len();
        self.frames[idx]
    }

    /// Get the display string for the current time.
    pub fn render(&self, elapsed: Duration) -> String {
        let frame = self.frame_at(elapsed);
        let style_ansi = self.style.to_ansi();
        let reset = if style_ansi.is_empty() { "" } else { "\x1b[0m" };
        if self.text.is_empty() {
            format!("{style_ansi}{frame}{reset}")
        } else {
            format!("{style_ansi}{frame}{reset} {}", self.text)
        }
    }
}

impl Default for Spinner {
    fn default() -> Self {
        Self::new(&DEFAULT_SPINNER)
    }
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_spinner_frame_at() {
        let s = Spinner::new(&SPINNER_LINE);
        let f = s.frame_at(Duration::from_millis(200));
        assert!(f == "-" || f == "\\" || f == "|" || f == "/");
    }

    #[test]
    fn test_get_spinner_found() {
        let s = get_spinner("dots").unwrap();
        assert!(!s.frames.is_empty());

        let s = get_spinner("DOTS").unwrap();
        assert!(!s.frames.is_empty());

        let s = get_spinner("arc").unwrap();
        assert_eq!(s.frames.len(), 6);
    }

    #[test]
    fn test_get_spinner_not_found() {
        assert!(get_spinner("nonexistent").is_none());
    }

    #[test]
    fn test_get_spinner_case_insensitive() {
        let s1 = get_spinner("ARC").unwrap();
        let s2 = get_spinner("arc").unwrap();
        assert_eq!(s1.frames, s2.frames);
    }

    #[test]
    fn test_get_spinner_camel_case() {
        let s = get_spinner("bouncingBar").unwrap();
        assert!(!s.frames.is_empty());

        let s = get_spinner("BOUNCINGBAR").unwrap();
        assert!(!s.frames.is_empty());
    }

    #[test]
    fn test_spinners_list_all_accessible() {
        for (name, frames) in SPINNERS {
            let found = get_spinner(name).unwrap();
            assert!(!frames.frames.is_empty(), "spinner '{}' has no frames", name);
            // Compare frame content rather than raw pointers, since `const`
            // values may be inlined at different addresses by the compiler.
            assert_eq!(
                frames.frames, found.frames,
                "spinner '{}' points to different frames than expected",
                name
            );
            assert!(
                (frames.interval - found.interval).abs() < f64::EPSILON,
                "spinner '{}' interval mismatch",
                name
            );
        }
    }

    #[test]
    fn test_spinner_arc_frames() {
        assert_eq!(SPINNER_ARC.frames.len(), 6);
        assert!(SPINNER_ARC.interval > 0.0);
    }

    #[test]
    fn test_spinner_arrow_frames() {
        assert_eq!(SPINNER_ARROW.frames.len(), 8);
    }

    #[test]
    fn test_spinner_arrow2_frames() {
        assert_eq!(SPINNER_ARROW2.frames.len(), 8);
    }

    #[test]
    fn test_spinner_arrow3_frames() {
        assert_eq!(SPINNER_ARROW3.frames.len(), 6);
    }

    #[test]
    fn test_spinner_bouncing_bar() {
        assert_eq!(SPINNER_BOUNCING_BAR.frames.len(), 8);
    }

    #[test]
    fn test_spinner_bouncing_ball() {
        assert_eq!(SPINNER_BOUNCING_BALL.frames.len(), 8);
    }

    #[test]
    fn test_spinner_christmas() {
        assert_eq!(SPINNER_CHRISTMAS.frames.len(), 2);
    }

    #[test]
    fn test_spinner_circle() {
        assert_eq!(SPINNER_CIRCLE.frames.len(), 4);
    }

    #[test]
    fn test_spinner_clock() {
        assert_eq!(SPINNER_CLOCK.frames.len(), 12);
    }

    #[test]
    fn test_spinner_earth() {
        assert_eq!(SPINNER_EARTH.frames.len(), 3);
    }

    #[test]
    fn test_spinner_grenade() {
        assert_eq!(SPINNER_GRENADE.frames.len(), 3);
    }

    #[test]
    fn test_spinner_grow_horizontal() {
        assert_eq!(SPINNER_GROW_HORIZONTAL.frames.len(), 14);
    }

    #[test]
    fn test_spinner_grow_vertical() {
        assert_eq!(SPINNER_GROW_VERTICAL.frames.len(), 14);
    }

    #[test]
    fn test_spinner_hamburger() {
        assert_eq!(SPINNER_HAMBURGER.frames.len(), 3);
    }

    #[test]
    fn test_spinner_hearts() {
        assert_eq!(SPINNER_HEARTS.frames.len(), 12);
    }

    #[test]
    fn test_spinner_monkey() {
        assert_eq!(SPINNER_MONKEY.frames.len(), 11);
    }

    #[test]
    fn test_spinner_noise() {
        assert_eq!(SPINNER_NOISE.frames.len(), 9);
    }

    #[test]
    fn test_spinner_pong() {
        assert_eq!(SPINNER_PONG.frames.len(), 30);
    }

    #[test]
    fn test_spinner_runner() {
        assert_eq!(SPINNER_RUNNER.frames.len(), 6);
    }

    #[test]
    fn test_spinner_shark() {
        assert_eq!(SPINNER_SHARK.frames.len(), 6);
    }

    #[test]
    fn test_spinner_toggle() {
        assert_eq!(SPINNER_TOGGLE.frames.len(), 2);
    }

    #[test]
    fn test_spinner_triangle() {
        assert_eq!(SPINNER_TRIANGLE.frames.len(), 4);
    }

    #[test]
    fn test_spinner_vertical_bars() {
        assert_eq!(SPINNER_VERTICAL_BARS.frames.len(), 15);
    }

    #[test]
    fn test_spinner_interval_positive() {
        for (name, frames) in SPINNERS {
            assert!(
                frames.interval > 0.0,
                "spinner '{}' has non-positive interval",
                name
            );
        }
    }

    #[test]
    fn test_default_spinner_is_dots() {
        assert_eq!(DEFAULT_SPINNER.frames, SPINNER_DOTS.frames);
    }
}