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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
use crate::{
    util::*, ConfigurationBuilder, ConfigurationProvider, ConfigurationSource, LoadResult, Value,
};
use std::borrow::Cow;
use std::collections::HashMap;

/// Represents a [`ConfigurationProvider`](crate::ConfigurationProvider) that
/// provides command line configuration values.
pub struct CommandLineConfigurationProvider {
    data: HashMap<String, (String, Value)>,
    args: Vec<String>,
    switch_mappings: HashMap<String, String>,
}

impl CommandLineConfigurationProvider {
    /// Initializes a new command line configuration provider.
    ///
    /// # Arguments
    ///
    /// * `args` - The command line arguments
    /// * `switch_mappings` - The mapping of switches to configuration values
    ///
    /// # Remarks
    ///
    /// Only switch mapping keys that start with `--` or `-` are acceptable. Command
    /// line arguments may start with `--`, `-`, or `/`
    pub fn new(args: Vec<String>, switch_mappings: HashMap<String, String>) -> Self {
        Self {
            data: Default::default(),
            args,
            switch_mappings,
        }
    }
}

impl ConfigurationProvider for CommandLineConfigurationProvider {
    fn get(&self, key: &str) -> Option<Value> {
        self.data.get(&key.to_uppercase()).map(|t| t.1.clone())
    }

    fn load(&mut self) -> LoadResult {
        let mut data = HashMap::new();
        let mut args = self.args.iter();

        while let Some(arg) = args.next() {
            let mut current = Cow::Borrowed(arg);
            let start: usize = if arg.starts_with("--") {
                2
            } else if arg.starts_with('-') {
                1
            } else if arg.starts_with('/') {
                // "/SomeSwitch" is equivalent to "--SomeSwitch" when interpreting switch mappings
                let mut temp = arg.clone();
                temp.replace_range(0..1, "--");
                current = Cow::Owned(temp);
                2
            } else {
                0
            };

            let mut key: String;
            let value: String;

            if let Some(separator) = current.find('=') {
                let segment: String = current
                    .chars()
                    .take(separator)
                    .map(|c| c.to_ascii_uppercase())
                    .collect();

                key = if let Some(mapping) = self.switch_mappings.get(&segment) {
                    mapping.clone()
                } else if start == 1 {
                    continue;
                } else {
                    current
                        .chars()
                        .skip(start)
                        .take(separator - start)
                        .collect()
                };

                value = current.chars().skip(separator + 1).collect();
            } else {
                if start == 0 {
                    continue;
                }

                key = if let Some(mapping) = self.switch_mappings.get(&current.to_uppercase()) {
                    mapping.clone()
                } else if start == 0 {
                    continue;
                } else {
                    current.chars().skip(start).collect()
                };

                if let Some(next) = args.next() {
                    value = next.clone();
                } else {
                    continue;
                }
            }

            key = to_pascal_case_parts(key, '-');
            data.insert(key.to_uppercase(), (key, value.into()));
        }

        data.shrink_to_fit();
        self.data = data;
        Ok(())
    }

    fn child_keys(&self, earlier_keys: &mut Vec<String>, parent_path: Option<&str>) {
        accumulate_child_keys(&self.data, earlier_keys, parent_path)
    }
}

/// Represents a [`ConfigurationSource`](crate::ConfigurationSource) for command line data.
#[derive(Default)]
pub struct CommandLineConfigurationSource {
    /// Gets or sets a collection of key/value pairs representing the mapping between
    /// switches and configuration keys.
    pub switch_mappings: HashMap<String, String>,

    /// Gets or sets the command line arguments.
    pub args: Vec<String>,
}

impl CommandLineConfigurationSource {
    /// Initializes a new command line configuration source.
    ///
    /// # Arguments
    ///
    /// * `args` - The command line arguments
    /// * `switch_mappings` - The mapping of switches to configuration values
    ///
    /// # Remarks
    ///
    /// Only switch mapping keys that start with `--` or `-` are acceptable. Command
    /// line arguments may start with `--`, `-`, or `/`.
    pub fn new<I, S1, S2>(args: I, switch_mappings: &[(S2, S2)]) -> Self
    where
        I: Iterator<Item = S1>,
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        Self {
            args: args.map(|a| a.as_ref().to_owned()).collect(),
            switch_mappings: switch_mappings
                .iter()
                .filter(|m| m.0.as_ref().starts_with("--") || m.0.as_ref().starts_with('-'))
                .map(|(k, v)| (k.as_ref().to_uppercase(), v.as_ref().to_owned()))
                .collect(),
        }
    }
}

