cargo-reclaim 0.2.0

Safe Cargo cleanup for target directories, stale artifacts, and Cargo home caches
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

use std::path::{Component, Path};

use super::model::CargoHomeClass;

pub fn classify_cargo_home_relative_path(path: impl AsRef<Path>) -> CargoHomeClass {
    let parts = normalized_parts(path.as_ref());
    match parts.as_slice() {
        ["registry", "index"] => CargoHomeClass::RegistryIndex,
        ["registry", "cache"] => CargoHomeClass::RegistryCache,
        ["registry", "src"] => CargoHomeClass::RegistrySource,
        ["git", "db"] => CargoHomeClass::GitDatabase,
        ["git", "checkouts"] => CargoHomeClass::GitCheckouts,
        ["config.toml"] | ["config"] => CargoHomeClass::Config,
        ["credentials.toml"] | ["credentials"] => CargoHomeClass::Credentials,
        [".crates.toml"] | [".crates2.json"] => CargoHomeClass::InstallMetadata,
        ["bin"] => CargoHomeClass::InstalledBinaries,
        _ => CargoHomeClass::UnknownUserAuthored,
    }
}

fn normalized_parts(path: &Path) -> Vec<&str> {
    path.components()
        .filter_map(|component| match component {
            Component::Normal(value) => value.to_str(),
            _ => None,
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn classifies_known_cargo_home_layout_paths() {
        assert_eq!(
            classify_cargo_home_relative_path("registry/index"),
            CargoHomeClass::RegistryIndex
        );
        assert_eq!(
            classify_cargo_home_relative_path("registry/cache"),
            CargoHomeClass::RegistryCache
        );
        assert_eq!(
            classify_cargo_home_relative_path("registry/src"),
            CargoHomeClass::RegistrySource
        );
        assert_eq!(
            classify_cargo_home_relative_path("git/db"),
            CargoHomeClass::GitDatabase
        );
        assert_eq!(
            classify_cargo_home_relative_path("git/checkouts"),
            CargoHomeClass::GitCheckouts
        );
    }

    #[test]
    fn preserves_sensitive_and_user_authored_paths() {
        assert_eq!(
            classify_cargo_home_relative_path("config.toml"),
            CargoHomeClass::Config
        );
        assert_eq!(
            classify_cargo_home_relative_path("credentials"),
            CargoHomeClass::Credentials
        );
        assert_eq!(
            classify_cargo_home_relative_path(".crates2.json"),
            CargoHomeClass::InstallMetadata
        );
        assert_eq!(
            classify_cargo_home_relative_path("bin"),
            CargoHomeClass::InstalledBinaries
        );
        assert_eq!(
            classify_cargo_home_relative_path("registry"),
            CargoHomeClass::UnknownUserAuthored
        );
        assert_eq!(
            classify_cargo_home_relative_path("custom"),
            CargoHomeClass::UnknownUserAuthored
        );
    }
}