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
// Copyright 2024 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub use fuzzy_matcher::{skim::SkimMatcherV2, FuzzyMatcher as _};
use matrix_sdk::Client;

use super::{normalize_string, Filter};

struct FuzzyMatcher {
    matcher: SkimMatcherV2,
    pattern: Option<String>,
}

impl FuzzyMatcher {
    fn new() -> Self {
        Self { matcher: SkimMatcherV2::default().smart_case().use_cache(true), pattern: None }
    }

    fn with_pattern(mut self, pattern: &str) -> Self {
        self.pattern = Some(normalize_string(pattern));

        self
    }

    fn matches(&self, subject: &str) -> bool {
        // No pattern means there is a match.
        let Some(pattern) = self.pattern.as_ref() else { return true };

        self.matcher.fuzzy_match(&normalize_string(subject), pattern).is_some()
    }
}

/// Create a new filter that will fuzzy match a pattern on room names.
///
/// Rooms are fetched from the `Client`. The pattern and the room names are
/// normalized with `normalize_string`.
pub fn new_filter(client: &Client, pattern: &str) -> impl Filter {
    let searcher = FuzzyMatcher::new().with_pattern(pattern);

    let client = client.clone();

    move |room_list_entry| -> bool {
        let Some(room_id) = room_list_entry.as_room_id() else { return false };
        let Some(room) = client.get_room(room_id) else { return false };
        let Some(room_name) = room.cached_display_name() else { return false };

        searcher.matches(&room_name.to_string())
    }
}

#[cfg(test)]
mod tests {
    use std::ops::Not;

    use super::FuzzyMatcher;

    #[test]
    fn test_no_pattern() {
        let matcher = FuzzyMatcher::new();

        assert!(matcher.matches("hello"));
    }

    #[test]
    fn test_empty_pattern() {
        let matcher = FuzzyMatcher::new();

        assert!(matcher.matches("hello"));
    }

    #[test]
    fn test_literal() {
        let matcher = FuzzyMatcher::new();

        let matcher = matcher.with_pattern("mtx");
        assert!(matcher.matches("matrix"));

        let matcher = matcher.with_pattern("mxt");
        assert!(matcher.matches("matrix").not());
    }

    #[test]
    fn test_ignore_case() {
        let matcher = FuzzyMatcher::new();

        let matcher = matcher.with_pattern("mtx");
        assert!(matcher.matches("MaTrIX"));

        let matcher = matcher.with_pattern("mxt");
        assert!(matcher.matches("MaTrIX").not());
    }

    #[test]
    fn test_smart_case() {
        let matcher = FuzzyMatcher::new();

        let matcher = matcher.with_pattern("mtx");
        assert!(matcher.matches("matrix"));
        assert!(matcher.matches("Matrix"));

        let matcher = matcher.with_pattern("Mtx");
        assert!(matcher.matches("matrix").not());
        assert!(matcher.matches("Matrix"));
    }

    #[test]
    fn test_normalization() {
        let matcher = FuzzyMatcher::new();

        let matcher = matcher.with_pattern("ubété");

        // First, assert that the pattern has been normalized.
        assert_eq!(matcher.pattern, Some("ubete".to_owned()));

        // Second, assert that the subject is normalized too.
        assert!(matcher.matches("un bel été"));

        // Another concrete test.
        let matcher = matcher.with_pattern("stf");
        assert!(matcher.matches("Ștefan"));
    }
}