impl<I, S> From<I> for CommandLineConfigurationSource
where
    I: Iterator<Item = S>,
    S: AsRef<str>,
{
    fn from(value: I) -> Self {
        let switch_mappings = Vec::<(&str, &str)>::with_capacity(0);
        Self::new(value, &switch_mappings)
    }
}

impl ConfigurationSource for CommandLineConfigurationSource {
    fn build(&self, _builder: &dyn ConfigurationBuilder) -> Box<dyn ConfigurationProvider> {
        Box::new(CommandLineConfigurationProvider::new(
            self.args.clone(),
            self.switch_mappings.clone(),
        ))
    }
}

pub mod ext {

    use super::*;

    /// Defines extension methods for [`ConfigurationBuilder`](crate::ConfigurationBuilder).
    pub trait CommandLineConfigurationBuilderExtensions {
        /// Adds the command line configuration source.
        fn add_command_line(&mut self) -> &mut Self;

        /// Adds the command line configuration source.
        ///
        /// # Arguments
        ///
        /// * `switch_mappings` - The mapping of switches to configuration values
        fn add_command_line_map<S: AsRef<str>>(&mut self, switch_mappings: &[(S, S)]) -> &mut Self;
    }

    impl CommandLineConfigurationBuilderExtensions for dyn ConfigurationBuilder + '_ {
        fn add_command_line(&mut self) -> &mut Self {
            self.add(Box::new(CommandLineConfigurationSource::from(
                std::env::args(),
            )));
            self
        }

        fn add_command_line_map<S: AsRef<str>>(&mut self, switch_mappings: &[(S, S)]) -> &mut Self {
            self.add(Box::new(CommandLineConfigurationSource::new(
                std::env::args(),
                switch_mappings,
            )));
            self
        }
    }

    impl<T: ConfigurationBuilder> CommandLineConfigurationBuilderExtensions for T {
        fn add_command_line(&mut self) -> &mut Self {
            self.add(Box::new(CommandLineConfigurationSource::from(
                std::env::args(),
            )));
            self
        }

        fn add_command_line_map<S: AsRef<str>>(&mut self, switch_mappings: &[(S, S)]) -> &mut Self {
            self.add(Box::new(CommandLineConfigurationSource::new(
                std::env::args(),
                switch_mappings,
            )));
            self
        }
    }
}

#[cfg(test)]
mod tests {

    use super::*;

    struct TestConfigurationBuilder;

    impl ConfigurationBuilder for TestConfigurationBuilder {
        fn properties(&self) -> &HashMap<String, Box<dyn std::any::Any>> {
            unimplemented!()
        }

        fn sources(&self) -> &[Box<dyn ConfigurationSource>] {
            unimplemented!()
        }

        fn add(&mut self, _source: Box<dyn ConfigurationSource>) {
            unimplemented!()
        }

        fn build(&self) -> Result<Box<dyn crate::ConfigurationRoot>, crate::ReloadError> {
            unimplemented!()
        }
    }

    #[test]
    fn load_should_ignore_unknown_arguments() {
        // arrange
        let args = ["foo", "/bar=baz"].iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);
        let mut child_keys = Vec::with_capacity(2);

        // act
        provider.load().unwrap();
        provider.child_keys(&mut child_keys, None);

