liwe 0.6.1

IWE core library
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
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

use serde::Deserialize;
use serde_yaml::{Mapping, Value};

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawOperation {
    #[serde(default)]
    pub filter: Option<RawFilter>,
    #[serde(default)]
    pub project: Option<RawProjection>,
    #[serde(default, rename = "addFields")]
    pub add_fields: Option<RawProjection>,
    #[serde(default)]
    pub sort: Option<RawSort>,
    #[serde(default)]
    pub limit: Option<i64>,
    #[serde(default)]
    pub update: Option<RawUpdate>,
}

#[derive(Debug, Deserialize)]
#[serde(transparent)]
pub struct RawFilter(pub Mapping);

#[derive(Debug, Deserialize)]
#[serde(transparent)]
pub struct RawProjection(pub Mapping);

#[derive(Debug, Deserialize)]
#[serde(transparent)]
pub struct RawSort(pub Mapping);

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawUpdate {
    #[serde(rename = "$set", default)]
    pub set: Option<Mapping>,
    #[serde(rename = "$unset", default)]
    pub unset: Option<Mapping>,
}

pub fn parse(yaml: &str) -> Result<RawOperation, serde_yaml::Error> {
    if yaml.trim().is_empty() {
        return Ok(RawOperation::default());
    }
    let value: Value = serde_yaml::from_str(yaml)?;
    if matches!(value, Value::Null) {
        return Ok(RawOperation::default());
    }
    serde_yaml::from_value(value)
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum RawKeyArg {
    Scalar(String),
    Map(RawKeyOpMap),
}

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawKeyOpMap {
    #[serde(rename = "$eq", default)]
    pub eq: Option<String>,
    #[serde(rename = "$ne", default)]
    pub ne: Option<String>,
    #[serde(rename = "$in", default)]
    pub in_: Option<Vec<Value>>,
    #[serde(rename = "$nin", default)]
    pub nin: Option<Vec<Value>>,
}

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawRelationalObj {
    #[serde(rename = "match", default)]
    pub match_: Option<Mapping>,
    #[serde(rename = "maxDepth", default)]
    pub max_depth: Option<i64>,
    #[serde(rename = "minDepth", default)]
    pub min_depth: Option<i64>,
    #[serde(rename = "maxDistance", default)]
    pub max_distance: Option<i64>,
    #[serde(rename = "minDistance", default)]
    pub min_distance: Option<i64>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use indoc::indoc;

    fn parse_ok(yaml: &str) -> RawOperation {
        parse(yaml).expect("expected wire parse to succeed")
    }

    fn parse_err(yaml: &str) -> String {
        parse(yaml)
            .expect_err("expected wire parse to fail")
            .to_string()
    }

    #[test]
    fn empty_yaml_parses_to_default() {
        let op = parse_ok("");
        assert!(op.filter.is_none() && op.update.is_none());
    }

    #[test]
    fn full_operation_round_trips() {
        let op = parse_ok(indoc! {"
            filter:
              status: draft
            project:
              title: 1
            sort:
              modified_at: -1
            limit: 10
            update:
              $set:
                reviewed: true
        "});
        assert!(op.filter.is_some());
        assert!(op.project.is_some());
        assert_eq!(op.sort.as_ref().unwrap().0["modified_at"], -1);
        assert_eq!(op.limit, Some(10));
        assert!(op.update.is_some());
    }

    #[test]
    fn unknown_top_level_field_rejected() {
        let err = parse_err("bogus: 1\n");
        assert!(err.contains("bogus"), "{}", err);
    }

    #[test]
    fn scope_field_rejected() {
        let err = parse_err("scope:\n  notes/foo: { self: true }\n");
        assert!(err.contains("scope"), "{}", err);
    }

    #[test]
    fn limit_string_rejected() {
        let err = parse_err("limit: \"20\"\n");
        assert!(
            err.to_lowercase().contains("invalid type") || err.to_lowercase().contains("expected"),
            "{}",
            err
        );
    }

    #[test]
    fn sort_parses_as_raw_mapping() {
        let op = parse_ok("sort:\n  modified_at: -1\n");
        assert!(op.sort.is_some());
    }
}