clearurls 0.0.4

Clear URLS from tracking parameters with crowd-sourced rules from https://clearurls.xyz
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 alloc::borrow::Cow;
use alloc::fmt;
use alloc::vec::Vec;
use core::marker::PhantomData;

use regex::{Regex, RegexBuilder, RegexSet, RegexSetBuilder};
use serde::de::{Error as _, IgnoredAny, MapAccess, SeqAccess, Visitor};
use serde::{Deserialize, Deserializer};

/// Deserialize a [`Regex`]
/// The result will have the `case_insensitive` flag set.
pub(crate) fn deserialize_regex<'de, D>(d: D) -> Result<Regex, D::Error>
where
    D: Deserializer<'de>,
{
    let s = <Cow<'_, str>>::deserialize(d)?;
    RegexBuilder::new(&s)
        .case_insensitive(true)
        .build()
        .map_err(D::Error::custom)
}

/// Deserialize a [`Vec<Regex>`].
/// All regexes will have the `case_insensitive` flag set.
pub(crate) fn deserialize_regex_vec<'de, D>(d: D) -> Result<Vec<Regex>, D::Error>
where
    D: Deserializer<'de>,
{
    struct RegexVecVisitor;
    impl<'a> Visitor<'a> for RegexVecVisitor {
        type Value = Vec<Regex>;

        fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
            formatter.write_str("valid sequence")
        }

        fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
        where
            A: SeqAccess<'a>,
        {
            let cap = seq.size_hint().unwrap_or(0);
            let mut vec = Vec::with_capacity(cap);
            while let Some(el) = seq.next_element::<Cow<'_, str>>()? {
                let regex = RegexBuilder::new(&el)
                    .case_insensitive(true)
                    .build()
                    .map_err(A::Error::custom)?;
                vec.push(regex);
            }
            Ok(vec)
        }
    }

    d.deserialize_seq(RegexVecVisitor)
}

/// Deserialize a [`RegexSet`].
/// All regexes will have the `case_insensitive` flag set.
pub(crate) fn deserialize_regex_set<'de, D>(d: D) -> Result<RegexSet, D::Error>
where
    D: Deserializer<'de>,
{
    let regexes = <Vec<Cow<'_, str>>>::deserialize(d)?;
    RegexSetBuilder::new(regexes)
        .case_insensitive(true)
        .build()
        .map_err(D::Error::custom)
}

/// Deserialize a [`Vec`] from a map by ignoring the keys.
pub(crate) fn deserialize_map_as_vec<'de, D, T>(d: D) -> Result<Vec<T>, D::Error>
where
    D: Deserializer<'de>,
    T: Deserialize<'de>,
{
    struct MapAsVecVisitor<T>(PhantomData<T>);
    impl<'de, T: Deserialize<'de>> Visitor<'de> for MapAsVecVisitor<T> {
        type Value = Vec<T>;

        fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
            formatter.write_str("valid map")
        }

        fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
        where
            A: MapAccess<'de>,
        {
            let cap = map.size_hint().unwrap_or(0);
            let mut vec = Vec::with_capacity(cap);
            while let Some((_, v)) = map.next_entry::<IgnoredAny, T>()? {
                vec.push(v);
            }
            Ok(vec)
        }
    }

    d.deserialize_map(MapAsVecVisitor(PhantomData))
}

#[cfg(test)]
mod tests {
    use crate::deserialize_utils::*;
    use serde_json::error::Category;
    use serde_json::json;

    #[test]
    fn test_deserialize_regex() {
        let regex = deserialize_regex(json!("a")).unwrap();
        assert!(regex.is_match("A"));
        let error = deserialize_regex(json!("[")).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex(json!(true)).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex(json!([])).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
    }

    #[test]
    fn test_deserialize_regex_set_error() {
        let error = deserialize_regex_set(json!([".*", 1])).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex_set(json!("")).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex_set(json!(["["])).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
    }

    #[test]
    fn test_deserialize_regex_vec_error() {
        let error = deserialize_regex_vec(json!([".*", 1])).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex_vec(json!("")).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_regex_vec(json!(["["])).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
    }

    #[test]
    fn test_deserialize_map_as_vec_error() {
        let error = deserialize_map_as_vec::<_, bool>(json!(true)).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
        let error = deserialize_map_as_vec::<_, bool>(json!({"a": 5})).unwrap_err();
        assert_eq!(error.classify(), Category::Data);
    }
}