standout-input 9.0.0

Declarative input collection for CLI 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
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

use std::fmt;
use std::sync::Arc;

use crate::env::{ClipboardReader, RealClipboard, RealStdin, StdinReader};
use crate::responder::PromptResponder;

#[derive(Clone)]
pub struct InputSources {
    stdin: Arc<dyn StdinReader>,
    clipboard: Arc<dyn ClipboardReader>,
    responder: Option<Arc<dyn PromptResponder>>,
}

impl fmt::Debug for InputSources {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("InputSources")
            .field("has_responder", &self.responder.is_some())
            .finish_non_exhaustive()
    }
}

impl InputSources {
    pub fn new(
        stdin: impl StdinReader + 'static,
        clipboard: impl ClipboardReader + 'static,
        responder: Option<Arc<dyn PromptResponder>>,
    ) -> Self {
        Self {
            stdin: Arc::new(stdin),
            clipboard: Arc::new(clipboard),
            responder,
        }
    }

    pub fn from_process() -> Self {
        Self::new(RealStdin, RealClipboard, None)
    }

    pub fn with_stdin(mut self, stdin: impl StdinReader + 'static) -> Self {
        self.stdin = Arc::new(stdin);
        self
    }

    pub fn with_clipboard(mut self, clipboard: impl ClipboardReader + 'static) -> Self {
        self.clipboard = Arc::new(clipboard);
        self
    }

    pub fn with_responder(mut self, responder: Arc<dyn PromptResponder>) -> Self {
        self.responder = Some(responder);
        self
    }

    pub fn stdin(&self) -> &dyn StdinReader {
        self.stdin.as_ref()
    }

    pub fn stdin_arc(&self) -> Arc<dyn StdinReader> {
        Arc::clone(&self.stdin)
    }

    pub fn clipboard(&self) -> &dyn ClipboardReader {
        self.clipboard.as_ref()
    }

    pub fn clipboard_arc(&self) -> Arc<dyn ClipboardReader> {
        Arc::clone(&self.clipboard)
    }

    pub fn responder(&self) -> Option<&dyn PromptResponder> {
        self.responder.as_deref()
    }

    pub fn responder_arc(&self) -> Option<Arc<dyn PromptResponder>> {
        self.responder.clone()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::env::{MockClipboard, MockStdin};

    fn sample() -> InputSources {
        InputSources::new(MockStdin::piped("hello"), MockClipboard::empty(), None)
    }

    #[test]
    fn input_sources_constructs_from_explicit_readers() {
        let sources = sample();
        assert!(!sources.stdin().is_terminal());
        assert_eq!(sources.stdin().read_to_string().unwrap(), "hello");
        assert_eq!(sources.clipboard().read().unwrap(), None);
        assert!(sources.responder().is_none());
    }

    #[test]
    fn input_sources_is_not_copy() {
        struct Probe<U>(std::marker::PhantomData<U>);
        trait AmbiguousIfImpl<A> {
            fn check() {}
        }
        impl<U> AmbiguousIfImpl<()> for Probe<U> {}
        impl<U: Copy> AmbiguousIfImpl<u8> for Probe<U> {}
        let _ = <Probe<InputSources> as AmbiguousIfImpl<_>>::check;

        let sources = sample();
        let moved = sources;
        assert!(!moved.stdin().is_terminal());
    }

    #[test]
    fn input_sources_is_clone() {
        let sources = sample();
        let cloned = sources.clone();
        assert_eq!(cloned.stdin().read_to_string().unwrap(), "hello");
        assert_eq!(sources.stdin().read_to_string().unwrap(), "hello");
    }

    #[test]
    fn input_sources_debug_is_structural() {
        let sources = sample();
        let debug = format!("{sources:?}");
        assert!(debug.contains("InputSources"));
        assert!(debug.contains("has_responder: false"));
    }

    #[test]
    fn from_process_constructs_production_sources() {
        let sources = InputSources::from_process();
        let _ = sources.stdin().is_terminal();
        assert!(sources.responder().is_none());
    }

    #[test]
    fn builders_replace_readers() {
        let sources = InputSources::from_process()
            .with_stdin(MockStdin::piped("in"))
            .with_clipboard(MockClipboard::with_content("clip"));
        assert_eq!(sources.stdin().read_to_string().unwrap(), "in");
        assert_eq!(
            sources.clipboard().read().unwrap(),
            Some("clip".to_string())
        );
    }
}