eml-nl 0.5.0

Parse, manipulate and emit EML_NL documents
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

use std::sync::LazyLock;

use regex::Regex;
use thiserror::Error;

use crate::{EMLError, EMLValueResultExt, utils::StringValueData};

/// Regular expression for validating ReportingUnitIdentifier id values.
static REPORTING_UNIT_IDENTIFIER_ID_RE: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^((HSB\d+)|((HSB\d+::)?\d{4})|(((HSB\d+::)?\d{4}::)?SB\d+)|(HSB\d+::SB\d+))$")
        .expect("Failed to compile ReportingUnitIdentifier id regex")
});

/// A string of type ReportingUnitIdentifier id as defined in the EML_NL specification
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct ReportingUnitIdentifierId(String);

impl ReportingUnitIdentifierId {
    /// Create a new ReportingUnitIdentifierId from a string, validating its format
    pub fn new(s: impl AsRef<str>) -> Result<Self, EMLError> {
        StringValueData::parse_from_str(s.as_ref()).wrap_value_error()
    }

    /// Get the raw string value of the ReportingUnitIdentifierId.
    pub fn value(&self) -> &str {
        &self.0
    }
}

/// Error returned when a string could not be parsed as a [`ReportingUnitIdentifierId`]
#[derive(Debug, Clone, Error)]
#[error("Invalid reporting unit identifier id: {0}")]
pub struct InvalidReportingUnitIdentifierIdError(String);

impl StringValueData for ReportingUnitIdentifierId {
    type Error = InvalidReportingUnitIdentifierIdError;
    fn parse_from_str(s: &str) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        if REPORTING_UNIT_IDENTIFIER_ID_RE.is_match(s) {
            Ok(ReportingUnitIdentifierId(s.to_string()))
        } else {
            Err(InvalidReportingUnitIdentifierIdError(s.to_string()))
        }
    }

    fn to_raw_value(&self) -> String {
        self.0.clone()
    }
}

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

    #[test]
    fn test_reporting_unit_identifier_id_regex_compiles() {
        LazyLock::force(&REPORTING_UNIT_IDENTIFIER_ID_RE);
    }

    #[test]
    fn test_valid_reporting_unit_identifier_ids() {
        let valid_ids = [
            "HSB123",
            "HSB123::5678",
            "5678",
            "SB456",
            "HSB123::SB456",
            "HSB123::5678::SB456",
        ];
        for id in valid_ids {
            assert!(
                ReportingUnitIdentifierId::new(id).is_ok(),
                "ReportingUnitIdentifierId should accept valid id: {}",
                id
            );
        }
    }

    #[test]
    fn test_invalid_reporting_unit_identifier_ids() {
        let invalid_ids = [
            "",
            "HSB",
            "HSB::123",
            "HSB123::",
            "::5678",
            "HSB123::5678::",
            "HSB123::5678::SB",
        ];
        for id in invalid_ids {
            assert!(
                ReportingUnitIdentifierId::new(id).is_err(),
                "ReportingUnitIdentifierId should reject invalid id: {}",
                id
            );
        }
    }
}