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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

use std::{
    fs::File,
    io::{BufRead, BufReader, Write},
    path::PathBuf,
};

use tiny_dc::index::DirectoryIndex;

#[test]
fn directory_index_z_returns_correct_result() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir_other = temp_dir.path().join("test_dir_other");
    std::fs::create_dir_all(&temp_test_dir_other).unwrap();

    // Create temporary directory inside the temp directory
    let temp_other_dir = temp_dir.path().join("other_dir");
    std::fs::create_dir_all(&temp_other_dir).unwrap();

    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut file = File::create(&index_file_path).unwrap();

    let mock_data = vec![
        (temp_test_dir.to_str().unwrap(), 100, 100),
        (temp_test_dir_other.to_str().unwrap(), 150, 100),
        (temp_other_dir.to_str().unwrap(), 100, 100),
    ];

    for line in mock_data {
        writeln!(file, "{}|{}|{}\n", line.0, line.1, line.2).unwrap();
    }

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["test".into()]).unwrap();

    assert_eq!(result, Some(temp_test_dir_other.to_str().unwrap().into()));
}

#[test]
fn directory_index_z_returns_correct_result_for_case_sensitive_query() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("Test_Dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir_other = temp_dir.path().join("test_dir_other");
    std::fs::create_dir_all(&temp_test_dir_other).unwrap();

    // Create temporary directory inside the temp directory
    let temp_other_dir = temp_dir.path().join("other_dir");
    std::fs::create_dir_all(&temp_other_dir).unwrap();

    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut file = File::create(&index_file_path).unwrap();

    let mock_data = vec![
        (temp_test_dir.to_str().unwrap(), 100, 100),
        (temp_test_dir_other.to_str().unwrap(), 150, 100),
        (temp_other_dir.to_str().unwrap(), 100, 100),
    ];

    for line in mock_data {
        writeln!(file, "{}|{}|{}\n", line.0, line.1, line.2).unwrap();
    }

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["Test".into()]).unwrap();

    assert_eq!(result, Some(temp_test_dir.to_str().unwrap().into()));
}

#[test]
fn directory_index_z_returns_correct_result_for_multiple_queries() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir_other = temp_dir.path().join("test_dir_other");
    std::fs::create_dir_all(&temp_test_dir_other).unwrap();

    // Create temporary directory inside the temp directory
    let temp_other_dir = temp_dir.path().join("other_dir");
    std::fs::create_dir_all(&temp_other_dir).unwrap();

    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut file = File::create(&index_file_path).unwrap();

    let mock_data = vec![
        (temp_test_dir.to_str().unwrap(), 100, 100),
        (temp_test_dir_other.to_str().unwrap(), 150, 100),
        (temp_other_dir.to_str().unwrap(), 100, 100),
    ];

    for line in mock_data {
        writeln!(file, "{}|{}|{}\n", line.0, line.1, line.2).unwrap();
    }

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index
        .z(vec!["other".into(), "test".into()])
        .unwrap();

    assert_eq!(result, Some(temp_test_dir_other.to_str().unwrap().into()));
}

#[test]
fn directory_index_z_returns_existing_path_only() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir_other = temp_dir.path().join("test_dir_other");
    std::fs::create_dir_all(&temp_test_dir_other).unwrap();

    // Create temporary directory inside the temp directory
    let temp_other_dir = temp_dir.path().join("other_dir");
    std::fs::create_dir_all(&temp_other_dir).unwrap();

    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut file = File::create(&index_file_path).unwrap();

    let mock_data = vec![
        (temp_test_dir.to_str().unwrap(), 100, 100),
        (temp_test_dir_other.to_str().unwrap(), 150, 100),
        (temp_other_dir.to_str().unwrap(), 100, 100),
    ];

    // Delete the temp_test_dir_other directory to simulate a non-existing path.
    std::fs::remove_dir_all(&temp_test_dir_other).unwrap();

    for line in mock_data {
        writeln!(file, "{}|{}|{}\n", line.0, line.1, line.2).unwrap();
    }

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["test".into()]).unwrap();

    assert_eq!(result, Some(temp_test_dir.to_str().unwrap().into()));
}

#[test]
fn directory_index_z_returns_none_for_no_match() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create temporary directory inside the temp directory
    let temp_test_dir_other = temp_dir.path().join("test_dir_other");
    std::fs::create_dir_all(&temp_test_dir_other).unwrap();

    // Create temporary directory inside the temp directory
    let temp_other_dir = temp_dir.path().join("other_dir");
    std::fs::create_dir_all(&temp_other_dir).unwrap();

    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut file = File::create(&index_file_path).unwrap();

    let mock_data = vec![
        (temp_test_dir.to_str().unwrap(), 100, 100),
        (temp_test_dir_other.to_str().unwrap(), 150, 100),
        (temp_other_dir.to_str().unwrap(), 100, 100),
    ];

    for line in mock_data {
        writeln!(file, "{}|{}|{}\n", line.0, line.1, line.2).unwrap();
    }

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["non-existent".into()]).unwrap();

    assert_eq!(result, None);
}

