ens-normalize 0.1.0

Rust port of adraffy's ENS normalizer
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

use ens_normalize::{EnsError, Result, Token, ens_normalize, ens_tokenize, nfc, nfd, str_from_cps};
use serde::Deserialize;
use std::collections::BTreeMap;

#[derive(Debug, Deserialize)]
struct NormCase {
    name: String,
    norm: Option<String>,
    #[serde(default)]
    error: bool,
    comment: Option<String>,
}

fn load_cases(json: &str) -> Vec<NormCase> {
    serde_json::from_str(json).expect("valid upstream validation JSON")
}

fn case_label(case: &NormCase, i: usize) -> String {
    format!(
        "#{i} {:?} ({})",
        case.name,
        case.comment.as_deref().unwrap_or("no comment")
    )
}

fn assert_normalize_cases(cases: &[NormCase]) {
    for (i, case) in cases.iter().enumerate() {
        let result = ens_normalize(&case.name);
        if case.error {
            assert!(
                result.is_err(),
                "{} expected error, got {:?}",
                case_label(case, i),
                result
            );
        } else {
            let expected = case.norm.as_ref().unwrap_or(&case.name);
            assert_eq!(
                result.as_deref(),
                Ok(expected.as_str()),
                "{}",
                case_label(case, i)
            );
        }
    }
}

fn normalize_via_tokenize(name: &str) -> Result<String> {
    let mut cps = Vec::new();
    for token in ens_tokenize(name) {
        match token {
            Token::Disallowed { .. } => return Err(EnsError::new("disallowed")),
            Token::Ignored { .. } => {}
            Token::Stop { cp } => cps.push(cp),
            Token::Valid { cps: v }
            | Token::Mapped { cps: v, .. }
            | Token::Emoji { cps: v, .. }
            | Token::Nfc { cps: v, .. } => cps.extend(v),
        }
    }
    let norm = str_from_cps(&nfc(&cps))?;
    if ens_normalize(&norm)? != norm {
        return Err(EnsError::new(format!("wrong: {norm}")));
    }
    if norm.is_empty() {
        ens_normalize(name)?;
    }
    Ok(norm)
}

fn assert_tokenize_cases(cases: &[NormCase]) {
    for (i, case) in cases.iter().enumerate() {
        let result = normalize_via_tokenize(&case.name);
        if case.error {
            assert!(
                result.is_err(),
                "{} expected tokenization error, got {:?}",
                case_label(case, i),
                result
            );
        } else {
            let expected = case.norm.as_ref().unwrap_or(&case.name);
            assert_eq!(
                result.as_deref(),
                Ok(expected.as_str()),
                "{}",
                case_label(case, i)
            );
        }
    }
}

#[test]
fn upstream_validate_normalize() {
    let cases = load_cases(include_str!("fixtures/validate-tests.json"));
    assert_normalize_cases(&cases);
}

#[test]
fn upstream_custom_normalize() {
    let cases = load_cases(include_str!("fixtures/custom-tests.json"));
    assert_normalize_cases(&cases);
}

#[test]
fn upstream_validate_tokenize_equivalence() {
    let cases = load_cases(include_str!("fixtures/validate-tests.json"));
    assert_tokenize_cases(&cases);
}

#[test]
fn upstream_nf_tests() {
    let tests: BTreeMap<String, Vec<[String; 3]>> =
        serde_json::from_str(include_str!("fixtures/nf-tests.json")).expect("valid nf tests");
    for (section, cases) in tests {
        for (i, [input, want_nfd, want_nfc]) in cases.into_iter().enumerate() {
            let input = ens_normalize::explode_cp(&input);
            let got_nfd = str_from_cps(&nfd(&input)).unwrap();
            let got_nfc = str_from_cps(&nfc(&input)).unwrap();
            assert_eq!(got_nfd, want_nfd, "{section} #{i} nfd");
            assert_eq!(got_nfc, want_nfc, "{section} #{i} nfc");
        }
    }
}