stuffr-cli 0.18.1

The stuffr command line interface
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

//! Which reference the compress family behaves as, and how a run picks it.

use std::ffi::OsString;

/// Which reference the family behaves as.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Flavour {
    /// Apple's `/usr/bin/compress` (`file_cmds-487.0.1`): the default on
    /// macOS and the BSDs.
    Apple,
    /// ncompress 5.0 as Ubuntu 24.04 ships it (`5.0-1`): the default
    /// elsewhere.
    Ncompress,
}

/// The flavour a build uses when `STUFFR_COMPRESS_FLAVOR` is unset or
/// empty: Apple on Apple platforms and the BSDs (the cfg of
/// `gzip::default_flavour`), ncompress everywhere else, Windows included.
pub fn default_flavour() -> Flavour {
    if cfg!(any(
        target_vendor = "apple",
        target_os = "freebsd",
        target_os = "netbsd",
        target_os = "openbsd",
        target_os = "dragonfly"
    )) {
        Flavour::Apple
    } else {
        Flavour::Ncompress
    }
}

/// The flavour `STUFFR_COMPRESS_FLAVOR`'s value selects: `apple` or
/// `ncompress`, the default when unset or empty, and `Err(value)` for
/// anything else (another case, a blank).
pub(crate) fn flavour_from(value: Option<OsString>) -> Result<Flavour, OsString> {
    match value {
        None => Ok(default_flavour()),
        Some(v) if v.is_empty() => Ok(default_flavour()),
        Some(v) if v == "apple" => Ok(Flavour::Apple),
        Some(v) if v == "ncompress" => Ok(Flavour::Ncompress),
        Some(v) => Err(v),
    }
}

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

    #[test]
    fn flavour_var_selects_and_rejects() {
        let d = default_flavour();
        assert_eq!(flavour_from(None), Ok(d));
        assert_eq!(flavour_from(Some("".into())), Ok(d));
        assert_eq!(flavour_from(Some("apple".into())), Ok(Flavour::Apple));
        assert_eq!(
            flavour_from(Some("ncompress".into())),
            Ok(Flavour::Ncompress)
        );
        for bad in ["Apple", "NCOMPRESS", " apple", "bsd", "ubuntu", "gnu"] {
            assert_eq!(flavour_from(Some(bad.into())), Err(bad.into()));
        }
    }

    #[test]
    fn default_flavour_is_apple_on_macos() {
        let apple = cfg!(any(
            target_os = "macos",
            target_os = "ios",
            target_os = "freebsd",
            target_os = "netbsd",
            target_os = "openbsd",
            target_os = "dragonfly"
        ));
        assert_eq!(
            default_flavour(),
            if apple {
                Flavour::Apple
            } else {
                Flavour::Ncompress
            }
        );
        if cfg!(target_os = "macos") {
            assert_eq!(default_flavour(), Flavour::Apple);
        }
    }
}