wrapped_list/

lib.rs

//! # wrapped-list
//!
//! This crate provides macros which allow you to create lists of elements
//! that are wrappped by an object, function, or another macro at compile time.
//!
//! ```ignore
//! wrapped_list![Box::new; value_1, value_2, ...]
//! ```
//!
//! Expands to:
//!
//! ```ignore
//! [Box::new(value_1), Box::new(value_2), ...]
//! ```
//!
//! With this you can:
//!
//! - [Wrap values with a tuple struct or enum](#wrap-values-with-a-tuple-struct-or-enum)
//! - [Wrap values with an object or function](#wrap-values-with-an-object-or-function)
//! - [Wrap values with a macro](#wrap-values-with-a-macro)
//!
//! ## Examples
//!
//! ### Wrap values with a tuple struct or enum
//!
//! ```
//! use wrapped_list::wrapped_list;
//!
//! #[derive(Debug, PartialEq, Eq)]
//! struct Wrapper(i32);
//!
//! let wrapped_items = wrapped_list![Wrapper; 1, 2, 3, 4];
//!
//! assert_eq!(wrapped_items, [Wrapper(1), Wrapper(2), Wrapper(3), Wrapper(4)]);
//! ```
//!
//! ### Wrap values with an object or function
//!
//! ```
//! use wrapped_list::wrapped_list;
//!
//! let boxed_items = wrapped_list![Box::new; 1, 2, 3];
//!
//! assert_eq!(boxed_items, [Box::new(1), Box::new(2), Box::new(3)])
//! ```
//!
//! ```
//! use wrapped_list::wrapped_list;
//!
//! let func = |x| x * 2;
//!
//! let doubled = wrapped_list![func; 1, 2, 3];
//!
//! assert_eq!(doubled, [2, 4, 6]);
//! ```
//!
//! ### Wrap values with a macro
//!
//! ```
//! use wrapped_list::wrapped_list;
//!
//! macro_rules! add_one {
//!     ($e:expr) => {
//!         $e + 1
//!     };
//! }
//!
//! let one_more = wrapped_list![add_one!; 1, 2, 3];
//!
//! assert_eq!(one_more, [2, 3, 4]);
//! ```

/// Macro to wrap a list of values with a function, object, or another macro.
///
/// See the [examples](crate#examples) to learn more.
#[macro_export]
macro_rules! wrapped_list {
    [$wrapper:path ; $($e:expr),* $(,)?] => {
        [$($wrapper($e)),*]
    };
    [$wrapper:ident! ; $($e:expr),* $(,)?] => {
        [$($wrapper!($e)),*]
    }
}

/// Functions identically to [wrapped_list], but the list is returned as a vector.
#[macro_export]
macro_rules! wrapped_vec {
    [$wrapper:path ; $($e:expr),* $(,)?] => {
        vec![$($wrapper($e)),*]
    };
    [$wrapper:ident! ; $($e:expr),* $(,)?] => {
        vec![$($wrapper!($e)),*]
    }
}

/// Functions identically to [wrapped_list], but the list is returned as a tuple.
#[macro_export]
macro_rules! wrapped_tuple {
    ($wrapper:path ; $($e:expr),* $(,)?) => {
        ($($wrapper($e)),*)
    };
    ($wrapper:ident! ; $($e:expr),* $(,)?) => {
        ($($wrapper!($e)),*)
    }
}

#[doc(hidden)]
#[cfg(test)]
mod tests {
    use duplicate::duplicate_item;

    #[derive(PartialEq, Eq, Debug)]
    struct Wrapper(i32);

    #[derive(PartialEq, Eq, Debug)]
    struct ComplexWrapper {
        wrapped_item: i32,
    }

    impl ComplexWrapper {
        pub fn new(item: i32) -> Self {
            ComplexWrapper { wrapped_item: item }
        }
    }

    fn wrapper_function1(input: i32) -> i32 {
        input * 10
    }

    fn wrapper_function2(input: i32) -> bool {
        input > 2
    }

    macro_rules! wrapper_macro1 {
        ($e:expr) => {
            Wrapper($e)
        };
    }

    macro_rules! add_one {
        ($e:expr) => {
            $e + 1
        };
    }

    macro_rules! wrapper_macro2 {
        ($e:expr) => {
            Wrapper(add_one!($e))
        };
    }

