Feat: Implement IDebouncer interfaces for standardization

Author: AnnaSasDev

src/CodeOfChaos.Extensions.AspNetCore.Components/EventCallbacks/EventCallbackDebouncer.cs

@@ -9,12 +9,12 @@ namespace CodeOfChaos.Extensions.Debouncers;
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 // ReSharper disable once ConvertToAutoPropertyWithPrivateSetter
-public sealed class EventCallbackDebouncer : DebouncerBase<EventCallbackDebouncer.EmptyUnit> {
+public sealed class EventCallbackDebouncer : DebouncerBase<EventCallbackDebouncer.EmptyUnit>, IDebouncer {
     public readonly struct EmptyUnit;
     private EventCallback Callback { get; init; }
 
     private bool _isEmpty;
-    protected override bool IsEmpty => _isEmpty;
+    public override bool IsEmpty => _isEmpty;
     public static EventCallbackDebouncer Empty => new() {
         Callback = default,
         _isEmpty = true
@@ -42,11 +42,11 @@ protected async override ValueTask InvokeCallbackAsync(EmptyUnit item, Cancellat
 }
 
 // ReSharper disable once ConvertToAutoPropertyWithPrivateSetter
-public sealed class EventCallbackDebouncer<T> : DebouncerBase<T> {
+public sealed class EventCallbackDebouncer<T> : DebouncerBase<T>, IDebouncer, IDebouncer<T> {
     private EventCallback<T> Callback { get; init; }
 
     private bool _isEmpty;
-    protected override bool IsEmpty => _isEmpty;
+    public override bool IsEmpty => _isEmpty;
     public static EventCallbackDebouncer<T> Empty => new() {
         Callback = default,
         _isEmpty = true

src/CodeOfChaos.Extensions/Debouncers/IDebouncer.cs

@@ -0,0 +1,19 @@
+// ---------------------------------------------------------------------------------------------------------------------
+// Imports
+// ---------------------------------------------------------------------------------------------------------------------
+namespace CodeOfChaos.Extensions.Debouncers;
+
+// ---------------------------------------------------------------------------------------------------------------------
+// Code
+// ---------------------------------------------------------------------------------------------------------------------
+public interface IDebouncerBase {
+    bool IsEmpty { get; }
+}
+
+public interface IDebouncer : IDebouncerBase {
+    Task InvokeDebouncedAsync(CancellationToken ct = default);
+}
+
+public interface IDebouncer<in T> : IDebouncerBase {
+    Task InvokeDebouncedAsync(T item, CancellationToken ct = default);
+}

src/CodeOfChaos.Extensions/Debouncers/Regular/Debouncer.cs

@@ -6,10 +6,10 @@ namespace CodeOfChaos.Extensions.Debouncers;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
-public sealed class Debouncer: DebouncerBase<Debouncer.EmptyUnit> {
+public sealed class Debouncer: DebouncerBase<Debouncer.EmptyUnit>, IDebouncer {
     public readonly struct EmptyUnit; // Workaround for reusing DebouncerBase<T> instead of creating a fully new DebouncerBase without generics
     private object? Callback { get; init; }
-    protected override bool IsEmpty => Callback is null;
+    public override bool IsEmpty => Callback is null;
 
     public static Debouncer Empty => new() {
         Callback = null
@@ -68,9 +68,9 @@ protected async override ValueTask InvokeCallbackAsync(EmptyUnit item, Cancellat
     }
 }
 
-public sealed class Debouncer<T> : DebouncerBase<T> {
+public sealed class Debouncer<T> : DebouncerBase<T>, IDebouncer<T> {
     private object? Callback { get; init; }
-    protected override bool IsEmpty => Callback is null;
+    public override bool IsEmpty => Callback is null;
 
     public static Debouncer<T> Empty => new() {
         Callback = null

src/CodeOfChaos.Extensions/Debouncers/Regular/DebouncerBase.cs

@@ -16,7 +16,7 @@ public abstract class DebouncerBase<T> : IAsyncDisposable {
     private bool _isDisposed;
     private T? _latestValue;
 
-    protected abstract bool IsEmpty { get; }
+    public abstract bool IsEmpty { get; }
 
     // -----------------------------------------------------------------------------------------------------------------
     // Methods

src/CodeOfChaos.Extensions/Debouncers/Throttled/ThrottledDebouncer.cs

@@ -6,11 +6,11 @@ namespace CodeOfChaos.Extensions.Debouncers;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
-public sealed class ThrottledDebouncer: ThrottledDebouncerBase<ThrottledDebouncer.EmptyUnit> {
+public sealed class ThrottledDebouncer: ThrottledDebouncerBase<ThrottledDebouncer.EmptyUnit>, IDebouncer {
     public readonly struct EmptyUnit; // Workaround for reusing ThrottledDebouncerBase<T> instead of creating a fully new DebouncerBase without generics
     private object? Callback { get; init; }
-
-    protected override bool IsEmpty => Callback is null;
+    public override bool IsEmpty => Callback is null;
+    
     public static ThrottledDebouncer Empty => new() {
         Callback = null
     };
@@ -71,9 +71,10 @@ protected async override ValueTask InvokeCallbackAsync(EmptyUnit item, Cancellat
     }
 }
 
-public sealed class ThrottledDebouncer<T> : ThrottledDebouncerBase<T> {
+public sealed class ThrottledDebouncer<T> : ThrottledDebouncerBase<T>, IDebouncer<T> {
     private object? Callback { get; init; }
-    protected override bool IsEmpty => Callback is null;
+    public override bool IsEmpty => Callback is null;
+    
     public static ThrottledDebouncer<T> Empty => new() {
         Callback = null
     };

src/CodeOfChaos.Extensions/Debouncers/Throttled/ThrottledDebouncerBase.cs

@@ -21,7 +21,7 @@ public abstract class ThrottledDebouncerBase<T> : IAsyncDisposable {
     private DateTime _lastExecuteTime = DateTime.MinValue;
     private DateTime _firstCallTime = DateTime.MinValue;
 
-    protected abstract bool IsEmpty { get; }
+    public abstract bool IsEmpty { get; }
 
     // -----------------------------------------------------------------------------------------------------------------
     // Methods

tests/Tests.CodeOfChaos.Extensions.AspNetCore.Components/EventCallbacks/EventCallbackDebouncerTests.cs

@@ -9,6 +9,25 @@ namespace Tests.CodeOfChaos.Extensions.AspNetCore.Components.EventCallbacks;
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 public class EventCallbackDebouncerTests {
+    public static IEnumerable<Func<(IDebouncerBase, bool)>> GetEmptyDebouncers() {
+        yield return () => (EventCallbackDebouncer.Empty, true);
+        yield return () => (EventCallbackDebouncer<string>.Empty, true);
+        yield return () => (EventCallbackDebouncer<int>.Empty, true);
+        yield return () => (EventCallbackDebouncer.FromEventCallback(EventCallback.Factory.Create(string.Empty, callback: () => Task.CompletedTask)), false);
+        yield return () => (EventCallbackDebouncer<string>.FromEventCallback(EventCallback.Factory.Create<string>(string.Empty, callback: () => Task.CompletedTask)), false);
+        yield return () => (EventCallbackDebouncer<int>.FromEventCallback(EventCallback.Factory.Create<int>(string.Empty, callback: () => Task.CompletedTask)), false);
+    }
+    
+    [Test]
+    [MethodDataSource(nameof(GetEmptyDebouncers))]
+    public async Task Empty_ShouldBeEmpty(IDebouncerBase debouncer, bool expectedIsEmpty) {
+        // Arrange & Act
+        bool result = debouncer.IsEmpty;
+
+        // Assert
+        await Assert.That(result).IsEqualTo(expectedIsEmpty);
+    }
+    
 
     [Test]
     public async Task DefaultDebounceMs_ShouldBe100() {

tests/Tests.CodeOfChaos.Extensions/Debouncers/Regular/DebouncerTests.cs

@@ -0,0 +1,37 @@
+// ---------------------------------------------------------------------------------------------------------------------
+// Imports
+// ---------------------------------------------------------------------------------------------------------------------
+using CodeOfChaos.Extensions.Debouncers;
+
+namespace Tests.CodeOfChaos.Extensions.Debouncers.Regular;
+
+// ---------------------------------------------------------------------------------------------------------------------
+// Code
+// ---------------------------------------------------------------------------------------------------------------------
+public class DebouncerTests {
+    public static IEnumerable<Func<(IDebouncerBase, bool)>> GetEmptyDebouncers() {
+        yield return () => (Debouncer.Empty, true);
+        yield return () => (Debouncer<string>.Empty, true);
+        yield return () => (Debouncer<int>.Empty, true);
+        yield return () => (Debouncer.FromDelegate(() => {}), false);
+        yield return () => (Debouncer<string>.FromDelegate(_ => {}), false);
+        yield return () => (Debouncer<int>.FromDelegate(_ => {}), false);
+        
+        yield return () => (ThrottledDebouncer.Empty, true);
+        yield return () => (ThrottledDebouncer<string>.Empty, true);
+        yield return () => (ThrottledDebouncer<int>.Empty, true);
+        yield return () => (ThrottledDebouncer.FromDelegate(() => {}), false);
+        yield return () => (ThrottledDebouncer<string>.FromDelegate(_ => {}), false);
+        yield return () => (ThrottledDebouncer<int>.FromDelegate(_ => {}), false);
+    }
+    
+    [Test]
+    [MethodDataSource(nameof(GetEmptyDebouncers))]
+    public async Task Empty_ShouldBeEmpty(IDebouncerBase debouncer, bool expectedIsEmpty) {
+        // Arrange & Act
+        bool result = debouncer.IsEmpty;
+
+        // Assert
+        await Assert.That(result).IsEqualTo(expectedIsEmpty);
+    }
+}