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

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

pub type NoValue = super::NoTitlesOrGenerator;

/// Internal data container for `action=wbformatvalue` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiWbformatvalueData {
    datavalue: Option<String>,
    generate: Option<String>,
    datatype: Option<String>,
    property: Option<String>,
    options: Option<String>,
}

impl ActionApiData for ActionApiWbformatvalueData {}

impl ActionApiWbformatvalueData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        params.insert("action".to_string(), "wbformatvalue".to_string());
        Self::add_str(&self.datavalue, "datavalue", &mut params);
        Self::add_str(&self.generate, "generate", &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);
        params
    }
}

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

impl<T> ActionApiWbformatvalueBuilder<T> {
    /// Sets the output format generator (e.g., `text/html`). `generate`
    pub fn generate<S: AsRef<str>>(mut self, generate: S) -> Self {
        self.data.generate = Some(generate.as_ref().to_string());
        self
    }

    /// Sets the data type of the value to format. `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
    }
}

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

    /// Sets the data value to format as a JSON-encoded string, advancing the builder to the runnable state. `datavalue`
    pub fn datavalue<S: AsRef<str>>(
        mut self,
        datavalue: S,
    ) -> ActionApiWbformatvalueBuilder<Runnable> {
        self.data.datavalue = Some(datavalue.as_ref().to_string());
        ActionApiWbformatvalueBuilder {
            _phantom: PhantomData,
            data: self.data,
        }
    }
}

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

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

    fn new_builder() -> ActionApiWbformatvalueBuilder<NoValue> {
        ActionApiWbformatvalueBuilder::new()
    }

    #[test]
    fn datavalue_set() {
        let params = new_builder()
            .datavalue(r#"{"type":"string","value":"foo"}"#)
            .data
            .params();
        assert_eq!(params["datavalue"], r#"{"type":"string","value":"foo"}"#);
    }

    #[test]
    fn generate_set() {
        let params = new_builder()
            .datavalue("{}")
            .generate("text/html")
            .data
            .params();
        assert_eq!(params["generate"], "text/html");
    }

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

    #[test]
    fn action_is_wbformatvalue() {
        let params = new_builder().datavalue("{}").data.params();
        assert_eq!(params["action"], "wbformatvalue");
    }
}