arvo 0.9.0

Validated, immutable value objects for common domain types (email, money, identifiers, …)
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

use crate::errors::ValidationError;
use crate::traits::ValueObject;
use std::net::Ipv4Addr;

/// Input type for [`IpV4Address`].
pub type IpV4AddressInput = String;

/// Output type for [`IpV4Address`].
pub type IpV4AddressOutput = String;

/// A validated IPv4 address (e.g. `"192.168.1.1"`).
///
/// **Normalisation:** trimmed. Leading zeros in octets are rejected
/// (e.g. `"192.168.001.001"` is invalid).
///
/// # Example
///
/// ```rust,ignore
/// use arvo::net::IpV4Address;
/// use arvo::traits::ValueObject;
///
/// let ip = IpV4Address::new("192.168.1.1".into())?;
/// assert_eq!(ip.value(), "192.168.1.1");
///
/// let ip: IpV4Address = "10.0.0.1".try_into()?;
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
pub struct IpV4Address(String);

impl ValueObject for IpV4Address {
    type Input = IpV4AddressInput;
    type Output = IpV4AddressOutput;
    type Error = ValidationError;

    fn new(value: Self::Input) -> Result<Self, Self::Error> {
        let trimmed = value.trim();

        if trimmed.is_empty() {
            return Err(ValidationError::empty("IpV4Address"));
        }

        // Reject leading zeros in any octet
        for octet in trimmed.split('.') {
            if octet.len() > 1 && octet.starts_with('0') {
                return Err(ValidationError::invalid("IpV4Address", trimmed));
            }
        }

        trimmed
            .parse::<Ipv4Addr>()
            .map(|ip| Self(ip.to_string()))
            .map_err(|_| ValidationError::invalid("IpV4Address", trimmed))
    }

    fn value(&self) -> &Self::Output {
        &self.0
    }

    fn into_inner(self) -> Self::Input {
        self.0
    }
}

impl TryFrom<&str> for IpV4Address {
    type Error = ValidationError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Self::new(value.to_owned())
    }
}

impl std::fmt::Display for IpV4Address {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

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

    #[test]
    fn accepts_valid_ipv4() {
        let ip = IpV4Address::new("192.168.1.1".into()).unwrap();
        assert_eq!(ip.value(), "192.168.1.1");
    }

    #[test]
    fn accepts_loopback() {
        assert!(IpV4Address::new("127.0.0.1".into()).is_ok());
    }

    #[test]
    fn accepts_all_zeros() {
        assert!(IpV4Address::new("0.0.0.0".into()).is_ok());
    }

    #[test]
    fn accepts_broadcast() {
        assert!(IpV4Address::new("255.255.255.255".into()).is_ok());
    }

    #[test]
    fn rejects_empty() {
        assert!(IpV4Address::new(String::new()).is_err());
    }

    #[test]
    fn rejects_out_of_range_octet() {
        assert!(IpV4Address::new("256.0.0.1".into()).is_err());
    }

    #[test]
    fn rejects_too_few_octets() {
        assert!(IpV4Address::new("192.168.1".into()).is_err());
    }

    #[test]
    fn rejects_leading_zeros() {
        assert!(IpV4Address::new("192.168.001.001".into()).is_err());
    }

    #[test]
    fn rejects_ipv6() {
        assert!(IpV4Address::new("::1".into()).is_err());
    }

    #[test]
    fn try_from_str() {
        let ip: IpV4Address = "10.0.0.1".try_into().unwrap();
        assert_eq!(ip.value(), "10.0.0.1");
    }
}