sherlock 5.0.5

🔍 Hunt down social media accounts by username across social networks
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

use std::collections::HashMap;

///
/// Creates username variants by replacing the variant symbol with check symbols.
///
/// # Arguments
/// * `usernames` - The usernames to create variants for.
///
/// # Returns
/// The username variants.
///
/// # Example
/// ```
/// use sherlock::utils::create_username_variants;
///
/// let usernames = vec![
///    String::from("user{?}name"),
///    String::from("another{?}user"),
///   String::from("test{?}user"),
/// ];
///
/// let variants = create_username_variants(&usernames);
///
/// assert_eq!(variants, vec![
///   "user_name",
///   "user-name",
///   "user.name",
///   "another_user",
///   "another-user",
///   "another.user",
///   "test_user",
///   "test-user",
///   "test.user",
/// ]);
/// ```
#[must_use]
pub fn create_username_variants(usernames: &[String]) -> Vec<String> {
    let variant_symbol = "{?}";
    let check_symbols = ["_", "-", "."];
    usernames
        .iter()
        .flat_map(|username| {
            if !username.contains(variant_symbol) {
                return vec![username.clone()];
            }

            check_symbols
                .iter()
                .map(|symbol| username.replace(variant_symbol, symbol))
                .collect::<Vec<String>>()
        })
        .collect()
}

pub trait Interpolatable {
    fn interpolate(&self, text: &str) -> Self;
}

impl Interpolatable for String {
    ///
    /// Interpolates the given text into the receiver.
    ///
    /// # Arguments
    /// * `text` - The text to interpolate.
    ///
    /// # Returns
    /// The interpolated text.
    ///
    /// # Example
    /// ```
    /// use sherlock::utils::Interpolatable;
    ///
    /// let string = "value is '{}'".to_string();
    /// let interpolated_string = string.interpolate("test".into());
    ///
    /// assert_eq!(interpolated_string, "value is 'test'");
    /// ```
    fn interpolate(&self, text: &str) -> Self {
        self.replace("{}", text)
    }
}

impl<T: Interpolatable> Interpolatable for Vec<T> {
    /// Interpolates the given text into the receiver.
    ///
    /// # Arguments
    /// * `text` - The text to interpolate.
    ///
    /// # Returns
    /// The interpolated text.
    ///
    /// # Example
    /// ```
    /// use sherlock::utils::Interpolatable;
    ///
    /// let vec = vec!["value is '{}'".to_string()];
    /// let interpolated_vec = vec.interpolate("test");
    ///
    /// assert_eq!(interpolated_vec[0], "value is 'test'");
    /// ```
    fn interpolate(&self, text: &str) -> Self {
        self.iter().map(|item| item.interpolate(text)).collect()
    }
}

impl<T: Interpolatable> Interpolatable for HashMap<String, T> {
    /// Interpolates the given text into the receiver.
    ///
    /// # Arguments
    /// * `text` - The text to interpolate.
    ///
    /// # Returns
    /// The interpolated text.
    ///
    /// # Example
    /// ```
    /// use std::collections::HashMap;
    /// use sherlock::utils::Interpolatable;
    ///
    /// let mut map = HashMap::new();
    /// map.insert("key".to_string(), "value is '{}'".to_string());
    /// let interpolated_map = map.interpolate("test");
    ///
    /// assert_eq!(interpolated_map.get("key").unwrap(), "value is 'test'");
    /// ```
    fn interpolate(&self, text: &str) -> Self {
        self.iter()
            .map(|(key, value)| (key.clone(), value.interpolate(text)))
            .collect()
    }
}

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

    #[test]
    fn test_create_username_variants() {
        let usernames = vec![
            String::from("user{?}name"),
            String::from("another{?}user"),
            String::from("test{?}user"),
        ];
        let expected = vec![
            "user_name",
            "user-name",
            "user.name",
            "another_user",
            "another-user",
            "another.user",
            "test_user",
            "test-user",
            "test.user",
        ];
        let result = create_username_variants(&usernames);
        assert_eq!(result, expected);
    }

    #[test]
    fn test_create_username_variants_no_symbol() {
        let usernames = vec![
            String::from("username"),
            String::from("anotheruser"),
            String::from("testuser"),
        ];
        let expected = vec!["username", "anotheruser", "testuser"];
        let result = create_username_variants(&usernames);
        assert_eq!(result, expected);
    }

    #[test]
    fn test_create_username_variants_empty() {
        let usernames: Vec<String> = vec![];
        let expected: Vec<String> = vec![];
        let result = create_username_variants(&usernames);
        assert_eq!(result, expected);
    }
}