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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Region criterion (Regionskriterium) component.

use serde::{Deserialize, Serialize};

use crate::enums::{RegionCriterionType, ValidityType};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// Component for modeling a regional criterion.
///
/// Used to define criteria for regional delimitation, such as postal codes,
/// federal states, or network areas.
///
/// German: Regionskriterium
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::RegionCriterion;
/// use bo4e_core::enums::{RegionCriterionType, ValidityType};
///
/// let criterion = RegionCriterion {
///     validity_type: Some(ValidityType::OnlyIn),
///     criterion_type: Some(RegionCriterionType::PostalCode),
///     value: Some("50667".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Regionskriterium"))]
#[serde(rename_all = "camelCase")]
pub struct RegionCriterion {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Whether this is an inclusive or exclusive criterion (Gueltigkeitstyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigkeitstyp"))]
    pub validity_type: Option<ValidityType>,

    /// The type of criterion, e.g., federal state, postal code (Regionskriteriumtyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "regionskriteriumtyp"))]
    pub criterion_type: Option<RegionCriterionType>,

    /// The value the criterion takes, e.g., "NRW" or "50667" (Wert)
    /// Note: For BUNDESWEIT (nationwide), this value is not relevant.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "wert"))]
    pub value: Option<String>,
}

impl Bo4eObject for RegionCriterion {
    fn type_name_german() -> &'static str {
        "Regionskriterium"
    }

    fn type_name_english() -> &'static str {
        "RegionCriterion"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

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

    #[test]
    fn test_region_criterion_default() {
        let criterion = RegionCriterion::default();
        assert!(criterion.validity_type.is_none());
        assert!(criterion.criterion_type.is_none());
        assert!(criterion.value.is_none());
    }

    #[test]
    fn test_region_criterion_postal_code() {
        let criterion = RegionCriterion {
            validity_type: Some(ValidityType::OnlyIn),
            criterion_type: Some(RegionCriterionType::PostalCode),
            value: Some("50667".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&criterion).unwrap();
        assert!(json.contains(r#""validityType":"NUR_IN""#));
        assert!(json.contains(r#""criterionType":"POSTLEITZAHL""#));
        assert!(json.contains(r#""value":"50667""#));
    }

    #[test]
    fn test_region_criterion_federal_state() {
        let criterion = RegionCriterion {
            validity_type: Some(ValidityType::NotIn),
            criterion_type: Some(RegionCriterionType::FederalStateName),
            value: Some("Bayern".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&criterion).unwrap();
        assert!(json.contains(r#""validityType":"NICHT_IN""#));
        assert!(json.contains(r#""criterionType":"BUNDESLAND_NAME""#));
    }

    #[test]
    fn test_region_criterion_nationwide() {
        let criterion = RegionCriterion {
            validity_type: Some(ValidityType::OnlyIn),
            criterion_type: Some(RegionCriterionType::Nationwide),
            value: None, // Not relevant for nationwide
            ..Default::default()
        };

        let json = serde_json::to_string(&criterion).unwrap();
        assert!(json.contains(r#""criterionType":"BUNDESWEIT""#));
        assert!(!json.contains(r#""value""#)); // Should be skipped
    }

    #[test]
    fn test_region_criterion_roundtrip() {
        let criterion = RegionCriterion {
            meta: Bo4eMeta::with_type("Regionskriterium"),
            validity_type: Some(ValidityType::OnlyInCombinationWith),
            criterion_type: Some(RegionCriterionType::MunicipalityName),
            value: Some("Köln".to_string()),
        };

        let json = serde_json::to_string(&criterion).unwrap();
        let parsed: RegionCriterion = serde_json::from_str(&json).unwrap();
        assert_eq!(criterion, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(RegionCriterion::type_name_german(), "Regionskriterium");
        assert_eq!(RegionCriterion::type_name_english(), "RegionCriterion");
    }
}