serde-ordered-collections 2.0.0

Ordered serialization/deserialization serde functionality
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

use serde::Serialize;
use std::collections::BTreeMap;

pub fn sorted_serialize<S, K, V, M>(map: M, s: S) -> Result<S::Ok, S::Error>
where
    M: IntoIterator<Item = (K, V)>,
    S: serde::Serializer,
    K: Ord + Serialize + Clone,
    V: Serialize + Clone,
{
    let ordered_map: BTreeMap<K, V> = map.into_iter().collect();
    Serialize::serialize(&ordered_map, s)
}

#[cfg(test)]
mod tests {
    #![allow(non_snake_case)]

    use serde_derive::{Deserialize, Serialize};
    use std::collections::HashMap;

    #[derive(Debug, Serialize, Deserialize, Eq, PartialEq)]
    struct SampleData {
        #[serde(flatten, serialize_with = "super::sorted_serialize")]
        values: HashMap<String, String>,
    }

    #[test]
    fn serde_roundtrip__produces_matching_data() {
        // Given
        let data = SampleData {
            values: {
                let mut map = HashMap::new();
                map.insert("foo".into(), "bar".into());
                map.insert("abc".into(), "def".into());
                map.insert("123".into(), "456".into());

                map
            },
        };

        // When
        let string = serde_yaml::to_string(&data).unwrap();

        // Then
        let deserialized_data: SampleData = serde_yaml::from_str(&string).unwrap();
        assert_eq!(data, deserialized_data);
    }

    #[test]
    fn yaml_to_string__produces_correctly_sorted_order_consistently() {
        for _i in 0..100 {
            // Given
            let data = SampleData {
                values: {
                    let mut map = HashMap::new();
                    map.insert("d".into(), "jkl".into());
                    map.insert("a".into(), "abc".into());
                    map.insert("e".into(), "mno".into());
                    map.insert("c".into(), "ghi".into());
                    map.insert("b".into(), "def".into());

                    map
                },
            };

            // When
            let string = serde_yaml::to_string(&data).unwrap();

            // Then
            assert_eq!(
                string,
                r###"---
a: abc
b: def
c: ghi
d: jkl
e: mno
"###
            );
        }
    }
}