iriq 0.30.2

IRI/URL extraction, normalization, and shape clustering.
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

use crate::classifier::{
    canonical_currency, canonical_date, display_type, param_name_hint, SegmentClassifier,
    SegmentType, DEFAULT_CLASSIFIER,
};
use crate::errors::ParseError;
use crate::hints::derive_hints;
use crate::identifier::Identifier;
use crate::parser::parse;
use crate::path_shape::PathShape;

pub trait NormalizationEvidence: Send + Sync {
    fn render_path(&self, iri: &Identifier, c: &SegmentClassifier, hints: bool) -> String;
    fn render_query(&self, iri: &Identifier, c: &SegmentClassifier) -> String;
}

pub struct NullEvidence;

impl NormalizationEvidence for NullEvidence {
    fn render_path(&self, iri: &Identifier, c: &SegmentClassifier, hints: bool) -> String {
        let mut ps = PathShape::new();
        ps.classifier = c;
        ps.hints = hints;
        ps.canonical_dates = true;
        ps.canonical_currencies = true;
        ps.for_segments(&iri.path_segments)
    }

    fn render_query(&self, iri: &Identifier, c: &SegmentClassifier) -> String {
        shape_query(iri, c)
    }
}

pub fn normalize(input: &str) -> Result<String, ParseError> {
    normalize_with(input, &DEFAULT_CLASSIFIER, true)
}

pub fn normalize_with(
    input: &str,
    c: &SegmentClassifier,
    hints: bool,
) -> Result<String, ParseError> {
    let iri = parse(input)?;
    Ok(normalize_identifier(&iri, c, hints))
}

pub fn normalize_identifier(iri: &Identifier, c: &SegmentClassifier, hints: bool) -> String {
    normalize_identifier_with_evidence(iri, c, hints, &NullEvidence)
}

pub fn normalize_identifier_with_evidence(
    iri: &Identifier,
    c: &SegmentClassifier,
    hints: bool,
    ev: &dyn NormalizationEvidence,
) -> String {
    if iri.is_urn() {
        return normalize_urn(iri, c, hints);
    }
    let mut s = String::new();
    if !iri.scheme.is_empty() {
        s.push_str(&iri.scheme);
        s.push_str("://");
    }
    if !iri.host.is_empty() {
        s.push_str(&iri.host);
    }
    if iri.port != 0 {
        s.push(':');
        s.push_str(&iri.port.to_string());
    }
    s.push_str(&ev.render_path(iri, c, hints));
    if !iri.query_params.is_empty() {
        s.push('?');
        s.push_str(&ev.render_query(iri, c));
    }
    s
}

fn normalize_urn(iri: &Identifier, c: &SegmentClassifier, hints: bool) -> String {
    if !(iri.scheme == "urn" && !iri.nss.is_empty() && iri.nss.contains(':')) {
        return iri.canonical();
    }
    let (ns, value) = iri.nss.split_once(':').unwrap();
    let entries = derive_hints(&[ns.to_string(), value.to_string()], c);
    let entry = entries.last().unwrap();
    let shaped = if entry.ty == SegmentType::Date {
        if let Some(canon) = canonical_date(&entry.value) {
            canon
        } else {
            placeholder(entry, hints)
        }
    } else if entry.ty == SegmentType::Currency {
        if let Some(canon) = canonical_currency(&entry.value) {
            canon
        } else {
            placeholder(entry, hints)
        }
    } else if entry.variable {
        placeholder(entry, hints)
    } else {
        entry.value.clone()
    };
    format!("urn:{}:{}", ns, shaped)
}

fn placeholder(entry: &crate::hints::SegmentHint, hints: bool) -> String {
    let p = if hints && !entry.hint.is_empty() {
        entry.hint.clone()
    } else {
        display_type(entry.ty).to_string()
    };
    format!("{{{}}}", p)
}

fn shape_query(iri: &Identifier, c: &SegmentClassifier) -> String {
    let mut keys = iri.query_params.keys();
    keys.sort();
    let mut parts: Vec<String> = Vec::with_capacity(keys.len());
    for k in keys {
        let v = iri.query_params.get(&k).unwrap_or("").to_string();
        let mut t = c.classify(&v);
        if let Some(h) = param_name_hint(&k, t) {
            t = h;
        }
        let shaped = if t == SegmentType::Date {
            if let Some(canon) = canonical_date(&v) {
                canon
            } else {
                format!("{{{}}}", display_type(t))
            }
        } else if t == SegmentType::Currency {
            if let Some(canon) = canonical_currency(&v) {
                canon
            } else {
                format!("{{{}}}", display_type(t))
            }
        } else if c.variable(t) {
            format!("{{{}}}", display_type(t))
        } else {
            v.clone()
        };
        parts.push(format!("{}={}", k, shaped));
    }
    parts.join("&")
}