🚧Replace custom guards (#911)

* Replace `EnsureThat.ParamIsNotNull()` with `ArgumentNullException.ThrowIfNull()` * Replace `EnsureThat.EnsureThat.ParamIsNotNull()` with `ArgumentNullException.ThrowIfNullOrEmpty()` * Delete `EnsureThat.cs` class file * cleanup: remove unused usings * chore: readd ensure that guards for pointers and adjust tests * refactor: replace guard * test: adjust tests for replaced guards --------- Co-authored-by: Calvin Wilkinson <[email protected]> Co-authored-by: Calvin Wilkinson <[email protected]>
KinsonDigital · Apr 12, 2024 · 34ea7d0 · 34ea7d0
1 parent 1bd6a3e
commit 34ea7d0
Show file tree

Hide file tree

Showing 18 changed files with 30 additions and 124 deletions.
diff --git a/Testing/VelaptorTests/Content/AudioPathResolverTests.cs b/Testing/VelaptorTests/Content/AudioPathResolverTests.cs
@@ -47,7 +47,7 @@ public void Ctor_WithNullDirectoryParam_ThrowsException()
 
         // Assert
         act.Should().Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'directory')");
+            .WithMessage("Value cannot be null. (Parameter 'directory')");
     }
 
     [Fact]

diff --git a/Testing/VelaptorTests/Content/Factories/AudioFactoryTests.cs b/Testing/VelaptorTests/Content/Factories/AudioFactoryTests.cs
@@ -48,7 +48,7 @@ public void Ctor_WithNullReactableFactoryParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'reactableFactory')");
+            .WithMessage("Value cannot be null. (Parameter 'reactableFactory')");
     }
     #endregion
 

diff --git a/Testing/VelaptorTests/Content/Factories/FontFactoryTests.cs b/Testing/VelaptorTests/Content/Factories/FontFactoryTests.cs
@@ -54,7 +54,7 @@ public void Ctor_WithNullFontServiceParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'fontService')");
+            .WithMessage("Value cannot be null. (Parameter 'fontService')");
     }
 
     [Fact]
@@ -73,7 +73,7 @@ public void Ctor_WithNullFontStatsServiceParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'fontStatsService')");
+            .WithMessage("Value cannot be null. (Parameter 'fontStatsService')");
     }
 
     [Fact]
@@ -92,7 +92,7 @@ public void Ctor_WithNullFontAtlasServiceParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'fontAtlasService')");
+            .WithMessage("Value cannot be null. (Parameter 'fontAtlasService')");
     }
 
     [Fact]
@@ -111,7 +111,7 @@ public void Ctor_WithNullTextureCacheParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'textureCache')");
+            .WithMessage("Value cannot be null. (Parameter 'textureCache')");
     }
     #endregion
 

diff --git a/Testing/VelaptorTests/Guards/EnsureThatTests.cs b/Testing/VelaptorTests/Guards/EnsureThatTests.cs
@@ -7,7 +7,6 @@ namespace VelaptorTests.Guards;
 
 using System;
 using FluentAssertions;
-using Helpers;
 using Velaptor.Guards;
 using Xunit;
 
@@ -17,44 +16,6 @@ namespace VelaptorTests.Guards;
 public class EnsureThatTests
 {
     #region Method Tests
-    [Fact]
-    public void ParamIsNotNull_WithNullValue_ThrowsException()
-    {
-        // Arrange
-        object? nullObj = null;
-
-        // Act & Assert
-        AssertExtensions.ThrowsWithMessage<ArgumentNullException>(() =>
-        {
-            EnsureThat.ParamIsNotNull(nullObj);
-        }, "The parameter must not be null. (Parameter 'nullObj')");
-    }
-
-    [Fact]
-    public void ParamIsNotNull_WithNonNullValue_DoesNotThrowException()
-    {
-        // Arrange
-        object nonNullObj = "non-null-obj";
-
-        // Act & Assert
-        AssertExtensions.DoesNotThrow<Exception>(() =>
-        {
-            EnsureThat.ParamIsNotNull(nonNullObj);
-        });
-    }
-
-    [Theory]
-    [InlineData("")]
-    [InlineData(null)]
-    public void StringParamIsNotNullOrEmpty_WhenInvoked_ThrowsException(string? value)
-    {
-        // Act & Assert
-        AssertExtensions.ThrowsWithMessage<ArgumentNullException>(() =>
-        {
-            EnsureThat.StringParamIsNotNullOrEmpty(value);
-        }, $"The string parameter must not be null or empty. (Parameter '{nameof(value)}')");
-    }
-
     [Fact]
     public void PointerIsNotNull_WithNonZeroIntPointer_DoesNotThrowException()
     {

diff --git a/Testing/VelaptorTests/Hardware/SystemDisplayTests.cs b/Testing/VelaptorTests/Hardware/SystemDisplayTests.cs
@@ -52,7 +52,7 @@ public void Ctor_WithNullPlatformParam_ThrowsException()
         AssertExtensions.ThrowsWithMessage<ArgumentNullException>(() =>
         {
             _ = new SystemDisplay(null);
-        }, "The parameter must not be null. (Parameter 'platform')");
+        }, "Value cannot be null. (Parameter 'platform')");
     }
     #endregion
 

