Create a type-safe configuration library

Cargo.lock

@@ -19,9 +19,9 @@ checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
 
 [[package]]
 name = "aho-corasick"
-version = "1.0.2"
+version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "43f6cb1bf222025340178f382c426f13757b2960e89779dfcb319c32542a5a41"
+checksum = "6748e8def348ed4d14996fa801f4122cd763fff530258cdc03f64b25f89d3a5a"
 dependencies = [
  "memchr",
 ]
@@ -43,9 +43,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.72"
+version = "1.0.74"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3b13c32d80ecc7ab747b80c3784bce54ee8a7a0cc4fbda9bf4cda2cf6fe90854"
+checksum = "8c6f84b74db2535ebae81eede2f39b947dcbf01d093ae5f791e5dd414a1bf289"
 
 [[package]]
 name = "autocfg"
@@ -103,9 +103,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
 
 [[package]]
 name = "bitflags"
-version = "2.3.3"
+version = "2.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "630be753d4e58660abd17930c71b647fe46c27ea6b63cc59e1e3851406972e42"
+checksum = "b4682ae6287fcf752ecaabbfcc7b6f9b72aa33933dc23a554d853aea8eea8635"
 
 [[package]]
 name = "bumpalo"
@@ -185,7 +185,7 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 name = "changeset"
 version = "0.1.0"
 dependencies = [
- "uuid",
+ "uuid 1.4.1",
 ]
 
 [[package]]
@@ -233,6 +233,34 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3d7b894f5411737b7867f4827955924d7c254fc9f4d91a6aad6b097804b1018b"
 
