prefer 0.4.1

A lightweight library for managing application configurations with support for multiple file formats
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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
//! Tests for the registry-based load/watch pipeline.

use async_trait::async_trait;
use prefer::loader::db::{ColumnValue, ConfigEntry, ConfigLoader, DbLoader};
use prefer::loader::file::FileLoader;
use prefer::loader::Loader;
use prefer::registry;
use prefer::registry::RegisteredLoader;
use serial_test::serial;
use std::collections::BTreeMap;
use std::io::Write;
use tempfile::TempDir;

struct RawJsonDbLoader;

#[async_trait]
impl ConfigLoader for RawJsonDbLoader {
    fn scheme(&self) -> &str {
        "rawjson"
    }

    async fn load_config(&self, _identifier: &str) -> prefer::Result<ConfigEntry> {
        Ok(ConfigEntry::Raw {
            format: "json".to_string(),
            content: r#"{"host": "localhost", "port": 8080, "debug": true}"#.to_string(),
        })
    }

    fn name(&self) -> &str {
        "raw-json-integration"
    }
}

struct RawTomlDbLoader;

#[async_trait]
impl ConfigLoader for RawTomlDbLoader {
    fn scheme(&self) -> &str {
        "rawtoml"
    }

    async fn load_config(&self, _identifier: &str) -> prefer::Result<ConfigEntry> {
        Ok(ConfigEntry::Raw {
            format: "toml".to_string(),
            content: "[server]\nhost = \"localhost\"\nport = 9090\n".to_string(),
        })
    }

    fn name(&self) -> &str {
        "raw-toml-integration"
    }
}

struct ColumnarDbLoader;

#[async_trait]
impl ConfigLoader for ColumnarDbLoader {
    fn scheme(&self) -> &str {
        "colint"
    }

    async fn load_config(&self, _identifier: &str) -> prefer::Result<ConfigEntry> {
        let mut values = BTreeMap::new();
        values.insert(
            "database_host".to_string(),
            ColumnValue::String("db.example.com".into()),
        );
        values.insert("database_port".to_string(), ColumnValue::Integer(5432));
        values.insert("pool_size".to_string(), ColumnValue::Integer(10));
        values.insert("ssl_enabled".to_string(), ColumnValue::Bool(true));
        values.insert("connect_timeout".to_string(), ColumnValue::Float(5.5));
        Ok(ConfigEntry::Columnar(values))
    }

    fn name(&self) -> &str {
        "columnar-integration"
    }
}

static RAW_JSON_LOADER: DbLoader<RawJsonDbLoader> = DbLoader::new(RawJsonDbLoader);
static RAW_TOML_LOADER: DbLoader<RawTomlDbLoader> = DbLoader::new(RawTomlDbLoader);
static COLUMNAR_LOADER: DbLoader<ColumnarDbLoader> = DbLoader::new(ColumnarDbLoader);

inventory::submit! { RegisteredLoader(&RAW_JSON_LOADER) }
inventory::submit! { RegisteredLoader(&RAW_TOML_LOADER) }
inventory::submit! { RegisteredLoader(&COLUMNAR_LOADER) }

#[test]
fn test_file_loader_provides_bare_names() {
    let loader = FileLoader::new();
    assert!(loader.provides("myapp"));
    assert!(loader.provides("settings"));
    assert!(loader.provides("config"));
}

#[test]
fn test_file_loader_rejects_db_urls() {
    let loader = FileLoader::new();
    assert!(!loader.provides("postgres://localhost/mydb"));
    assert!(!loader.provides("sqlite:///tmp/db.sqlite"));
    assert!(!loader.provides("mysql://root@localhost/db"));
}

#[test]
fn test_find_loader_returns_file_loader_for_bare_name() {
    let loader = registry::find_loader("myapp");
    assert!(loader.is_some());
    assert_eq!(loader.unwrap().name(), "file");
}

#[test]
fn test_find_loader_returns_none_for_unknown_scheme() {
    // No loader registered for postgres:// in prefer itself
    let loader = registry::find_loader("postgres://localhost/db");
    assert!(loader.is_none());
}

