logss 0.0.4

A simple command line tool that helps you visualize an input stream of text.
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

use std::io;

use anyhow::Result;
use crossterm::terminal::{self, EnterAlternateScreen, LeaveAlternateScreen};
use ratatui::{backend::Backend, Terminal};

use crate::{app::App, event::EventHandler};

/// Representation of a terminal user interface.
///
/// It is responsible for setting up the terminal,
/// initializing the interface and handling the draw events.
#[derive(Debug)]
pub struct Tui<B: Backend> {
    /// Interface to the Terminal.
    terminal: Terminal<B>,
    /// Terminal event handler.
    pub events: EventHandler,
}

impl<B: Backend> Tui<B> {
    /// Constructs a new instance of [`Tui`].
    pub fn new(terminal: Terminal<B>, events: EventHandler) -> Self {
        Self { terminal, events }
    }

    /// Initializes the terminal interface.
    ///
    /// It enables the raw mode and sets terminal properties.
    pub fn init(&mut self) -> Result<()> {
        terminal::enable_raw_mode()?;
        crossterm::execute!(io::stderr(), EnterAlternateScreen)?;
        self.terminal.hide_cursor()?;
        self.terminal.clear()?;
        self.events.init();
        Ok(())
    }

    /// [`Draw`] the terminal interface by [`rendering`] the widgets.
    ///
    /// [`Draw`]: ratatui::Terminal::draw
    /// [`rendering`]: crate::app::App::render
    pub fn draw(&mut self, app: &mut App) -> Result<()> {
        self.terminal.draw(|frame| app.render(frame))?;
        Ok(())
    }

    /// Exits the terminal interface.
    ///
    /// It disables the raw mode and reverts back the terminal properties.
    pub fn exit(&mut self) -> Result<()> {
        terminal::disable_raw_mode()?;
        crossterm::execute!(io::stderr(), LeaveAlternateScreen)?;
        self.terminal.show_cursor()?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use ratatui::{
        backend::TestBackend,
        buffer::Buffer,
        style::{Color, Modifier, Style},
        Terminal,
    };

    use super::*;
    use crate::args::parse_args;

    #[test]
    fn new() {
        let backend = TestBackend::new(13, 10);
        let terminal = Terminal::new(backend).unwrap();
        let events = EventHandler::new(1);
        let mut app = App::new(Some(parse_args()));
        app.raw_buffer.state.color = Color::White;

        let mut tui = Tui::new(terminal, events);
        //tui.init().unwrap(); // This fails in github tests
        tui.draw(&mut app).unwrap();
        let mut expected = Buffer::with_lines(vec![
            "┌[0]'.*' (0)┐",
            "│           │",
            "│           │",
            "│           │",
            "│           │",
            "│           │",
            "│           │",
            "│           │",
            "│           │",
            "└───────────┘",
        ]);
        let bolds = 1..=11;
        for x in 0..=12 {
            for y in 0..=9 {
                if bolds.contains(&x) && y == 0 {
                    expected[(x, y)].set_style(Style::default().add_modifier(Modifier::BOLD));
                }
                expected[(x, y)].set_fg(Color::White);
                expected[(x, y)].set_bg(Color::Black);
            }
        }

        tui.terminal.backend().assert_buffer(&expected);
        tui.exit().unwrap();
    }
}