spacehog 0.1.7

A simple utility for finding large files on your system.
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

#![allow(clippy::cast_possible_truncation)]
use clap::Parser;
use crossterm::{
    cursor,
    terminal::{self, ClearType},
    ExecutableCommand, QueueableCommand,
};
use std::{
    io::{self, Write},
    path::PathBuf,
};

use spacehog::{find_top_n_largest_files, FileSize};

#[derive(Parser, Debug)]
#[command(version, about)]
struct Args {
    #[arg(default_value = ".")]
    path: String,

    #[arg(short, default_value_t = 5)]
    number: usize,

    #[arg(long, default_value_t = false)]
    #[arg(help = "Include hidden files and directories")]
    hidden: bool,
}

fn main() -> anyhow::Result<()> {
    let args = Args::parse();
    let ignore_hidden = !args.hidden;
    let mut app = App::new(std::io::stdout());

    let rx = find_top_n_largest_files(&args.path, args.number, ignore_hidden)?;
    while let Ok(results) = rx.recv() {
        if !results.is_empty() {
            app.update(results);
            app.render()?;
        }
    }
    app.close()?;

    Ok(())
}

struct App<Out: Write> {
    out: Out,
    files: Vec<(FileSize, PathBuf)>,
}

impl<Out: Write> App<Out> {
    fn new(out: Out) -> Self {
        Self {
            out,
            files: Vec::new(),
        }
    }

    fn update(&mut self, files: Vec<(FileSize, PathBuf)>) {
        self.files = files;
    }

    fn render(&mut self) -> io::Result<()> {
        self.out.queue(cursor::SavePosition)?;
        self.out.queue(terminal::Clear(ClearType::FromCursorDown))?;

        let mut buf = Vec::new();
        writeln!(&mut buf, "*** Top {} largest files ***", self.files.len())?;
        for (size, path) in &self.files {
            writeln!(&mut buf, "{} {}", size, path.display())?;
        }
        self.out.write_all(&buf)?;

        self.out.queue(cursor::RestorePosition)?;
        self.out.flush()
    }

    fn close(&mut self) -> io::Result<()> {
        if self.files.is_empty() {
            writeln!(self.out, "No files found.")?;
        } else {
            let row = self.files.len() + 1;
            self.out.execute(cursor::MoveDown(row as u16))?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::{App, Args};
    use clap::Parser;
    use std::path::PathBuf;

    #[test]
    fn cli_args_can_be_parsed_without_panicing() {
        Args::parse();
    }

    #[test]
    fn test_close_with_no_files() {
        let mut output = Vec::new();
        let mut app = App::new(&mut output);

        app.close().unwrap();

        let output_str = String::from_utf8(output).unwrap();
        assert_eq!(output_str, "No files found.\n");
    }

    #[test]
    fn test_close_with_files_moves_cursor_to_row_after_last_file() {
        let mut output = Vec::new();
        let mut app = App::new(&mut output);

        app.update(vec![
            (2048.into(), PathBuf::from("file1.txt")),
            (1024.into(), PathBuf::from("file2.txt")),
        ]);
        app.close().unwrap();

        let output_str = String::from_utf8(output).unwrap();
        assert!(output_str.ends_with("\x1B[3B"));
    }
}