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

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

pub type NoValues = super::NoTitlesOrGenerator;

/// Internal data container for `action=wbparsevalue` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiWbparsevalueData {
    values: Option<Vec<String>>,
    datatype: Option<String>,
    property: Option<String>,
    options: Option<String>,
    validate: bool,
}

impl ActionApiData for ActionApiWbparsevalueData {}

impl ActionApiWbparsevalueData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        params.insert("action".to_string(), "wbparsevalue".to_string());
        Self::add_vec(&self.values, "values", &mut params);
        Self::add_str(&self.datatype, "datatype", &mut params);
        Self::add_str(&self.property, "property", &mut params);
        Self::add_str(&self.options, "options", &mut params);
        Self::add_boolean(self.validate, "validate", &mut params);
        params
    }
}

/// Builder for the `action=wbparsevalue` API action; uses the typestate pattern to enforce required parameters before execution.
#[derive(Debug, Clone)]
pub struct ActionApiWbparsevalueBuilder<T> {
    _phantom: PhantomData<T>,
    pub(crate) data: ActionApiWbparsevalueData,
}

impl<T> ActionApiWbparsevalueBuilder<T> {
    /// Sets the expected data type for parsing. `datatype`
    pub fn datatype<S: AsRef<str>>(mut self, datatype: S) -> Self {
        self.data.datatype = Some(datatype.as_ref().to_string());
        self
    }

    /// Sets the property ID used to infer the data type. `property`
    pub fn property<S: AsRef<str>>(mut self, property: S) -> Self {
        self.data.property = Some(property.as_ref().to_string());
        self
    }

    /// Sets additional options as a JSON-encoded string. `options`
    pub fn options<S: AsRef<str>>(mut self, options: S) -> Self {
        self.data.options = Some(options.as_ref().to_string());
        self
    }

    /// If true, validates the parsed values without saving. `validate`
    pub fn validate(mut self, validate: bool) -> Self {
        self.data.validate = validate;
        self
    }
}

impl ActionApiWbparsevalueBuilder<NoValues> {
    /// Creates a new builder with default values.
    pub fn new() -> Self {
        Self {
            _phantom: PhantomData,
            data: ActionApiWbparsevalueData::default(),
        }
    }

    /// Sets the list of values to parse, advancing the builder to the runnable state. `values`
    pub fn values<S: Into<String> + Clone>(
        mut self,
        values: &[S],
    ) -> ActionApiWbparsevalueBuilder<Runnable> {
        self.data.values = Some(values.iter().map(|s| s.clone().into()).collect());
        ActionApiWbparsevalueBuilder {
            _phantom: PhantomData,
            data: self.data,
        }
    }
}

impl ActionApiRunnable for ActionApiWbparsevalueBuilder<Runnable> {
    fn params(&self) -> HashMap<String, String> {
        self.data.params()
    }
}

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

    fn new_builder() -> ActionApiWbparsevalueBuilder<NoValues> {
        ActionApiWbparsevalueBuilder::new()
    }

    #[test]
    fn values_single_set() {
        let params = new_builder().values(&["foo"]).data.params();
        assert_eq!(params["values"], "foo");
    }

    #[test]
    fn values_multiple_set() {
        let params = new_builder().values(&["foo", "bar"]).data.params();
        assert_eq!(params["values"], "foo|bar");
    }

    #[test]
    fn datatype_set() {
        let params = new_builder().values(&["foo"]).datatype("string").data.params();
        assert_eq!(params["datatype"], "string");
    }

    #[test]
    fn action_is_wbparsevalue() {
        let params = new_builder().values(&["foo"]).data.params();
        assert_eq!(params["action"], "wbparsevalue");
    }
}