dotling 0.1.0

A dotfiles management CLI — track, link, and sync your config files across machines
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

/// OS platform detection for multi-OS dotfile support.
///
/// Each [`LinkEntry`](crate::config::LinkEntry) carries a [`Platform`] tag.
/// Entries tagged [`All`](Platform::All) deploy everywhere; other variants
/// restrict the entry to a single operating system.
use clap::ValueEnum;
use serde::{Deserialize, Serialize};

/// Target operating system for a config entry.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ValueEnum)]
#[serde(rename_all = "lowercase")]
pub enum Platform {
    /// Deploys on every platform (the default).
    #[default]
    All,
    /// Linux only.
    Linux,
    /// macOS only.
    #[serde(alias = "darwin")]
    Macos,
    /// Windows only.
    Windows,
}

impl Platform {
    /// Returns the platform of the current machine.
    pub fn current() -> Self {
        match std::env::consts::OS {
            "linux" => Self::Linux,
            "macos" => Self::Macos,
            "windows" => Self::Windows,
            _ => Self::All,
        }
    }

    /// Returns `true` if this platform matches the current machine.
    ///
    /// [`All`](Self::All) matches every machine.
    pub fn is_active(self) -> bool {
        self == Self::All || self == Self::current()
    }
}

impl std::fmt::Display for Platform {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::All => write!(f, "all"),
            Self::Linux => write!(f, "linux"),
            Self::Macos => write!(f, "macos"),
            Self::Windows => write!(f, "windows"),
        }
    }
}

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

    #[test]
    fn current_returns_known_variant() {
        let p = Platform::current();
        assert!(matches!(
            p,
            Platform::Linux | Platform::Macos | Platform::Windows
        ));
    }

    #[test]
    fn all_is_always_active() {
        assert!(Platform::All.is_active());
    }

    #[test]
    fn current_is_active() {
        assert!(Platform::current().is_active());
    }

    #[test]
    fn serde_round_trip() {
        #[derive(Debug, Serialize, Deserialize, PartialEq)]
        struct Wrapper {
            os: Platform,
        }
        for p in [
            Platform::All,
            Platform::Linux,
            Platform::Macos,
            Platform::Windows,
        ] {
            let w = Wrapper { os: p };
            let s = toml::to_string(&w).unwrap();
            let back: Wrapper = toml::from_str(&s).unwrap();
            assert_eq!(w, back);
        }
    }
}