bo4e-core 0.1.1

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

//! Price sheet (Preisblatt) business object.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::com::{PricePosition, TimePeriod};
use crate::enums::Division;
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A generic price sheet containing price positions.
///
/// German: Preisblatt
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::PriceSheet;
/// use bo4e_core::enums::Division;
///
/// let price_sheet = PriceSheet {
///     designation: Some("Standardpreisblatt 2024".to_string()),
///     division: Some(Division::Electricity),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PriceSheet {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Name/designation of the price sheet (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub designation: Option<String>,

    /// Description (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Energy division (Sparte)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub division: Option<Division>,

    /// Price number/identifier (Preisnummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price_number: Option<String>,

    /// Validity period (Gueltigkeitszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validity_period: Option<TimePeriod>,

    /// Valid from date (Gueltig ab)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub valid_from: Option<DateTime<Utc>>,

    /// Valid until date (Gueltig bis)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub valid_until: Option<DateTime<Utc>>,

    /// Price positions (Preispositionen)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub positions: Vec<PricePosition>,

    /// Publisher of the price sheet
    #[serde(skip_serializing_if = "Option::is_none")]
    pub publisher: Option<Box<super::BusinessPartner>>,
}

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

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

    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_price_sheet_creation() {
        let price_sheet = PriceSheet {
            designation: Some("Standardpreisblatt 2024".to_string()),
            division: Some(Division::Electricity),
            price_number: Some("PB-2024-001".to_string()),
            ..Default::default()
        };

        assert_eq!(
            price_sheet.designation,
            Some("Standardpreisblatt 2024".to_string())
        );
        assert_eq!(price_sheet.division, Some(Division::Electricity));
    }

    #[test]
    fn test_serialize() {
        let price_sheet = PriceSheet {
            meta: Bo4eMeta::with_type("Preisblatt"),
            designation: Some("Test Price Sheet".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&price_sheet).unwrap();
        assert!(json.contains(r#""designation":"Test Price Sheet""#));
        assert!(json.contains(r#""_typ":"Preisblatt""#));
    }

    #[test]
    fn test_roundtrip() {
        let price_sheet = PriceSheet {
            meta: Bo4eMeta::with_type("Preisblatt"),
            designation: Some("Network Fee Sheet".to_string()),
            description: Some("Standard network fees".to_string()),
            division: Some(Division::Electricity),
            price_number: Some("NF-2024".to_string()),
            ..Default::default()
        };

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

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