tiny-dc 0.1.4

A tiny but mighty TUI directory changer
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

use std::fs::{create_dir, File};

use crossterm::event::{KeyCode, KeyModifiers};
use insta::assert_snapshot;
use ratatui::{backend::TestBackend, Terminal};

use tiny_dc::app::App;

#[test]
fn change_directory_lists_correct_directory_entires() {
    // Create a temporary directory with a static name so that test snapshots are consistent
    let temp_dir = tempfile::Builder::new()
        .prefix("tiny_dc")
        .rand_bytes(0)
        .tempdir()
        .unwrap();

    let temp_path = temp_dir.path();

    // Create some temp files in the firectory
    let file_1 = temp_path.join("file_1.txt");
    File::create(&file_1).unwrap();

    let file_2 = temp_path.join("file_2.txt");
    File::create(&file_2).unwrap();

    // Create a temporary subdirectory
    let sub_dir = temp_path.join("sub_dir");
    create_dir(&sub_dir).unwrap();

    let mut app = App::default();
    app.change_directory(temp_path).unwrap();

    let mut terminal = Terminal::new(TestBackend::new(80, 10)).unwrap();
    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    assert_snapshot!(terminal.backend());
}

#[test]
fn entry_hotkey_jumps_successfully() {
    // Create a temporary directory with a static name so that test snapshots are consistent
    let temp_dir = tempfile::Builder::new()
        .prefix("tiny_dc_jump")
        .rand_bytes(0)
        .tempdir()
        .unwrap();

    let temp_path = temp_dir.path();

    // Create some temp files in the firectory
    let file_1 = temp_path.join("file_1.txt");
    File::create(&file_1).unwrap();

    let file_2 = temp_path.join("file_2.txt");
    File::create(&file_2).unwrap();

    // Create a temporary subdirectory
    create_dir(temp_path.join("sub_dir")).unwrap();

    let mut app = App::default();

    app.change_directory(temp_path).unwrap();

    let mut terminal = Terminal::new(TestBackend::new(80, 10)).unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    // Jump to the subdirectory using the hotkey `a` (it gets the highest priority because it's the
    // first and `a` is the first in the preferred hotkeys)
    app.handle_key_event(KeyCode::Char('a').into(), KeyModifiers::NONE)
        .unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    assert_snapshot!(terminal.backend());
}

#[test]
fn entry_hotkey_missing_when_in_search_mode_and_search_input_is_empty() {
    // Create a temporary directory with a static name so that test snapshots are consistent
    let temp_dir = tempfile::Builder::new()
        .prefix("tiny_dc_jump_search_1")
        .rand_bytes(0)
        .tempdir()
        .unwrap();

    let temp_path = temp_dir.path();

    // Create some temp files in the firectory
    let file_1 = temp_path.join("file_1_s.txt");
    File::create(&file_1).unwrap();

    let file_2 = temp_path.join("file_2_s.txt");
    File::create(&file_2).unwrap();

    // Create a temporary subdirectory
    create_dir(temp_path.join("sub_dir")).unwrap();

    let mut app = App::default();

    app.change_directory(temp_path).unwrap();

    let mut terminal = Terminal::new(TestBackend::new(80, 10)).unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    // Enter search mode
    app.handle_key_event(KeyCode::Char('/').into(), KeyModifiers::NONE)
        .unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    assert_snapshot!(terminal.backend());
}

#[test]
fn entry_hotkey_jumps_successfully_in_search_mode() {
    // Create a temporary directory with a static name so that test snapshots are consistent
    let temp_dir = tempfile::Builder::new()
        .prefix("tiny_dc_jump_search_2")
        .rand_bytes(0)
        .tempdir()
        .unwrap();

    let temp_path = temp_dir.path();

    // Create some temp files in the firectory
    let file_1 = temp_path.join("file_1_s.txt");
    File::create(&file_1).unwrap();

    let file_2 = temp_path.join("file_2_s.txt");
    File::create(&file_2).unwrap();

    // Create a temporary subdirectory
    create_dir(temp_path.join("sub_dir")).unwrap();

    let mut app = App::default();

    app.change_directory(temp_path).unwrap();

    let mut terminal = Terminal::new(TestBackend::new(80, 10)).unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    // Enter search mode
    app.handle_key_event(KeyCode::Char('/').into(), KeyModifiers::NONE)
        .unwrap();

    // Search for an entry that contains s (in this case it should be all of them)
    app.handle_key_event(KeyCode::Char('s').into(), KeyModifiers::NONE)
        .unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    // Jump to the subdirectory using the hotkey `a` (it gets the highest priority because it's the
    // first and `a` is the first in the preferred hotkeys)
    app.handle_key_event(KeyCode::Char('a').into(), KeyModifiers::NONE)
        .unwrap();

    terminal
        .draw(|frame| frame.render_widget(&mut app, frame.area()))
        .unwrap();

    assert_snapshot!(terminal.backend());
}

#[test]
fn app_returns_expected_path_after_exit() {
    // Create a temporary directory with a static name so that test snapshots are consistent
    let temp_dir = tempfile::Builder::new().tempdir().unwrap();

    let temp_path = temp_dir.path();

    // Create some temp files in the firectory
    let file_1 = temp_path.join("file_1.txt");
    File::create(&file_1).unwrap();

    let file_2 = temp_path.join("file_2.txt");
    File::create(&file_2).unwrap();

    // Create a temporary subdirectory
    let sub_dir = temp_path.join("sub_dir");
    create_dir(&sub_dir).unwrap();

    let mut app = App::default();
    app.change_directory(&temp_dir).unwrap();

    let mut terminal = Terminal::new(TestBackend::new(80, 10)).unwrap();

    // Move into the subdirectory
    app.handle_key_event(KeyCode::Enter.into(), KeyModifiers::NONE)
        .unwrap();

    // Exit the app
    app.handle_key_event(KeyCode::Esc.into(), KeyModifiers::NONE)
        .unwrap();

    let result = app.run(&mut terminal).unwrap();

    // The app should return the path of the subdirectory since that's where we exited
    assert_eq!(result, sub_dir);
}