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

use crate::errors::ValidationError;
use crate::traits::ValueObject;

use super::{Latitude, Longitude};

/// Input for [`Coordinate`].
#[derive(Debug, Clone, PartialEq)]
pub struct CoordinateInput {
    pub lat: Latitude,
    pub lng: Longitude,
}

/// A geographic coordinate (latitude + longitude pair).
///
/// Constructed from a validated [`Latitude`] and [`Longitude`]. The canonical
/// string representation is `"lat, lng"` with six decimal places each.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::geo::{Coordinate, CoordinateInput, Latitude, Longitude};
/// use arvo::traits::ValueObject;
///
/// let coord = Coordinate::new(CoordinateInput {
///     lat: Latitude::new(48.858844)?,
///     lng: Longitude::new(2.294351)?,
/// })?;
///
/// assert_eq!(coord.value(), "48.858844, 2.294351");
/// assert_eq!(*coord.lat().value(), 48.858844);
/// ```
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Coordinate {
    lat: Latitude,
    lng: Longitude,
    #[cfg_attr(feature = "serde", serde(skip))]
    canonical: String,
}

impl ValueObject for Coordinate {
    type Input = CoordinateInput;
    type Output = str;
    type Error = ValidationError;

    fn new(value: Self::Input) -> Result<Self, Self::Error> {
        let canonical = format!("{:.6}, {:.6}", value.lat.value(), value.lng.value());
        Ok(Self {
            lat: value.lat,
            lng: value.lng,
            canonical,
        })
    }

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

    fn into_inner(self) -> Self::Input {
        CoordinateInput {
            lat: self.lat,
            lng: self.lng,
        }
    }
}

impl Coordinate {
    /// Returns the latitude component.
    pub fn lat(&self) -> &Latitude {
        &self.lat
    }

    /// Returns the longitude component.
    pub fn lng(&self) -> &Longitude {
        &self.lng
    }
}

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

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

    fn make(lat: f64, lng: f64) -> Coordinate {
        Coordinate::new(CoordinateInput {
            lat: Latitude::new(lat).unwrap(),
            lng: Longitude::new(lng).unwrap(),
        })
        .unwrap()
    }

    #[test]
    fn canonical_format() {
        let c = make(48.858844, 2.294351);
        assert_eq!(c.value(), "48.858844, 2.294351");
    }

    #[test]
    fn accessors() {
        let c = make(51.5074, -0.1278);
        assert_eq!(*c.lat().value(), 51.5074);
        assert_eq!(*c.lng().value(), -0.1278);
    }

    #[test]
    fn display_matches_value() {
        let c = make(0.0, 0.0);
        assert_eq!(c.to_string(), c.value());
    }

    #[test]
    fn into_inner_roundtrip() {
        let c = make(48.858844, 2.294351);
        let inner = c.clone().into_inner();
        assert_eq!(*inner.lat.value(), 48.858844);
        assert_eq!(*inner.lng.value(), 2.294351);
    }
}