Skip to main content

bo4e_core/com/
seasonal_tariff.rs

1//! Seasonal tariff (Saisontarif) component.
2
3use chrono::NaiveDate;
4use serde::{Deserialize, Serialize};
5
6use crate::traits::{Bo4eMeta, Bo4eObject};
7
8/// A seasonal tariff period with date range and tariff name.
9///
10/// German: Saisontarif
11///
12/// # Example
13///
14/// ```rust
15/// use bo4e_core::com::SeasonalTariff;
16/// use chrono::NaiveDate;
17///
18/// let tariff = SeasonalTariff {
19///     season_name: Some("Winter".to_string()),
20///     start_date: Some(NaiveDate::from_ymd_opt(2024, 11, 1).unwrap()),
21///     end_date: Some(NaiveDate::from_ymd_opt(2025, 3, 31).unwrap()),
22///     ..Default::default()
23/// };
24/// ```
25#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
26#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
27#[cfg_attr(feature = "json-schema", schemars(rename = "Saisontarif"))]
28#[serde(rename_all = "camelCase")]
29pub struct SeasonalTariff {
30    /// BO4E metadata
31    #[serde(flatten)]
32    pub meta: Bo4eMeta,
33
34    /// Name of the season/tariff period (Saisonbezeichnung)
35    #[serde(skip_serializing_if = "Option::is_none")]
36    #[cfg_attr(feature = "json-schema", schemars(rename = "saisonbezeichnung"))]
37    pub season_name: Option<String>,
38
39    /// Start date of the season (Startdatum)
40    #[serde(skip_serializing_if = "Option::is_none")]
41    #[cfg_attr(feature = "json-schema", schemars(rename = "startdatum"))]
42    pub start_date: Option<NaiveDate>,
43
44    /// End date of the season (Enddatum)
45    #[serde(skip_serializing_if = "Option::is_none")]
46    #[cfg_attr(feature = "json-schema", schemars(rename = "enddatum"))]
47    pub end_date: Option<NaiveDate>,
48
49    /// Tariff identifier (Tarifkennung)
50    #[serde(skip_serializing_if = "Option::is_none")]
51    #[cfg_attr(feature = "json-schema", schemars(rename = "tarifkennung"))]
52    pub tariff_id: Option<String>,
53
54    /// Price factor for the season (Preisfaktor)
55    #[serde(skip_serializing_if = "Option::is_none")]
56    #[cfg_attr(feature = "json-schema", schemars(rename = "preisfaktor"))]
57    pub price_factor: Option<f64>,
58}
59
60impl Bo4eObject for SeasonalTariff {
61    fn type_name_german() -> &'static str {
62        "Saisontarif"
63    }
64
65    fn type_name_english() -> &'static str {
66        "SeasonalTariff"
67    }
68
69    fn meta(&self) -> &Bo4eMeta {
70        &self.meta
71    }
72
73    fn meta_mut(&mut self) -> &mut Bo4eMeta {
74        &mut self.meta
75    }
76}
77
78#[cfg(test)]
79mod tests {
80    use super::*;
81
82    #[test]
83    fn test_winter_tariff() {
84        let tariff = SeasonalTariff {
85            season_name: Some("Winter".to_string()),
86            start_date: Some(NaiveDate::from_ymd_opt(2024, 11, 1).unwrap()),
87            end_date: Some(NaiveDate::from_ymd_opt(2025, 3, 31).unwrap()),
88            price_factor: Some(1.2),
89            ..Default::default()
90        };
91
92        let json = serde_json::to_string(&tariff).unwrap();
93        assert!(json.contains("Winter"));
94        assert!(json.contains("1.2"));
95    }
96
97    #[test]
98    fn test_roundtrip() {
99        let tariff = SeasonalTariff {
100            season_name: Some("Summer".to_string()),
101            tariff_id: Some("SUMMER_2024".to_string()),
102            ..Default::default()
103        };
104
105        let json = serde_json::to_string(&tariff).unwrap();
106        let parsed: SeasonalTariff = serde_json::from_str(&json).unwrap();
107        assert_eq!(tariff, parsed);
108    }
109
110    #[test]
111    fn test_bo4e_object_impl() {
112        assert_eq!(SeasonalTariff::type_name_german(), "Saisontarif");
113        assert_eq!(SeasonalTariff::type_name_english(), "SeasonalTariff");
114    }
115}