using NUnit.Framework;

namespace System.Utility
{
    /// <summary>
    /// Utility code to make testing easier.
    /// </summary>
    public static class AssertExtensions
    {
        /// <summary>
        /// Performs the same job as <see cref="Assert.AreEqual(object, object, string)"/>
        /// but prints out a pre-formatted message using <paramref name="name"/>.
        /// </summary>
        /// <typeparam name="T">The types being compared.</typeparam>
        /// <param name="actual">The actual value.</param>
        /// <param name="expected">The value that is expected.</param>
        /// <param name="name">The name of the values being compared (such as the
        /// name of the property, method, etc.).</param>
        public static void IsEqualTo<T>(this T actual, T expected, string name)
        {
            Assert.AreEqual(expected, actual, $"The value returned by '{name}' was not the expected value.");
        }

        /// <summary>
        /// Performs the same job as <see cref="Assert.AreNotEqual(object, object, string)"/>
        /// but prints out a pre-formatted message using <paramref name="name"/>.
        /// </summary>
        /// <typeparam name="T">The types being compared.</typeparam>
        /// <param name="actual">The actual value.</param>
        /// <param name="notExpected">The value that is not expected.</param>
        /// <param name="name">The name of the values being compared (such as the
        /// name of the property, method, etc.).</param>
        public static void IsNotEqualTo<T>(this T actual, T notExpected, string name)
        {
            Assert.AreNotEqual(notExpected, actual, $"The value returned by '{name}' was not the expected value.");
        }

        /// <summary>
        /// Performs the same job as <see cref="Assert.IsTrue(bool, string)"/>
        /// but prints out a pre-formatted message using <paramref name="name"/>.
        /// </summary>
        /// <param name="actual">The actual value.</param>
        /// <param name="name">The name of the values being compared (such as the
        /// name of the property, method, etc.).</param>
        public static void IsTrue(this bool actual, string name)
        {
            Assert.IsTrue(actual, $"The value returned by '{name}' was expected to be true.");
        }

        /// <summary>
        /// Performs the same job as <see cref="Assert.IsFalse(bool, string)"/>
        /// but prints out a pre-formatted message using <paramref name="name"/>.
        /// </summary>
        /// <param name="actual">The actual value.</param>
        /// <param name="name">The name of the values being compared (such as the
        /// name of the property, method, etc.).</param>
        public static void IsFalse(this bool actual, string name)
        {
            Assert.IsFalse(actual, $"The value returned by '{name}' was expected to be false.");
        }
    }
}