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
136
137
138
139
140
141
142
143
144

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

/// Internal data container for `list=pageswithprop` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiListPageswithpropData {
    pwppropname: Option<String>,
    pwpprop: Option<Vec<String>>,
    pwpdir: Option<String>,
    pwplimit: usize,
    pwpcontinue: Option<String>,
}

impl ActionApiData for ActionApiListPageswithpropData {}

impl ActionApiListPageswithpropData {
    pub(crate) fn new() -> Self {
        Self {
            pwppropname: None,
            pwpprop: None,
            pwpdir: None,
            pwplimit: 10,
            pwpcontinue: None,
        }
    }

    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        Self::add_str(&self.pwppropname, "pwppropname", &mut params);
        Self::add_vec(&self.pwpprop, "pwpprop", &mut params);
        Self::add_str(&self.pwpdir, "pwpdir", &mut params);
        params.insert("pwplimit".to_string(), self.pwplimit.to_string());
        Self::add_str(&self.pwpcontinue, "pwpcontinue", &mut params);
        params
    }
}

/// Builder for `list=pageswithprop` — lists all pages using a certain page property.
#[derive(Debug, Clone)]
pub struct ActionApiListPageswithpropBuilder {
    pub(crate) data: ActionApiListPageswithpropData,
    pub(crate) continue_params: HashMap<String, String>,
}

impl ActionApiListPageswithpropBuilder {
    pub(crate) fn new() -> Self {
        Self {
            data: ActionApiListPageswithpropData::new(),
            continue_params: HashMap::new(),
        }
    }

    /// Page property for which to enumerate pages (`pwppropname`).
    pub fn pwppropname<S: AsRef<str>>(mut self, pwppropname: S) -> Self {
        self.data.pwppropname = Some(pwppropname.as_ref().to_string());
        self
    }

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

    /// Direction to sort (`pwpdir`).
    pub fn pwpdir<S: AsRef<str>>(mut self, pwpdir: S) -> Self {
        self.data.pwpdir = Some(pwpdir.as_ref().to_string());
        self
    }

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

impl ActionApiRunnable for ActionApiListPageswithpropBuilder {
    fn params(&self) -> HashMap<String, String> {
        let mut ret = self.data.params();
        ret.insert("action".to_string(), "query".to_string());
        ret.insert("list".to_string(), "pageswithprop".to_string());
        ret.extend(self.continue_params.clone());
        ret
    }
}

impl ActionApiContinuable for ActionApiListPageswithpropBuilder {
    fn continue_params_mut(&mut self) -> &mut HashMap<String, String> {
        &mut self.continue_params
    }
}

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

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

    #[test]
    fn default_pwplimit_is_10() {
        let params = new_builder().data.params();
        assert_eq!(params["pwplimit"], "10");
    }

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

    #[test]
    fn pwppropname_set() {
        let params = new_builder().pwppropname("wikibase_item").data.params();
        assert_eq!(params["pwppropname"], "wikibase_item");
    }

    #[test]
    fn pwpprop_set() {
        let params = new_builder().pwpprop(&["ids", "title", "value"]).data.params();
        assert_eq!(params["pwpprop"], "ids|title|value");
    }

    #[test]
    fn pwpdir_set() {
        let params = new_builder().pwpdir("descending").data.params();
        assert_eq!(params["pwpdir"], "descending");
    }

    #[test]
    fn pwplimit_set() {
        let params = new_builder().pwplimit(50).data.params();
        assert_eq!(params["pwplimit"], "50");
    }

    #[test]
    fn runnable_params_contain_action_list() {
        let params = ActionApiRunnable::params(&new_builder());
        assert_eq!(params["action"], "query");
        assert_eq!(params["list"], "pageswithprop");
    }
}