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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
mod error;
use crate::error::{Deserialization as DeserializationError, Result, UniversalConfig as Error};
use dirs::{config_dir, home_dir};
use serde::de::DeserializeOwned;
use std::fs;
use std::path::{Path, PathBuf};
use tracing::debug;
pub enum Format {
Json,
Yaml,
Toml,
Corn,
}
pub struct ConfigLoader<'a> {
app_name: &'a str,
file_name: &'a str,
formats: &'a [Format],
config_dir: Option<&'a str>,
}
impl<'a> ConfigLoader<'a> {
#[must_use]
pub const fn new(app_name: &'a str) -> ConfigLoader<'a> {
Self {
app_name,
file_name: "config",
formats: &[Format::Json, Format::Yaml, Format::Toml, Format::Corn],
config_dir: None,
}
}
pub fn with_file_name(&mut self, file_name: &'a str) -> &Self {
self.file_name = file_name;
self
}
pub fn with_formats(&mut self, formats: &'a [Format]) -> &Self {
self.formats = formats;
self
}
pub fn with_config_dir(&mut self, dir: &'a str) -> &Self {
self.config_dir = Some(dir);
self
}
pub fn find_and_load<T: DeserializeOwned>(&self) -> Result<T> {
let file = self.try_find_file()?;
debug!("Found file at: '{}", file.display());
Self::load(&file)
}
fn try_find_file(&self) -> Result<PathBuf> {
let config_dir = self
.config_dir
.map(Into::into)
.or_else(|| config_dir().map(|dir| dir.join(self.app_name)))
.or_else(|| home_dir().map(|dir| dir.join(format!(".{}", self.app_name))))
.ok_or(Error::MissingUserDir)?;
let extensions = self.get_extensions();
debug!("Using config dir: {}", config_dir.display());
let file = extensions.into_iter().find_map(|extension| {
let full_path = config_dir.join(format!("config.{extension}"));
if Path::exists(&full_path) {
Some(full_path)
} else {
None
}
});
file.ok_or(Error::FileNotFound)
}
pub fn load<T: DeserializeOwned, P: AsRef<Path>>(path: P) -> Result<T> {
let str = fs::read_to_string(&path)?;
let extension = path
.as_ref()
.extension()
.unwrap_or_default()
.to_str()
.unwrap_or_default();
let config = Self::deserialize(&str, extension)?;
Ok(config)
}
fn get_extensions(&self) -> Vec<&'static str> {
let mut extensions = vec![];
for format in self.formats {
match format {
Format::Json => extensions.push("json"),
Format::Yaml => {
extensions.push("yaml");
extensions.push("yml");
}
Format::Toml => extensions.push("toml"),
Format::Corn => extensions.push("corn"),
}
}
extensions
}
fn deserialize<T: DeserializeOwned>(
str: &str,
extension: &str,
) -> std::result::Result<T, DeserializationError> {
let res = match extension {
#[cfg(feature = "json")]
"json" => serde_json::from_str(str).map_err(DeserializationError::from),
#[cfg(feature = "toml")]
"toml" => toml::from_str(str).map_err(DeserializationError::from),
#[cfg(feature = "yaml")]
"yaml" | "yml" => serde_yaml::from_str(str).map_err(DeserializationError::from),
#[cfg(feature = "corn")]
"corn" => libcorn::from_str(str).map_err(DeserializationError::from),
_ => Err(DeserializationError::UnsupportedExtension(
extension.to_string(),
)),
}?;
Ok(res)
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde::Deserialize;
#[derive(Deserialize)]
struct ConfigContents {
test: String,
}
#[test]
fn test_json() {
let res: ConfigContents = ConfigLoader::load("test_configs/config.json").unwrap();
assert_eq!(res.test, "hello world")
}
#[test]
fn test_yaml() {
let res: ConfigContents = ConfigLoader::load("test_configs/config.yaml").unwrap();
assert_eq!(res.test, "hello world")
}
#[test]
fn test_toml() {
let res: ConfigContents = ConfigLoader::load("test_configs/config.toml").unwrap();
assert_eq!(res.test, "hello world")
}
#[test]
fn test_corn() {
let res: ConfigContents = ConfigLoader::load("test_configs/config.corn").unwrap();
assert_eq!(res.test, "hello world")
}
#[test]
fn test_find_load() {
let mut config = ConfigLoader::new("universal-config");
let res: ConfigContents = config
.with_config_dir("test_configs")
.find_and_load()
.unwrap();
assert_eq!(res.test, "hello world")
}
}