more-config 2.1.5

Provides support for configuration
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

const EMPTY: &str = "";
const KEY_DELIMITER: &str = ":";

/// Represents a configuration path.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ConfigurationPath {
    /// Indicates a qualified, absolute configuration path.
    Absolute,

    // Indicates a configuration path relative to a parent.
    Relative
}

impl ConfigurationPath {
    /// Gets the key delimiter used in configuration paths.
    pub fn key_delimiter() -> &'static str {
        KEY_DELIMITER
    }

    /// Combines the specified segments into one path.
    ///
    /// # Arguments
    ///
    /// * `segments` - The segments to combine into a path
    pub fn combine(segments: &[&str]) -> String {
        segments.join(KEY_DELIMITER)
    }

    /// Extracts the last path segment from the path.
    ///
    /// # Arguments
    ///
    /// * `path` - The path to extract the key from
    pub fn section_key(path: &str) -> &str {
        if let Some(index) = path.rfind(KEY_DELIMITER) {
            &path[(index + 1)..]
        } else {
            path
        }
    }

    /// Extracts the path corresponding to the parent node for a given path.
    ///
    /// # Arguments
    ///
    /// * `path` - The path to extract the parent path from
    pub fn parent_path(path: &str) -> &str {
        if let Some(index) = path.rfind(KEY_DELIMITER) {
            &path[..index]
        } else {
            EMPTY
        }
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use test_case::test_case;

    #[test_case(&["parent", ""], "parent:" ; "with 1 segment")]
    #[test_case(&["parent", "", ""], "parent::" ; "with 2 segments")]
    #[test_case(&["parent", "", "", "key"], "parent:::key" ; "with segments in between")]
    fn combine_with_empty_segment_leaves_delimiter(segments: &[&str], expected: &str) {
        // arrange

        // act
        let path = ConfigurationPath::combine(segments);

        // assert
        assert_eq!(&path, expected);
    }

    #[test_case("", "" ; "when empty")]
    #[test_case(":::", "" ; "when only delimiters")]
    #[test_case("a::b:::c", "c" ; "with empty segments in the middle")]
    #[test_case("a:::b:", "" ; "when last segment is empty")]
    #[test_case("key", "key" ; "with no parent")]
    #[test_case(":key", "key" ; "with 1 empty parent")]
    #[test_case("::key", "key" ; "with 2 empty parents")]
    #[test_case("parent:key", "key" ; "with parent")]
    fn section_key_should_return_expected_segment(path: &str, expected: &str) {
        // arrange

        // act
        let key = ConfigurationPath::section_key(path);

        // assert
        assert_eq!(key, expected);
    }

    #[test_case("", "" ; "when empty")]
    #[test_case(":::", "::" ; "when only delimiters")]
    #[test_case("a::b:::c", "a::b::" ; "with empty segments in the middle")]
    #[test_case("a:::b:", "a:::b" ; "when last segment is empty")]
    #[test_case("key", "" ; "with no parent")]
    #[test_case(":key", "" ; "with 1 empty parent")]
    #[test_case("::key", ":" ; "with 2 empty parents")]
    #[test_case("parent:key", "parent" ; "with parent")]
    fn parent_path_should_return_expected_segment(path: &str, expected: &str) {
        // arrange

        // act
        let key = ConfigurationPath::parent_path(path);

        // assert
        assert_eq!(key, expected);
    }
}