rsst 0.1.0

//! Code that manipulates the config file.

use crate::util;
use serde::Deserialize;
use std::path::PathBuf;
use toml;

/// A Setting session that carries optional settings.
#[derive(Deserialize)]
pub struct Setting {
    /// format to dump into. `"html"` or default
    pub output_format: Option<String>,
    /// the directory to saves all the dumped files.
    /// Defaults to `"~/rsst"`.
    pub output_dir: Option<String>,
    /// the directory to saves metadata about the feeds.
    /// Defaults to `"$XDG_DATA_HOME/rsst"`.
    pub metadata_dir: Option<String>,
}

/// A top level Configuration.
#[derive(Deserialize)]
pub struct Config {
    /// setting section (fields optional)
    pub setting: Setting,
    /// source section (fields are `alias -> source url` mappings)
    pub source: std::collections::BTreeMap<String, String>,
}

/// Try deserializing the file at the given `filepath` into a `String`.
fn to_string(filepath: Option<PathBuf>) -> Result<String, util::Error> {
    let filepath = util::get_config_file(match filepath {
        Some(v) => Some(String::from(v.to_str().expect("filepath is not legal"))),
        None => None,
    })?;
    util::to_string(filepath)
}

/// Try deserializing the given file into a `Config`. Use the default filepath
/// if not given.
pub fn get(name: Option<PathBuf>) -> Result<Config, util::Error> {
    let output = to_string(name)?;
    match toml::from_str(&output) {
        Ok(v) => Ok(v),
        Err(_) => Err(util::Error::ParseFailed),
    }
}

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

    #[test]
    fn parse_example() {
        let config: Config = toml::from_str(
            r#"
            [setting]
            metadata_dir = "$HOME/.local/share/rsst"
            output_format = "markdown"
            output_dir = "$HOME/rsst/"
            [source]
            example1 = "https://example.com/rss.xml"
            example2 = "https://example.org/rss.xml"
        "#,
        )
        .unwrap();
        assert_eq!(config.setting.output_format, Some(String::from("markdown")));
        assert_eq!(config.setting.output_dir, Some(String::from("$HOME/rsst/")));
        assert_eq!(
            config.setting.metadata_dir,
            Some(String::from("$HOME/.local/share/rsst"))
        );
        assert_eq!(config.source.len(), 2);
        assert_eq!(
            config.source.get("example1"),
            Some(&"https://example.com/rss.xml".to_string())
        );
        assert_eq!(
            config.source.get("example2"),
            Some(&"https://example.org/rss.xml".to_string())
        );
    }

    #[test]
    fn parse_example_alternative_format() {
        let config: Config = toml::from_str(
            r#"
            setting.output_format = "markdown"
            source.example3 = "https://example.com/rss.xml"
            source.example4 = "https://example.org/rss.xml"
        "#,
        )
        .unwrap();
        assert_eq!(config.setting.output_format, Some(String::from("markdown")));
        assert_eq!(config.source.len(), 2);
        assert_eq!(
            config.source.get("example3"),
            Some(&"https://example.com/rss.xml".to_string())
        );
        assert_eq!(
            config.source.get("example4"),
            Some(&"https://example.org/rss.xml".to_string())
        );
    }

    #[test]
    fn to_string_none() {
        assert_eq!(
            to_string(Some(PathBuf::from("NOT_EXISTS"))),
            Err(util::Error::NotFound)
        );
    }

    #[test]
    fn to_string_xdg_dir_empty_file() {
        let fixtures = env::current_dir()
            .expect("failed to get current dir")
            .join("fixtures/empty/");
        env::set_var("XDG_CONFIG_HOME", fixtures);
        assert_eq!(to_string(None), Ok(String::from("")));
    }

    #[test]
    fn to_string_xdg_dir_not_exists() {
        let fixtures = env::current_dir()
            .expect("failed to get current dir")
            .join("fixtures/NON_EXISTS/");
        env::set_var("XDG_CONFIG_HOME", fixtures);
        assert_eq!(to_string(None), Err(util::Error::NotFound));
    }

    #[test]
    fn to_string_xdg_dir_file_not_exists() {
        let fixtures = env::current_dir()
            .expect("failed to get current dir")
            .join("fixtures/nothing/");
        env::set_var("XDG_CONFIG_HOME", fixtures);
        assert_eq!(to_string(None), Err(util::Error::NotFound));
    }

    #[test]
    fn get_xdg_dir_simple_example() {
        let fixtures = env::current_dir()
            .expect("failed to get current dir")
            .join("fixtures/simple/");
        env::set_var("XDG_CONFIG_HOME", fixtures);
        let config = get(None).unwrap();
        assert_eq!(config.setting.output_format, Some(String::from("html")));
        assert_eq!(config.source.len(), 2);
        assert_eq!(
            config.source.get("mine"),
            Some(&"https://quinoa42.github.io/rss.xml".to_string())
        );
        assert_eq!(
            config.source.get("again"),
            Some(&"quinoa42.github.io/rss.xml".to_string())
        );
    }

    #[test]
    fn get_simple_example() {
        let filepath = env::current_dir()
            .expect("failed to get current dir")
            .join("fixtures/simple/rsst/config.toml");
        let config = get(Some(filepath)).unwrap();
        assert_eq!(config.setting.output_format, Some(String::from("html")));
        assert_eq!(config.source.len(), 2);
        assert_eq!(
            config.source.get("mine"),
            Some(&"https://quinoa42.github.io/rss.xml".to_string())
        );
        assert_eq!(
            config.source.get("again"),
            Some(&"quinoa42.github.io/rss.xml".to_string())
        );
    }
}