mwbot 0.7.1

A MediaWiki bot framework
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

// SPDX-FileCopyrightText: 2023 Misato Kano <me@mirror-kt.dev>
// SPDX-License-Identifier: GPL-3.0-or-later
//! Generator to get a random set of pages
//!
//! See the [`RandomPages`] type documentation for specifics.
use super::{Generator, ParamValue};

/// Get pages with random starting point.
///
/// See [API documentation](https://www.mediawiki.org/wiki/API:Random) for more details.
#[derive(Generator)]
#[params(generator = "random", grnlimit = "max")]
pub struct RandomPages {
    #[param("grnnamespace")]
    namespaces: Option<Vec<u32>>,
    #[param("grnfilterredir")]
    filterredir: Option<FilterRedirect>,
}

pub enum FilterRedirect {
    All,
    NonRedirects,
    Redirects,
}

impl ParamValue for FilterRedirect {
    fn stringify(&self) -> String {
        match self {
            Self::All => "all",
            Self::NonRedirects => "nonredirects",
            Self::Redirects => "redirects",
        }
        .to_string()
    }
}

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

    #[tokio::test]
    async fn test_random_pages() {
        let bot = testwp().await;
        let gen = RandomPages::new();

        let mut pages = gen.generate(&bot);
        let mut count = 0;

        while let Some(page) = pages.recv().await {
            let _page = page.unwrap();

            if count >= 5 {
                break;
            }
            count += 1;
        }

        assert_eq!(count, 5);
    }
}