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
use std::cmp::{Ordering, PartialEq, PartialOrd};
use std::fmt;
use std::marker::PhantomData;
use std::ops;

/// A wrapper used to embed JSON inside other structures
pub struct EmbedJson<T> {
    _pd: PhantomData<T>,
    pub inner: String,
}

impl<T> EmbedJson<T> {
    pub fn from_string(inner: String) -> Self {
        Self {
            _pd: PhantomData,
            inner,
        }
    }
}

impl<T> From<String> for EmbedJson<T> {
    fn from(inner: String) -> Self {
        Self::from_string(inner)
    }
}

impl<T> Clone for EmbedJson<T> {
    fn clone(&self) -> Self {
        Self::from_string(self.inner.clone())
    }
}

impl<T> ops::Deref for EmbedJson<T> {
    type Target = str;
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<T> fmt::Debug for EmbedJson<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_tuple("EmbedJson")
            .field(&format_args!("{}", &self.inner))
            .finish()
    }
}

impl<T> fmt::Display for EmbedJson<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(self.inner.as_str())
    }
}

impl<T> PartialEq<EmbedJson<T>> for EmbedJson<T> {
    fn eq(&self, other: &EmbedJson<T>) -> bool {
        self.inner == other.inner
    }
}

impl<T> Eq for EmbedJson<T> {}

impl<T> PartialOrd for EmbedJson<T> {
    fn partial_cmp(&self, other: &EmbedJson<T>) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl<T> Ord for EmbedJson<T> {
    fn cmp(&self, other: &EmbedJson<T>) -> Ordering {
        self.inner.cmp(&other.inner)
    }
}

/// A helper method for converting an embeddable type into an `EmbedJson<T>`
#[cfg(feature = "serde")]
pub fn embed_json<T: EmbedExtractJson>(
    value: &T::Inner,
) -> Result<EmbedJson<T>, crate::ConversionError> {
    EmbedJson::embed(value)
}

/// A trait implemented by types to facilitate embedding and extracting JSON
#[cfg(feature = "serde")]
pub trait EmbedExtractJson {
    type Inner: serde::Serialize + for<'de> serde::Deserialize<'de>;
}

#[cfg(feature = "serde")]
mod serde_support {
    use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};
    use serde_json::value::{RawValue, Value};
    use std::convert::TryFrom;

    use super::{EmbedExtractJson, EmbedJson};
    use crate::ConversionError;

    impl<T: EmbedExtractJson> EmbedJson<T> {
        pub fn embed(value: &T::Inner) -> Result<Self, crate::ConversionError> {
            Ok(serde_json::to_string(value).map(Self::from_string)?)
        }

        pub fn extract(&self) -> Result<T::Inner, crate::ConversionError> {
            Ok(serde_json::from_str(&self.inner)?)
        }
    }

    impl<T> Serialize for EmbedJson<T> {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: Serializer,
        {
            let raw = unsafe { std::mem::transmute::<&str, &RawValue>(&self.inner) };
            raw.serialize(serializer)
        }
    }

    impl<'de, T> Deserialize<'de> for EmbedJson<T> {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            let value = Value::deserialize(deserializer)?;
            Ok(EmbedJson::from_value(value).map_err(D::Error::custom)?)
        }
    }

    impl<T> EmbedJson<T> {
        pub fn from_value(value: Value) -> Result<Self, ConversionError> {
            let inner = serde_json::to_string(&value)?;
            Ok(Self::from_string(inner))
        }

        pub fn to_value(&self) -> Result<Value, ConversionError> {
            Ok(serde_json::to_value(&self.inner)?)
        }
    }

    impl<T> TryFrom<Value> for EmbedJson<T> {
        type Error = ConversionError;

        fn try_from(value: Value) -> Result<Self, Self::Error> {
            Self::from_value(value)
        }
    }
}

#[cfg(test)]
mod tests {
    #[cfg(feature = "serde")]
    use super::*;

    #[test]
    fn embed_json_string() {
        #[derive(Debug, PartialEq, Eq)]
        struct V {
            val: i32,
        }

        struct TestEmbed {
            v: EmbedJson<V>,
        }

        let json = r#"{"val":  5}"#;
        let embed = TestEmbed {
            v: EmbedJson::from_string(json.to_string()),
        };
        // literal embedded value is maintained as-is
        assert_eq!(embed.v.to_string(), json);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn embed_json_round_trip() {
        #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
        struct V {
            val: i32,
        }

        impl EmbedExtractJson for V {
            type Inner = Self;
        }

        #[derive(Serialize, Deserialize)]
        struct TestEmbed {
            a: i32,
            v: EmbedJson<V>,
        }

        let json = r#"{"a": 10, "v": {"val":  5}}"#;
        let test = serde_json::from_str::<TestEmbed>(json).unwrap();
        // inner value is parsed and re-serialized
        assert_eq!(test.v.inner, r#"{"val":5}"#);

        let inner = test.v.extract().unwrap();
        let cmp = V { val: 5 };
        assert_eq!(cmp, inner);

        let embed = embed_json::<V>(&inner).unwrap();
        assert_eq!(embed.inner, r#"{"val":5}"#);

        let reenc = serde_json::to_string(&test).unwrap();
        assert_eq!(reenc, r#"{"a":10,"v":{"val":5}}"#);
    }
}