requestty 0.6.3

An easy-to-use collection of interactive cli prompts
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
use ui::{backend::Backend, widgets::Text};

use super::MultiSelect;
use crate::{
    question::{Choice, Options},
    ListItem,
};

/// The builder for a [`multi_select`] prompt.
///
/// Unlike the other list based prompts, this has a per choice boolean default.
///
/// The choices are represented with the [`Choice`] enum. [`Choice::Choice`] can be multi-line,
/// but [`Choice::Separator`]s can only be single line.
///
/// <img
///   src="https://raw.githubusercontent.com/lutetium-vanadium/requestty/master/assets/multi-select.gif"
///   style="max-height: 20rem"
/// />
///
/// See the various methods for more details on each available option.
///
/// # Examples
///
/// ```
/// use requestty::{Question, DefaultSeparator};
///
/// let multi_select = Question::multi_select("cheese")
///     .message("What cheese do you want?")
///     .choice_with_default("Mozzarella", true)
///     .choices(vec![
///         "Cheddar",
///         "Parmesan",
///     ])
///     .build();
/// ```
///
/// [`multi_select`]: crate::question::Question::multi_select
#[derive(Debug)]
pub struct MultiSelectBuilder<'a> {
    opts: Options<'a>,
    multi_select: MultiSelect<'a>,
}

impl<'a> MultiSelectBuilder<'a> {
    pub(crate) fn new(name: String) -> Self {
        MultiSelectBuilder {
            opts: Options::new(name),
            multi_select: Default::default(),
        }
    }

    crate::impl_options_builder! {
    message
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .message("What cheese do you want?")
    ///     .build();
    /// ```

    when
    /// # Examples
    ///
    /// ```
    /// use requestty::{Answers, Question};
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .when(|previous_answers: &Answers| match previous_answers.get("vegan") {
    ///         Some(ans) => ans.as_bool().unwrap(),
    ///         None => true,
    ///     })
    ///     .build();
    /// ```

    ask_if_answered
    /// # Examples
    ///
    /// ```
    /// use requestty::{Answers, Question};
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .ask_if_answered(true)
    ///     .build();
    /// ```

    on_esc
    /// # Examples
    ///
    /// ```
    /// use requestty::{Answers, Question, OnEsc};
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .on_esc(OnEsc::Terminate)
    ///     .build();
    /// ```
    }

    /// The maximum height that can be taken by the list
    ///
    /// If the total height exceeds the page size, the list will be scrollable.
    ///
    /// The `page_size` must be a minimum of 5. If `page_size` is not set, it will default to 15.
    ///
    /// # Panics
    ///
    /// It will panic if the `page_size` is less than 5.
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .page_size(10)
    ///     .build();
    /// ```
    pub fn page_size(mut self, page_size: usize) -> Self {
        assert!(page_size >= 5, "page size can be a minimum of 5");

        self.multi_select.choices.set_page_size(page_size);
        self
    }

    /// Whether to wrap around when user gets to the last element.
    ///
    /// If `should_loop` is not set, it will default to `true`.
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .should_loop(false)
    ///     .build();
    /// ```
    pub fn should_loop(mut self, should_loop: bool) -> Self {
        self.multi_select.choices.set_should_loop(should_loop);
        self
    }

    /// Inserts a [`Choice`] with given text and its default checked state as `false`.
    ///
    /// If you want to set the default checked state, use [`choice_with_default`].
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`Choice`]: crate::question::Choice::Choice
    /// [`choice_with_default`]: Self::choice_with_default
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .choice("Cheddar")
    ///     .build();
    /// ```
    pub fn choice<I: Into<String>>(self, text: I) -> Self {
        self.choice_with_default(text.into(), false)
    }

    /// Inserts a [`Choice`] with a given text and default checked state.
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`Choice`]: crate::question::Choice::Choice
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .choice_with_default("Mozzarella", true)
    ///     .build();
    /// ```
    pub fn choice_with_default<I: Into<String>>(mut self, text: I, default: bool) -> Self {
        self.multi_select
            .choices
            .choices
            .push(Choice::Choice(Text::new(text.into())));
        self.multi_select.selected.push(default);
        self
    }

