diff-ba-rs 0.1.2

//! # diff-ba-rs
//!
//! diff-ba-rs is a library to get the differences of variables caused by procedures.

/// Module that provides a set of functions used inside macros.
///
/// This module is available externally but is not intended to be used.
pub mod _diff_ba_impl {
    use tiny_ansi::TinyAnsi;
    pub fn _dbg(before: &str, after: &str) {
        for diff in diff::lines(before, after) {
            match diff {
                diff::Result::Left(l) => println!("{}", format!("- {l}").red()),
                diff::Result::Both(l, _) => println!("{}", format!("  {l}")),
                diff::Result::Right(r) => println!("{}", format!("+ {r}").green()),
            }
        }
    }
}

/// Module that provides a set of macros.
pub mod diff_ba {
    /// Prints the procedural change difference
    /// and returns the final expression in the procedural block.
    ///
    /// This macro works with a `Debug` implementation of the given expression type.
    ///
    /// An example:
    ///
    /// ```rust
    /// use diff_ba_rs::prelude::*;
    ///
    /// let mut a = 2;
    /// let b =  diff_ba::dbg!(&a, {
    ///     a *= 2;
    ///     a + 1
    /// });
    /// // prints:
    /// // ```
    /// // - 2
    /// // + 4
    /// // ```
    /// assert_eq!(b, 5);
    /// ```
    #[macro_export]
    macro_rules! dbg_ {
        ($val:expr, $b:block) => {{
            let before = format!("{:#?}", $val);
            let value = $b;
            let after = format!("{:#?}", $val);
            _diff_ba_impl::_dbg(&before, &after);
            value
        }};
    }
    pub use dbg_ as dbg;
}

/// Prelude module to import when using this crate.
pub mod prelude {
    pub use crate::{_diff_ba_impl, diff_ba};
}

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

    #[test]
    fn test_dbg_nothing() {
        let mut v = Vec::new();
        v.push("foo");
        v.push("bar");
        let result = diff_ba::dbg!(&v, { v.join(", ") });
        assert_eq!(result, "foo, bar");
    }

    #[test]
    fn test_dbg_add() {
        let mut v = Vec::new();
        v.push("foo");
        v.push("bar");
        let result = diff_ba::dbg!(&v, {
            v.push("baz");
            v.join(", ")
        });
        assert_eq!(result, "foo, bar, baz");
    }

    #[test]
    fn test_dbg_sub() {
        let mut v = Vec::new();
        v.push("foo");
        v.push("bar");
        let result = diff_ba::dbg!(&v, {
            v.pop();
            v.join(", ")
        });
        assert_eq!(result, "foo");
    }

    #[test]
    fn test_dbg_mix() {
        let mut v = Vec::new();
        v.push("foo");
        v.push("bar");
        let result = diff_ba::dbg!(&v, {
            v.pop();
            v.push("baz");
            v.join(", ")
        });
        assert_eq!(result, "foo, baz");
    }
}