arvo 1.0.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
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

use crate::errors::ValidationError;
use crate::traits::{PrimitiveValue, ValueObject};

/// Input type for [`Latitude`].
pub type LatitudeInput = f64;

/// A validated geographic latitude in decimal degrees.
///
/// The value must be finite and in the inclusive range `−90.0..=90.0`.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::geo::Latitude;
/// use arvo::traits::ValueObject;
///
/// let lat = Latitude::new(48.8588).unwrap();
/// assert_eq!(*lat.value(), 48.8588);
///
/// assert!(Latitude::new(91.0).is_err());
/// assert!(Latitude::new(f64::NAN).is_err());
/// ```
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(try_from = "f64", into = "f64"))]
pub struct Latitude(f64);

impl ValueObject for Latitude {
    type Input = LatitudeInput;
    type Error = ValidationError;

    fn new(value: Self::Input) -> Result<Self, Self::Error> {
        if !value.is_finite() {
            return Err(ValidationError::invalid("Latitude", &value.to_string()));
        }
        if !(-90.0..=90.0).contains(&value) {
            return Err(ValidationError::invalid("Latitude", &value.to_string()));
        }
        Ok(Self(value))
    }

    fn into_inner(self) -> Self::Input {
        self.0
    }
}
impl PrimitiveValue for Latitude {
    type Primitive = f64;
    fn value(&self) -> &f64 {
        &self.0
    }
}

impl TryFrom<f64> for Latitude {
    type Error = ValidationError;
    fn try_from(v: f64) -> Result<Self, Self::Error> {
        Self::new(v)
    }
}

#[cfg(feature = "serde")]
impl From<Latitude> for f64 {
    fn from(v: Latitude) -> f64 {
        v.0
    }
}
impl TryFrom<&str> for Latitude {
    type Error = ValidationError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        let parsed = value
            .trim()
            .parse::<f64>()
            .map_err(|_| ValidationError::invalid("Latitude", value))?;
        Self::new(parsed)
    }
}

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

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

    #[test]
    fn accepts_valid_latitude() {
        let lat = Latitude::new(48.8588).unwrap();
        assert_eq!(*lat.value(), 48.8588);
    }

    #[test]
    fn accepts_boundaries() {
        assert!(Latitude::new(-90.0).is_ok());
        assert!(Latitude::new(90.0).is_ok());
    }

    #[test]
    fn rejects_out_of_range() {
        assert!(Latitude::new(90.001).is_err());
        assert!(Latitude::new(-90.001).is_err());
    }

    #[test]
    fn rejects_nan() {
        assert!(Latitude::new(f64::NAN).is_err());
    }

    #[test]
    fn rejects_infinity() {
        assert!(Latitude::new(f64::INFINITY).is_err());
        assert!(Latitude::new(f64::NEG_INFINITY).is_err());
    }

    #[test]
    fn display_six_decimal_places() {
        let lat = Latitude::new(48.858844).unwrap();
        assert_eq!(lat.to_string(), "48.858844");
    }

    #[test]
    fn into_inner_roundtrip() {
        let lat = Latitude::new(51.5074).unwrap();
        assert_eq!(lat.into_inner(), 51.5074);
    }

    #[test]
    fn try_from_parses_valid() {
        let lat = Latitude::try_from("48.8588").unwrap();
        assert_eq!(*lat.value(), 48.8588);
    }

    #[test]
    fn try_from_rejects_invalid_format() {
        assert!(Latitude::try_from("not_a_number").is_err());
    }

    #[test]
    fn try_from_rejects_out_of_range() {
        assert!(Latitude::try_from("91.0").is_err());
    }

    #[cfg(feature = "serde")]
    #[test]
    fn serde_roundtrip() {
        let v = Latitude::new(48.8588).unwrap();
        let json = serde_json::to_string(&v).unwrap();
        assert_eq!(json, "48.8588");
        let back: Latitude = serde_json::from_str(&json).unwrap();
        assert_eq!(v, back);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn serde_deserialize_validates() {
        let result: Result<Latitude, _> = serde_json::from_str("91.0");
        assert!(result.is_err());
    }
}