sheller 0.5.4

/// Macro to create a new `Sheller` instance.
///
/// # Examples
///
/// ```
/// sheller::new!("echo hello").run();
/// sheller::new!("{}", String::from("echo hello")).run();
/// sheller::new!("echo {}", "hello").run();
/// sheller::new!("echo {hello}", hello = "hello").run();
/// sheller::new!("echo {} {world}", "hello", world = "world").run();
#[macro_export]
macro_rules! new {
    ($script_fmt:expr) => {
        $crate::Sheller::new(format!($script_fmt))
    };
    ($script_fmt:expr, $($arg:tt)*) => {
        $crate::Sheller::new(format!($script_fmt, $($arg)*))
    };
}

/// Macro to run a shell script.  
/// It will panic if the script fails.
///
/// # Examples
///
/// ```
/// use sheller::run;
///
/// run!("echo hello");
/// run!("{}", String::from("echo hello"));
/// run!("echo {}", "hello");
/// run!("echo {hello}", hello = "hello");
/// run!("echo {} {world}", "hello", world = "world");
#[macro_export]
macro_rules! run {
    ($script_fmt:expr) => {
        $crate::new!($script_fmt).run();
    };
    ($script_fmt:expr, $($arg:tt)*) => {
        $crate::new!($script_fmt, $($arg)*).run();
    };
}

/// Macro to try to run a shell script.  
/// It will return a `Result`. If the script fails, it will return an `Err`. Otherwise, it will return an `Ok`.  
///
/// # Examples
///
/// ```
/// use sheller::try_run;
///
/// try_run!("echo hello").unwrap();
/// try_run!("{}", String::from("echo hello")).unwrap();
/// try_run!("echo {}", "hello").unwrap();
/// try_run!("echo {hello}", hello = "hello").unwrap();
/// try_run!("echo {} {world}", "hello", world = "world").unwrap();
#[macro_export]
macro_rules! try_run {
    ($script_fmt:expr) => {{
        let result = $crate::new!($script_fmt).try_run();
        result
    }};
    ($script_fmt:expr, $($arg:tt)*) => {{
        let result = $crate::new!($script_fmt, $($arg)*).try_run();
        result
    }};
}

#[cfg(test)]
mod tests {
    #[test]
    fn new_run_literal() {
        new!("echo hello").run();
    }

    #[test]
    fn new_run_string() {
        let echo_hello = String::from("echo hello");
        new!("{}", echo_hello).run();
    }

    #[test]
    fn new_run_format_positional_parameters() {
        new!("echo {}", "hello").run();
    }

    #[test]
    fn new_run_format_named_parameters() {
        new!("echo {hello}", hello = "hello").run();
    }

    #[test]
    fn new_run_format_positional_and_named_parameters() {
        new!("echo {} {world}", "hello", world = "world").run();
    }

    #[test]
    fn new_run_format_named_parameters_in_scope() {
        let world = "world";
        new!("echo {world}").run();
    }

    #[test]
    fn new_run_format_named_parameters_in_scope_and_positional_parameters() {
        let world = "world";
        new!("echo {} {world}", "hello").run();
    }

    #[test]
    fn new_run_format_all_parameters() {
        let name = "sheller";
        new!("echo {} {world}, {name}", "hello", world = "world").run();
    }

    #[test]
    fn run_literal() {
        run!("echo hello");
    }

    #[test]
    fn run_string() {
        let echo_hello = String::from("echo hello");
        run!("{}", echo_hello);
    }

    #[test]
    fn run_format_positional_parameters() {
        run!("echo {}", "hello");
    }

    #[test]
    fn run_format_named_parameters() {
        run!("echo {hello}", hello = "hello");
    }

    #[test]
    fn run_format_positional_and_named_parameters() {
        run!("echo {} {world}", "hello", world = "world");
    }

    #[test]
    fn run_format_named_parameters_in_scope() {
        let world = "world";
        run!("echo {world}");
    }

    #[test]
    fn run_format_named_parameters_in_scope_and_positional_parameters() {
        let world = "world";
        run!("echo {} {world}", "hello");
    }

    #[test]
    fn run_format_all_parameters() {
        let name = "sheller";
        run!("echo {} {world}, {name}", "hello", world = "world");
    }

    #[test]
    fn try_run_literal() {
        try_run!("echo hello").unwrap();
    }

    #[test]
    fn try_run_string() {
        let echo_hello = "echo hello".to_string();
        try_run!("{}", echo_hello).unwrap();
    }

    #[test]
    fn try_run_format_positional_parameters() {
        try_run!("echo {}", "hello").unwrap();
    }

    #[test]
    fn try_run_format_named_parameters() {
        try_run!("echo {hello}", hello = "hello").unwrap();
    }

    #[test]
    fn try_run_format_positional_and_named_parameters() {
        try_run!("echo {} {world}", "hello", world = "world").unwrap();
    }

    #[test]
    fn try_run_format_named_parameters_in_scope() {
        let world = "world";
        try_run!("echo {world}").unwrap();
    }

    #[test]
    fn try_run_format_named_parameters_in_scope_and_positional_parameters() {
        let world = "world";
        try_run!("echo {} {world}", "hello").unwrap();
    }

    #[test]
    fn try_run_format_all_parameters() {
        let name = "sheller";
        try_run!("echo {} {world}, {name}", "hello", world = "world").unwrap();
    }
}