mediawiki 0.5.1

A MediaWiki client library
Documentation
use super::{ActionApiData, ActionApiRunnable};
use std::collections::HashMap;

/// Internal data container for `action=parse` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiParseData {
    title: Option<String>,
    text: Option<String>,
    revid: Option<u64>,
    summary: Option<String>,
    page: Option<String>,
    pageid: Option<u64>,
    redirects: bool,
    oldid: Option<u64>,
    prop: Option<Vec<String>>,
    wrapoutputclass: Option<String>,
    parsoid: bool,
    pst: bool,
    onlypst: bool,
    section: Option<String>,
    sectiontitle: Option<String>,
    disablelimitreport: bool,
    disableeditsection: bool,
    disabletoc: bool,
    preview: bool,
    sectionpreview: bool,
    useskin: Option<String>,
    contentformat: Option<String>,
    contentmodel: Option<String>,
    mobileformat: bool,
}

impl ActionApiData for ActionApiParseData {}

impl ActionApiParseData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        params.insert("action".to_string(), "parse".to_string());
        Self::add_str(&self.title, "title", &mut params);
        Self::add_str(&self.text, "text", &mut params);
        if let Some(revid) = self.revid {
            params.insert("revid".to_string(), revid.to_string());
        }
        Self::add_str(&self.summary, "summary", &mut params);
        Self::add_str(&self.page, "page", &mut params);
        if let Some(pageid) = self.pageid {
            params.insert("pageid".to_string(), pageid.to_string());
        }
        Self::add_boolean(self.redirects, "redirects", &mut params);
        if let Some(oldid) = self.oldid {
            params.insert("oldid".to_string(), oldid.to_string());
        }
        Self::add_vec(&self.prop, "prop", &mut params);
        Self::add_str(&self.wrapoutputclass, "wrapoutputclass", &mut params);
        Self::add_boolean(self.parsoid, "parsoid", &mut params);
        Self::add_boolean(self.pst, "pst", &mut params);
        Self::add_boolean(self.onlypst, "onlypst", &mut params);
        Self::add_str(&self.section, "section", &mut params);
        Self::add_str(&self.sectiontitle, "sectiontitle", &mut params);
        Self::add_boolean(self.disablelimitreport, "disablelimitreport", &mut params);
        Self::add_boolean(self.disableeditsection, "disableeditsection", &mut params);
        Self::add_boolean(self.disabletoc, "disabletoc", &mut params);
        Self::add_boolean(self.preview, "preview", &mut params);
        Self::add_boolean(self.sectionpreview, "sectionpreview", &mut params);
        Self::add_str(&self.useskin, "useskin", &mut params);
        Self::add_str(&self.contentformat, "contentformat", &mut params);
        Self::add_str(&self.contentmodel, "contentmodel", &mut params);
        Self::add_boolean(self.mobileformat, "mobileformat", &mut params);
        params
    }
}

/// Builder for `action=parse`. Set the content source via `.page()`, `.text()`, `.pageid()`, or `.oldid()`, then call `.run()`.
#[derive(Debug, Clone)]
pub struct ActionApiParseBuilder {
    pub(crate) data: ActionApiParseData,
}

impl ActionApiParseBuilder {
    /// Creates a new builder with default values.
    pub fn new() -> Self {
        Self {
            data: ActionApiParseData::default(),
        }
    }

    /// Title of the page to use as context when parsing wikitext supplied via `text` (`title`).
    pub fn title<S: AsRef<str>>(mut self, title: S) -> Self {
        self.data.title = Some(title.as_ref().to_string());
        self
    }

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

    /// Revision ID to use for `{{REVISIONID}}` and similar magic words (`revid`).
    pub fn revid(mut self, revid: u64) -> Self {
        self.data.revid = Some(revid);
        self
    }

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

    /// Title of the existing wiki page to parse (`page`).
    pub fn page<S: AsRef<str>>(mut self, page: S) -> Self {
        self.data.page = Some(page.as_ref().to_string());
        self
    }

    /// Page ID of the existing wiki page to parse (`pageid`).
    pub fn pageid(mut self, pageid: u64) -> Self {
        self.data.pageid = Some(pageid);
        self
    }

    /// Whether to automatically resolve redirects when using `page` or `pageid` (`redirects`).
    pub fn redirects(mut self, redirects: bool) -> Self {
        self.data.redirects = redirects;
        self
    }

    /// Revision ID of the specific revision to parse (`oldid`).
    pub fn oldid(mut self, oldid: u64) -> Self {
        self.data.oldid = Some(oldid);
        self
    }

    /// List of output properties to include in the parse response (`prop`).
    pub fn prop<S: Into<String> + Clone>(mut self, prop: &[S]) -> Self {
        self.data.prop = Some(prop.iter().map(|s| s.clone().into()).collect());
        self
    }

