pidge-core 1.6.0

Core types for the pidge CLI: accounts, configuration, normalized message model
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

//! Where the tool keeps its files.
//!
//! Linux and macOS share one XDG layout, the same as Ailloy and every MKLab
//! tool: config in `$XDG_CONFIG_HOME/<tool>` (default `~/.config/<tool>`) and
//! cache in `$XDG_CACHE_HOME/<tool>` (default `~/.cache/<tool>`). Windows uses
//! its native folders (`%APPDATA%`, `%LOCALAPPDATA%`). Deliberately not
//! `dirs::config_dir()` on macOS, which is `~/Library/Application Support`.

use std::path::PathBuf;

/// Folder name under the config and cache roots.
pub const TOOL: &str = "pidge";

/// The tool's config directory (holds `config.yaml`).
#[cfg(not(windows))]
pub fn config_dir() -> Option<PathBuf> {
    xdg_dir(
        std::env::var_os("XDG_CONFIG_HOME"),
        dirs::home_dir(),
        ".config",
    )
}

/// The tool's config directory (holds `config.yaml`): `%APPDATA%\<tool>`.
#[cfg(windows)]
pub fn config_dir() -> Option<PathBuf> {
    dirs::config_dir().map(|d| d.join(TOOL))
}

/// The tool's cache directory (update check, other disposable state).
#[cfg(not(windows))]
pub fn cache_dir() -> Option<PathBuf> {
    xdg_dir(
        std::env::var_os("XDG_CACHE_HOME"),
        dirs::home_dir(),
        ".cache",
    )
}

/// The tool's cache directory: `%LOCALAPPDATA%\<tool>`.
#[cfg(windows)]
pub fn cache_dir() -> Option<PathBuf> {
    dirs::cache_dir().map(|d| d.join(TOOL))
}

/// `$XDG_*_HOME/<tool>` when that variable is an absolute path, else
/// `~/<fallback>/<tool>`.
#[cfg(not(windows))]
fn xdg_dir(
    xdg: Option<std::ffi::OsString>,
    home: Option<PathBuf>,
    fallback: &str,
) -> Option<PathBuf> {
    match xdg.map(PathBuf::from) {
        Some(dir) if dir.is_absolute() => Some(dir.join(TOOL)),
        _ => home.map(|h| h.join(fallback).join(TOOL)),
    }
}

#[cfg(all(test, not(windows)))]
mod tests {
    use super::*;

    #[test]
    fn an_absolute_xdg_variable_wins() {
        let dir = xdg_dir(Some("/xdg".into()), Some("/home/k".into()), ".config");
        assert_eq!(dir, Some(PathBuf::from("/xdg").join(TOOL)));
    }

    #[test]
    fn otherwise_the_dot_folder_in_home() {
        let config = xdg_dir(None, Some("/Users/k".into()), ".config");
        assert_eq!(config, Some(PathBuf::from("/Users/k/.config").join(TOOL)));
        let cache = xdg_dir(None, Some("/Users/k".into()), ".cache");
        assert_eq!(cache, Some(PathBuf::from("/Users/k/.cache").join(TOOL)));
    }

    #[test]
    fn empty_or_relative_xdg_variables_are_ignored() {
        // The XDG Base Directory spec says to ignore relative paths.
        for xdg in ["", "relative/dir"] {
            let dir = xdg_dir(Some(xdg.into()), Some("/home/k".into()), ".config");
            assert_eq!(
                dir,
                Some(PathBuf::from("/home/k/.config").join(TOOL)),
                "{xdg:?}"
            );
        }
    }

    #[test]
    fn no_home_and_no_xdg_is_none() {
        assert_eq!(xdg_dir(None, None, ".config"), None);
    }
}