+[[package]]
+name = "config"
+version = "0.1.0"
+dependencies = [
+ "config-derive",
+ "cool_asserts",
+ "serde",
+ "serde_json",
+ "thiserror",
+]
+
+[[package]]
+name = "config-derive"
+version = "0.1.0"
+dependencies = [
+ "quote",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "cool_asserts"
+version = "2.0.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee9f254e53f61e2688d3677fa2cbe4e9b950afd56f48819c98817417cf6b28ec"
+dependencies = [
+ "indent_write",
+]
+
 [[package]]
 name = "coordinates"
 version = "0.1.0"
@@ -394,7 +422,7 @@ dependencies = [
  "serde_json",
  "tempfile",
  "thiserror",
- "uuid",
+ "uuid 0.8.2",
 ]
 
 [[package]]
@@ -476,9 +504,9 @@ dependencies = [
 
 [[package]]
 name = "flate2"
-version = "1.0.26"
+version = "1.0.27"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3b9429470923de8e8cbd4d2dc513535400b4b3fef0319fb5c4e1f520a7bef743"
+checksum = "c6c98ee8095e9d1dcbf2fcc6d95acccb90d1c81db1e44725c6a984b1dbdfb010"
 dependencies = [
  "crc32fast",
  "miniz_oxide",
@@ -1083,9 +1111,9 @@ checksum = "d897f394bad6a705d5f4104762e116a75639e470d80901eed05a860a95cb1904"
 
 [[package]]
 name = "httpdate"
-version = "1.0.2"
+version = "1.0.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c4a1e36c821dbe04574f602848a19f742f4fb3c98d40449f11bcad18d6b17421"
+checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9"
 
 [[package]]
 name = "hyper"
@@ -1104,7 +1132,7 @@ dependencies = [
  "httpdate",
  "itoa",
  "pin-project-lite",
- "socket2",
+ "socket2 0.4.9",
  "tokio",
  "tower-service",
  "tracing",
@@ -1168,9 +1196,9 @@ dependencies = [
 
 [[package]]
 name = "image"
-version = "0.24.6"
+version = "0.24.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "527909aa81e20ac3a44803521443a765550f09b5130c2c2fa1ea59c2f8f50a3a"
+checksum = "6f3dfdbdd72063086ff443e297b61695500514b1e41095b6fb9a5ab48a70a711"
 dependencies = [
  "bytemuck",
  "byteorder",
@@ -1185,6 +1213,12 @@ dependencies = [
  "tiff",
 ]
 
+[[package]]
+name = "indent_write"
+version = "2.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0cfe9645a18782869361d9c8732246be7b410ad4e919d3609ebabdac00ba12c3"
+
 [[package]]
 name = "indexmap"
 version = "1.9.3"
@@ -1329,9 +1363,9 @@ dependencies = [
 
 [[package]]
 name = "log"
-version = "0.4.19"
+version = "0.4.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b06a4cde4c0f271a446782e3eff8de789548ce57dbc8eca9292c27f4a42004b4"
+checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"
 
 [[package]]
 name = "memchr"
@@ -1653,9 +1687,9 @@ dependencies = [
 
 [[package]]
 name = "pin-project-lite"
-version = "0.2.11"
+version = "0.2.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2c516611246607d0c04186886dbb3a754368ef82c79e9827a802c6d836dd111c"
+checksum = "12cc1b0bf1727a77a54b6654e7b5f1af8604923edc8b81885f8ec92f9e3f0a05"
 
 [[package]]
 name = "pin-utils"
@@ -1940,11 +1974,11 @@ dependencies = [
 
 [[package]]
 name = "rustix"
-version = "0.38.7"
+version = "0.38.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "172891ebdceb05aa0005f533a6cbfca599ddd7d966f6f5d4d9b2e70478e70399"
+checksum = "19ed4fa021d81c8392ce04db050a3da9a60299050b7ae1cf482d862b54a7218f"
 dependencies = [
- "bitflags 2.3.3",
+ "bitflags 2.4.0",
  "errno",
  "libc",
  "linux-raw-sys",
@@ -2048,9 +2082,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.104"
+version = "1.0.105"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "076066c5f1078eac5b722a31827a8832fe108bed65dfa75e233c89f8206e976c"
+checksum = "693151e1ac27563d6dbcec9dee9fbd5da8539b20fa14ad3752b2e6d363ace360"
 dependencies = [
  "itoa",
  "ryu",
@@ -2135,6 +2169,16 @@ dependencies = [
  "winapi",
 ]
 
+[[package]]
+name = "socket2"
+version = "0.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2538b18701741680e0322a2302176d3253a35388e2e62f172f64f4f16605f877"
+dependencies = [
+ "libc",
+ "windows-sys",
+]
+
 [[package]]
 name = "spin"
 version = "0.9.8"
@@ -2200,18 +2244,18 @@ dependencies = [
 
 [[package]]
 name = "thiserror"
-version = "1.0.44"
+version = "1.0.46"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "611040a08a0439f8248d1990b111c95baa9c704c805fa1f62104b39655fd7f90"
+checksum = "d9207952ae1a003f42d3d5e892dac3c6ba42aa6ac0c79a6a91a2b5cb4253e75c"
 dependencies = [
  "thiserror-impl",
 ]
 
 [[package]]
 name = "thiserror-impl"
-version = "1.0.44"
+version = "1.0.46"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "090198534930841fab3a5d1bb637cde49e339654e606195f8d9c76eeb081dc96"
+checksum = "f1728216d3244de4f14f14f8c15c79be1a7c67867d28d69b719690e2a19fb445"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2220,9 +2264,9 @@ dependencies = [
 
 [[package]]
 name = "tiff"
-version = "0.8.1"
+version = "0.9.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7449334f9ff2baf290d55d73983a7d6fa15e01198faef72af07e2a8db851e471"
+checksum = "6d172b0f4d3fba17ba89811858b9d3d97f928aece846475bbda076ca46736211"
 dependencies = [
  "flate2",
  "jpeg-decoder",
@@ -2266,11 +2310,10 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"
 
 [[package]]
 name = "tokio"
-version = "1.29.1"
+version = "1.31.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "532826ff75199d5833b9d2c5fe410f29235e25704ee5f0ef599fb51c21f4a4da"
+checksum = "40de3a2ba249dcb097e01be5e67a5ff53cf250397715a071a81543e8a832a920"
 dependencies = [
- "autocfg",
  "backtrace",
  "bytes",
  "libc",
@@ -2279,7 +2322,7 @@ dependencies = [
  "parking_lot",
  "pin-project-lite",
  "signal-hook-registry",
- "socket2",
+ "socket2 0.5.3",
  "tokio-macros",
  "windows-sys",
 ]
@@ -2488,6 +2531,15 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "uuid"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79daa5ed5740825c40b389c5e50312b9c86df53fccd33f281df655642b43869d"
+dependencies = [
+ "getrandom",
+]
+
 [[package]]
 name = "vcpkg"
 version = "0.2.15"
@@ -2660,9 +2712,9 @@ dependencies = [
 
 [[package]]
 name = "windows-targets"
-version = "0.48.1"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "05d4b17490f70499f20b9e791dcf6a299785ce8af4d709018206dc5b4953e95f"
+checksum = "d1eeca1c172a285ee6c2c84c341ccea837e7c01b12fbb2d0fe3c9e550ce49ec8"
 dependencies = [
  "windows_aarch64_gnullvm",
  "windows_aarch64_msvc",
@@ -2675,51 +2727,51 @@ dependencies = [
 
 [[package]]
 name = "windows_aarch64_gnullvm"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "91ae572e1b79dba883e0d315474df7305d12f569b400fcf90581b06062f7e1bc"
+checksum = "b10d0c968ba7f6166195e13d593af609ec2e3d24f916f081690695cf5eaffb2f"
 
 [[package]]
 name = "windows_aarch64_msvc"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b2ef27e0d7bdfcfc7b868b317c1d32c641a6fe4629c171b8928c7b08d98d7cf3"
+checksum = "571d8d4e62f26d4932099a9efe89660e8bd5087775a2ab5cdd8b747b811f1058"
 
 [[package]]
 name = "windows_i686_gnu"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "622a1962a7db830d6fd0a69683c80a18fda201879f0f447f065a3b7467daa241"
+checksum = "2229ad223e178db5fbbc8bd8d3835e51e566b8474bfca58d2e6150c48bb723cd"
 
 [[package]]
 name = "windows_i686_msvc"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4542c6e364ce21bf45d69fdd2a8e455fa38d316158cfd43b3ac1c5b1b19f8e00"
+checksum = "600956e2d840c194eedfc5d18f8242bc2e17c7775b6684488af3a9fff6fe3287"
 
 [[package]]
 name = "windows_x86_64_gnu"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ca2b8a661f7628cbd23440e50b05d705db3686f894fc9580820623656af974b1"
+checksum = "ea99ff3f8b49fb7a8e0d305e5aec485bd068c2ba691b6e277d29eaeac945868a"
 
 [[package]]
 name = "windows_x86_64_gnullvm"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7896dbc1f41e08872e9d5e8f8baa8fdd2677f29468c4e156210174edc7f7b953"
+checksum = "8f1a05a1ece9a7a0d5a7ccf30ba2c33e3a61a30e042ffd247567d1de1d94120d"
 
 [[package]]
 name = "windows_x86_64_msvc"
-version = "0.48.0"
+version = "0.48.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a"
+checksum = "d419259aba16b663966e29e6d7c6ecfa0bb8425818bb96f6f1f3c3eb71a6e7b9"
 
 [[package]]
 name = "winnow"
-version = "0.5.4"
+version = "0.5.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "acaaa1190073b2b101e15083c38ee8ec891b5e05cbee516521e94ec008f61e64"
+checksum = "1e461589e194280efaa97236b73623445efa195aa633fd7004f39805707a9d53"
 dependencies = [
  "memchr",
 ]

Cargo.toml

@@ -1,16 +1,18 @@
 [workspace]
 members = [
+    "changeset",
+    "config",
+    "config-derive",
+    "coordinates",
     "cyberpunk-splash",
     "dashboard",
+    "emseries",
+    "flow",
     "fluent-ergonomics",
     "geo-types",
+    "hex-grid",
     "ifc",
     "memorycache",
     "screenplay",
-    "emseries",
-    "coordinates",
-    "flow",
     "sgf",
-    "changeset",
-    "hex-grid",
 ]

build.sh

@@ -3,19 +3,21 @@
 set -euo pipefail
 
 RUST_ALL_TARGETS=(
+    "changeset"
+    "config"
+    "config-derive"
+    "coordinates"
+    "cyberpunk-splash"
     "dashboard"
+    "emseries"
+    "flow"
+    "fluent-ergonomics"
+    "geo-types"
+    "hex-grid"
     "ifc"
     "memorycache"
-    "geo-types"
-    "fluent-ergonomics"
-    "cyberpunk-splash"
     "screenplay"
-    "emseries"
-    "coordinates"
-    "flow"
     "sgf"
-    "changeset"
-    "hex-grid"
 )
 
 build_rust_targets() {

config-derive/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "config-derive"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+proc-macro = true
+
+[dependencies]
+quote           = { version = "1" }
+syn             = { version = "1", features = [ "extra-traits" ] }
+

config-derive/src/lib.rs

@@ -0,0 +1,23 @@
+extern crate proc_macro;
+
+use proc_macro::TokenStream;
+use quote::quote;
+
+use syn::{parse_macro_input, DeriveInput};
+
+#[proc_macro_derive(ConfigOption)]
+pub fn derive(input: TokenStream) -> TokenStream {
+    let DeriveInput { ident, .. } = parse_macro_input!(input as DeriveInput);
+
+    let result = quote! {
+        impl From<&Config> for Option<#ident> {
+            fn from(config: &Config) -> Self {
+                match config.values.get(&ConfigName::#ident) {
+                    Some(ConfigOption::#ident(val)) => Some(val.clone()),
+                    _ => None,
+                }
+            }
+        }
+    };
+    result.into()
+}

config/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "config"
+version = "0.1.0"
+edition = "2021"
+
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+config-derive   = { path = "../config-derive" }
+serde_json      = { version = "1" }
+serde           = { version = "1", features = [ "derive" ] }
+thiserror       = { version = "1" }
+
+[dev-dependencies]
+cool_asserts    = { version = "2" }

config/src/lib.rs

@@ -0,0 +1,154 @@
+pub use config_derive::ConfigOption;
+use thiserror::Error;
+
+#[derive(Debug, Error)]
+pub enum ConfigReadError {
+    #[error("Cannot read the configuration file: {0}")]
+    CannotRead(std::io::Error),
+    #[error("Cannot open the configuration file for reading: {0}")]
+    CannotOpen(std::io::Error),
+    #[error("Invalid json data found in the configurationfile: {0}")]
+    InvalidJSON(serde_json::Error),
+}
+
+macro_rules! define_config {
+    ($($name:ident($struct:ident),)+) => (
+        use serde::{Deserialize, Serialize};
+        use std::{
+            collections::HashMap,
+            fs::File,
+            hash::Hash,
+            io::{ErrorKind, Read},
+            path::PathBuf,
+        };
+
+        #[derive(Clone, Debug, Hash, PartialEq, Eq, Serialize, Deserialize)]
+        pub enum ConfigName {
+            $($name),+
+        }
+
+        #[derive(Clone, Debug, Serialize, Deserialize)]
+        pub enum ConfigOption {
+            $($name($struct)),+
+        }
+
+        #[derive(Clone, Debug)]
+        pub struct Config {
+            values: HashMap<ConfigName, ConfigOption>,
+        }
+
+        impl Config {
+            pub fn new() -> Self {
+                Self {
+                    values: HashMap::new(),
+                }
+            }
+
+            pub fn from_path(config_path: PathBuf) -> Result<Self, ConfigReadError> {
+                let mut settings = config_path.clone();
+                settings.push("config");
+
+                match File::open(settings) {
+                    Ok(mut file) => {
+                        let mut buf = String::new();
+                        file.read_to_string(&mut buf)
+                            .map_err(|err| ConfigReadError::CannotRead(err))?;
+                        let values = serde_json::from_str(buf.as_ref())
+                            .map_err(|err| ConfigReadError::InvalidJSON(err))?;
+                        Ok(Self {
+                            values,
+                        })
+                    }
+                    Err(io_err) => {
+                        match io_err.kind() {
+                            ErrorKind::NotFound => {
+                                /* create the path and an empty file */
+                                Ok(Self {
+                                    values: HashMap::new(),
+                                })
+                            }
+                            _ => Err(ConfigReadError::CannotOpen(io_err)),
+                        }
+                    }
+                }
+            }
+
+            pub fn set(&mut self, val: ConfigOption) {
+                let _ = match val {
+                    $(ConfigOption::$struct(_) => self.values.insert(ConfigName::$name, val)),+
+                };
+            }
+
+            pub fn get<'a, T>(&'a self) -> Option<T>
+            where
+                Option<T>: From<&'a Self>,
+            {
+                self.into()
+            }
+        }
+    )
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+    use cool_asserts::assert_matches;
+
+    define_config! {
+        DatabasePath(DatabasePath),
+        Me(Me),
+    }
+
+    #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, ConfigOption)]
+    pub struct DatabasePath(PathBuf);
+
+    #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+    enum Rank {
+        Kyu(i8),
+        Dan(i8),
+    }
+
+    #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, ConfigOption)]
+    pub struct Me {
+        name: String,
+        rank: Option<Rank>,
+    }
+
+    #[test]
+    fn it_can_set_and_get_options() {
+        let mut config: Config = Config::new();
+        config.set(ConfigOption::DatabasePath(DatabasePath(PathBuf::from(
+            "./fixtures/five_games",
+        ))));
+
+        assert_eq!(
+            Some(DatabasePath(PathBuf::from("./fixtures/five_games"))),
+            config.get()
+        );
+    }
+
+    #[test]
+    fn it_can_serialize_and_deserialize() {
+        let mut config = Config::new();
+        config.set(ConfigOption::DatabasePath(DatabasePath(PathBuf::from(
+            "fixtures/five_games",
+        ))));
+        config.set(ConfigOption::Me(Me {
+            name: "Savanni".to_owned(),
+            rank: Some(Rank::Kyu(10)),
+        }));
+        let s = serde_json::to_string(&config.values).unwrap();
+        println!("{}", s);
+        let values: HashMap<ConfigName, ConfigOption> = serde_json::from_str(s.as_ref()).unwrap();
+        println!("options: {:?}", values);
+
+        assert_matches!(values.get(&ConfigName::DatabasePath),
+                        Some(ConfigOption::DatabasePath(ref db_path)) =>
+                        assert_eq!(Some(db_path.clone()), config.get())
+        );
+
+        assert_matches!(values.get(&ConfigName::Me), Some(ConfigOption::Me(val)) =>
+            assert_eq!(Some(val.clone()), config.get())
+        );
+    }
+}

rust-toolchain

@@ -1,3 +1,3 @@
 [toolchain]
-channel = "1.68.2"
+channel = "1.71.1"
 targets = [ "wasm32-unknown-unknown" ]