use-config-profile 0.1.0

Primitive runtime and deployment profile names for RustUse
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
131

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use core::{fmt, str::FromStr};
use std::error::Error;

/// A primitive runtime or deployment profile name.
#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum ConfigProfile {
    /// Local developer profile.
    Local,
    /// Development profile.
    Development,
    /// Test profile.
    Test,
    /// Staging profile.
    Staging,
    /// Production profile.
    Production,
    /// Caller-defined profile name.
    Custom(String),
}

/// Error returned when a profile name is invalid.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ConfigProfileError;

impl fmt::Display for ConfigProfileError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str("configuration profile is empty")
    }
}

impl Error for ConfigProfileError {}

impl fmt::Display for ConfigProfile {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Local => formatter.write_str("local"),
            Self::Development => formatter.write_str("development"),
            Self::Test => formatter.write_str("test"),
            Self::Staging => formatter.write_str("staging"),
            Self::Production => formatter.write_str("production"),
            Self::Custom(value) => formatter.write_str(value),
        }
    }
}

impl FromStr for ConfigProfile {
    type Err = ConfigProfileError;

    fn from_str(input: &str) -> Result<Self, Self::Err> {
        let trimmed = input.trim();

        if trimmed.is_empty() {
            return Err(ConfigProfileError);
        }

        let profile = match trimmed.to_ascii_lowercase().as_str() {
            "local" => Self::Local,
            "development" | "dev" => Self::Development,
            "test" | "testing" => Self::Test,
            "staging" | "stage" => Self::Staging,
            "production" | "prod" => Self::Production,
            _ => Self::Custom(trimmed.to_owned()),
        };

        Ok(profile)
    }
}

#[cfg(test)]
mod tests {
    use super::{ConfigProfile, ConfigProfileError};
    use std::str::FromStr;

    #[test]
    fn parse_known_profiles() {
        assert_eq!(ConfigProfile::from_str("local"), Ok(ConfigProfile::Local));
        assert_eq!(
            ConfigProfile::from_str("development"),
            Ok(ConfigProfile::Development)
        );
        assert_eq!(ConfigProfile::from_str("test"), Ok(ConfigProfile::Test));
        assert_eq!(
            ConfigProfile::from_str("staging"),
            Ok(ConfigProfile::Staging)
        );
        assert_eq!(
            ConfigProfile::from_str("production"),
            Ok(ConfigProfile::Production)
        );
    }

    #[test]
    fn parse_aliases() {
        assert_eq!(
            ConfigProfile::from_str("dev"),
            Ok(ConfigProfile::Development)
        );
        assert_eq!(
            ConfigProfile::from_str("prod"),
            Ok(ConfigProfile::Production)
        );
        assert_eq!(ConfigProfile::from_str("stage"), Ok(ConfigProfile::Staging));
    }

    #[test]
    fn parse_custom_profile() {
        assert_eq!(
            ConfigProfile::from_str("preview"),
            Ok(ConfigProfile::Custom("preview".to_owned()))
        );
        assert_eq!(ConfigProfile::from_str(" "), Err(ConfigProfileError));
    }

    #[test]
    fn display_known_profiles() {
        assert_eq!(ConfigProfile::Local.to_string(), "local");
        assert_eq!(ConfigProfile::Development.to_string(), "development");
        assert_eq!(ConfigProfile::Production.to_string(), "production");
    }

    #[test]
    fn display_custom_profile() {
        assert_eq!(
            ConfigProfile::Custom("preview".to_owned()).to_string(),
            "preview"
        );
    }
}