espanso/espanso-config/src/lib.rs

/*
 * This file is part of espanso.
 *
 * Copyright (C) 2019-2021 Federico Terzi
 *
 * espanso is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * espanso is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with espanso.  If not, see <https://www.gnu.org/licenses/>.
 */

use anyhow::Result;
use config::ConfigStore;
use matches::store::MatchStore;
use std::path::Path;
use thiserror::Error;

#[macro_use]
extern crate lazy_static;

pub mod config;
mod counter;
pub mod matches;
mod util;

pub fn load(base_path: &Path) -> Result<(impl ConfigStore, impl MatchStore)> {
  let config_dir = base_path.join("config");
  if !config_dir.exists() || !config_dir.is_dir() {
    return Err(ConfigError::MissingConfigDir().into());
  }

  let config_store = config::load_store(&config_dir)?;
  let root_paths = config_store.get_all_match_paths();

  let mut match_store = matches::store::new();
  match_store.load(&root_paths.into_iter().collect::<Vec<String>>());

  Ok((config_store, match_store))
}

#[derive(Error, Debug)]
pub enum ConfigError {
  #[error("missing config directory")]
  MissingConfigDir(),
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::util::tests::use_test_directory;
  use config::{AppProperties, ConfigStore};

  #[test]
  fn load_works_correctly() {
    use_test_directory(|base, match_dir, config_dir| {
      let base_file = match_dir.join("base.yml");
      std::fs::write(
        &base_file,
        r#"
      matches:
        - trigger: "hello"
          replace: "world"
      "#,
      )
      .unwrap();

      let another_file = match_dir.join("another.yml");
      std::fs::write(
        &another_file,
        r#"
      imports:
        - "_sub.yml"

      matches:
        - trigger: "hello2"
          replace: "world2"
      "#,
      )
      .unwrap();

      let under_file = match_dir.join("_sub.yml");
      std::fs::write(
        &under_file,
        r#"
      matches:
        - trigger: "hello3"
          replace: "world3"
      "#,
      )
      .unwrap();

      let config_file = config_dir.join("default.yml");
      std::fs::write(&config_file, "").unwrap();

      let custom_config_file = config_dir.join("custom.yml");
      std::fs::write(
        &custom_config_file,
        r#"
      filter_title: "Chrome"

      use_standard_includes: false
      includes: ["../match/another.yml"]
      "#,
      )
      .unwrap();

      let (config_store, match_store) = load(&base).unwrap();

      assert_eq!(config_store.default().match_paths().len(), 2);
      assert_eq!(
        config_store
          .active(&AppProperties {
            title: Some("Google Chrome"),
            class: None,
            exec: None,
          })
          .match_paths()
          .len(),
        1
      );

      assert_eq!(
        match_store
          .query(config_store.default().match_paths())
          .matches
          .len(),
        3
      );
      assert_eq!(
        match_store
          .query(
            config_store
              .active(&AppProperties {
                title: Some("Chrome"),
                class: None,
                exec: None,
              })
              .match_paths()
          )
          .matches
          .len(),
        2
      );
    });
  }

  #[test]
  fn load_without_valid_config_dir() {
    use_test_directory(|_, match_dir, _| {
      // To correcly load the configs, the "load" method looks for the "config" directory
      assert!(load(&match_dir).is_err());
    });
  }
}