diff --git a/Testing/VelaptorTests/Input/KeyboardTests.cs b/Testing/VelaptorTests/Input/KeyboardTests.cs
@@ -37,7 +37,7 @@ public void Ctor_WithNullKeyboardDataStoreParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'keyboardDataService')");
+            .WithMessage("Value cannot be null. (Parameter 'keyboardDataService')");
     }
     #endregion
 

diff --git a/Testing/VelaptorTests/Input/MouseTests.cs b/Testing/VelaptorTests/Input/MouseTests.cs
@@ -50,7 +50,7 @@ public void Ctor_WithNullReactableFactoryParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'reactableFactory')");
+            .WithMessage("Value cannot be null. (Parameter 'reactableFactory')");
     }
 
     [Fact]

diff --git a/Testing/VelaptorTests/UI/WindowTests.cs b/Testing/VelaptorTests/UI/WindowTests.cs
@@ -56,7 +56,7 @@ public void Ctor_WithNullWindowParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'window')");
+            .WithMessage("Value cannot be null. (Parameter 'window')");
     }
 
     [Fact]
@@ -71,7 +71,7 @@ public void Ctor_WithNullSceneManagerParam_ThrowsException()
         // Assert
         act.Should()
             .Throw<ArgumentNullException>()
-            .WithMessage("The parameter must not be null. (Parameter 'sceneManager')");
+            .WithMessage("Value cannot be null. (Parameter 'sceneManager')");
     }
 
     [Fact]

diff --git a/Velaptor/Content/AudioPathResolver.cs b/Velaptor/Content/AudioPathResolver.cs
@@ -8,7 +8,6 @@ namespace Velaptor.Content;
 using System.IO;
 using System.IO.Abstractions;
 using System.Linq;
-using Guards;
 
 /// <summary>
 /// Resolves paths to audio content.
@@ -23,7 +22,7 @@ internal sealed class AudioPathResolver : ContentPathResolver
     /// <param name="directory">Performs operations with directories.</param>
     public AudioPathResolver(IDirectory directory)
     {
-        EnsureThat.ParamIsNotNull(directory);
+        ArgumentNullException.ThrowIfNull(directory);
         this.directory = directory;
         ContentDirectoryName = "Audio";
     }

diff --git a/Velaptor/Content/Factories/AudioFactory.cs b/Velaptor/Content/Factories/AudioFactory.cs
@@ -12,7 +12,6 @@ namespace Velaptor.Content.Factories;
 using System.Linq;
 using Carbonate;
 using Carbonate.OneWay;
-using Guards;
 using ReactableData;
 using Velaptor.Factories;
 using CASLAudio = CASL.Audio;