    /// Inserts a [`Separator`] with the given text
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`Separator`]: crate::question::Choice::Separator
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .separator("-- custom separator text --")
    ///     .build();
    /// ```
    pub fn separator<I: Into<String>>(mut self, text: I) -> Self {
        self.multi_select
            .choices
            .choices
            .push(Choice::Separator(text.into()));
        self.multi_select.selected.push(false);
        self
    }

    /// Inserts a [`DefaultSeparator`]
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`DefaultSeparator`]: crate::question::Choice::DefaultSeparator
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .default_separator()
    ///     .build();
    /// ```
    pub fn default_separator(mut self) -> Self {
        self.multi_select
            .choices
            .choices
            .push(Choice::DefaultSeparator);
        self.multi_select.selected.push(false);
        self
    }

    /// Extends the given iterator of [`Choice`]s
    ///
    /// Every [`Choice::Choice`] within will have a default checked value of `false`. If you want to
    /// set the default checked value, use [`choices_with_default`].
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`Choice`]: crate::question::Choice
    /// [`choices_with_default`]: Self::choices_with_default
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .choices(vec![
    ///         "Mozzarella",
    ///         "Cheddar",
    ///         "Parmesan",
    ///     ])
    ///     .build();
    /// ```
    pub fn choices<I, T>(mut self, choices: I) -> Self
    where
        T: Into<Choice<String>>,
        I: IntoIterator<Item = T>,
    {
        self.multi_select
            .choices
            .choices
            .extend(choices.into_iter().map(|c| c.into().map(Text::new)));
        self.multi_select
            .selected
            .resize(self.multi_select.choices.len(), false);
        self
    }

    /// Extends the given iterator of [`Choice`]s with the given default checked value.
    ///
    /// See [`multi_select`] for more information.
    ///
    /// [`Choice`]: crate::question::Choice
    /// [`multi_select`]: crate::question::Question::multi_select
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .choices_with_default(vec![
    ///         ("Mozzarella", true),
    ///         ("Cheddar", false),
    ///         ("Parmesan", false),
    ///     ])
    ///     .build();
    /// ```
    pub fn choices_with_default<I, T>(mut self, choices: I) -> Self
    where
        T: Into<Choice<(String, bool)>>,
        I: IntoIterator<Item = T>,
    {
        let iter = choices.into_iter();
        self.multi_select
            .selected
            .reserve(iter.size_hint().0.saturating_add(1));
        self.multi_select
            .choices
            .choices
            .reserve(iter.size_hint().0.saturating_add(1));

        for choice in iter {
            match choice.into() {
                Choice::Choice((choice, selected)) => {
                    self.multi_select
                        .choices
                        .choices
                        .push(Choice::Choice(Text::new(choice)));
                    self.multi_select.selected.push(selected);
                }
                Choice::Separator(s) => {
                    self.multi_select.choices.choices.push(Choice::Separator(s));
                    self.multi_select.selected.push(false);
                }
                Choice::DefaultSeparator => {
                    self.multi_select
                        .choices
                        .choices
                        .push(Choice::DefaultSeparator);
                    self.multi_select.selected.push(false);
                }
            }
        }
        self
    }

    crate::impl_filter_builder! {
    /// NOTE: The boolean [`Vec`] contains a boolean value for each index even if it is a separator.
    /// However it is guaranteed that all the separator indices will be false.
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("evil-cheese")
    ///     .filter(|mut cheeses, previous_answers| {
    ///         cheeses.iter_mut().for_each(|checked| *checked = !*checked);
    ///         cheeses
    ///     })
    ///     .build();
    /// ```
    Vec<bool>; multi_select
    }
    crate::impl_validate_builder! {
    /// NOTE: The boolean [`slice`] contains a boolean value for each index even if it is a
    /// separator. However it is guaranteed that all the separator indices will be false.
    ///
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .validate(|cheeses, previous_answers| {
    ///         if cheeses.iter().filter(|&&a| a).count() < 1 {
    ///             Err("You must choose at least one cheese.".into())
    ///         } else {
    ///             Ok(())
    ///         }
    ///     })
    ///     .build();
    /// ```
    [bool]; multi_select
    }

    crate::impl_transform_builder! {
    /// # Examples
    ///
    /// ```
    /// use requestty::Question;
    ///
    /// let multi_select = Question::multi_select("cheese")
    ///     .transform(|cheeses, previous_answers, backend| {
    ///         for cheese in cheeses {
    ///             write!(backend, "({}) {}, ", cheese.index, cheese.text)?;
    ///         }
    ///         Ok(())
    ///     })
    ///     .build();
    /// ```
    [ListItem]; multi_select
    }

    /// Consumes the builder returning a [`Question`]
    ///
    /// [`Question`]: crate::question::Question
    pub fn build(self) -> crate::question::Question<'a> {
        crate::question::Question::new(
            self.opts,
            crate::question::QuestionKind::MultiSelect(self.multi_select),
        )
    }
}

impl<'a> From<MultiSelectBuilder<'a>> for crate::question::Question<'a> {
    /// Consumes the builder returning a [`Question`]
    ///
    /// [`Question`]: crate::question::Question
    fn from(builder: MultiSelectBuilder<'a>) -> Self {
        builder.build()
    }
}