cdevents-sdk 0.4.1

A Rust SDK for CDEvents
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

use std::str::FromStr;

use serde::{Deserialize, Serialize};

use crate::{Content, Id, UriReference};

/// see <https://github.com/cdevents/spec/blob/main/spec.md#cdevent-subject>
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct Subject {
    #[serde(rename = "content")]
    content: Content,
    #[serde(rename = "id")]
    id: Id,
    #[serde(
        rename = "source",
        default,
        skip_serializing_if = "Option::is_none",
    )]
    source: Option<UriReference>,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none", default)]
    #[deprecated = "this file was removed since cdevents spec 0.5"]
    #[doc(hidden)]
    ty: Option<String>,
}

impl Subject {
    /// see <https://github.com/cdevents/spec/blob/main/spec.md#id-subject>
    pub fn id(&self) -> &Id {
        &self.id
    }

    pub fn with_id(mut self, id: Id) -> Self {
        self.id = id;
        self
    }

    /// see <https://github.com/cdevents/spec/blob/main/spec.md#source-subject>
    pub fn source(&self) -> &Option<UriReference> {
        &self.source
    }

    pub fn with_source(mut self, source: UriReference) -> Self {
        self.source = Some(source);
        self
    }

    // /// see <https://github.com/cdevents/spec/blob/main/spec.md#type-context>
    // /// derived from content
    // pub fn ty(&self) -> &str {
    //     &self.ty
    // }

    /// see <https://github.com/cdevents/spec/blob/main/spec.md#content>
    pub fn content(&self) -> &Content {
        &self.content
    }

    #[allow(deprecated)]
    pub fn from_json(ty: &str, json: serde_json::Value) -> Result<Self, serde_json::Error> {
        Ok(Subject {
            id: json["id"]
                .as_str()
                .ok_or_else(|| serde::de::Error::missing_field("id"))?
                .try_into()
                .map_err(serde::de::Error::custom)?,
            ty: json["type"]
                .as_str().map(|s| s.to_owned()),
            source: match json["source"].as_str() {
                None => None,
                Some(s) => Some(
                    UriReference::from_str(s).map_err(serde::de::Error::custom)?,
                ),
            },
            content: Content::from_json(ty, json["content"].clone())?,
        })
    }
}

impl<T> From<T> for Subject where T: Into<Content>{
    #[allow(deprecated)]
    fn from(content: T) -> Self {
        let content = content.into();
        // TODO remove this hack when remove support for spec < 0.5
        let ty = crate::extract_subject_predicate(content.ty())
            .map(|(s, _)| s.to_string());
        Self {
            content,
            id: Id::default(),
            source: None,
            ty,
        }
    }
}

#[cfg(feature = "testkit")]
impl<> proptest::arbitrary::Arbitrary for Subject {
    type Parameters = ();
    type Strategy = proptest::strategy::BoxedStrategy<Self>;
    fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy {
        use proptest::prelude::*;
        (
            any::<Content>(),
            any::<Id>(),
            any::<Option<UriReference>>(),
        ).prop_map(|(content, id, source)| {
            let mut subject = Subject::from(content).with_id(id);
            if let Some(source) = source {
                subject = subject.with_source(source);
            }
            subject
        }).boxed()
    }
}


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

    proptest! {
        #[test]
        #[cfg(feature = "testkit")]
        fn jsonify_arbitraries(s in any::<Subject>()) {
            // Not enough information into json of subject to deserialize into the same sut content
            // so only check that it could be serialized
            serde_json::to_string(&s).unwrap();
        }
    }
}