#[test]
fn directory_index_z_returns_correct_result_for_common_parent() {
    let temp_dir = tempfile::tempdir().unwrap();

    // Create a common parent directory.
    let common_parent = temp_dir.path().join("common_parent");
    std::fs::create_dir_all(&common_parent).unwrap();

    // Create two subdirectories inside the common parent.
    let child_dir = common_parent.join("child");
    std::fs::create_dir_all(&child_dir).unwrap();

    let nested_dir = child_dir.join("nested");
    std::fs::create_dir_all(&nested_dir).unwrap();

    // Write the paths to the index file.
    let index_file_path = temp_dir.path().join(".tiny-dc");
    let mut file = File::create(&index_file_path).unwrap();

    // Here we set up three entries. Even though the `child` and its nested directory have
    // higher rank values, we want the query for "common" to match the common parent directory.
    let mock_data = vec![
        (common_parent.to_str().unwrap(), 100, 100), // Common parent entry.
        (child_dir.to_str().unwrap(), 200, 200),     // Child entry with higher rank.
        (nested_dir.to_str().unwrap(), 300, 300),    // Nested entry with the highest rank.
    ];
    for line in mock_data {
        writeln!(file, "{}|{}|{}", line.0, line.1, line.2).unwrap();
    }

    // Load the index and query for the common parent.
    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["common".into()]).unwrap();

    // Assert that the common parent is returned even if a subdirectory has a higher rank.
    assert_eq!(result, Some(common_parent.to_str().unwrap().into()),);
}

#[test]
fn directory_index_z_returns_none_for_empty_index() {
    let temp_dir = tempfile::tempdir().unwrap();
    let index_file_path = temp_dir.path().join(".tiny-dc");

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    let result = directory_index.z(vec!["nonexistent".into()]).unwrap();

    assert_eq!(result, None);
}

#[test]
fn directory_index_push_creates_index_file() {
    let temp_dir = tempfile::tempdir().unwrap();
    let index_file_path = temp_dir.path().join(".tiny-dc");

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    // Create a new DirectoryIndex and push an entry.
    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    directory_index.push(temp_test_dir.clone()).unwrap();

    // Check if the index file was created
    assert!(index_file_path.exists());

    // Check if the entry was added to the index
    let file = File::open(&index_file_path).unwrap();
    let reader = BufReader::new(file);
    let lines: Vec<String> = reader.lines().map(|line| line.unwrap()).collect();
    let line = &lines[0];
    let parts: Vec<&str> = line.split('|').collect();
    assert_eq!(parts.len(), 3);
    assert_eq!(parts[0], temp_test_dir.to_str().unwrap());
}

fn get_index_file_lines(index_file_path: &PathBuf) -> Vec<String> {
    let file = File::open(index_file_path).unwrap();
    let reader = BufReader::new(file);
    reader.lines().map(|line| line.unwrap()).collect()
}

#[test]
fn directory_index_push_multiple_times_updates_entry_rank() {
    let temp_dir = tempfile::tempdir().unwrap();
    let index_file_path = temp_dir.path().join(".tiny-dc");

    // Create temporary directory inside the temp directory
    let temp_test_dir = temp_dir.path().join("test_dir");
    std::fs::create_dir_all(&temp_test_dir).unwrap();

    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    directory_index.push(temp_test_dir.clone()).unwrap();

    let lines = get_index_file_lines(&index_file_path);
    let line = &lines[0];
    let parts: Vec<&str> = line.split('|').collect();

    // Check if the entry was added to the index
    assert_eq!(parts.len(), 3);
    assert_eq!(parts[1], "0");

    // Push the entry second time
    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    directory_index.push(temp_test_dir.clone()).unwrap();

    let lines = get_index_file_lines(&index_file_path);
    let line = &lines[0];
    let parts: Vec<&str> = line.split('|').collect();

    // Check if the entry was updated in the index
    assert_eq!(parts.len(), 3);
    // The rank should be updated to 1
    assert_eq!(parts[1], "1");

    // Push the entry third time
    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    directory_index.push(temp_test_dir.clone()).unwrap();

    let lines = get_index_file_lines(&index_file_path);
    let line = &lines[0];
    let parts: Vec<&str> = line.split('|').collect();

    // Check if the entry was updated in the index
    assert_eq!(parts.len(), 3);
    // The rank should be updated to 1.99
    assert_eq!(parts[1], "1.99");
}

#[test]
fn directory_index_push_non_existent_path_does_is_a_no_op() {
    let temp_dir = tempfile::tempdir().unwrap();
    let index_file_path = temp_dir.path().join(".tiny-dc");

    // Create a new DirectoryIndex and push a non-existent entry.
    let mut directory_index = DirectoryIndex::try_from(index_file_path.clone()).unwrap();
    directory_index
        .push(PathBuf::from("/non/existent/path"))
        .unwrap();

    // Check if the index file was created
    assert!(index_file_path.exists());

    // Check if the entry was added to the index
    let lines = get_index_file_lines(&index_file_path);
    assert_eq!(lines.len(), 0);
}