geo-kit 0.1.0

Typed newtypes for validated geo primitives — postcodes, country codes, coordinates, addresses
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

use geo_kit::{CountryCode, Coords, UkPostcode, UsZipCode};
use proptest::prelude::*;
use std::str::FromStr;

// Strategies -----------------------------------------------------------

fn arb_uk_postcode() -> impl Strategy<Value = String> {
    // Generate valid UK postcodes: [A-Z]{1,2}[0-9][A-Z0-9]? [0-9][A-Z]{2}
    // We'll generate via parts.
    let outward = prop_oneof![
        // 1 letter + digit
        ("[A-Z]", "[0-9]").prop_map(|(a, b): (String, String)| format!("{}{}", a, b)),
        // 2 letters + digit
        ("[A-Z][A-Z]", "[0-9]").prop_map(|(a, b): (String, String)| format!("{}{}", a, b)),
        // 1 letter + digit + letter
        ("[A-Z]", "[0-9]", "[A-Z0-9]").prop_map(|(a, b, c): (String, String, String)| format!("{}{}{}", a, b, c)),
        // 2 letters + digit + alnum
        ("[A-Z][A-Z]", "[0-9]", "[A-Z0-9]").prop_map(|(a, b, c): (String, String, String)| format!("{}{}{}", a, b, c)),
    ];
    let inward = ("[0-9]", "[A-Z][A-Z]").prop_map(|(a, b)| format!("{}{}", a, b));
    (outward, inward).prop_map(|(o, i)| format!("{} {}", o, i))
}

fn arb_us_zip() -> impl Strategy<Value = String> {
    prop_oneof![
        "[0-9]{5}",
        ("[0-9]{5}", "[0-9]{4}").prop_map(|(a, b)| format!("{}-{}", a, b)),
    ]
}

fn arb_country() -> impl Strategy<Value = String> {
    "[A-Z]{2}"
}

fn arb_coords() -> impl Strategy<Value = (f64, f64)> {
    // lat -90..90, lon -180..180
    (-90.0f64..=90.0f64, -180.0f64..=180.0f64)
}

// Tests ---------------------------------------------------------------

proptest! {
    #[test]
    fn uk_roundtrip(s in arb_uk_postcode()) {
        let parsed = UkPostcode::parse(&s).unwrap();
        let displayed = parsed.to_string();
        let reparsed = UkPostcode::from_str(&displayed).unwrap();
        prop_assert_eq!(parsed.as_str(), reparsed.as_str());
        // With regex, should still be valid
        prop_assert!(geo_kit::is_valid_uk_postcode(&s));
    }

    #[test]
    fn uk_normalises_lowercase(s in arb_uk_postcode()) {
        let lower = s.to_ascii_lowercase();
        let parsed = UkPostcode::parse(&lower).unwrap();
        prop_assert_eq!(parsed.as_str(), s);
    }

    #[test]
    fn us_roundtrip(s in arb_us_zip()) {
        let parsed = UsZipCode::parse(&s).unwrap();
        let displayed = parsed.to_string();
        let reparsed = UsZipCode::from_str(&displayed).unwrap();
        prop_assert_eq!(parsed.as_str(), reparsed.as_str());
    }

    #[test]
    fn country_roundtrip(s in arb_country()) {
        let parsed = CountryCode::parse(&s).unwrap();
        let displayed = parsed.to_string();
        let reparsed = CountryCode::from_str(&displayed).unwrap();
        prop_assert_eq!(parsed.as_str(), reparsed.as_str());
        prop_assert!(geo_kit::is_valid_country_code(&s));
    }

    #[test]
    fn coords_roundtrip(pair in arb_coords()) {
        let (lat, lon) = pair;
        // filter out NaN not needed because range generates finite
        let coords = Coords::new(lat, lon).unwrap();
        let displayed = coords.to_string();
        let reparsed = Coords::from_str(&displayed).unwrap();
        // Allow small floating error due to display precision? We compare with tolerance.
        prop_assert!((coords.lat - reparsed.lat).abs() < 1e-9);
        prop_assert!((coords.lon - reparsed.lon).abs() < 1e-9);
    }

    #[test]
    fn coords_valid_range(pair in arb_coords()) {
        let (lat, lon) = pair;
        prop_assert!(geo_kit::is_valid_coords(lat, lon));
    }
}

// Negative property tests ---------------------------------------------

proptest! {
    #[test]
    fn uk_rejects_lowercase_country_mismatch(s in "[a-z]{2} [0-9][A-Z]{2}") {
        // This pattern looks like postcode but lowercase outward should be accepted via normalization,
        // but we test that country codes reject lowercase.
        prop_assert!(CountryCode::parse(&s[..2]).is_err());
    }

    #[test]
    fn us_rejects_invalid_len(s in "[0-9]{4}") {
        prop_assert!(UsZipCode::parse(&s).is_err());
    }

    #[test]
    fn us_rejects_alpha(s in "[A-Z]{5}") {
        prop_assert!(UsZipCode::parse(&s).is_err());
    }

    #[test]
    fn country_rejects_lowercase(s in "[a-z]{2}") {
        prop_assert!(CountryCode::parse(&s).is_err());
    }

    #[test]
    fn country_rejects_too_long(s in "[A-Z]{3,5}") {
        prop_assert!(CountryCode::parse(&s).is_err());
    }

    #[test]
    fn coords_rejects_out_of_range_lat(lat in 91.0..1000.0f64, lon in -180.0..180.0f64) {
        prop_assert!(Coords::new(lat, lon).is_err());
        prop_assert!(Coords::new(-lat, lon).is_err());
    }

    #[test]
    fn coords_rejects_out_of_range_lon(lat in -90.0..90.0f64, lon in 181.0..1000.0f64) {
        prop_assert!(Coords::new(lat, lon).is_err());
        prop_assert!(Coords::new(lat, -lon).is_err());
    }
}