bitpill 0.3.5

A personal medication management TUI application built in Rust.
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
130
131
132
133
134
135
136
137
138
139
140
141
142

use std::path::PathBuf;

const APP_DIR_NAME: &str = "bitpill";
const ENV_MEDICATIONS: &str = "BITPILL_MEDICATIONS_FILE";
const ENV_DOSE_RECORDS: &str = "BITPILL_DOSE_RECORDS_FILE";
const ENV_SETTINGS: &str = "BITPILL_SETTINGS_FILE";

/// Resolves all file system paths for BitPill's persistent data.
///
/// Default resolution (no env overrides):
///   - config dir   → `~/.config/bitpill/`
///   - medications  → `~/.config/bitpill/medications.json`
///   - dose records → `~/.config/bitpill/dose_records.json`
///   - settings     → `~/.config/bitpill/settings.json`
///
/// Each path can be overridden via its env var, which is useful for
/// integration tests and custom deployments.
pub struct AppPaths {
    config_dir: PathBuf,
    medications: PathBuf,
    dose_records: PathBuf,
    settings: PathBuf,
}

impl AppPaths {
    /// Builds paths from env var overrides or XDG-standard defaults.
    pub fn resolve() -> Self {
        let config_dir = dirs::config_dir()
            .unwrap_or_else(|| PathBuf::from(".config"))
            .join(APP_DIR_NAME);

        let medications = std::env::var(ENV_MEDICATIONS)
            .map(PathBuf::from)
            .unwrap_or_else(|_| config_dir.join("medications.json"));

        let dose_records = std::env::var(ENV_DOSE_RECORDS)
            .map(PathBuf::from)
            .unwrap_or_else(|_| config_dir.join("dose_records.json"));

        let settings = std::env::var(ENV_SETTINGS)
            .map(PathBuf::from)
            .unwrap_or_else(|_| config_dir.join("settings.json"));

        Self {
            config_dir,
            medications,
            dose_records,
            settings,
        }
    }

    /// Constructs paths from explicit values. Intended for tests only.
    #[cfg(any(test, feature = "test-helpers"))]
    pub fn with_paths(
        config_dir: PathBuf,
        medications: PathBuf,
        dose_records: PathBuf,
        settings: PathBuf,
    ) -> Self {
        Self {
            config_dir,
            medications,
            dose_records,
            settings,
        }
    }

    pub fn config_dir(&self) -> &PathBuf {
        &self.config_dir
    }

    pub fn medications_path(&self) -> &PathBuf {
        &self.medications
    }

    pub fn dose_records_path(&self) -> &PathBuf {
        &self.dose_records
    }

    pub fn settings_path(&self) -> &PathBuf {
        &self.settings
    }
}

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

    #[test]
    fn resolve_returns_paths_ending_with_expected_filenames() {
        let paths = AppPaths::resolve();

        assert!(
            paths
                .medications_path()
                .to_str()
                .unwrap()
                .ends_with("medications.json")
        );
        assert!(
            paths
                .dose_records_path()
                .to_str()
                .unwrap()
                .ends_with("dose_records.json")
        );
        assert!(
            paths
                .settings_path()
                .to_str()
                .unwrap()
                .ends_with("settings.json")
        );
    }

    #[test]
    fn config_dir_contains_bitpill_segment() {
        let paths = AppPaths::resolve();

        assert!(
            paths
                .config_dir()
                .components()
                .any(|c| c.as_os_str() == APP_DIR_NAME)
        );
    }

    #[test]
    fn with_paths_stores_provided_paths() {
        let paths = AppPaths::with_paths(
            PathBuf::from("/tmp/cfg"),
            PathBuf::from("/tmp/meds.json"),
            PathBuf::from("/tmp/doses.json"),
            PathBuf::from("/tmp/settings.json"),
        );

        assert_eq!(paths.config_dir(), &PathBuf::from("/tmp/cfg"));
        assert_eq!(paths.medications_path(), &PathBuf::from("/tmp/meds.json"));
        assert_eq!(paths.dose_records_path(), &PathBuf::from("/tmp/doses.json"));
        assert_eq!(paths.settings_path(), &PathBuf::from("/tmp/settings.json"));
    }
}