slate 1.4.0

Manage your snippets from your command line.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use std::env;
use std::path::PathBuf;

const SLATE_FILEPATH: &'static str = "SLATE_FILEPATH";

pub trait EnvWrapper {
    fn var(&self, var: &'static str) -> Result<String, env::VarError>;
}

struct Env;

impl EnvWrapper for Env {
    fn var(&self, var: &'static str) -> Result<String, env::VarError> {
        env::var(var)
    }
}

/// Main Configuration struct
#[derive(Clone)]
pub struct Config {
    /// Path to the slate file.
    pub filepath: PathBuf,
}

impl Config {
    /// Get a new Config struct with all of its fields
    /// initialized with env vars or default values.
    ///
    /// If the env var `SLATE_FILEPATH` is set with a valid
    /// path to a file, that value will be used when initializing
    /// the Config struct.
    ///
    /// # Example
    ///
    /// ```rust
    /// use slate::config::Config;
    /// use std::env;
    ///
    /// env::set_var("SLATE_FILEPATH", "/tmp/var");
    /// let config = Config::from_env();
    /// println!("{}", config.filepath.to_str().unwrap());
    /// //=> /tmp/slate
    /// env::remove_var("SLATE_FILEPATH");
    /// ```
    ///
    /// If there is no env var, the default `$HOME/.slate` value
    /// will be used.
    ///
    /// # Example
    ///
    /// ```rust
    /// use slate::config::Config;
    /// use std::env;
    ///
    /// env::remove_var("SLATE_FILEPATH");
    /// let config = Config::from_env();
    /// println!("{}", config.filepath.to_str().unwrap());
    /// //=> $HOME/.slate
    /// ```
    pub fn from_env() -> Config {
        let wrapper = Env;
        Self::new(wrapper)
    }

    pub fn new<T: EnvWrapper>(wrapper: T) -> Config {
        let config: Config = match wrapper.var(SLATE_FILEPATH) {
            Ok(value) => Config { filepath: PathBuf::from(value) },
            Err(_) => Default::default(),
        };

        config
    }
}

impl Default for Config {
    /// Default implementation of a Config struct.
    ///
    /// It will always use the `$HOME/.slate` for the
    /// filepath.
    ///
    /// It panics if there is no HOME dir.
    fn default() -> Config {
        let mut path = match env::home_dir() {
            Some(home) => home,
            None => panic!("No HOME dir found"),
        };
        path.push(".slate");

        Config { filepath: path }
    }
}

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

    struct MockEnv {
        value: Option<bool>,
    }

    impl EnvWrapper for MockEnv {
        fn var(&self, _var: &'static str) -> Result<String, env::VarError> {
            match self.value {
                Some(_) => Ok("/tmp/slate".to_string()),
                None => Err(env::VarError::NotPresent)
            }
        }
    }

    #[test]
    fn it_uses_the_homedir_as_default_path() {
        let wrapper = MockEnv { value: None };
        let config: Config = Config::new(wrapper);
        let mut expected: PathBuf = env::home_dir().unwrap();
        expected.push(".slate");

        assert_eq!(expected, config.filepath);
    }

    #[test]
    fn it_uses_the_environment_var_if_set() {
        let wrapper = MockEnv { value: Some(true) };
        let config: Config = Config::new(wrapper);
        let expected: PathBuf = PathBuf::from("/tmp/slate");

        assert_eq!(expected, config.filepath);
    }
}