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
use derive_builder::Builder;
use std::marker::PhantomData;

use serde::de::{self, Deserialize, Deserializer, MapAccess, Visitor};
use serde::{ser::SerializeStruct, Serialize};
use serde_json::Value;

use crate::context::PredicateContext;
use crate::json_path::JSONPath;
use crate::predicate::error::PredicateError;
use crate::{FirstOrder, PredicateImpl};

/// The "defined" predicate evaluates as true if the referenced element exists
/// within the target context.
#[derive(Debug, Builder, Clone, PartialEq, Eq)]
#[builder(pattern = "owned", setter(into, strip_option))]
pub struct Defined {
    /// Must be a [JSON Pointer](https://tools.ietf.org/html/rfc6901)
    /// If the "path" member is not specified within the predicate object, it's value is assumed to be an empty string.
    pub path: Option<JSONPath>,
}

impl Serialize for Defined {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        let mut state = serializer.serialize_struct("Defined", 2)?;
        state.serialize_field("op", "defined")?;
        state.serialize_field("path", &self.path)?;
        state.end()
    }
}

impl<'de> Deserialize<'de> for Defined {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[allow(non_camel_case_types)]
        enum Field {
            op,
            path,
            __ignore,
        }
        struct FieldVisitor;

        impl<'de> Visitor<'de> for FieldVisitor {
            type Value = Field;
            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("field identifier")
            }

            fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
            where
                E: de::Error,
            {
                match value {
                    "op" => Ok(Field::op),
                    "path" => Ok(Field::path),
                    _ => Ok(Field::__ignore),
                }
            }
        }

        impl<'de> Deserialize<'de> for Field {
            #[inline]
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: Deserializer<'de>,
            {
                Deserializer::deserialize_identifier(deserializer, FieldVisitor)
            }
        }

        struct VisitorDefined<'de> {
            marker: PhantomData<Defined>,
            lifetime: PhantomData<&'de ()>,
        }

        impl<'de> Visitor<'de> for VisitorDefined<'de> {
            type Value = Defined;
            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("Defined")
            }

            #[inline]
            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
            where
                A: MapAccess<'de>,
            {
                let mut path: Option<Option<JSONPath>> = None;
                let mut op: Option<String> = None;

                while let Some(key) = MapAccess::next_key::<Field>(&mut map)? {
                    match key {
                        Field::op => {
                            if op.is_some() {
                                return Err(serde::de::Error::duplicate_field("op"));
                            }
                            op = Some(MapAccess::next_value::<String>(&mut map)?);
                        }
                        Field::path => {
                            if path.is_some() {
                                return Err(serde::de::Error::duplicate_field("path"));
                            }
                            path = Some(MapAccess::next_value::<Option<JSONPath>>(&mut map)?);
                        }
                        Field::__ignore => {}
                    }
                }

                let path = path.ok_or(serde::de::Error::missing_field("path"))?;
                let op = op.ok_or(serde::de::Error::missing_field("op"))?;

                if op != "defined" {
                    return Err(serde::de::Error::custom("`op` should be `defined`"));
                }

                Ok(Defined { path })
            }
        }

        const FIELDS: &[&str] = &["path", "op"];
        Deserializer::deserialize_struct(
            deserializer,
            "Defined",
            FIELDS,
            VisitorDefined {
                marker: PhantomData::<Defined>,
                lifetime: PhantomData,
            },
        )
    }
}

impl From<Defined> for FirstOrder {
    fn from(value: Defined) -> Self {
        FirstOrder::Defined(value)
    }
}

impl PredicateImpl for Defined {
    fn evaluate(&self, data: &Value, ctx: PredicateContext) -> Result<bool, PredicateError> {
        let path = ctx.final_path(&self.path).unwrap_or(JSONPath::empty());
        let ptr = path.take();

        let _context_value = ptr.get(data)?;

        // The "defined" predicate evaluates as true if the referenced element
        // exists within the target context.
        //
        // If the element doesn't exist we woulnd't be here so even if
        // it's null, it's enough to tell it exists.
        Ok(true)
    }
}

#[cfg(test)]
mod tests {
    use serde::Deserialize;

    use crate::{json_path::JSONPath, predicate::first_order::defined::Defined};

    #[test]
    fn snapshot_test() {
        let defined_expect = serde_json::json!({
             "op": "defined",
             "path": "/a/b",
        });

        let defined = Defined {
            path: Some(JSONPath::new("/a/b").unwrap()),
        };

        assert_eq!(serde_json::to_value(defined).unwrap(), defined_expect);
    }

    #[test]
    fn deser_test() {
        let defined_expect = serde_json::json!({
             "op": "defined",
             "path": "/a/b",
        });

        let defined = Defined {
            path: Some(JSONPath::new("/a/b").unwrap()),
        };

        let deser = Defined::deserialize(defined_expect).unwrap();

        assert_eq!(defined, deser);
    }
}