zola/src/config.rs

164 lines
4.1 KiB
Rust
Raw Normal View History

2016-12-06 06:55:17 +00:00
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;
2017-02-23 08:34:57 +00:00
use std::collections::HashMap;
2016-12-06 05:51:33 +00:00
2017-02-23 08:34:57 +00:00
use toml::{Value as Toml, self};
2016-12-06 05:51:33 +00:00
2017-02-23 08:34:57 +00:00
use errors::{Result, ResultExt};
2016-12-06 05:51:33 +00:00
2017-03-07 12:34:31 +00:00
2017-03-19 11:20:24 +00:00
// TO ADD:
// highlight code theme
// generate_tags_pages
// generate_categories_pages
#[derive(Debug, PartialEq, Serialize, Deserialize)]
2016-12-06 05:51:33 +00:00
pub struct Config {
2017-02-23 08:34:57 +00:00
/// Title of the site
2016-12-06 05:51:33 +00:00
pub title: String,
2017-02-23 08:34:57 +00:00
/// Base URL of the site
2016-12-06 05:51:33 +00:00
pub base_url: String,
2017-03-10 11:39:58 +00:00
/// Whether to highlight all code blocks found in markdown files. Defaults to false
pub highlight_code: Option<bool>,
2017-02-23 08:34:57 +00:00
/// Description of the site
pub description: Option<String>,
/// The language used in the site. Defaults to "en"
pub language_code: Option<String>,
2017-03-12 03:59:28 +00:00
/// Whether to generate RSS, defaults to false
pub generate_rss: Option<bool>,
2017-02-23 08:34:57 +00:00
/// All user params set in [extra] in the config
pub extra: Option<HashMap<String, Toml>>,
2016-12-06 06:55:17 +00:00
}
impl Config {
2017-02-23 08:34:57 +00:00
/// Parses a string containing TOML to our Config struct
/// Any extra parameter will end up in the extra field
pub fn parse(content: &str) -> Result<Config> {
let mut config: Config = match toml::from_str(content) {
Ok(c) => c,
Err(e) => bail!(e)
};
2017-02-23 08:34:57 +00:00
if config.language_code.is_none() {
config.language_code = Some("en".to_string());
2016-12-06 06:55:17 +00:00
}
2017-02-23 08:34:57 +00:00
if config.highlight_code.is_none() {
config.highlight_code = Some(false);
}
2017-03-12 03:59:28 +00:00
if config.generate_rss.is_none() {
config.generate_rss = Some(false);
}
2017-02-23 08:34:57 +00:00
Ok(config)
2016-12-06 06:55:17 +00:00
}
2017-02-23 08:34:57 +00:00
/// Parses a config file from the given path
2016-12-06 06:55:17 +00:00
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Config> {
let mut content = String::new();
File::open(path)
2017-02-23 08:34:57 +00:00
.chain_err(|| "No `config.toml` file found. Are you in the right directory?")?
.read_to_string(&mut content)?;
2016-12-06 05:51:33 +00:00
2017-02-23 08:34:57 +00:00
Config::parse(&content)
2016-12-06 06:55:17 +00:00
}
}
2017-03-06 14:45:57 +00:00
impl Default for Config {
/// Exists for testing purposes
fn default() -> Config {
Config {
title: "".to_string(),
base_url: "http://a-website.com/".to_string(),
highlight_code: Some(true),
description: None,
language_code: Some("en".to_string()),
2017-03-12 03:59:28 +00:00
generate_rss: Some(false),
2017-03-06 14:45:57 +00:00
extra: None,
}
}
}
/// Get and parse the config.
/// If it doesn't succeed, exit
pub fn get_config(path: &Path) -> Config {
match Config::from_file(path.join("config.toml")) {
Ok(c) => c,
Err(e) => {
println!("Failed to load config.toml");
println!("Error: {}", e);
::std::process::exit(1);
}
}
}
2016-12-06 06:55:17 +00:00
#[cfg(test)]
mod tests {
use super::{Config};
#[test]
fn test_can_import_valid_config() {
let config = r#"
title = "My site"
base_url = "https://replace-this-with-your-url.com"
"#;
2017-02-23 08:34:57 +00:00
let config = Config::parse(config).unwrap();
2016-12-06 06:55:17 +00:00
assert_eq!(config.title, "My site".to_string());
}
#[test]
fn test_errors_when_invalid_type() {
let config = r#"
title = 1
base_url = "https://replace-this-with-your-url.com"
"#;
2017-02-23 08:34:57 +00:00
let config = Config::parse(config);
assert!(config.is_err());
}
#[test]
fn test_errors_when_missing_required_field() {
let config = r#"
title = ""
"#;
let config = Config::parse(config);
2016-12-06 06:55:17 +00:00
assert!(config.is_err());
}
2017-02-23 08:34:57 +00:00
#[test]
fn test_can_add_extra_values() {
let config = r#"
title = "My site"
base_url = "https://replace-this-with-your-url.com"
[extra]
hello = "world"
"#;
let config = Config::parse(config);
assert!(config.is_ok());
assert_eq!(config.unwrap().extra.unwrap().get("hello").unwrap().as_str().unwrap(), "world");
}
#[test]
fn test_language_defaults_to_en() {
let config = r#"
title = "My site"
base_url = "https://replace-this-with-your-url.com""#;
let config = Config::parse(config);
assert!(config.is_ok());
let config = config.unwrap();
assert_eq!(config.language_code.unwrap(), "en");
}
2016-12-06 06:55:17 +00:00
}