json-predicate 0.1.16

JSON Predicate lib based on draft-snell-json-07
Documentation
use derive_builder::Builder;
use serde_json::Value;
use std::marker::PhantomData;

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

use crate::json_path::JSONPath;
use crate::predicate::context::PredicateContext;
use crate::predicate::error::PredicateError;
use crate::predicate::PredicateImpl;

use super::FirstOrder;

/// The JSON Patch "test" operation, as defined by [RFC6902, Section 4.6](https://datatracker.ietf.org/doc/html/rfc6902#section-4.6),
/// can be used as a First Order Predicate operation.
/// It evaluates as true if the referenced element exists and specifies a value
/// that is exactly equal to that provided by the predicate's "value" member.
/// The rules for evaluating equality are identical to those defined within [RFC6902, Section 4.6](https://datatracker.ietf.org/doc/html/rfc6902#section-4.6),
/// with one exception given for optional case-insensitive comparisons.
#[derive(Debug, Clone, PartialEq, Eq, Builder)]
#[builder(pattern = "owned", setter(into, strip_option))]
pub struct Test {
    /// 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>,
    #[builder(default)]
    pub ignore_case: bool,
    pub value: serde_json::Value,
}

impl Serialize for Test {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        let mut state = serializer.serialize_struct("Test", 3)?;
        if self.ignore_case {
            state.serialize_field("op", "test-")?;
        } else {
            state.serialize_field("op", "test")?;
        }
        state.serialize_field("path", &self.path)?;
        state.serialize_field("value", &self.value)?;
        state.end()
    }
}

impl<'de> Deserialize<'de> for Test {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[allow(non_camel_case_types)]
        enum Field {
            op,
            path,
            value,
            __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),
                    "value" => Ok(Field::value),
                    _ => 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 VisitorTest<'de> {
            marker: PhantomData<Test>,
            lifetime: PhantomData<&'de ()>,
        }

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

            #[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 value: Option<serde_json::Value> = 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::value => {
                            if value.is_some() {
                                return Err(serde::de::Error::duplicate_field("value"));
                            }
                            value = Some(MapAccess::next_value::<serde_json::Value>(&mut map)?);
                        }
                        Field::__ignore => {}
                    }
                }

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

                let ignore_case = match op.as_str() {
                    "test" => false,
                    "test-" => true,
                    _ => {
                        return Err(serde::de::Error::custom(
                            "`op` should be either `test` or `test-`",
                        ));
                    }
                };

                Ok(Test {
                    path,
                    ignore_case,
                    value,
                })
            }
        }

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

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

impl PredicateImpl for Test {
    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 value = &self.value;
        let context_value = ptr.get(data)?;

        if self.ignore_case {
            Ok(context_value.to_string().to_lowercase() == value.to_string().to_lowercase())
        } else {
            Ok(context_value == value)
        }
    }
}

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

    use crate::{json_path::JSONPath, predicate::first_order::test::Test};

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

        let end = Test {
            path: Some(JSONPath::new("/a/b").unwrap()),
            ignore_case: false,
            value: serde_json::Value::String("val".to_string()),
        };

        assert_eq!(serde_json::to_value(end).unwrap(), end_expect);
    }

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

        let end = Test {
            path: Some(JSONPath::new("/a/b").unwrap()),
            ignore_case: false,
            value: serde_json::Value::String("val".to_string()),
        };

        let deser = Test::deserialize(end_expect).unwrap();

        assert_eq!(end, deser);
    }
}