sourceatlas 0.1.0

A small CLI app that generates a report on directories
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

mod command;
mod config;
mod file_stats;
mod report;

use config::Config;
use file_stats::FileStats;
use report::Report;
use std::{
    env,
    fs::{self},
    path::Path,
    process,
};

use crate::command::Command;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::parse(&args).unwrap_or_else(|err| {
        eprintln!("{err}");
        process::exit(1)
    });

    match config.command {
        Command::Scan { directory } => {
            let mut report = Report::new();
            scan_directory(Path::new(&directory), &mut report);
            report.generate();
            report.print();
        }
        Command::Help => println!("You won't get any help here"),
    }
}

fn scan_directory(directory: &Path, report: &mut Report) {
    println!("Scanning {}", directory.display());

    let entries = match fs::read_dir(directory) {
        Ok(entries) => entries,
        Err(err) => {
            eprintln!("Skipping directory {}: {err}", directory.display());
            return;
        }
    };

    for entry in entries {
        let entry = match entry {
            Ok(entry) => entry,
            Err(err) => {
                eprintln!("Skipping entry in {}: {err}", directory.display());
                continue;
            }
        };

        let path = entry.path();
        if path.is_dir() {
            if should_ignore_directory(&path) {
                continue;
            }

            report.record_directory_found();
            scan_directory(&path, report);
            continue;
        }

        if path.is_file() {
            report.record_file_found();
            match fs::read_to_string(&path) {
                Ok(source) => report.add_file(FileStats::new(&source)),
                Err(_) => {
                    report.record_skipped_file();
                    continue;
                }
            };
        }
    }
}

fn should_ignore_directory(path: &Path) -> bool {
    let skippable_directories = [".idea", ".vscode", "build", "target", "node_modules"];
    let Some(directory_name) = path.file_name().and_then(|name| name.to_str()) else {
        return false;
    };

    skippable_directories.contains(&directory_name)
}

#[cfg(test)]
mod tests {
    use std::{
        fs::{self},
        path::Path,
    };

    use tempfile::tempdir;

    use crate::{report::Report, scan_directory};

    #[test]
    fn binary_files_are_skipped_but_counted() {
        let temp_dir = tempdir().unwrap();
        let dir_path = temp_dir.path();
        fs::write(dir_path.join("image1.png"), [0xFF, 0xD7, 0xFF]).unwrap();
        fs::write(dir_path.join("image2.png"), [0xFF, 0xD7, 0xFF]).unwrap();
        fs::write(dir_path.join("image3.png"), [0xFF, 0xD7, 0xFF]).unwrap();

        let mut report = Report::new();
        scan_directory(Path::new(dir_path), &mut report);
        report.generate();

        assert_eq!(report.total_files_found(), 3);
        assert_eq!(report.total_files_skipped(), 3);
        assert_eq!(report.total_files_analyzed(), 0);
    }

    #[test]
    fn recursively_scans_directories() {
        let temp_dir = tempdir().unwrap();
        let dir_path = temp_dir.path();

        let lib_dir = dir_path.join("lib");
        fs::create_dir(&lib_dir).unwrap();

        fs::write(dir_path.join("main.rs"), "fn main() {}").unwrap();
        fs::write(dir_path.join("image1.png"), [0xFF, 0xDD, 0xFF]).unwrap();
        fs::write(lib_dir.join("main.rs"), "fn main() {}").unwrap();

        let mut report = Report::new();
        scan_directory(Path::new(dir_path), &mut report);
        report.generate();

        assert_eq!(report.total_files_found(), 3);
        assert_eq!(report.total_files_analyzed(), 2);
        assert_eq!(report.total_files_skipped(), 1);

        fs::remove_dir_all(dir_path).unwrap();
    }

    #[test]
    fn ignores_skippable_directories() {
        let temp_dir = tempdir().unwrap();
        let dir_path = temp_dir.path();

        let test_directories = vec![".idea", ".vscode", "target", "build", "node_modules"];
        for directory in test_directories {
            let fake_ide_dir = dir_path.join(directory);
            fs::create_dir(&fake_ide_dir).unwrap();
        }

        let lib_dir = dir_path.join("lib");
        fs::create_dir(&lib_dir).unwrap();

        let mut report = Report::new();
        scan_directory(Path::new(dir_path), &mut report);
        report.generate();

        assert_eq!(report.total_directories_found(), 1);
    }
}