rich_rust 0.2.1

A Rust port of Python's Rich library for beautiful terminal output
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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
//! Group renderable for combining multiple renderables.
//!
//! A `Group` combines multiple renderables into a single unit that can be
//! passed to containers like Panel or Layout. This is useful when you want
//! to pass multiple renderables as panel content.
//!
//! # Examples
//!
//! ```rust,ignore
//! use rich_rust::renderables::{Group, Panel, Rule};
//! use rich_rust::text::Text;
//!
//! // Combine multiple renderables into a group
//! let group = Group::new()
//!     .push("First paragraph of text")
//!     .push(Rule::new())
//!     .push("Second paragraph");
//!
//! // Use the group as panel content
//! let panel = Panel::from_renderable(&group, 80)
//!     .title("Grouped Content");
//!
//! // Or render directly
//! console.print_renderable(&group);
//! ```
//!
//! # Fit Option
//!
//! By default, each renderable is rendered on its own lines. Use `fit(true)`
//! to attempt to render items inline when they fit.

use crate::console::{Console, ConsoleOptions};
use crate::segment::Segment;

use super::Renderable;

/// A container that groups multiple renderables together.
///
/// Group implements the Renderable trait, allowing you to combine
/// multiple renderables into a single unit. Each child is rendered
/// in sequence with optional separators.
#[derive(Default)]
pub struct Group<'a> {
    /// The renderables in this group.
    children: Vec<Box<dyn Renderable + 'a>>,
    /// Whether to fit items inline when possible.
    fit: bool,
}

impl<'a> Group<'a> {
    /// Create a new empty group.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Add a renderable to the group.
    ///
    /// The renderable is boxed and stored. You can add any type that
    /// implements the Renderable trait.
    #[must_use]
    pub fn push<R: Renderable + 'a>(mut self, renderable: R) -> Self {
        self.children.push(Box::new(renderable));
        self
    }

    /// Add a boxed renderable to the group.
    #[must_use]
    pub fn push_boxed(mut self, renderable: Box<dyn Renderable + 'a>) -> Self {
        self.children.push(renderable);
        self
    }

    /// Set whether to fit items inline when possible.
    ///
    /// When `fit` is true, items that fit on the same line are
    /// rendered together. When false (default), each item gets its own line.
    #[must_use]
    pub fn fit(mut self, fit: bool) -> Self {
        self.fit = fit;
        self
    }

    /// Check if the group is empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }

    /// Return the number of items in the group.
    #[must_use]
    pub fn len(&self) -> usize {
        self.children.len()
    }
}

impl Renderable for Group<'_> {
    fn render(&self, console: &Console, options: &ConsoleOptions) -> Vec<Segment<'_>> {
        let mut segments = Vec::new();

        for (i, child) in self.children.iter().enumerate() {
            // Add newline between items unless fit mode is on
            if i > 0 && !self.fit {
                segments.push(Segment::new("\n".to_string(), None));
            }

            // Render the child
            let child_segments = child.render(console, options);
            segments.extend(child_segments.into_iter().map(Segment::into_owned));
        }

        segments
    }
}

