Merge pull request #572 from EnergySystemsModellingLab/prohibit-dubious-ids

Disallow certain values for IDs

Author: alexdewar

src/id.rs

@@ -12,9 +12,7 @@ impl<T> IDLike for T where T: Eq + Hash + Borrow<str> + Clone + Display + From<S
 
 macro_rules! define_id_type {
     ($name:ident) => {
-        #[derive(
-            Clone, std::hash::Hash, PartialEq, Eq, serde::Deserialize, Debug, serde::Serialize,
-        )]
+        #[derive(Clone, std::hash::Hash, PartialEq, Eq, Debug, serde::Serialize)]
         /// An ID type (e.g. `AgentID`, `CommodityID`, etc.)
         pub struct $name(pub std::rc::Rc<str>);
 
@@ -42,6 +40,32 @@ macro_rules! define_id_type {
             }
         }
 
+        impl<'de> serde::Deserialize<'de> for $name {
+            fn deserialize<D>(deserialiser: D) -> std::result::Result<Self, D::Error>
+            where
+                D: serde::Deserializer<'de>,
+            {
+                use serde::de::Error;
+
+                let id: String = serde::Deserialize::deserialize(deserialiser)?;
+                let id = id.trim();
+                if id.is_empty() {
+                    return Err(D::Error::custom("IDs cannot be empty"));
+                }
+
+                const FORBIDDEN_IDS: [&str; 2] = ["all", "annual"];
+                for forbidden in FORBIDDEN_IDS.iter() {
+                    if id.eq_ignore_ascii_case(forbidden) {
+                        return Err(D::Error::custom(format!(
+                            "'{id}' is an invalid value for an ID"
+                        )));
+                    }
+                }
+
+                Ok(id.into())
+            }
+        }
+
         impl $name {
             /// Create a new ID from a string slice
             pub fn new(id: &str) -> Self {
@@ -114,3 +138,39 @@ impl<ID: IDLike, V> IDCollection<ID> for IndexMap<ID, V> {
         Ok(found)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rstest::rstest;
+
+    use serde::Deserialize;
+
+    #[derive(Debug, Deserialize)]
+    struct Record {
+        id: GenericID,
+    }
+
+    fn deserialise_id(id: &str) -> Result<Record> {
+        Ok(toml::from_str(&format!("id = \"{id}\""))?)
+    }
+
+    #[rstest]
+    #[case("commodity1")]
+    #[case("some commodity")]
+    #[case("PROCESS")]
+    #[case("café")] // unicode supported
+    fn test_deserialise_id_valid(#[case] id: &str) {
+        assert_eq!(deserialise_id(id).unwrap().id.to_string(), id);
+    }
+
+    #[rstest]
+    #[case("")]
+    #[case("all")]
+    #[case("annual")]
+    #[case("ALL")]
+    #[case(" ALL ")]
+    fn test_deserialise_id_invalid(#[case] id: &str) {
+        assert!(deserialise_id(id).is_err());
+    }
+}