    /// CSS class to wrap parsed output in (`wrapoutputclass`).
    pub fn wrapoutputclass<S: AsRef<str>>(mut self, wrapoutputclass: S) -> Self {
        self.data.wrapoutputclass = Some(wrapoutputclass.as_ref().to_string());
        self
    }

    /// Whether to apply pre-save transform (expand templates etc.) before parsing (`pst`).
    pub fn pst(mut self, pst: bool) -> Self {
        self.data.pst = pst;
        self
    }

    /// Section number or `"new"` to parse only that section (`section`).
    pub fn section<S: AsRef<str>>(mut self, section: S) -> Self {
        self.data.section = Some(section.as_ref().to_string());
        self
    }

    /// Whether to omit the parser limit report from the output (`disablelimitreport`).
    pub fn disablelimitreport(mut self, disablelimitreport: bool) -> Self {
        self.data.disablelimitreport = disablelimitreport;
        self
    }

    /// Whether to omit section-edit links from the parsed output (`disableeditsection`).
    pub fn disableeditsection(mut self, disableeditsection: bool) -> Self {
        self.data.disableeditsection = disableeditsection;
        self
    }

    /// Whether to omit the table of contents from the parsed output (`disabletoc`).
    pub fn disabletoc(mut self, disabletoc: bool) -> Self {
        self.data.disabletoc = disabletoc;
        self
    }

    /// Whether to parse in preview mode (`preview`).
    pub fn preview(mut self, preview: bool) -> Self {
        self.data.preview = preview;
        self
    }

    /// Skin to apply to the parsed output (`useskin`).
    pub fn useskin<S: AsRef<str>>(mut self, useskin: S) -> Self {
        self.data.useskin = Some(useskin.as_ref().to_string());
        self
    }

    /// Content serialization format of the input text, e.g. `"text/x-wiki"` (`contentformat`).
    pub fn contentformat<S: AsRef<str>>(mut self, contentformat: S) -> Self {
        self.data.contentformat = Some(contentformat.as_ref().to_string());
        self
    }

    /// Content model of the input text, e.g. `"wikitext"` (`contentmodel`).
    pub fn contentmodel<S: AsRef<str>>(mut self, contentmodel: S) -> Self {
        self.data.contentmodel = Some(contentmodel.as_ref().to_string());
        self
    }

    /// Whether to transform the parsed output for mobile display (`mobileformat`).
    pub fn mobileformat(mut self, mobileformat: bool) -> Self {
        self.data.mobileformat = mobileformat;
        self
    }
}

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

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Api, action_api::ActionApi};

    #[test]
    fn page_set() {
        let params = ActionApiParseBuilder::new()
            .page("Albert Einstein")
            .data
            .params();
        assert_eq!(params["page"], "Albert Einstein");
    }

    #[test]
    fn text_with_contentmodel() {
        let params = ActionApiParseBuilder::new()
            .text("Hello '''world'''")
            .contentmodel("wikitext")
            .data
            .params();
        assert_eq!(params["text"], "Hello '''world'''");
        assert_eq!(params["contentmodel"], "wikitext");
    }

    #[test]
    fn prop_set() {
        let params = ActionApiParseBuilder::new()
            .page("Foo")
            .prop(&["text", "links"])
            .data
            .params();
        assert_eq!(params["prop"], "text|links");
    }

    #[test]
    fn pageid_set() {
        let params = ActionApiParseBuilder::new().pageid(736).data.params();
        assert_eq!(params["pageid"], "736");
    }

    #[test]
    fn oldid_set() {
        let params = ActionApiParseBuilder::new().oldid(12345).data.params();
        assert_eq!(params["oldid"], "12345");
    }

    #[test]
    fn disabletoc_set() {
        let params = ActionApiParseBuilder::new()
            .page("Foo")
            .disabletoc(true)
            .data
            .params();
        assert!(params.contains_key("disabletoc"));
    }

    #[test]
    fn action_is_parse() {
        let params = ActionApiParseBuilder::new().data.params();
        assert_eq!(params["action"], "parse");
    }

    #[tokio::test]
    async fn test_parse_page() {
        use wiremock::matchers::query_param;
        use wiremock::{Mock, ResponseTemplate};
        let server = crate::test_helpers::test_helpers_mod::start_enwiki_mock().await;
        Mock::given(query_param("action", "parse"))
            .respond_with(ResponseTemplate::new(200).set_body_json(json!({
                "parse": {
                    "title": "Albert Einstein",
                    "pageid": 736,
                    "text": {"*": "<div>Einstein article content</div>"}
                }
            })))
            .mount(&server)
            .await;
        let api = Api::new(&server.uri()).await.unwrap();
        let result = ActionApi::parse()
            .page("Albert Einstein")
            .prop(&["text"])
            .disablelimitreport(true)
            .run(&api)
            .await
            .unwrap();
        assert!(result["parse"]["text"].is_object() || result["parse"]["text"].is_string());
    }
}