bo4e-core 0.2.0

Core types for BO4E (Business Objects for Energy)
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

//! Additional attributes for extensibility.

use serde::{Deserialize, Serialize};

/// Value type for additional attributes.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[serde(untagged)]
pub enum AttributeValue {
    /// String value
    String(String),
    /// Numeric value (integer or float)
    Number(f64),
    /// Boolean value
    Boolean(bool),
    /// Nested object with more attributes
    Object(Vec<AdditionalAttribute>),
    /// Array of values
    Array(Vec<AttributeValue>),
    /// Null value
    Null,
}

/// Additional attribute for external system IDs and custom metadata.
///
/// This enables interoperability with external systems that need to attach
/// their own identifiers or metadata to BO4E objects.
///
/// # Example
///
/// ```rust
/// use bo4e_core::AdditionalAttribute;
/// use bo4e_core::additional_attribute::AttributeValue;
///
/// let attr = AdditionalAttribute {
///     name: "sap_id".to_string(),
///     value: Some(AttributeValue::String("SAP123".to_string())),
/// };
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub struct AdditionalAttribute {
    /// Name/key of the attribute
    pub name: String,
    /// Value of the attribute (optional)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<AttributeValue>,
}

impl AdditionalAttribute {
    /// Create a new additional attribute with a string value.
    pub fn string(name: impl Into<String>, value: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            value: Some(AttributeValue::String(value.into())),
        }
    }

    /// Create a new additional attribute with a numeric value.
    pub fn number(name: impl Into<String>, value: f64) -> Self {
        Self {
            name: name.into(),
            value: Some(AttributeValue::Number(value)),
        }
    }

    /// Create a new additional attribute with a boolean value.
    pub fn boolean(name: impl Into<String>, value: bool) -> Self {
        Self {
            name: name.into(),
            value: Some(AttributeValue::Boolean(value)),
        }
    }
}

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

    #[test]
    fn test_string_attribute() {
        let attr = AdditionalAttribute::string("system_id", "ABC123");
        assert_eq!(attr.name, "system_id");
        assert_eq!(
            attr.value,
            Some(AttributeValue::String("ABC123".to_string()))
        );
    }

    #[test]
    fn test_number_attribute() {
        let attr = AdditionalAttribute::number("priority", 42.0);
        assert_eq!(attr.name, "priority");
        assert_eq!(attr.value, Some(AttributeValue::Number(42.0)));
    }

    #[test]
    fn test_serialize_attribute() {
        let attr = AdditionalAttribute::string("key", "value");
        let json = serde_json::to_string(&attr).unwrap();
        assert_eq!(json, r#"{"name":"key","value":"value"}"#);
    }

    #[test]
    fn test_deserialize_attribute() {
        let json = r#"{"name":"key","value":"value"}"#;
        let attr: AdditionalAttribute = serde_json::from_str(json).unwrap();
        assert_eq!(attr.name, "key");
        assert_eq!(
            attr.value,
            Some(AttributeValue::String("value".to_string()))
        );
    }

    #[test]
    fn test_deserialize_nested_attribute() {
        let json = r#"{"name":"parent","value":[{"name":"child","value":123}]}"#;
        let attr: AdditionalAttribute = serde_json::from_str(json).unwrap();
        assert_eq!(attr.name, "parent");
        match attr.value {
            Some(AttributeValue::Object(children)) => {
                assert_eq!(children.len(), 1);
                assert_eq!(children[0].name, "child");
            }
            _ => panic!("Expected nested object"),
        }
    }
}