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
// 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.

use matrix_sdk::{Client, RoomListEntry};

use super::Filter;

struct FavouriteRoomMatcher<F>
where
    F: Fn(&RoomListEntry) -> Option<bool>,
{
    is_favourite: F,
}

impl<F> FavouriteRoomMatcher<F>
where
    F: Fn(&RoomListEntry) -> Option<bool>,
{
    fn matches(&self, room_list_entry: &RoomListEntry) -> bool {
        if !matches!(room_list_entry, RoomListEntry::Filled(_) | RoomListEntry::Invalidated(_)) {
            return false;
        }

        (self.is_favourite)(room_list_entry).unwrap_or(false)
    }
}

/// Create a new filter that will accept all filled or invalidated entries, but
/// filters out rooms that are not marked as favourite (see
/// [`matrix_sdk_base::Room::is_favourite`]).
pub fn new_filter(client: &Client) -> impl Filter {
    let client = client.clone();

    let matcher = FavouriteRoomMatcher {
        is_favourite: move |room| {
            let room_id = room.as_room_id()?;
            let room = client.get_room(room_id)?;

            Some(room.is_favourite())
        },
    };

    move |room_list_entry| -> bool { matcher.matches(room_list_entry) }
}

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

    use matrix_sdk::RoomListEntry;
    use ruma::room_id;

    use super::FavouriteRoomMatcher;

    #[test]
    fn test_is_favourite() {
        let matcher = FavouriteRoomMatcher { is_favourite: |_| Some(true) };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())));
        assert!(matcher.matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned())));
    }

    #[test]
    fn test_is_not_favourite() {
        let matcher = FavouriteRoomMatcher { is_favourite: |_| Some(false) };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())).not());
        assert!(matcher
            .matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            .not());
    }

    #[test]
    fn test_favourite_state_cannot_be_found() {
        let matcher = FavouriteRoomMatcher { is_favourite: |_| None };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())).not());
        assert!(matcher
            .matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            .not());
    }
}