        // assert
        assert_eq!(child_keys.len(), 1);
        assert_eq!(provider.get("bar").unwrap().as_str(), "baz");
    }

    #[test]
    fn load_should_ignore_arguments_in_the_middle() {
        // arrange
        let args = [
            "Key1=Value1",
            "--Key2=Value2",
            "/Key3=Value3",
            "Bogus1",
            "--Key4",
            "Value4",
            "Bogus2",
            "/Key5",
            "Value5",
            "Bogus3",
        ]
        .iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);
        let mut child_keys = Vec::with_capacity(5);

        // act
        provider.load().unwrap();
        provider.child_keys(&mut child_keys, None);

        // assert
        assert_eq!(provider.get("Key1").unwrap().as_str(), "Value1");
        assert_eq!(provider.get("Key2").unwrap().as_str(), "Value2");
        assert_eq!(provider.get("Key3").unwrap().as_str(), "Value3");
        assert_eq!(provider.get("Key4").unwrap().as_str(), "Value4");
        assert_eq!(provider.get("Key5").unwrap().as_str(), "Value5");
    }

    #[test]
    fn load_should_process_key_value_pairs_without_mappings() {
        // arrange
        let args = [
            "Key1=Value1",
            "--Key2=Value2",
            "/Key3=Value3",
            "--Key4",
            "Value4",
            "/Key5",
            "Value5",
            "--single=1",
            "--two-part=2",
        ]
        .iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);

        // act
        provider.load().unwrap();

        // assert
        assert_eq!(provider.get("Key1").unwrap().as_str(), "Value1");
        assert_eq!(provider.get("Key2").unwrap().as_str(), "Value2");
        assert_eq!(provider.get("Key3").unwrap().as_str(), "Value3");
        assert_eq!(provider.get("Key4").unwrap().as_str(), "Value4");
        assert_eq!(provider.get("Key5").unwrap().as_str(), "Value5");
        assert_eq!(provider.get("Single").unwrap().as_str(), "1");
        assert_eq!(provider.get("TwoPart").unwrap().as_str(), "2");
    }

    #[test]
    fn load_should_process_key_value_pairs_with_mappings() {
        // arrange
        let args = [
            "-K1=Value1",
            "--Key2=Value2",
            "/Key3=Value3",
            "--Key4",
            "Value4",
            "/Key5",
            "Value5",
            "/Key6=Value6",
        ]
        .iter();
        let switch_mappings = [
            ("-K1", "LongKey1"),
            ("--Key2", "SuperLongKey2"),
            ("--Key6", "SuchALongKey6"),
        ];
        let source = CommandLineConfigurationSource::new(args, &switch_mappings);
        let mut provider = source.build(&TestConfigurationBuilder);

        // act
        provider.load().unwrap();

        // assert
        assert_eq!(provider.get("LongKey1").unwrap().as_str(), "Value1");
        assert_eq!(provider.get("SuperLongKey2").unwrap().as_str(), "Value2");
        assert_eq!(provider.get("Key3").unwrap().as_str(), "Value3");
        assert_eq!(provider.get("Key4").unwrap().as_str(), "Value4");
        assert_eq!(provider.get("Key5").unwrap().as_str(), "Value5");
        assert_eq!(provider.get("SuchALongKey6").unwrap().as_str(), "Value6");
    }

    #[test]
    fn load_should_override_value_when_key_is_duplicated() {
        // arrange
        let args = ["/Key1=Value1", "--Key1=Value2"].iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);

        // act
        provider.load().unwrap();

        // assert
        assert_eq!(provider.get("Key1").unwrap().as_str(), "Value2");
    }

    #[test]
    fn load_should_ignore_key_when_value_is_missing() {
        // arrange
        let args = ["--Key1", "Value1", "/Key2"].iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);
        let mut child_keys = Vec::with_capacity(2);

        // act
        provider.load().unwrap();
        provider.child_keys(&mut child_keys, None);

        // assert
        assert_eq!(child_keys.len(), 1);
        assert_eq!(provider.get("Key1").unwrap().as_str(), "Value1");
    }

    #[test]
    fn load_should_ignore_unrecognizable_argument() {
        // arrange
        let args = ["ArgWithoutPrefixAndEqualSign"].iter();
        let source = CommandLineConfigurationSource::from(args);
        let mut provider = source.build(&TestConfigurationBuilder);
        let mut child_keys = Vec::with_capacity(1);

        // act
        provider.load().unwrap();
        provider.child_keys(&mut child_keys, None);

        // assert
        assert!(child_keys.is_empty());
    }

    #[test]
    fn load_should_ignore_argument_when_short_switch_is_undefined() {
        // arrange
        let args = ["-Key1", "Value1"].iter();
        let switch_mappings = [("-Key2", "LongKey2")];
        let source = CommandLineConfigurationSource::new(args, &switch_mappings);
        let mut provider = source.build(&TestConfigurationBuilder);
        let mut child_keys = Vec::with_capacity(1);

        // act
        provider.load().unwrap();
        provider.child_keys(&mut child_keys, Some(""));

        // assert
        assert!(child_keys.is_empty());
    }
}