tori 0.2.6

The frictionless music player for the terminal
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

pub mod confirmation_modal;
pub mod help_modal;
pub mod hotkey_modal;
pub mod input_modal;

pub use confirmation_modal::ConfirmationModal;
pub use help_modal::HelpModal;
pub use hotkey_modal::HotkeyModal;
pub use input_modal::InputModal;

use tui::{layout::Rect, style::Style, Frame};

use crate::{
    app::component::Mode,
    error::Result,
    events::Event,
};

///////////////////////////////////////////////////
//                    Message                    //
///////////////////////////////////////////////////
/// The return type for [Modal::handle_event].
#[derive(Debug, Default, PartialEq)]
pub enum Message {
    /// Nothing changed
    #[default]
    Nothing,

    /// User has quit the modal (by pressing Esc)
    Quit,

    /// User has written something (the String) in the modal and pressed Enter
    Commit(String),
}

/////////////////////////////////////////////////
//                    Modal                    //
/////////////////////////////////////////////////
pub trait Modal {
    fn apply_style(&mut self, style: Style);
    fn handle_event(&mut self, event: Event) -> Result<Message>;
    fn render(&mut self, frame: &mut Frame);
    fn mode(&self) -> Mode;
}

impl Default for Box<dyn Modal> {
    fn default() -> Self {
        Box::new(InputModal::new(String::default()))
    }
}

pub fn get_modal_chunk(frame: Rect) -> Rect {
    let width = (frame.width / 3).max(70).min(frame.width);
    let height = 5;

    Rect {
        x: frame.width.saturating_sub(width) / 2,
        width,
        y: frame.height.saturating_sub(height) / 2,
        height,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::events::Event;
    use crossterm::event::{
        Event::Key,
        KeyCode::{self, Backspace, Char, Enter, Esc},
        KeyEvent, KeyEventKind, KeyEventState, KeyModifiers,
    };

    fn key_event(code: KeyCode) -> crossterm::event::Event {
        Key(KeyEvent {
            code,
            modifiers: KeyModifiers::NONE,
            kind: KeyEventKind::Press,
            state: KeyEventState::NONE,
        })
    }

    #[test]
    fn test_modal_commit_lifecycle() {
        let mut modal = InputModal::new("commit lifecycle");
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Char('h'))))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Char('i'))))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Char('!'))))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Backspace)))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal.handle_event(Event::Terminal(key_event(Enter))).ok(),
            Some(Message::Commit("hi".into()))
        );
    }

    #[test]
    fn test_modal_quit_lifecycle() {
        let mut modal = InputModal::new("commit lifecycle");
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Char('h'))))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal
                .handle_event(Event::Terminal(key_event(Char('i'))))
                .ok(),
            Some(Message::Nothing)
        );
        assert_eq!(
            modal.handle_event(Event::Terminal(key_event(Esc))).ok(),
            Some(Message::Quit)
        );
    }
}