onpath 0.2.0

Get your tools on the PATH — cross-shell, cross-platform, zero fuss
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

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

use crate::config::Position;
use crate::context::SystemContext;
use crate::shell::{Shell, ShellKind};

pub struct Tcsh;

impl Shell for Tcsh {
    fn kind(&self) -> ShellKind {
        ShellKind::Tcsh
    }

    fn env_extension(&self) -> &'static str {
        ".tcsh"
    }

    fn env_script(&self, dir: &Path, position: Position) -> String {
        let dir = dir.display();
        let setenv = match position {
            Position::Prepend => format!("setenv PATH \"{dir}:${{PATH}}\""),
            Position::Append => format!("setenv PATH \"${{PATH}}:{dir}\""),
        };
        format!(
            r#"#!/bin/tcsh
# Generated by onpath. Do not edit.
switch (":${{PATH}}:")
    case *\:"{dir}"\:*:
        breaksw
    default:
        {setenv}
        breaksw
endsw
"#
        )
    }

    fn source_line(&self, env_script_path: &Path) -> String {
        format!("source \"{}\"", env_script_path.display())
    }

    fn rc_candidates(&self, ctx: &SystemContext) -> Vec<PathBuf> {
        vec![
            ctx.home_dir().join(".tcshrc"),
            ctx.home_dir().join(".cshrc"),
        ]
    }

    fn primary_rc(&self, ctx: &SystemContext) -> PathBuf {
        ctx.home_dir().join(".tcshrc")
    }
}

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

    #[test]
    fn env_script_uses_switch_pattern() {
        let script = Tcsh.env_script(Path::new("/app/bin"), Position::Prepend);
        assert!(script.contains("switch"));
        assert!(script.contains("setenv PATH"));
        assert!(script.contains("endsw"));
    }

    #[test]
    fn env_script_append() {
        let script = Tcsh.env_script(Path::new("/app/bin"), Position::Append);
        assert!(script.contains("\"${PATH}:/app/bin\""));
    }

    #[test]
    fn rc_candidates_includes_tcshrc_and_cshrc() {
        let ctx = SystemContext::with_home(PathBuf::from("/home/user"));
        let candidates = Tcsh.rc_candidates(&ctx);
        assert!(candidates.contains(&PathBuf::from("/home/user/.tcshrc")));
        assert!(candidates.contains(&PathBuf::from("/home/user/.cshrc")));
    }
}