@@ -32,7 +31,7 @@ internal sealed class AudioFactory : IAudioFactory
     /// <param name="reactableFactory">Creates reactables for sending and receiving notifications with or without data.</param>
     public AudioFactory(IReactableFactory reactableFactory)
     {
-        EnsureThat.ParamIsNotNull(reactableFactory);
+        ArgumentNullException.ThrowIfNull(reactableFactory);
 
         this.disposeReactable = reactableFactory.CreateDisposeAudioReactable();
 

diff --git a/Velaptor/Content/Factories/FontFactory.cs b/Velaptor/Content/Factories/FontFactory.cs
@@ -4,11 +4,11 @@
 
 namespace Velaptor.Content.Factories;
 
+using System;
 using Caching;
 using Fonts;
 using Fonts.Services;
 using Graphics;
-using Guards;
 using Services;
 
 /// <summary>
@@ -34,10 +34,10 @@ public FontFactory(
         IFontAtlasService fontAtlasService,
         IItemCache<string, ITexture> textureCache)
     {
-        EnsureThat.ParamIsNotNull(fontAtlasService);
-        EnsureThat.ParamIsNotNull(textureCache);
-        EnsureThat.ParamIsNotNull(fontService);
-        EnsureThat.ParamIsNotNull(fontStatsService);
+        ArgumentNullException.ThrowIfNull(fontAtlasService);
+        ArgumentNullException.ThrowIfNull(textureCache);
+        ArgumentNullException.ThrowIfNull(fontService);
+        ArgumentNullException.ThrowIfNull(fontStatsService);
 
         this.fontAtlasService = fontAtlasService;
         this.textureCache = textureCache;

diff --git a/Velaptor/Guards/EnsureThat.cs b/Velaptor/Guards/EnsureThat.cs
@@ -14,61 +14,13 @@ namespace Velaptor.Guards;
 /// </summary>
 internal static class EnsureThat
 {
-    /// <summary>
-    /// Throws an <see cref="ArgumentNullException"/> if the given <paramref name="value"/> is null.
-    /// </summary>
-    /// <param name="value">The value to check.</param>
-    /// <param name="paramName">The name of the parameter being checked.</param>
-    /// <typeparam name="T">The class restricted type of the value.</typeparam>
-    /// <remarks>
-    /// <para>
-    ///     This method is intended to have the value <paramref name="paramName"/> to be the
-    ///     name of the item that is null.
-    /// </para>
-    /// <para>
-    ///     Example:  A parameter being injected into a constructor.
-    /// </para>
-    /// </remarks>
-    /// <exception cref="ArgumentNullException">
-    ///     Thrown if <paramref name="value"/> is null.
-    /// </exception>
-    public static void ParamIsNotNull<T>(
-        T? value,
-        [CallerArgumentExpression("value")] string paramName = "")
-        where T : class
-    {
-        if (value is null)
-        {
-            throw new ArgumentNullException(paramName, "The parameter must not be null.");
-        }
-    }
-
-    /// <summary>
-    /// Throws an <see cref="ArgumentNullException"/> if the given string <paramref name="value"/>
-    /// is null or empty.
-    /// </summary>
-    /// <param name="value">The string value to check.</param>
-    /// <param name="paramName">The name of the parameter being checked.</param>
-    /// <exception cref="ArgumentNullException">
-    ///     Thrown if the <paramref name="value"/> is null or empty.
-    /// </exception>
-    public static void StringParamIsNotNullOrEmpty(
-        string value,
-        [CallerArgumentExpression("value")] string paramName = "")
-    {
-        if (string.IsNullOrEmpty(value))
-        {
-            throw new ArgumentNullException(paramName, "The string parameter must not be null or empty.");
-        }
-    }
-
     /// <summary>
     /// Throws a <see cref="NullReferenceException"/> if the given <paramref name="pointer"/> is a value of zero.
     /// </summary>
     /// <param name="pointer">The pointer to check.</param>
     /// <param name="paramName">The name of the parameter being checked.</param>
     /// <exception cref="NullReferenceException">
-    ///     Thrown if the <paramref name="pointer"/> is a value of zero.
+    ///     Thrown if <paramref name="pointer"/> is a value of zero.
     /// </exception>
     [SuppressMessage("csharpsquid|should not be thrown by user code.", "S112", Justification = "Intentional")]
     public static void PointerIsNotNull(nint pointer, [CallerArgumentExpression("pointer")] string paramName = "")
@@ -91,7 +43,7 @@ public static void PointerIsNotNull(nint pointer, [CallerArgumentExpression("poi
     /// <param name="pointer">The pointer to check.</param>
     /// <param name="paramName">The name of the parameter being checked.</param>
     /// <exception cref="NullReferenceException">
-    ///     Thrown if the <paramref name="pointer"/> is a value of zero.
+    ///     Thrown if <paramref name="pointer"/> is a value of zero.
     /// </exception>
     [SuppressMessage("csharpsquid|should not be thrown by user code.", "S112", Justification = "Intentional")]
     public static void PointerIsNotNull(nuint pointer, [CallerArgumentExpression("pointer")] string paramName = "")

diff --git a/Velaptor/Hardware/SystemDisplay.cs b/Velaptor/Hardware/SystemDisplay.cs
@@ -8,7 +8,6 @@ namespace Velaptor.Hardware;
 using System.Diagnostics.CodeAnalysis;
 using System.Numerics;
 using System.Runtime.InteropServices;
-using Guards;
 
 /// <summary>
 /// Holds information about a single display in the system.
@@ -32,7 +31,7 @@ public readonly record struct SystemDisplay
     /// </exception>
     internal SystemDisplay(IPlatform platform)
     {
-        EnsureThat.ParamIsNotNull(platform);
+        ArgumentNullException.ThrowIfNull(platform);
         this.platform = platform;
     }
 

diff --git a/Velaptor/Input/Keyboard.cs b/Velaptor/Input/Keyboard.cs
@@ -5,7 +5,7 @@
 #pragma warning disable SA1129 // Do not use default value type constructor
 namespace Velaptor.Input;
 
-using Guards;
+using System;
 using Services;
 
 /// <summary>
@@ -21,7 +21,7 @@ internal sealed class Keyboard : IAppInput<KeyboardState>
     /// <param name="keyboardDataService">Creates reactables for sending and receiving notifications with or without data.</param>
     public Keyboard(IKeyboardDataService keyboardDataService)
     {
-        EnsureThat.ParamIsNotNull(keyboardDataService);
+        ArgumentNullException.ThrowIfNull(keyboardDataService);
 
         this.keyboardDataService = keyboardDataService;
     }

diff --git a/Velaptor/Input/Mouse.cs b/Velaptor/Input/Mouse.cs
@@ -9,7 +9,6 @@ namespace Velaptor.Input;
 using System.Drawing;
 using Carbonate;
 using Factories;
-using Guards;
 using ReactableData;
 
 /// <summary>
@@ -32,7 +31,7 @@ internal sealed class Mouse : IAppInput<MouseState>
     /// <param name="reactableFactory">Creates reactables for sending and receiving notifications with or without data.</param>
     public Mouse(IReactableFactory reactableFactory)
     {
-        EnsureThat.ParamIsNotNull(reactableFactory);
+        ArgumentNullException.ThrowIfNull(reactableFactory);
 
         var mouseDataReactable = reactableFactory.CreateMouseReactable();
 

diff --git a/Velaptor/UI/Button.cs b/Velaptor/UI/Button.cs
@@ -12,7 +12,6 @@ namespace Velaptor.UI;
 using Factories;
 using Graphics;
 using Graphics.Renderers;
-using Guards;
 using Input;
 
 /// <summary>
@@ -56,7 +55,7 @@ public Button()
     [SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Used by library users.")]
     public Button(Label? label)
     {
-        EnsureThat.ParamIsNotNull(label);
+        ArgumentNullException.ThrowIfNull(label);
 
         this.rectRenderer = RendererFactory.CreateShapeRenderer();
 
@@ -164,7 +163,7 @@ internal Button(
         IAppInput<MouseState> mouse)
         : base(keyboard, mouse)
     {
-        EnsureThat.ParamIsNotNull(controlFactory);
+        ArgumentNullException.ThrowIfNull(controlFactory);
 
         this.controlFactory = controlFactory;
     }

diff --git a/Velaptor/UI/Label.cs b/Velaptor/UI/Label.cs
@@ -15,7 +15,6 @@ namespace Velaptor.UI;
 using ExtensionMethods;
 using Factories;
 using Graphics.Renderers;
-using Guards;
 using Input;
 
 /// <summary>
@@ -80,7 +79,7 @@ internal Label(
         IAppInput<MouseState> mouse)
             : base(keyboard, mouse)
     {
-        EnsureThat.ParamIsNotNull(fontLoader);
+        ArgumentNullException.ThrowIfNull(fontLoader);
 
         Init(fontLoader, RendererFactory.CreateFontRenderer());
     }