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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

//! Surcharge/discount (AufAbschlag) component.

use serde::{Deserialize, Serialize};

use crate::enums::{Currency, SurchargeTarget, SurchargeType};
use crate::traits::{Bo4eMeta, Bo4eObject};

use super::PriceTier;

/// A surcharge or discount applied to a price.
///
/// German: AufAbschlag
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::Surcharge;
///
/// let surcharge = Surcharge {
///     description: Some("Ökosteuer".to_string()),
///     value: Some(0.02),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Surcharge {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

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

    /// Type of surcharge (AufAbschlagstyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub surcharge_type: Option<SurchargeType>,

    /// Value of the surcharge (Wert)
    /// Positive = surcharge, negative = discount
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<f64>,

    /// Currency unit for absolute surcharges (Waehrungseinheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,

    /// Target price/cost category (AufAbschlagsziel)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target: Option<SurchargeTarget>,

    /// Tiered surcharge values (Staffeln)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tiers: Vec<PriceTier>,

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

    /// Website for published information (Website)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
}

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

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

    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_surcharge() {
        let surcharge = Surcharge {
            description: Some("Ökosteuer".to_string()),
            value: Some(0.02),
            surcharge_type: Some(SurchargeType::Absolute),
            currency: Some(Currency::Eur),
            ..Default::default()
        };

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

    #[test]
    fn test_discount() {
        let discount = Surcharge {
            description: Some("Neukunden-Rabatt".to_string()),
            value: Some(-50.0),
            surcharge_type: Some(SurchargeType::Absolute),
            currency: Some(Currency::Eur),
            ..Default::default()
        };

        assert!(discount.value.unwrap() < 0.0);
    }

    #[test]
    fn test_percentage_surcharge() {
        let surcharge = Surcharge {
            description: Some("MwSt".to_string()),
            value: Some(19.0),
            surcharge_type: Some(SurchargeType::Relative),
            ..Default::default()
        };

        assert_eq!(surcharge.surcharge_type, Some(SurchargeType::Relative));
    }

    #[test]
    fn test_tiered_surcharge() {
        let surcharge = Surcharge {
            description: Some("Staffelrabatt".to_string()),
            tiers: vec![
                PriceTier {
                    lower_limit: Some(0.0),
                    upper_limit: Some(1000.0),
                    unit_price: Some(0.05),
                    ..Default::default()
                },
                PriceTier {
                    lower_limit: Some(1000.0),
                    upper_limit: Some(5000.0),
                    unit_price: Some(0.03),
                    ..Default::default()
                },
            ],
            ..Default::default()
        };

        assert_eq!(surcharge.tiers.len(), 2);
    }

    #[test]
    fn test_default() {
        let surcharge = Surcharge::default();
        assert!(surcharge.description.is_none());
        assert!(surcharge.value.is_none());
        assert!(surcharge.tiers.is_empty());
    }

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