sparcli 0.3.0

Lightweight, cross-platform toolkit for styled CLI output and interactive input widgets
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

//! Inline status badges such as `[TAG]` or `(v1.0)`.

use crate::core::render::{Renderable, Rendered};
use crate::core::style::Style;
use crate::core::text::{Line, Span};
use crate::core::theme::theme;

/// A small inline token with configurable caps and style.
///
/// # Examples
///
/// ```
/// use sparcli::{Badge, Renderable};
///
/// let out = Badge::new("NEW").render(20);
/// assert!(out.plain().contains("[NEW]"));
/// ```
pub struct Badge {
    text: String,
    left_cap: String,
    right_cap: String,
    style: Style,
    pad: u16,
}

impl Badge {
    /// Creates a badge with default square brackets and the accent style.
    pub fn new(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            left_cap: "[".to_string(),
            right_cap: "]".to_string(),
            style: Style::new().fg(theme().accent).bold(),
            pad: 0,
        }
    }

    /// Sets both caps at once.
    #[must_use]
    pub fn caps(
        mut self,
        left: impl Into<String>,
        right: impl Into<String>,
    ) -> Self {
        self.left_cap = left.into();
        self.right_cap = right.into();
        self
    }

    /// Sets the badge text style.
    #[must_use]
    pub fn style(mut self, style: Style) -> Self {
        self.style = style;
        self
    }

    /// Sets the number of spaces inside the caps.
    #[must_use]
    pub fn pad(mut self, pad: u16) -> Self {
        self.pad = pad;
        self
    }

    /// Returns the badge as a single styled [`Span`].
    pub fn span(&self) -> Span {
        let spaces = " ".repeat(self.pad as usize);
        let content = format!(
            "{}{spaces}{}{spaces}{}",
            self.left_cap, self.text, self.right_cap
        );
        Span::styled(content, self.style)
    }
}

impl Renderable for Badge {
    fn render(&self, _max_width: u16) -> Rendered {
        Rendered::new(vec![Line::new(vec![self.span()])])
    }
}

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

    #[test]
    fn badge_wraps_text_in_caps() {
        assert_eq!(Badge::new("OK").span().content, "[OK]");
    }

    #[test]
    fn badge_honors_custom_caps_and_pad() {
        let span = Badge::new("v1").caps("(", ")").pad(1).span();
        assert_eq!(span.content, "( v1 )");
    }
}