    #[duplicate_item(
        wrapper                test_name;
        [Wrapper]              [wrapper_test];
        [ComplexWrapper::new]  [complex_wrapper_test];
        [Box::new]             [box_test];
        [wrapper_function1]    [function_test1];
        [wrapper_function2]    [function_test2];
    )]
    #[test]
    fn test_name() {
        let my_list = [wrapper(1)];
        assert_eq!(my_list, wrapped_list![wrapper; 1]);
        let my_list = [wrapper(1), wrapper(2)];
        assert_eq!(my_list, wrapped_list![wrapper; 1, 2]);
        let my_list = [wrapper(1), wrapper(2), wrapper(3)];
        assert_eq!(my_list, wrapped_list![wrapper; 1, 2, 3]);
        let my_list = [wrapper(1), wrapper(2), wrapper(3), wrapper(4)];
        assert_eq!(my_list, wrapped_list![wrapper; 1, 2, 3, 4]);
    }

    #[duplicate_item(
        wrapper                test_name;
        [Wrapper]              [vec_wrapper_test];
        [ComplexWrapper::new]  [vec_complex_wrapper_test];
        [Box::new]             [vec_box_test];
        [wrapper_function1]    [vec_function_test1];
        [wrapper_function2]    [vec_function_test2];
    )]
    #[test]
    fn test_name() {
        let my_list = vec![wrapper(1)];
        assert_eq!(my_list, wrapped_vec![wrapper; 1]);
        let my_list = vec![wrapper(1), wrapper(2)];
        assert_eq!(my_list, wrapped_vec![wrapper; 1, 2]);
        let my_list = vec![wrapper(1), wrapper(2), wrapper(3)];
        assert_eq!(my_list, wrapped_vec![wrapper; 1, 2, 3]);
        let my_list = vec![wrapper(1), wrapper(2), wrapper(3), wrapper(4)];
        assert_eq!(my_list, wrapped_vec![wrapper; 1, 2, 3, 4]);
    }

    #[duplicate_item(
        wrapper                test_name;
        [Wrapper]              [tuple_wrapper_test];
        [ComplexWrapper::new]  [tuple_complex_wrapper_test];
        [Box::new]             [tuple_box_test];
        [wrapper_function1]    [tuple_function_test1];
        [wrapper_function2]    [tuple_function_test2];
    )]
    #[test]
    fn test_name() {
        let my_list = wrapper(1);
        assert_eq!(my_list, wrapped_tuple!(wrapper; 1));
        let my_list = (wrapper(1), wrapper(2));
        assert_eq!(my_list, wrapped_tuple!(wrapper; 1, 2));
        let my_list = (wrapper(1), wrapper(2), wrapper(3));
        assert_eq!(my_list, wrapped_tuple!(wrapper; 1, 2, 3));
        let my_list = (wrapper(1), wrapper(2), wrapper(3), wrapper(4));
        assert_eq!(my_list, wrapped_tuple!(wrapper; 1, 2, 3, 4));
    }

    #[test]
    fn trailing_commas() {
        let my_list = [Wrapper(1)];
        assert_eq!(my_list, wrapped_list![Wrapper; 1,]);
        let my_list = [Wrapper(1), Wrapper(2)];
        assert_eq!(my_list, wrapped_list![Wrapper; 1, 2,]);
        let my_list = [Wrapper(1), Wrapper(2), Wrapper(3)];
        assert_eq!(my_list, wrapped_list![Wrapper; 1, 2, 3,]);
        let my_list = [Wrapper(1), Wrapper(2), Wrapper(3), Wrapper(4)];
        assert_eq!(my_list, wrapped_list![Wrapper; 1, 2, 3, 4,]);
    }

    #[duplicate_item(
        macro_name        test_name;
        [wrapper_macro1]  [macro_test1];
        [wrapper_macro2]  [macro_test2];
    )]
    #[test]
    fn test_name() {
        let my_list = [macro_name!(1)];
        assert_eq!(my_list, wrapped_list![macro_name!; 1]);
        let my_list = [macro_name!(1), macro_name!(2)];
        assert_eq!(my_list, wrapped_list![macro_name!; 1, 2]);
        let my_list = [macro_name!(1), macro_name!(2), macro_name!(3)];
        assert_eq!(my_list, wrapped_list![macro_name!; 1, 2, 3]);
        let my_list = [
            macro_name!(1),
            macro_name!(2),
            macro_name!(3),
            macro_name!(4),
        ];
        assert_eq!(my_list, wrapped_list!(macro_name!; 1, 2, 3, 4));
    }

    #[test]
    fn trailing_commas_macro() {
        let my_list = [wrapper_macro2!(1)];
        assert_eq!(my_list, wrapped_list![wrapper_macro2!; 1,]);
        let my_list = [wrapper_macro2!(1), wrapper_macro2!(2)];
        assert_eq!(my_list, wrapped_list![wrapper_macro2!; 1, 2,]);
        let my_list = [wrapper_macro2!(1), wrapper_macro2!(2), wrapper_macro2!(3)];
        assert_eq!(my_list, wrapped_list![wrapper_macro2!; 1, 2, 3,]);
        let my_list = [
            wrapper_macro2!(1),
            wrapper_macro2!(2),
            wrapper_macro2!(3),
            wrapper_macro2!(4),
        ];
        assert_eq!(my_list, wrapped_list![wrapper_macro2!; 1, 2, 3, 4,]);
    }
}