fs-tree 0.4.0

//! Macros for declaring a [`FsTree`](crate::FsTree)

/// Macro for declaring a [`FsTree`](crate::FsTree) literal.
///
/// # Syntax:
///
/// - `name: { ... }` is a directory.
/// - `name -> name` is a symlink.
/// - `name` is a regular file.
/// - Spaces is optional.
/// - Commas are not required, but you should separate items with newlines or commas to improve
/// readability.
///
/// # Example:
///
/// ```
/// use fs_tree::{FsTree, trees};
///
/// let result = trees! {
///     config
///     outer_dir: {
///         file1
///         file2
///     }
///     link -> target
/// };
///
/// let expected = vec![
///     FsTree::new_regular("config"),
///     FsTree::new_directory("outer_dir", vec![
///         FsTree::new_regular("file1"),
///         FsTree::new_regular("file2")
///     ]),
///     FsTree::new_symlink("link", "target"),
/// ];
///
/// assert_eq!(result, expected);
/// ```
#[macro_export]
macro_rules! trees {
    ($($all:tt)*) => {{
        let mut vec = std::vec::Vec::<$crate::FsTree>::new();
        $crate::trees_internal!(vec $($all)*);
        vec
    }};
}

/// Same as `trees`, but panics if more than a single one is provided.
///
/// Ideally this macro would not compile instead of panicking.
#[macro_export]
macro_rules! tree {
    ($($all:tt)*) => {{
        #[allow(clippy::vec_init_then_push)]
        let mut vec = std::vec::Vec::<$crate::FsTree>::new();
        $crate::trees_internal!(vec $($all)*);
        assert!(
            vec.len() == 1,
            "Use of macro `tree!` requires a single folder at the root, \n\
             use `trees!` instead if you want to declare multiple ones",
        );
        vec.remove(0)
    }};
}

#[doc(hidden)]
#[macro_export]
macro_rules! trees_internal {
    // Base case
    ($vec:ident) => {};
    // Directory
    ($vec:ident $path:ident : { $($inner:tt)* } $($rest:tt)*) => {
        #[allow(unused_mut)]
        let mut inner_dir = std::vec::Vec::<$crate::FsTree>::new();
        $crate::trees_internal!(inner_dir $($inner)*);
        $vec.push($crate::FsTree::new_directory(stringify!($path), inner_dir));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Directory variation
    ($vec:ident $path:literal : { $($inner:tt)* } $($rest:tt)*) => {
        #[allow(unused_mut)]
        let mut inner_dir = std::vec::Vec::<$crate::FsTree>::new();
        $crate::trees_internal!(inner_dir $($inner)*);
        $vec.push($crate::FsTree::new_directory($path, inner_dir));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Symlink
    ($vec:ident $path:ident -> $target:ident $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_symlink(stringify!($path), stringify!($target)));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Symlink variation
    ($vec:ident $path:literal -> $target:ident $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_symlink($path, stringify!($target)));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Symlink variation
    ($vec:ident $path:ident -> $target:literal $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_symlink(stringify!($path), $target));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Symlink variation
    ($vec:ident $path:literal -> $target:literal $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_symlink($path, $target));
        $crate::trees_internal!($vec $($rest)*)
    };
    // Regular file
    ($vec:ident $path:ident $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_regular(stringify!($path)));
        $crate::trees_internal!($vec $($rest)*);
    };
    // Regular file
    ($vec:ident $path:literal $($rest:tt)*) => {
        $vec.push($crate::FsTree::new_regular($path));
        $crate::trees_internal!($vec $($rest)*);
    };
}

#[cfg(test)]
mod tests {
    use crate::FsTree;

    #[test]
    fn macro_compiles() {
        let _ = trees! {
            ".config": {
                oi
                "oi"
                i3: {
                    config -> oi
                    config -> "oi"
                    "config" -> oi
                    "config" -> "oi"
                }
            }
        };
    }

    #[test]
    fn test_tree_macro_single_regular_file() {
        let result = trees! {
            file
        };

        let expected = FsTree::new_regular("file");

        assert_eq!(result, vec![expected]);
    }

    #[test]
    fn test_tree_macro_empty_directory() {
        let result = trees! {
            dir: {}
        };

        let expected = FsTree::new_directory("dir", vec![]);

        assert_eq!(result, vec![expected]);
    }

    #[test]
    fn test_tree_macro_single_symlink() {
        let result = trees! {
            link -> target
        };

        let expected = FsTree::new_symlink("link", "target");

        assert_eq!(result, vec![expected]);
    }

    #[test]
    fn test_tree_macro_nested_directories() {
        let result = trees! {
            outer_dir: {
                inner_dir: {
                }
            }
        };

        let expected = FsTree::new_directory(
            "outer_dir",
            vec![FsTree::new_directory("inner_dir", vec![])],
        );

        assert_eq!(result, vec![expected]);
    }

    #[test]
    fn test_tree_macro_mixed_types() {
        let result = trees! {
            config
            outer_dir: {
                file1
                file2
            }
            link -> target
        };

        let expected = vec![
            FsTree::new_regular("config"),
            FsTree::new_directory(
                "outer_dir",
                vec![FsTree::new_regular("file1"), FsTree::new_regular("file2")],
            ),
            FsTree::new_symlink("link", "target"),
        ];

        assert_eq!(result, expected);
    }

    #[test]
    fn test_tree_macro_big_example() {
        let result = trees! {
            config1
            config2
            outer_dir: {
                file1
                file2
                inner_dir: {
                    inner1
                    inner2
                    inner3
                    inner_link -> inner_target
                }
            }
            link -> target
            config3
        };

        let expected = vec![
            FsTree::new_regular("config1"),
            FsTree::new_regular("config2"),
            FsTree::new_directory(
                "outer_dir",
                vec![
                    FsTree::new_regular("file1"),
                    FsTree::new_regular("file2"),
                    FsTree::new_directory(
                        "inner_dir",
                        vec![
                            FsTree::new_regular("inner1"),
                            FsTree::new_regular("inner2"),
                            FsTree::new_regular("inner3"),
                            FsTree::new_symlink("inner_link", "inner_target"),
                        ],
                    ),
                ],
            ),
            FsTree::new_symlink("link", "target"),
            FsTree::new_regular("config3"),
        ];

        assert_eq!(result, expected);
    }
}