mock_todo 0.1.0

//! A macro that makes it easy to mock [todo](https://doc.rust-lang.org/std/macro.todo.html) with
//! values to make the code compilable.
//!
//! The macro has two features:
//! - `todo`: works like a normal [todo].
//! - `mock`: returns the mock value we provide.
//!
//! # Installation
//! ```toml
//! [dependencies]
//! mock_todo = { version = "0.1.0", features = ["mock"] }
//! # use the following commented line if you want to use a regular todo.
//! # mock_todo = { version = "0.1.0", features = ["todo"] }
//! ```
//!
//! # Example of usage
//! ```rust
//! use mock_todo::mock_todo;
//! // returns 0 if the feature is "mock" and panics with the message "not yet implemented: Add feature" otherwise.
//! fn feature() -> u32 {
//!     // first argument can be ommited.
//!     mock_todo!("Add feature", 0)
//! }
//! ```

#[cfg(feature = "mock")]
#[macro_export]
macro_rules! mock_todo {
    ($message: expr, $value: expr) => {
        $value
    };
    ($value: expr) => {
        $value
    };
}

#[cfg(feature = "todo")]
#[macro_export]
macro_rules! mock_todo {
    ($message: expr, $value: expr) => {
        todo!($message)
    };
    ($value: expr) => {
        todo!()
    };
}

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

    #[cfg(feature = "mock")]
    #[test]
    fn on() {
        let result = mock_todo!("Fix", 1);
        assert_eq!(result, 1);
    }

    #[cfg(feature = "mock")]
    #[test]
    fn on_empty_message() {
        let result = mock_todo!(1);
        assert_eq!(result, 1);
    }

    #[cfg(feature = "todo")]
    #[test]
    #[should_panic(expected = "not yet implemented: Fix")]
    fn off() {
        mock_todo!("Fix", 1)
    }

    #[cfg(feature = "todo")]
    #[test]
    #[should_panic(expected = "not yet implemented")]
    fn off_empty_message() {
        mock_todo!(1)
    }
}