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

// Copyright 2020 Eray Erdin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use derivative::Derivative;
use log::*;
use snafu::Snafu;
use std::io;

#[derive(Debug, Snafu)]
pub enum CodeError<'a> {
    #[snafu(display(
        "Code could not be initialized due to its name containing whitespace. Name: {}",
        name
    ))]
    /// Error if a code name contains any whitespace.
    WhitespaceError { name: &'a str },
}

type CodeResult<'a, T> = Result<T, CodeError<'a>>;

/// A trait for structs that are invokable/runnable.
pub trait Invokable {
    /// Invocation of a series of events.
    ///
    /// `args` can be an empty string if nothing is given. You can use `stdout` and `stderr`
    /// to write output.
    fn invoke(&self, args: &str, stdout: Box<&mut dyn io::Write>, stderr: Box<&mut dyn io::Write>);
}

#[derive(Derivative)]
#[derivative(Eq, PartialEq, Hash)]
/// A cheat code.
pub(crate) struct Code<'a> {
    pub name: &'a str,
    #[derivative(PartialEq = "ignore", Hash = "ignore")]
    pub invokable: Box<dyn Invokable>,
}

impl<'a> Code<'a> {
    pub(crate) fn new(name: &'a str, invokable: Box<dyn Invokable>) -> CodeResult<Self> {
        debug!("Initializing Code...");
        trace!("name: {}", name);
        match name.chars().any(|c| c.is_whitespace()) {
            true => {
                error!("Name contains whitespace.");
                Err(CodeError::WhitespaceError { name })
            }
            false => Ok(Self { name, invokable }),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rstest::*;

    struct ClHello;
    impl Invokable for ClHello {
        fn invoke(
            &self,
            _args: &str,
            _stdout: Box<&mut dyn std::io::Write>,
            _stderr: Box<&mut dyn std::io::Write>,
        ) {
            todo!()
        }
    }

    #[fixture]
    fn invokable() -> Box<dyn Invokable> {
        Box::new(ClHello)
    }

    #[rstest]
    fn code_new_success(invokable: Box<dyn Invokable>) {
        let code_r = Code::new("cl_hello", invokable);
        assert!(code_r.is_ok());
    }
}