frostx 0.1.0

frostx monitors project directories for inactivity. Once a configured inactivity threshold elapses (e.g. "90 days since any file was modified"), frostx executes a pipeline of **actions** - e.g., checking git state, creating archives, uploading backups, deleting local copies. Automating the lifecycle of projects, frostx helps users manage disk space and maintain a clean workspace.
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

use super::{Action, ActionContext, ActionFactory, ActionKind, ActionOutcome};
use crate::error::FrostxError;

/// Static registration of all local actions.
pub const REGISTRY: &[(&str, ActionFactory)] = &[("local.delete", |_, _| Ok(Box::new(Delete)))];

/// Delete the local project directory. Always asks for explicit confirmation.
pub struct Delete;

impl Action for Delete {
    fn name(&self) -> &'static str {
        "local.delete"
    }
    fn kind(&self) -> ActionKind {
        ActionKind::Mutation
    }
    fn supports_compressed_archive(&self) -> bool {
        true
    }

    fn run(&self, ctx: &ActionContext<'_>) -> Result<ActionOutcome, FrostxError> {
        let path = ctx.project_path;

        if ctx.dry_run {
            return Ok(ActionOutcome::dry_run(format!(
                "would delete {}",
                path.display()
            )));
        }

        if super::cwd_is_inside(path) {
            return Err(FrostxError::ActionFailed {
                action: self.name().to_owned(),
                message: format!(
                    "current working directory is inside {}; cd to a different location and retry",
                    path.display()
                ),
            });
        }

        let size: u64 = walkdir::WalkDir::new(path)
            .into_iter()
            .filter_map(std::result::Result::ok)
            .filter_map(|e| e.metadata().ok())
            .filter(std::fs::Metadata::is_file)
            .map(|m| m.len())
            .sum();

        // local.delete ALWAYS confirms, even with --yes.
        println!(
            "About to permanently delete: {} ({} on disk)",
            path.display(),
            human_size(size)
        );
        if !confirm_delete(path)? {
            return Ok(ActionOutcome::skipped("cancelled by user"));
        }

        if path.is_file() {
            std::fs::remove_file(path)?;
        } else {
            std::fs::remove_dir_all(path)?;
        }
        Ok(ActionOutcome::ok(format!("deleted {}", path.display())))
    }
}

#[allow(clippy::cast_precision_loss)]
fn human_size(bytes: u64) -> String {
    if bytes < 1024 * 1024 {
        format!("{:.1} KB", bytes as f64 / 1024.0)
    } else {
        format!("{:.1} MB", bytes as f64 / (1024.0 * 1024.0))
    }
}

fn confirm_delete(path: &std::path::Path) -> Result<bool, FrostxError> {
    use dialoguer::Confirm;
    let prompt = format!(
        "Permanently delete {}? This cannot be undone",
        path.display()
    );
    Confirm::new()
        .with_prompt(prompt)
        .default(false)
        .interact()
        .map_err(|e| FrostxError::Other(e.into()))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::project::ActionConfig;
    use std::collections::HashMap;
    use tempfile::tempdir;
    use uuid::Uuid;

    fn make_config() -> crate::config::project::ProjectConfig {
        crate::config::project::ProjectConfig {
            id: Uuid::new_v4(),
            name: None,
            description: None,
            include: vec![],
            template: std::collections::HashMap::new(),
            groups: HashMap::new(),
            config: ActionConfig::default(),
            rules: vec![],
        }
    }

    #[test]
    fn dry_run_does_not_delete() {
        let tmp = tempdir().unwrap();
        let project = tmp.path().join("myproject");
        std::fs::create_dir(&project).unwrap();
        std::fs::write(project.join("main.rs"), "fn main() {}").unwrap();

        let cfg = make_config();
        let ctx = ActionContext {
            project_path: &project,
            config: &cfg,
            dry_run: true,
            yes: true,
        };
        let out = Delete.run(&ctx).unwrap();
        assert_eq!(out.status, crate::pipeline::ActionStatus::DryRun);
        assert!(project.exists());
    }
}