#[test]
fn test_find_formatter_by_extension() {
    let fmt = registry::find_formatter("config.json");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "json");

    let fmt = registry::find_formatter("config.yaml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "yaml");

    let fmt = registry::find_formatter("config.yml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "yaml");

    let fmt = registry::find_formatter("config.toml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "toml");

    let fmt = registry::find_formatter("config.ini");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "ini");

    let fmt = registry::find_formatter("config.xml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "xml");
}

#[test]
fn test_find_formatter_returns_none_for_unknown() {
    let fmt = registry::find_formatter("config.bson");
    assert!(fmt.is_none());

    let fmt = registry::find_formatter("no_extension");
    assert!(fmt.is_none());
}

#[test]
fn test_find_formatter_by_hint() {
    let fmt = registry::find_formatter_by_hint("json");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "json");

    let fmt = registry::find_formatter_by_hint("toml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "toml");

    let fmt = registry::find_formatter_by_hint("yaml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "yaml");
}

#[test]
fn test_find_formatter_by_hint_returns_none_for_unknown() {
    let fmt = registry::find_formatter_by_hint("bson");
    assert!(fmt.is_none());
}

#[tokio::test]
#[serial]
async fn test_load_routes_to_file_loader() {
    let temp_dir = TempDir::new().unwrap();
    let file_path = temp_dir.path().join("testcfg.json");
    let mut file = std::fs::File::create(&file_path).unwrap();
    writeln!(file, r#"{{"host": "localhost", "port": 8080}}"#).unwrap();

    let original_dir = std::env::current_dir().unwrap();
    std::env::set_current_dir(temp_dir.path()).unwrap();

    let config = prefer::load("testcfg").await.unwrap();

    let host: String = config.get("host").unwrap();
    assert_eq!(host, "localhost");

    let port: u16 = config.get("port").unwrap();
    assert_eq!(port, 8080);

    // Verify metadata was populated
    assert_eq!(config.loader_name(), Some("file"));
    assert!(config.source().is_some());

    std::env::set_current_dir(original_dir).unwrap();
}

#[tokio::test]
#[serial]
async fn test_load_toml_routes_correctly() {
    let temp_dir = TempDir::new().unwrap();
    let file_path = temp_dir.path().join("myapp.toml");
    let mut file = std::fs::File::create(&file_path).unwrap();
    writeln!(file, r#"name = "test""#).unwrap();

    let original_dir = std::env::current_dir().unwrap();
    std::env::set_current_dir(temp_dir.path()).unwrap();

    let config = prefer::load("myapp").await.unwrap();

    let name: String = config.get("name").unwrap();
    assert_eq!(name, "test");

    std::env::set_current_dir(original_dir).unwrap();
}

#[tokio::test]
async fn test_load_no_loader_found() {
    let result = prefer::load("postgres://localhost/db").await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(matches!(err, prefer::Error::NoLoaderFound(_)));
}

#[tokio::test]
async fn test_watch_no_loader_found() {
    let result = prefer::watch("postgres://localhost/db").await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(matches!(err, prefer::Error::NoLoaderFound(_)));
}

#[test]
fn test_formatter_deserialize_serialize_roundtrip() {
    let fmt = registry::find_formatter("test.json").unwrap();
    let data = fmt.deserialize(r#"{"key": "value", "num": 42}"#).unwrap();
    let serialized = fmt.serialize(&data).unwrap();
    let restored = fmt.deserialize(&serialized).unwrap();
    assert_eq!(data, restored);
}

#[test]
fn test_config_set_and_get() {
    let mut config = prefer::Config::new(prefer::ConfigValue::Object(Default::default()));

    config.set(
        "server.host",
        prefer::ConfigValue::String("localhost".into()),
    );
    config.set("server.port", prefer::ConfigValue::Integer(8080));

    let host: String = config.get("server.host").unwrap();
    assert_eq!(host, "localhost");

    let port: u16 = config.get("server.port").unwrap();
    assert_eq!(port, 8080);
}

#[test]
fn test_config_on_change_fires() {
    let mut config = prefer::Config::new(prefer::ConfigValue::Object(Default::default()));

    let changes = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
    let changes_clone = changes.clone();

    config.on_change(Box::new(move |key, _value, _prev| {
        changes_clone.lock().unwrap().push(key.to_string());
    }));

    config.set("a", prefer::ConfigValue::Integer(1));
    config.set("b.c", prefer::ConfigValue::String("hello".into()));

    let log = changes.lock().unwrap();
    assert_eq!(log.len(), 2);
    assert_eq!(log[0], "a");
    assert_eq!(log[1], "b.c");
}

#[tokio::test]
#[serial]
async fn test_load_yaml_routes_correctly() {
    let temp_dir = TempDir::new().unwrap();
    let file_path = temp_dir.path().join("settings.yaml");
    let mut file = std::fs::File::create(&file_path).unwrap();
    writeln!(file, "host: localhost\nport: 3000").unwrap();

    let original_dir = std::env::current_dir().unwrap();
    std::env::set_current_dir(temp_dir.path()).unwrap();

    let config = prefer::load("settings").await.unwrap();

    let host: String = config.get("host").unwrap();
    assert_eq!(host, "localhost");
    assert_eq!(config.loader_name(), Some("file"));

    std::env::set_current_dir(original_dir).unwrap();
}

#[tokio::test]
#[serial]
async fn test_load_file_not_found() {
    let temp_dir = TempDir::new().unwrap();
    let original_dir = std::env::current_dir().unwrap();
    std::env::set_current_dir(temp_dir.path()).unwrap();

    let result = prefer::load("nonexistent_config").await;
    assert!(result.is_err());

    std::env::set_current_dir(original_dir).unwrap();
}

#[test]
fn test_formatter_toml_roundtrip() {
    let fmt = registry::find_formatter("test.toml").unwrap();
    let data = fmt.deserialize("name = \"test\"\nport = 8080").unwrap();
    let serialized = fmt.serialize(&data).unwrap();
    let restored = fmt.deserialize(&serialized).unwrap();
    assert_eq!(data, restored);
}

#[test]
fn test_formatter_yaml_roundtrip() {
    let fmt = registry::find_formatter("test.yaml").unwrap();
    let data = fmt.deserialize("name: test\nport: 8080").unwrap();
    let serialized = fmt.serialize(&data).unwrap();
    let restored = fmt.deserialize(&serialized).unwrap();
    assert_eq!(data, restored);
}

#[test]
fn test_find_formatter_by_hint_ini() {
    let fmt = registry::find_formatter_by_hint("ini");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "ini");
}

#[test]
fn test_find_formatter_by_hint_xml() {
    let fmt = registry::find_formatter_by_hint("xml");
    assert!(fmt.is_some());
    assert_eq!(fmt.unwrap().name(), "xml");
}

#[test]
fn test_file_loader_provides_file_url() {
    let loader = FileLoader::new();
    assert!(loader.provides("file:///etc/myapp.toml"));
    assert!(loader.provides("file://config.json"));
}

#[test]
fn test_error_display_messages() {
    let err = prefer::Error::NoLoaderFound("redis://host".into());
    assert!(err.to_string().contains("redis://host"));

    let err = prefer::Error::NoFormatterFound("config.bson".into());
    assert!(err.to_string().contains("config.bson"));

    let err = prefer::Error::WatchNotSupported("scheme://x".into());
    assert!(err.to_string().contains("scheme://x"));
}

#[tokio::test]
async fn test_db_loader_end_to_end_raw_json() {
    let config = prefer::load("rawjson://settings").await.unwrap();

    let host: String = config.get("host").unwrap();
    assert_eq!(host, "localhost");

    let port: i64 = config.get("port").unwrap();
    assert_eq!(port, 8080);

    let debug: bool = config.get("debug").unwrap();
    assert!(debug);
}

#[tokio::test]
async fn test_db_loader_end_to_end_raw_toml() {
    let config = prefer::load("rawtoml://settings").await.unwrap();

    let host: String = config.get("server.host").unwrap();
    assert_eq!(host, "localhost");

    let port: i64 = config.get("server.port").unwrap();
    assert_eq!(port, 9090);
}

#[tokio::test]
async fn test_db_loader_end_to_end_columnar() {
    let config = prefer::load("colint://mydb/config").await.unwrap();

    let host: String = config.get("database_host").unwrap();
    assert_eq!(host, "db.example.com");

    let port: i64 = config.get("database_port").unwrap();
    assert_eq!(port, 5432);

    let pool: i64 = config.get("pool_size").unwrap();
    assert_eq!(pool, 10);

    let ssl: bool = config.get("ssl_enabled").unwrap();
    assert!(ssl);

    let timeout: f64 = config.get("connect_timeout").unwrap();
    assert!((timeout - 5.5).abs() < f64::EPSILON);
}

#[tokio::test]
async fn test_db_loader_unregistered_scheme_returns_error() {
    let result = prefer::load("unknowndb://settings").await;
    assert!(result.is_err());
}