ratatree 0.1.0

A terminal file/directory picker widget for ratatui
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

use std::fs;
use std::path::{Path, PathBuf};

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum EntryKind {
    File,
    Directory,
    Symlink,
}

#[derive(Debug, Clone)]
pub struct Entry {
    pub name: String,
    pub path: PathBuf,
    pub kind: EntryKind,
    pub is_hidden: bool,
}

impl Entry {
    pub fn from_path(path: &Path) -> Option<Entry> {
        let name = path.file_name()?.to_string_lossy().to_string();
        let is_hidden = name.starts_with('.');
        let metadata = fs::symlink_metadata(path).ok()?;
        let kind = if metadata.is_symlink() {
            EntryKind::Symlink
        } else if metadata.is_dir() {
            EntryKind::Directory
        } else {
            EntryKind::File
        };
        Some(Entry { name, path: path.to_path_buf(), kind, is_hidden })
    }
}

pub fn read_entries(
    dir: &Path,
    show_hidden: bool,
    filter: Option<&dyn Fn(&Path) -> bool>,
) -> Vec<Entry> {
    let Ok(read_dir) = fs::read_dir(dir) else {
        return Vec::new();
    };
    let mut entries: Vec<Entry> = read_dir
        .filter_map(|e| e.ok())
        .filter_map(|e| Entry::from_path(&e.path()))
        .filter(|e| show_hidden || !e.is_hidden)
        .filter(|e| {
            filter
                .map(|f| e.kind == EntryKind::Directory || f(&e.path))
                .unwrap_or(true)
        })
        .collect();
    entries.sort_by(|a, b| {
        let dir_ord = matches!(b.kind, EntryKind::Directory)
            .cmp(&matches!(a.kind, EntryKind::Directory));
        dir_ord.then_with(|| a.name.to_lowercase().cmp(&b.name.to_lowercase()))
    });
    entries
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    #[test]
    fn entry_from_file() {
        let dir = TempDir::new().unwrap();
        let file_path = dir.path().join("hello.txt");
        fs::write(&file_path, b"").unwrap();
        let entry = Entry::from_path(&file_path).unwrap();
        assert_eq!(entry.name, "hello.txt");
        assert_eq!(entry.kind, EntryKind::File);
        assert!(!entry.is_hidden);
    }

    #[test]
    fn entry_from_directory() {
        let dir = TempDir::new().unwrap();
        let sub = dir.path().join("subdir");
        fs::create_dir(&sub).unwrap();
        let entry = Entry::from_path(&sub).unwrap();
        assert_eq!(entry.kind, EntryKind::Directory);
    }

    #[test]
    fn entry_hidden_detection() {
        let dir = TempDir::new().unwrap();
        let hidden = dir.path().join(".hidden");
        fs::write(&hidden, b"").unwrap();
        let entry = Entry::from_path(&hidden).unwrap();
        assert!(entry.is_hidden);
    }

    #[test]
    fn read_entries_filters_hidden() {
        let dir = TempDir::new().unwrap();
        fs::write(dir.path().join("visible.txt"), b"").unwrap();
        fs::write(dir.path().join(".hidden.txt"), b"").unwrap();
        let entries = read_entries(dir.path(), false, None);
        assert!(entries.iter().all(|e| !e.is_hidden));
        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].name, "visible.txt");
    }

    #[test]
    fn read_entries_shows_hidden() {
        let dir = TempDir::new().unwrap();
        fs::write(dir.path().join("visible.txt"), b"").unwrap();
        fs::write(dir.path().join(".hidden.txt"), b"").unwrap();
        let entries = read_entries(dir.path(), true, None);
        assert_eq!(entries.len(), 2);
    }

    #[test]
    fn read_entries_sorts_dirs_first() {
        let dir = TempDir::new().unwrap();
        fs::write(dir.path().join("aaa.txt"), b"").unwrap();
        fs::write(dir.path().join("zzz.txt"), b"").unwrap();
        fs::create_dir(dir.path().join("mmm")).unwrap();
        let entries = read_entries(dir.path(), false, None);
        assert_eq!(entries[0].name, "mmm");
        assert_eq!(entries[0].kind, EntryKind::Directory);
        assert_eq!(entries[1].name, "aaa.txt");
        assert_eq!(entries[2].name, "zzz.txt");
    }

    #[test]
    fn read_entries_with_filter() {
        let dir = TempDir::new().unwrap();
        fs::write(dir.path().join("notes.txt"), b"").unwrap();
        fs::write(dir.path().join("image.png"), b"").unwrap();
        fs::create_dir(dir.path().join("mydir")).unwrap();
        // filter: only .txt files (but dirs always pass)
        let filter: &dyn Fn(&std::path::Path) -> bool =
            &|p| p.extension().and_then(|e| e.to_str()) == Some("txt");
        let entries = read_entries(dir.path(), false, Some(filter));
        // directory always passes
        assert!(entries.iter().any(|e| e.name == "mydir"));
        // .txt passes
        assert!(entries.iter().any(|e| e.name == "notes.txt"));
        // .png filtered out
        assert!(!entries.iter().any(|e| e.name == "image.png"));
    }

    #[cfg(unix)]
    #[test]
    fn read_entries_symlink_detection() {
        let dir = TempDir::new().unwrap();
        let target = dir.path().join("target.txt");
        fs::write(&target, b"").unwrap();
        let link = dir.path().join("link.txt");
        std::os::unix::fs::symlink(&target, &link).unwrap();
        let entries = read_entries(dir.path(), false, None);
        let sym = entries.iter().find(|e| e.name == "link.txt").unwrap();
        assert_eq!(sym.kind, EntryKind::Symlink);
    }
}