superconsole 0.2.0

A simple but powerful Text-based User Interface (TUI) framework
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

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under both the MIT license found in the
 * LICENSE-MIT file in the root directory of this source tree and the Apache
 * License, Version 2.0 found in the LICENSE-APACHE file in the root directory
 * of this source tree.
 */

use crate::Component;
use crate::Dimensions;
use crate::DrawMode;
use crate::Lines;

/// Component that ensures its child component has at most `max_size` render space.
#[derive(Debug)]
pub struct Bounded<C: Component = Box<dyn Component>> {
    child: C,
    max_size: Dimensions,
}

impl<C: Component> Bounded<C> {
    pub fn new(child: C, max_x: Option<usize>, max_y: Option<usize>) -> Self {
        Self {
            child,
            max_size: Dimensions {
                width: max_x.unwrap_or(usize::MAX),
                height: max_y.unwrap_or(usize::MAX),
            },
        }
    }
}

impl<C: Component> Component for Bounded<C> {
    fn draw_unchecked(&self, dimensions: Dimensions, mode: DrawMode) -> anyhow::Result<Lines> {
        let output = self.child.draw(dimensions.intersect(self.max_size), mode)?;
        Ok(output)
    }
}

#[cfg(test)]
mod tests {
    use derive_more::AsRef;

    use super::*;
    use crate::components::echo::Echo;
    use crate::Line;
    use crate::Span;

    #[derive(AsRef, Debug)]
    struct Msg(Lines);

    #[test]
    fn test_no_bounding() -> anyhow::Result<()> {
        let msg = Lines(vec![Line::from_iter([Span::new_unstyled("hello world")?])]);
        let test = Bounded::new(Echo(msg.clone()), Some(40), Some(40));
        let output = test.draw(
            Dimensions {
                width: 50,
                height: 50,
            },
            DrawMode::Normal,
        )?;

        assert_eq!(output, msg);

        Ok(())
    }

    #[test]
    fn test_bounding() -> anyhow::Result<()> {
        let msg = Lines(vec![
            Line::from_iter([Span::new_unstyled("hello world")?]),
            Line::from_iter([Span::new_unstyled("hello world")?]),
        ]);
        let test = Bounded::new(Echo(msg), Some(2), Some(1));
        let output = test.draw(
            Dimensions {
                width: 50,
                height: 50,
            },
            DrawMode::Normal,
        )?;
        let expected = Lines(vec![Line::from_iter([Span::new_unstyled("he")?])]);

        assert_eq!(output, expected);

        Ok(())
    }
}