From 52c65affa2645a9ab7883b6e4d4007a8a56d908a Mon Sep 17 00:00:00 2001 From: Gareth Johnson Date: Mon, 26 Feb 2024 14:12:38 +0000 Subject: [PATCH] Remove ref display name injection + make decoder visitor public --- .../encoding/decode_ref_dis_factory.rs | 65 ----------------- src/haystack/encoding/json/decode.rs | 72 +++++++++---------- src/haystack/encoding/json/encode.rs | 17 ++--- src/haystack/encoding/mod.rs | 2 - 4 files changed, 37 insertions(+), 119 deletions(-) delete mode 100644 src/haystack/encoding/decode_ref_dis_factory.rs diff --git a/src/haystack/encoding/decode_ref_dis_factory.rs b/src/haystack/encoding/decode_ref_dis_factory.rs deleted file mode 100644 index 221bded..0000000 --- a/src/haystack/encoding/decode_ref_dis_factory.rs +++ /dev/null @@ -1,65 +0,0 @@ -// Copyright (C) 2020 - 2024, J2 Innovations - -use std::borrow::Cow; -use std::sync::RwLock; - -/// Enables display values to be injected into encoded/decoded Ref objects. -/// -/// This is used to handle the case whereby pre-calculated display -/// names for Refs need to be utilized when encoding/decoding haystack data. -/// -/// Please note, the return type is a `Cow`. At some point we'll make `Ref` a little -/// more flexible regarding how it holds its display data. -type RefDisFactoryFunc<'a> = Box) -> Option> + Send + Sync>; - -/// Holds the Ref factory function used for creating Refs. -static REF_DIS_FACTORY_FUNC: RwLock> = RwLock::new(None); - -/// Get a ref's display name value from any registered factory. -pub fn get_ref_dis_from_factory<'a>(val: &str, dis: Option<&'a str>) -> Option> { - if let Some(func) = REF_DIS_FACTORY_FUNC.read().unwrap().as_ref() { - func(val, dis) - } else { - dis.map(Cow::Borrowed) - } -} - -/// Set the factory function for getting ref display name values. -pub fn set_ref_dis_factory(factory_fn: Option>) { - *REF_DIS_FACTORY_FUNC.write().unwrap() = factory_fn; -} - -#[cfg(test)] -mod test { - use std::{borrow::Cow, sync::Mutex}; - - use super::{get_ref_dis_from_factory, set_ref_dis_factory}; - - // Use a mutex to prevent unit tests from interfering with each other. One of the tests - // sets some global data so they can overlap. - static MUTEX: Mutex<()> = Mutex::new(()); - - #[test] - fn make_ref_returns_ref() { - let _ = MUTEX.lock(); - - let dis = get_ref_dis_from_factory("a", Some("c")); - - assert_eq!(dis, Some(Cow::Borrowed("c"))); - } - - #[test] - fn make_ref_from_factory_returns_ref() { - let _ = MUTEX.lock(); - - let factory_fn = Box::new(|_: &str, _: Option<&str>| Some(Cow::Owned(String::from("c")))); - - set_ref_dis_factory(Some(factory_fn)); - - let dis = get_ref_dis_from_factory("a", Some("b")); - - assert_eq!(dis, Some(Cow::Borrowed("c"))); - - set_ref_dis_factory(None); - } -} diff --git a/src/haystack/encoding/json/decode.rs b/src/haystack/encoding/json/decode.rs index d7d558c..e344458 100644 --- a/src/haystack/encoding/json/decode.rs +++ b/src/haystack/encoding/json/decode.rs @@ -3,7 +3,6 @@ //! //! Implement Hayson decoding //! -use crate::encoding::decode_ref_dis_factory::get_ref_dis_from_factory; use crate::haystack::val::{ Column, Coord, Date, DateTime, Dict, Grid, HaystackDict, List, Marker, Na, Number, Ref, Remove, Str, Symbol, Time, Uri, Value as HVal, XStr, @@ -20,7 +19,7 @@ use std::fmt; /// Hayson Marker deserializer impl<'de> Deserialize<'de> for Marker { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; if val.is_marker() { Ok(Marker) } else { @@ -34,7 +33,7 @@ type JsonErr = serde_json::Error; /// Hayson Remove deserializer impl<'de> Deserialize<'de> for Remove { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; if val.is_remove() { Ok(Remove) } else { @@ -46,7 +45,7 @@ impl<'de> Deserialize<'de> for Remove { /// Hayson Remove deserializer impl<'de> Deserialize<'de> for Na { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; if val.is_na() { Ok(Na) } else { @@ -58,7 +57,7 @@ impl<'de> Deserialize<'de> for Na { /// Hayson Number deserializer impl<'de> Deserialize<'de> for Number { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Number(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Number")), @@ -69,7 +68,7 @@ impl<'de> Deserialize<'de> for Number { /// Hayson Date deserializer impl<'de> Deserialize<'de> for Date { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Date(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Date")), @@ -80,7 +79,7 @@ impl<'de> Deserialize<'de> for Date { /// Hayson Time deserializer impl<'de> Deserialize<'de> for Time { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Time(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Time")), @@ -91,7 +90,7 @@ impl<'de> Deserialize<'de> for Time { /// Hayson DateTime deserializer impl<'de> Deserialize<'de> for DateTime { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::DateTime(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson DateTime")), @@ -102,20 +101,9 @@ impl<'de> Deserialize<'de> for DateTime { /// Hayson Ref deserializer impl<'de> Deserialize<'de> for Ref { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { - HVal::Ref(val) => { - let dis = get_ref_dis_from_factory(val.value.as_str(), val.dis.as_deref()); - - Ok(if dis.as_deref() == val.dis.as_deref() { - val - } else { - Ref { - value: val.value, - dis: dis.map(|d| d.into_owned()), - } - }) - } + HVal::Ref(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Ref")), } } @@ -124,7 +112,7 @@ impl<'de> Deserialize<'de> for Ref { /// Hayson Uri deserializer impl<'de> Deserialize<'de> for Uri { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Uri(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Uri")), @@ -135,7 +123,7 @@ impl<'de> Deserialize<'de> for Uri { /// Hayson Symbol deserializer impl<'de> Deserialize<'de> for Symbol { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Symbol(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Symbol")), @@ -146,7 +134,7 @@ impl<'de> Deserialize<'de> for Symbol { /// Hayson Str deserializer impl<'de> Deserialize<'de> for Str { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Str(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Str")), @@ -157,7 +145,7 @@ impl<'de> Deserialize<'de> for Str { /// Hayson Coord deserializer impl<'de> Deserialize<'de> for Coord { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Coord(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Coord")), @@ -168,7 +156,7 @@ impl<'de> Deserialize<'de> for Coord { /// Hayson XStr deserializer impl<'de> Deserialize<'de> for XStr { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::XStr(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson XStr")), @@ -179,7 +167,7 @@ impl<'de> Deserialize<'de> for XStr { /// Hayson XStr deserializer impl<'de> Deserialize<'de> for Dict { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Dict(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Dict")), @@ -190,7 +178,7 @@ impl<'de> Deserialize<'de> for Dict { /// Hayson Grid deserializer impl<'de> Deserialize<'de> for Grid { fn deserialize>(deserializer: D) -> Result { - let val = deserializer.deserialize_any(HValVisitor)?; + let val = deserializer.deserialize_any(JsonValueDecoderVisitor)?; match val { HVal::Grid(val) => Ok(val), _ => Err(D::Error::custom("Invalid Hayson Grid")), @@ -201,13 +189,13 @@ impl<'de> Deserialize<'de> for Grid { /// Hayson deserializer impl<'de> Deserialize<'de> for HVal { fn deserialize>(deserializer: D) -> Result { - deserializer.deserialize_any(HValVisitor) + deserializer.deserialize_any(JsonValueDecoderVisitor) } } -struct HValVisitor; +pub struct JsonValueDecoderVisitor; /// Visitor for Hayson elements -impl<'de> Visitor<'de> for HValVisitor { +impl<'de> Visitor<'de> for JsonValueDecoderVisitor { type Value = HVal; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { @@ -387,17 +375,21 @@ fn parse_number(dict: &Dict) -> Result { } fn parse_ref(dict: &Dict) -> Result { - dict.get_str("val") - .map(|val| { - let dis_str = dict.get_str("dis").map(|d| d.as_str()); - let dis = get_ref_dis_from_factory(&val.value, dis_str).map(|val| val.into_owned()); - Ref { + match dict.get_str("val") { + Some(val) => match dict.get_str("dis") { + Some(dis) => Ok(Ref { value: val.value.clone(), - dis, + dis: Some(dis.value.clone()), } - .into() - }) - .ok_or_else(|| JsonErr::custom("Missing or invalid 'val'")) + .into()), + None => Ok(Ref { + value: val.value.clone(), + dis: None, + } + .into()), + }, + None => Err(JsonErr::custom("Missing or invalid 'val'")), + } } fn parse_symbol(dict: &Dict) -> Result { diff --git a/src/haystack/encoding/json/encode.rs b/src/haystack/encoding/json/encode.rs index 105cf93..c232635 100644 --- a/src/haystack/encoding/json/encode.rs +++ b/src/haystack/encoding/json/encode.rs @@ -6,12 +6,9 @@ use chrono::SecondsFormat; -use crate::{ - encoding::decode_ref_dis_factory::get_ref_dis_from_factory, - haystack::val::{ - Column, Coord, Date, DateTime, Dict, Grid, Marker, Na, Number, Ref, Remove, Symbol, Time, - Uri, Value as HVal, XStr, - }, +use crate::haystack::val::{ + Column, Coord, Date, DateTime, Dict, Grid, Marker, Na, Number, Ref, Remove, Symbol, Time, Uri, + Value as HVal, XStr, }; use serde::ser::{Serialize, SerializeMap, SerializeSeq, Serializer}; @@ -57,12 +54,8 @@ impl Serialize for Ref { let mut map = serializer.serialize_map(Some(if self.dis.is_none() { 2 } else { 3 }))?; map.serialize_entry("_kind", "ref")?; map.serialize_entry("val", &self.value)?; - - let dis = get_ref_dis_from_factory(self.value.as_str(), self.dis.as_deref()) - .map(|v| v.into_owned()) - .or_else(|| self.dis.clone()); - - if dis.is_some() { + if self.dis.is_some() { + let dis = self.dis.clone(); map.serialize_entry("dis", &dis)?; } map.end() diff --git a/src/haystack/encoding/mod.rs b/src/haystack/encoding/mod.rs index 6a32bb0..eeb7bac 100644 --- a/src/haystack/encoding/mod.rs +++ b/src/haystack/encoding/mod.rs @@ -7,5 +7,3 @@ pub mod json; #[cfg(feature = "zinc")] pub mod zinc; - -pub mod decode_ref_dis_factory;