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

// 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 std::cmp::Ordering;

use super::{BoxedSorterFn, Sorter};

/// Create a new sorter that will run multiple sorters. When the nth sorter
/// returns [`Ordering::Equal`], the next sorter is called. It stops at soon as
/// a sorter return [`Ordering::Greater`] or [`Ordering::Less`].
///
/// This is an implementation of a lexicographic order as defined for cartesian
/// products ([learn more](https://en.wikipedia.org/wiki/Lexicographic_order#Cartesian_products)).
pub fn new_sorter(sorters: Vec<BoxedSorterFn>) -> impl Sorter {
    move |left, right| -> Ordering {
        for sorter in &sorters {
            match sorter(left, right) {
                result @ Ordering::Greater | result @ Ordering::Less => return result,
                Ordering::Equal => continue,
            }
        }

        Ordering::Equal
    }
}

#[cfg(test)]
mod tests {
    use matrix_sdk_test::async_test;
    use ruma::room_id;

    use super::{
        super::super::filters::{client_and_server_prelude, new_rooms},
        *,
    };

    #[async_test]
    async fn test_with_zero_sorter() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room_a, room_b] =
            new_rooms([room_id!("!a:b.c"), room_id!("!d:e.f")], &client, &server, &sliding_sync)
                .await;

        let or = new_sorter(vec![]);

        assert_eq!(or(&room_a, &room_b), Ordering::Equal);
    }

    #[async_test]
    async fn test_with_one_sorter() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room_a, room_b] =
            new_rooms([room_id!("!a:b.c"), room_id!("!d:e.f")], &client, &server, &sliding_sync)
                .await;

        let sorter_1 = |_: &_, _: &_| Ordering::Less;
        let or = new_sorter(vec![Box::new(sorter_1)]);

        assert_eq!(or(&room_a, &room_b), Ordering::Less);
    }

    #[async_test]
    async fn test_with_two_sorters() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room_a, room_b] =
            new_rooms([room_id!("!a:b.c"), room_id!("!d:e.f")], &client, &server, &sliding_sync)
                .await;

        let sorter_1 = |_: &_, _: &_| Ordering::Equal;
        let sorter_2 = |_: &_, _: &_| Ordering::Greater;
        let or = new_sorter(vec![Box::new(sorter_1), Box::new(sorter_2)]);

        assert_eq!(or(&room_a, &room_b), Ordering::Greater);
    }

    #[async_test]
    async fn test_with_more_sorters() {
        let (client, server, sliding_sync) = client_and_server_prelude().await;
        let [room_a, room_b] =
            new_rooms([room_id!("!a:b.c"), room_id!("!d:e.f")], &client, &server, &sliding_sync)
                .await;

        let sorter_1 = |_: &_, _: &_| Ordering::Equal;
        let sorter_2 = |_: &_, _: &_| Ordering::Equal;
        let sorter_3 = |_: &_, _: &_| Ordering::Less;
        let sorter_4 = |_: &_, _: &_| Ordering::Greater;
        let or = new_sorter(vec![
            Box::new(sorter_1),
            Box::new(sorter_2),
            Box::new(sorter_3),
            Box::new(sorter_4),
        ]);

        assert_eq!(or(&room_a, &room_b), Ordering::Less);
    }
}