clawless-core 0.8.0

Types and traits for building command-line applications
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

use getset::Getters;

/// A question that a user answers with one of several options
///
/// The options are the texts that the user sees, in the order of display. The answer is the
/// position of one option, and the first option has the position zero.
///
/// [`Prompt::select`] builds this type from the `Display` text of its options and sends it to
/// the presenter. A command does not usually build it.
///
/// # Examples
///
/// ```
/// use clawless_core::prompt::Select;
///
/// let question = Select::new("Kind of change", ["Added", "Changed", "Fixed"]);
///
/// assert_eq!(question.options().len(), 3);
/// ```
///
/// [`Prompt::select`]: super::Prompt::select
#[derive(Clone, Eq, PartialEq, Hash, Debug, Getters)]
pub struct Select {
    /// The text of the question
    #[getset(get = "pub")]
    question: String,

    /// The texts of the options, in the order in which they are shown
    #[getset(get = "pub")]
    options: Vec<String>,
}

impl Select {
    /// Creates a question over the texts of its options
    ///
    /// # Examples
    ///
    /// ```
    /// use clawless_core::prompt::Select;
    ///
    /// let question = Select::new("Kind of change", ["Added", "Changed", "Fixed"]);
    /// ```
    pub fn new(
        question: impl Into<String>,
        options: impl IntoIterator<Item = impl Into<String>>,
    ) -> Self {
        Self {
            question: question.into(),
            options: options.into_iter().map(Into::into).collect(),
        }
    }
}

#[cfg(test)]
mod tests {
    // An assertion in a test panics by design. A `# Panics` section on every test
    // would repeat that and give the reader no information.
    #![allow(clippy::missing_panics_doc)]

    use super::*;

    #[test]
    fn new_keeps_the_options_in_their_order() {
        let question = Select::new("Kind of change", ["Added", "Fixed"]);

        assert_eq!(
            question.options(),
            &vec!["Added".to_owned(), "Fixed".to_owned()]
        );
    }

    #[test]
    fn trait_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Select>();
    }

    #[test]
    fn trait_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Select>();
    }

    #[test]
    fn trait_unpin() {
        fn assert_unpin<T: Unpin>() {}
        assert_unpin::<Select>();
    }
}