/// Create a group from an iterator of renderables.
///
/// This is a convenience function for creating groups from iterators.
///
/// # Examples
///
/// ```rust,ignore
/// use rich_rust::renderables::group::group;
///
/// let items = vec!["Item 1", "Item 2", "Item 3"];
/// let g = group(items.into_iter());
/// ```
pub fn group<'a, I, R>(iter: I) -> Group<'a>
where
    I: IntoIterator<Item = R>,
    R: Renderable + 'a,
{
    let mut g = Group::new();
    for item in iter {
        g = g.push(item);
    }
    g
}

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

    #[test]
    fn test_group_new() {
        let g: Group = Group::new();
        assert!(g.is_empty());
        assert_eq!(g.len(), 0);
    }

    #[test]
    fn test_group_add_strings() {
        let g = Group::new().push("First").push("Second").push("Third");
        assert_eq!(g.len(), 3);
    }

    #[test]
    fn test_group_render() {
        let g = Group::new().push("Line 1").push("Line 2");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();

        assert!(text.contains("Line 1"));
        assert!(text.contains("Line 2"));
        assert!(text.contains('\n'), "should have newline between items");
    }

    #[test]
    fn test_group_render_fit_mode() {
        let g = Group::new().push("Part1").push("Part2").fit(true);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();

        assert!(text.contains("Part1"));
        assert!(text.contains("Part2"));
        // In fit mode, no newlines between items
        assert!(!text.contains('\n'));
    }

    #[test]
    fn test_group_function() {
        let items = vec!["A", "B", "C"];
        let g = group(items);
        assert_eq!(g.len(), 3);
    }

    #[test]
    fn test_group_single_item() {
        let g = Group::new().push("Solo");
        assert_eq!(g.len(), 1);
        assert!(!g.is_empty());

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(text.contains("Solo"));
        // Single item should have no newlines
        assert!(!text.contains('\n'));
    }

    #[test]
    fn test_group_empty_render() {
        let g: Group = Group::new();

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        assert!(segments.is_empty());
    }

    #[test]
    fn test_group_nested() {
        let inner = Group::new().push("Inner 1").push("Inner 2");
        let outer = Group::new().push("Outer").push(inner);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = outer.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();

        assert!(text.contains("Outer"));
        assert!(text.contains("Inner 1"));
        assert!(text.contains("Inner 2"));
    }

    #[test]
    fn test_group_push_boxed() {
        let boxed: Box<dyn Renderable> = Box::new("Boxed content");
        let g = Group::new().push_boxed(boxed);
        assert_eq!(g.len(), 1);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(text.contains("Boxed content"));
    }

    #[test]
    fn test_group_is_empty_after_push() {
        let g = Group::new();
        assert!(g.is_empty());

        let g2 = g.push("Item");
        assert!(!g2.is_empty());
    }

    #[test]
    fn test_group_default() {
        let g: Group = Group::default();
        assert!(g.is_empty());
        assert_eq!(g.len(), 0);
        assert!(!g.fit);
    }

    #[test]
    fn test_group_fit_toggle() {
        let g = Group::new().fit(false);
        assert!(!g.fit);

        let g2 = g.fit(true);
        assert!(g2.fit);
    }

    #[test]
    fn test_group_many_items() {
        let mut g = Group::new();
        for i in 0..10 {
            g = g.push(format!("Item {i}"));
        }
        assert_eq!(g.len(), 10);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();

        for i in 0..10 {
            assert!(text.contains(&format!("Item {i}")));
        }
    }

    #[test]
    fn test_group_fit_with_multiple() {
        // Test that fit mode works with many items
        let g = Group::new()
            .push("A")
            .push("B")
            .push("C")
            .push("D")
            .fit(true);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();

        // In fit mode, all items should be on same conceptual line
        assert!(!text.contains('\n'));
        assert!(text.contains('A'));
        assert!(text.contains('D'));
    }

    #[test]
    fn test_group_empty_items() {
        // Group with empty strings should still work
        let g = Group::new().push("").push("Middle").push("");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let text: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(text.contains("Middle"));
        assert_eq!(g.len(), 3);
    }

    // =========================================================================
    // Mixed Renderable Types
    // =========================================================================

    #[test]
    fn test_group_mixed_text_and_str() {
        use crate::text::Text;

        let text_obj = Text::new("Styled text");
        let g = Group::new()
            .push("Plain string")
            .push(text_obj)
            .push("Another string");

        assert_eq!(g.len(), 3);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("Plain string"));
        assert!(output.contains("Styled text"));
        assert!(output.contains("Another string"));
    }

    #[test]
    fn test_group_mixed_str_and_rule() {
        use crate::renderables::Rule;

        let g = Group::new()
            .push("Header text")
            .push(Rule::new())
            .push("Footer text");

        assert_eq!(g.len(), 3);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("Header text"));
        assert!(output.contains("Footer text"));
        // Rule renders some characters (typically ─)
        assert!(segments.len() >= 3);
    }

    #[test]
    fn test_group_mixed_text_rule_string() {
        use crate::renderables::Rule;
        use crate::text::Text;

        let g = Group::new()
            .push(Text::new("Rich text"))
            .push(Rule::new())
            .push("Plain str".to_string());

        assert_eq!(g.len(), 3);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("Rich text"));
        assert!(output.contains("Plain str"));
    }

    #[test]
    fn test_group_boxed_mixed_types() {
        use crate::text::Text;

        let boxed_str: Box<dyn Renderable> = Box::new("boxed str");
        let boxed_text: Box<dyn Renderable> = Box::new(Text::new("boxed text"));

        let g = Group::new().push_boxed(boxed_str).push_boxed(boxed_text);
        assert_eq!(g.len(), 2);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("boxed str"));
        assert!(output.contains("boxed text"));
    }

    // =========================================================================
    // Width Propagation
    // =========================================================================

    #[test]
    fn test_group_width_propagation_narrow() {
        use crate::renderables::Rule;

        let g = Group::new().push(Rule::new());

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .width(20)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        // Rule should render to fit within the narrow width
        let total_width: usize = segments.iter().map(Segment::cell_length).sum();
        assert!(
            total_width <= 20,
            "Rule should fit in 20 columns, got {total_width}"
        );
    }

    #[test]
    fn test_group_width_propagation_wide() {
        use crate::renderables::Rule;

        let g = Group::new().push(Rule::new());

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .width(120)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let total_width: usize = segments.iter().map(Segment::cell_length).sum();
        // Rule should expand to fill the wider width
        assert!(
            total_width > 20,
            "Rule at width 120 should be wider than 20 chars, got {total_width}"
        );
    }

    #[test]
    fn test_group_width_update() {
        let g = Group::new().push("Short").push("Also short");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .width(40)
            .build();
        let options = console.options();
        let narrowed = options.update_width(10);

        // Both option sets should produce valid renders
        let segs_normal = g.render(&console, &options);
        let segs_narrow = g.render(&console, &narrowed);

        assert!(!segs_normal.is_empty());
        assert!(!segs_narrow.is_empty());
    }

    // =========================================================================
    // Segment Joining Behavior
    // =========================================================================

    #[test]
    fn test_group_newline_segments_between_items() {
        let g = Group::new().push("A").push("B").push("C");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);

        // Count newline segments - should have 2 (between A-B and B-C)
        let newline_count = segments.iter().filter(|s| s.text.as_ref() == "\n").count();
        assert_eq!(
            newline_count, 2,
            "Should have 2 newlines between 3 items, got {newline_count}"
        );
    }

    #[test]
    fn test_group_no_newline_in_fit_mode() {
        let g = Group::new().push("A").push("B").push("C").fit(true);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);

        let newline_count = segments.iter().filter(|s| s.text.as_ref() == "\n").count();
        assert_eq!(
            newline_count, 0,
            "Fit mode should have no newlines, got {newline_count}"
        );
    }

    #[test]
    fn test_group_segments_are_owned() {
        // Group's render uses into_owned() on child segments,
        // so the returned segments should have 'static-compatible lifetimes
        let g = Group::new().push("test content");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        // Verify segments contain expected content
        let any_match = segments
            .iter()
            .any(|s| s.text.as_ref().contains("test content"));
        assert!(any_match);
    }

    #[test]
    fn test_group_segment_count_no_fit() {
        // Each push adds child segments + newline separator (except before first)
        let g = Group::new().push("X").push("Y");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        // "X" renders to >=1 segment, then newline, then "Y" >=1 segment
        assert!(
            segments.len() >= 3,
            "Should have at least 3 segments (X + newline + Y), got {}",
            segments.len()
        );
    }

    // =========================================================================
    // Nested Groups (Extended)
    // =========================================================================

    #[test]
    fn test_group_deeply_nested() {
        let level3 = Group::new().push("L3");
        let level2 = Group::new().push("L2").push(level3);
        let level1 = Group::new().push("L1").push(level2);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = level1.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("L1"));
        assert!(output.contains("L2"));
        assert!(output.contains("L3"));
    }

    #[test]
    fn test_group_nested_fit_modes() {
        // Outer group: no fit (newlines). Inner group: fit (no newlines).
        let inner = Group::new().push("A").push("B").fit(true);
        let outer = Group::new().push("Before").push(inner).push("After");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = outer.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("Before"));
        assert!(output.contains('A'));
        assert!(output.contains('B'));
        assert!(output.contains("After"));

        // Inner group rendered in fit mode, so A and B should be adjacent (no newline between them)
        // But outer group adds newlines between its children
        let newlines_in_outer = segments.iter().filter(|s| s.text.as_ref() == "\n").count();
        // Outer has 3 children → 2 newlines from outer
        assert_eq!(newlines_in_outer, 2);
    }

    #[test]
    fn test_group_nested_empty_inner() {
        let inner: Group = Group::new(); // empty
        let outer = Group::new().push("Before").push(inner).push("After");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = outer.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("Before"));
        assert!(output.contains("After"));
    }

    // =========================================================================
    // group() Helper Function (Extended)
    // =========================================================================

    #[test]
    fn test_group_function_empty_iter() {
        let g = group(std::iter::empty::<&str>());
        assert!(g.is_empty());
        assert_eq!(g.len(), 0);
    }

    #[test]
    fn test_group_function_single_item() {
        let g = group(std::iter::once("only"));
        assert_eq!(g.len(), 1);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("only"));
    }

    #[test]
    fn test_group_function_from_vec() {
        let items = vec!["one", "two", "three"];
        let g = group(items);
        assert_eq!(g.len(), 3);
    }

    #[test]
    fn test_group_function_from_owned_strings() {
        let items: Vec<String> = vec!["owned1".into(), "owned2".into()];
        let g = group(items);
        assert_eq!(g.len(), 2);

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        assert!(output.contains("owned1"));
        assert!(output.contains("owned2"));
    }

    // =========================================================================
    // Builder Chaining
    // =========================================================================

    #[test]
    fn test_group_builder_chain_returns_self() {
        // Verify that push and fit return Self for chaining
        let g = Group::new()
            .fit(false)
            .push("A")
            .push("B")
            .fit(true)
            .push("C");

        assert_eq!(g.len(), 3);
        assert!(g.fit);
    }

    #[test]
    fn test_group_push_after_fit_toggle() {
        let g = Group::new().push("Before fit").fit(true).push("After fit");

        let console = Console::builder()
            .force_terminal(false)
            .markup(false)
            .build();
        let options = console.options();

        let segments = g.render(&console, &options);
        let output: String = segments.iter().map(|s| s.text.as_ref()).collect();
        // fit was set to true, so no newlines
        assert!(!output.contains('\n'));
        assert!(output.contains("Before fit"));
        assert!(output.contains("After fit"));
    }
}