configstore 0.1.3

use anyhow::Result;
use platform_dirs::AppDirs;
/// Expose so that consumer can determine the type of the application;
pub use platform_dirs::AppUI;
use serde::{Deserialize, Serialize};
use std::fs::OpenOptions;
use std::io::BufReader;
use std::path::PathBuf;
///Configstore store configurations
/// Will store configuration on your platforms native configuration directory
/// # Examples
///
/// ```
/// use configstore::{Configstore, AppUI};
///
/// let config_store = Configstore::new("myApp", AppUI::CommandLine).unwrap();
/// config_store.set("key", "value".to_string()).unwrap();
/// let value: String = config_store.get("key").unwrap();
/// assert_eq!("value".to_string(), value);
/// ```
pub struct Configstore {
    prefix_dir: PathBuf,
}

const CONFIG_STORE_NAME: &str = "configstore-rs";

impl Configstore {
    /// Creates a new configstore based on a name and a type of ui
    /// Takes:
    ///   app_name: &str representing the name of the application
    ///   app_ui: AppUI (either AppUI::CommandLine or AppUI::Graphical) type of the application
    /// # Examples
    ///
    /// ```
    /// use configstore::{Configstore, AppUI};
    ///
    /// let command_line_confg = Configstore::new("myApp", AppUI::CommandLine).unwrap();
    ///```
    ///
    /// # Errors
    ///
    /// Could error either if your plateform does not have a config directory (All Linux, MacOs and Windows do)
    /// Or if the application is unable to create the directories for its config files
    pub fn new(app_name: &str, app_ui: AppUI) -> Result<Self> {
        let prefix_dir = match AppDirs::new(Some(CONFIG_STORE_NAME), app_ui) {
            Some(dir) => dir.config_dir,
            None => return Err(anyhow::Error::msg("Unable to find config directory")),
        };
        let prefix_dir = prefix_dir.join(app_name);
        std::fs::create_dir_all(prefix_dir.clone())?;

        Ok(Configstore { prefix_dir })
    }

    /// Sets a value in the configstore, to be retrieved at any point in time with get
    /// Overwrites any existing values with the same key, or creates a new pair
    /// value is saved as a json file in $CONFIG/configstore-rs/$APPNAME/key.json
    /// value must implement serde::Serialize and serde::Deserialize
    ///
    /// # Examples
    ///
    /// ```
    /// use serde_derive::*;
    /// use configstore::{Configstore, AppUI};
    /// #[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
    /// struct Value {
    ///     text: String,
    ///     num: u32
    /// }
    ///
    /// let config_store = Configstore::new("myApp", AppUI::CommandLine).unwrap();
    /// let value = Value {text: "hello world".to_string(), num: 4343};
    /// config_store.set("key", value.clone()).unwrap();
    /// let same_value: Value = config_store.get("key").unwrap();
    /// assert_eq!(value, same_value);
    /// ```
    ///
    /// # Errors
    /// Possible errors if config file cannot be oppened, or value cannot be encoded
    /// into json
    pub fn set<T>(&self, key: &str, value: T) -> Result<()>
    where
        T: Serialize + for<'de> Deserialize<'de>,
    {
        let mut file_name = String::from(key);
        file_name.push_str(".json");
        let config_path = self.prefix_dir.join(&file_name);
        let file = OpenOptions::new()
            .write(true)
            .create(true)
            .truncate(true)
            .open(config_path)?;
        serde_json::to_writer(&file, &value)?;
        Ok(())
    }

    /// Check the set docs for usage
    /// # Errors
    /// Could produce errors if unable to open config file
    /// This could happen if the key was never set or if you manually deleted the file
    /// Otherwise could cause errors if the type cannot be decoded correctly
    pub fn get<T>(&self, key: &str) -> Result<T>
    where
        T: Serialize + for<'de> Deserialize<'de>,
    {
        let mut file_name = String::from(key);
        file_name.push_str(".json");
        let config_path = self.prefix_dir.join(&file_name);
        let file = std::fs::File::open(config_path)?;
        let buff_reader = BufReader::new(file);
        let ret: T = serde_json::from_reader(buff_reader)?;
        Ok(ret)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_derive::*;
    #[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
    struct TestStruct {
        str_test: String,
        num: i64,
    }
    #[test]
    fn test_struct() {
        let config_store = Configstore::new("tests", AppUI::CommandLine).unwrap();
        let test_struct = TestStruct {
            str_test: "Hello World".to_string(),
            num: 1000,
        };
        config_store.set("test1", test_struct.clone()).unwrap();
        let other_struct: TestStruct = config_store.get("test1").unwrap();
        assert_eq!(test_struct, other_struct);
    }

    #[test]
    fn test_string() {
        let config_store = Configstore::new("tests", AppUI::CommandLine).unwrap();
        config_store.set("test2", String::from("World")).unwrap();
        let out: String = config_store.get("test2").unwrap();
        assert_eq!(out, "World".to_string());
    }

    #[test]
    fn reset_same_type() {
        let config_store = Configstore::new("tests", AppUI::CommandLine).unwrap();
        let test_struct = TestStruct {
            str_test: "Hello World".to_string(),
            num: 1000,
        };
        config_store.set("test3", test_struct.clone()).unwrap();
        let other_struct: TestStruct = config_store.get("test3").unwrap();
        assert_eq!(test_struct, other_struct);
        let replacement_struct = TestStruct {
            str_test: "Goodbye World".to_string(),
            num: 4242,
        };
        config_store
            .set("test3", replacement_struct.clone())
            .unwrap();
        let out: TestStruct = config_store.get("test3").unwrap();
        assert_eq!(replacement_struct, out);
    }

    #[test]
    fn test_vector() {
        let config_store = Configstore::new("tests", AppUI::CommandLine).unwrap();
        let test_struct_1 = TestStruct {
            str_test: "Hello World".to_string(),
            num: 1000,
        };
        let test_struct_2 = TestStruct {
            str_test: "Goodbye world".to_string(),
            num: 4524,
        };
        let test_vec = vec![test_struct_1, test_struct_2];
        config_store.set("test4", test_vec.clone()).unwrap();
        let out: Vec<TestStruct> = config_store.get("test4").unwrap();
        assert_eq!(out.len(), test_vec.len());
        for (i, val) in out.iter().enumerate() {
            assert_eq!(test_vec[i], *val);
        }
    }
}