mediawiki 0.5.1

A MediaWiki client library
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

use super::{ActionApiData, ActionApiRunnable};
use std::collections::HashMap;

/// Internal data container for `action=sitematrix` parameters.
#[derive(Debug, Clone)]
pub struct ActionApiSitematrixData {
    smtype: Option<Vec<String>>,
    smlangprop: Option<Vec<String>>,
    smsiteprop: Option<Vec<String>>,
    smlimit: usize,
    smcontinue: Option<String>,
}

impl ActionApiData for ActionApiSitematrixData {}

impl Default for ActionApiSitematrixData {
    fn default() -> Self {
        Self {
            smtype: None,
            smlangprop: None,
            smsiteprop: None,
            smlimit: 500,
            smcontinue: None,
        }
    }
}

impl ActionApiSitematrixData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        Self::add_vec(&self.smtype, "smtype", &mut params);
        Self::add_vec(&self.smlangprop, "smlangprop", &mut params);
        Self::add_vec(&self.smsiteprop, "smsiteprop", &mut params);
        params.insert("smlimit".to_string(), self.smlimit.to_string());
        Self::add_str(&self.smcontinue, "smcontinue", &mut params);
        params
    }
}

/// Builder for `action=sitematrix` — returns the Wikimedia sitematrix.
#[derive(Debug, Clone)]
pub struct ActionApiSitematrixBuilder {
    pub(crate) data: ActionApiSitematrixData,
}

impl ActionApiSitematrixBuilder {
    pub(crate) fn new() -> Self {
        Self {
            data: ActionApiSitematrixData::default(),
        }
    }

    /// Filter by site type (`smtype`).
    pub fn smtype<S: Into<String> + Clone>(mut self, smtype: &[S]) -> Self {
        self.data.smtype = Some(smtype.iter().map(|s| s.clone().into()).collect());
        self
    }

    /// Properties to return for each language (`smlangprop`).
    pub fn smlangprop<S: Into<String> + Clone>(mut self, smlangprop: &[S]) -> Self {
        self.data.smlangprop = Some(smlangprop.iter().map(|s| s.clone().into()).collect());
        self
    }

    /// Properties to return for each site (`smsiteprop`).
    pub fn smsiteprop<S: Into<String> + Clone>(mut self, smsiteprop: &[S]) -> Self {
        self.data.smsiteprop = Some(smsiteprop.iter().map(|s| s.clone().into()).collect());
        self
    }

    /// Maximum number of results to return (`smlimit`).
    pub fn smlimit(mut self, smlimit: usize) -> Self {
        self.data.smlimit = smlimit;
        self
    }
}

impl ActionApiRunnable for ActionApiSitematrixBuilder {
    fn params(&self) -> HashMap<String, String> {
        let mut ret = self.data.params();
        ret.insert("action".to_string(), "sitematrix".to_string());
        ret
    }
}

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

    fn new_builder() -> ActionApiSitematrixBuilder {
        ActionApiSitematrixBuilder::new()
    }

    #[test]
    fn default_smlimit_is_500() {
        let params = new_builder().data.params();
        assert_eq!(params["smlimit"], "500");
    }

    #[test]
    fn default_smtype_absent() {
        let params = new_builder().data.params();
        assert!(!params.contains_key("smtype"));
    }

    #[test]
    fn smtype_set() {
        let params = new_builder().smtype(&["special", "language"]).data.params();
        assert_eq!(params["smtype"], "special|language");
    }

    #[test]
    fn smlangprop_set() {
        let params = new_builder().smlangprop(&["code", "name"]).data.params();
        assert_eq!(params["smlangprop"], "code|name");
    }

    #[test]
    fn smsiteprop_set() {
        let params = new_builder().smsiteprop(&["url", "dbname"]).data.params();
        assert_eq!(params["smsiteprop"], "url|dbname");
    }

    #[test]
    fn smlimit_set() {
        let params = new_builder().smlimit(100).data.params();
        assert_eq!(params["smlimit"], "100");
    }

    #[test]
    fn runnable_params_contain_action() {
        let params = ActionApiRunnable::params(&new_builder());
        assert_eq!(params["action"], "sitematrix");
    }
}