refactor: Remove ITestRenderer interface

linkdotnet · linkdotnet · commit d6478b985a36 · 2024-07-21T21:03:43.000+02:00
diff --git a/src/bunit/Diffing/HtmlComparer.cs b/src/bunit/Diffing/HtmlComparer.cs
@@ -8,7 +8,7 @@
 namespace Bunit.Diffing;
 
 /// <summary>
-/// Represents a test HTML comparer, that is configured to work with markup generated by the <see cref="ITestRenderer"/> and <see cref="Htmlizer"/> classes.
+/// Represents a test HTML comparer, that is configured to work with markup generated by the <see cref="TestRenderer"/> and <see cref="Htmlizer"/> classes.
 /// </summary>
 public sealed class HtmlComparer
 {
diff --git a/src/bunit/EventDispatchExtensions/TriggerEventDispatchExtensions.cs b/src/bunit/EventDispatchExtensions/TriggerEventDispatchExtensions.cs
@@ -63,7 +63,7 @@ public static Task TriggerEventAsync(this IElement element, string eventName, Ev
 		ArgumentNullException.ThrowIfNull(eventName);
 
 		var renderer = element.GetTestContext()?.Renderer
-			?? throw new InvalidOperationException($"Blazor events can only be raised on elements rendered with the Blazor test renderer '{nameof(ITestRenderer)}'.");
+			?? throw new InvalidOperationException($"Blazor events can only be raised on elements rendered with the Blazor test renderer '{nameof(TestRenderer)}'.");
 
 		// TriggerEventsAsync will traverse the DOM tree to find
 		// all event handlers that needs to be triggered. This is done
@@ -78,7 +78,7 @@ public static Task TriggerEventAsync(this IElement element, string eventName, Ev
 	}
 
 	[SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "HTML events are standardize to lower case and safe in this context.")]
-	private static Task TriggerEventsAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerEventsAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
 	{
 		var isNonBubblingEvent = NonBubblingEvents.Contains(eventName.ToLowerInvariant());
 		var unwrappedElement = element.Unwrap();
@@ -88,7 +88,7 @@ private static Task TriggerEventsAsync(ITestRenderer renderer, IElement element,
 			: TriggerBubblingEventAsync(renderer, unwrappedElement, eventName, eventArgs);
 	}
 
-	private static Task TriggerNonBubblingEventAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerNonBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
 	{
 		var eventAttrName = Htmlizer.ToBlazorAttribute(eventName);
 
@@ -105,7 +105,7 @@ private static Task TriggerNonBubblingEventAsync(ITestRenderer renderer, IElemen
 		throw new MissingEventHandlerException(element, eventName);
 	}
 
-	private static Task TriggerBubblingEventAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
 	{
 		var eventTasks = GetDispatchEventTasks(renderer, element, eventName, eventArgs);
 
@@ -118,7 +118,7 @@ private static Task TriggerBubblingEventAsync(ITestRenderer renderer, IElement e
 	}
 
 	private static List<Task> GetDispatchEventTasks(
-		ITestRenderer renderer,
+		TestRenderer renderer,
 		IElement element,
 		string eventName,
 		EventArgs eventArgs)
diff --git a/src/bunit/Extensions/RenderedComponentRenderExtensions.cs b/src/bunit/Extensions/RenderedComponentRenderExtensions.cs
@@ -28,7 +28,7 @@ public static void SetParametersAndRender<TComponent>(this IRenderedComponent<TC
 	{
 		ArgumentNullException.ThrowIfNull(renderedComponent);
 
-		var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContext>().Renderer;
+		var renderer = renderedComponent.Services.GetRequiredService<TestContext>().Renderer;
 
 		try
 		{
diff --git a/src/bunit/Extensions/RenderedFragmentInvokeAsyncExtensions.cs b/src/bunit/Extensions/RenderedFragmentInvokeAsyncExtensions.cs
@@ -8,7 +8,7 @@ namespace Bunit;
 public static class RenderedFragmentInvokeAsyncExtensions
 {
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="ITestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
 	/// </summary>
 	/// <param name="renderedFragment">The rendered fragment whose dispatcher to invoke with.</param>
 	/// <param name="workItem">The work item to execute on the renderer's thread.</param>
@@ -26,7 +26,7 @@ public static Task InvokeAsync(this IRenderedFragment renderedFragment, Action w
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="ITestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
 	/// </summary>
 	/// <param name="renderedFragment">The rendered component whose dispatcher to invoke with.</param>
 	/// <param name="workItem">The work item to execute on the renderer's thread.</param>
@@ -44,7 +44,7 @@ public static Task InvokeAsync(this IRenderedFragment renderedFragment, Func<Tas
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="ITestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
 	/// </summary>
 	/// <param name="renderedFragment">The rendered component whose dispatcher to invoke with.</param>
 	/// <param name="workItem">The work item to execute on the renderer's thread.</param>
@@ -62,7 +62,7 @@ public static Task<T> InvokeAsync<T>(this IRenderedFragment renderedFragment, Fu
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="ITestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
 	/// </summary>
 	/// <param name="renderedFragment">The rendered component whose dispatcher to invoke with.</param>
 	/// <param name="workItem">The work item to execute on the renderer's thread.</param>
diff --git a/src/bunit/Extensions/TestRendererExtensions.cs b/src/bunit/Extensions/TestRendererExtensions.cs
@@ -3,7 +3,7 @@
 namespace Bunit.Extensions;
 
 /// <summary>
-/// Helper methods that make it easier to work directly with a <see cref="ITestRenderer"/>
+/// Helper methods that make it easier to work directly with a <see cref="TestRenderer"/>
 /// in bUnit web.
 /// </summary>
 public static class TestRendererExtensions
@@ -15,7 +15,7 @@ public static class TestRendererExtensions
 	/// <param name="renderer">The renderer to use.</param>
 	/// <param name="parameters">The parameters to pass to the component.</param>
 	/// <returns>A <see cref="IRenderedComponent{TComponent}"/> that provides access to the rendered component.</returns>
-	public static IRenderedComponent<TComponent> RenderComponent<TComponent>(this ITestRenderer renderer, params ComponentParameter[] parameters)
+	public static IRenderedComponent<TComponent> RenderComponent<TComponent>(this TestRenderer renderer, params ComponentParameter[] parameters)
 		where TComponent : IComponent
 	{
 		ArgumentNullException.ThrowIfNull(renderer);
@@ -34,7 +34,7 @@ public static IRenderedComponent<TComponent> RenderComponent<TComponent>(this IT
 	/// <param name="renderer">The renderer to use.</param>
 	/// <param name="parameterBuilder">The a builder to create parameters to pass to the component.</param>
 	/// <returns>A <see cref="IRenderedComponent{TComponent}"/> that provides access to the rendered component.</returns>
-	public static IRenderedComponent<TComponent> RenderComponent<TComponent>(this ITestRenderer renderer, Action<ComponentParameterCollectionBuilder<TComponent>> parameterBuilder)
+	public static IRenderedComponent<TComponent> RenderComponent<TComponent>(this TestRenderer renderer, Action<ComponentParameterCollectionBuilder<TComponent>> parameterBuilder)
 		where TComponent : IComponent
 	{
 		ArgumentNullException.ThrowIfNull(renderer);
diff --git a/src/bunit/Extensions/WaitForHelpers/WaitForHelper.cs b/src/bunit/Extensions/WaitForHelpers/WaitForHelper.cs
@@ -54,7 +54,7 @@ protected WaitForHelper(
 		this.completeChecker = completeChecker ?? throw new ArgumentNullException(nameof(completeChecker));
 
 		logger = renderedFragment.Services.CreateLogger<WaitForHelper<T>>();
-		renderer = (TestRenderer)renderedFragment
+		renderer = renderedFragment
 			.Services
 			.GetRequiredService<TestContext>()
 			.Renderer;
diff --git a/src/bunit/IRenderedFragment.cs b/src/bunit/IRenderedFragment.cs
@@ -14,7 +14,7 @@ public interface IRenderedFragment : IDisposable
 	int RenderCount { get; }
 
 	/// <summary>
-	/// Gets a value indicating whether the rendered component or fragment has been disposed by the <see cref="ITestRenderer"/>.
+	/// Gets a value indicating whether the rendered component or fragment has been disposed by the <see cref="TestRenderer"/>.
 	/// </summary>
 	bool IsDisposed { get; }
 
@@ -24,7 +24,7 @@ public interface IRenderedFragment : IDisposable
 	int ComponentId { get; }
 
 	/// <summary>
-	/// Called by the owning <see cref="ITestRenderer"/> when it finishes a render.
+	/// Called by the owning <see cref="TestRenderer"/> when it finishes a render.
 	/// </summary>
 	/// <param name="renderEvent">A <see cref="RenderEvent"/> that represents a render.</param>
 	void OnRender(RenderEvent renderEvent);
@@ -51,6 +51,6 @@ public interface IRenderedFragment : IDisposable
 	/// <summary>
 	/// Gets the AngleSharp <see cref="INodeList"/> based
 	/// on the HTML markup from the rendered fragment/component.
-	/// </summary>	
+	/// </summary>
 	INodeList Nodes { get; }
 }
diff --git a/src/bunit/Rendering/ITestRenderer.cs b/src/bunit/Rendering/ITestRenderer.cs
diff --git a/src/bunit/Rendering/RenderEvent.cs b/src/bunit/Rendering/RenderEvent.cs
@@ -1,7 +1,7 @@
 namespace Bunit.Rendering;
 
 /// <summary>
-/// Represents an render event from a <see cref="ITestRenderer"/>.
+/// Represents an render event from a <see cref="TestRenderer"/>.
 /// </summary>
 public sealed class RenderEvent
 {
diff --git a/src/bunit/Rendering/TestRenderer.cs b/src/bunit/Rendering/TestRenderer.cs
@@ -6,9 +6,9 @@
 namespace Bunit.Rendering;
 
 /// <summary>
-/// Represents a bUnit <see cref="ITestRenderer"/> used to render Blazor components and fragments during bUnit tests.
+/// Represents a bUnit <see cref="TestRenderer"/> used to render Blazor components and fragments during bUnit tests.
 /// </summary>
-public class TestRenderer : Renderer, ITestRenderer
+public sealed class TestRenderer : Renderer
 {
 	[UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_isBatchInProgress")]
 	extern static ref bool GetIsBatchInProgressField(Renderer renderer);
diff --git a/src/bunit/TestContext.cs b/src/bunit/TestContext.cs
@@ -10,7 +10,7 @@ namespace Bunit;
 public class TestContext : IDisposable
 {
 	private bool disposed;
-	private ITestRenderer? testRenderer;
+	private TestRenderer? testRenderer;
 
 	/// <summary>
 	/// Gets or sets the default wait timeout used by "WaitFor" operations, i.e. <see cref="RenderedFragmentWaitForHelperExtensions.WaitForAssertion(IRenderedFragment, Action, TimeSpan?)"/>.
@@ -21,7 +21,7 @@ public class TestContext : IDisposable
 	/// <summary>
 	/// Gets the renderer used by the test context.
 	/// </summary>
-	public ITestRenderer Renderer => testRenderer ??= CreateTestRenderer();
+	public TestRenderer Renderer => testRenderer ??= CreateTestRenderer();
 
 	/// <summary>
 	/// Gets bUnits JSInterop, that allows setting up handlers for <see cref="IJSRuntime.InvokeAsync{TValue}(string, object[])"/> invocations
diff --git a/src/bunit/TestContextWrapper.cs b/src/bunit/TestContextWrapper.cs
@@ -17,7 +17,7 @@ public abstract class TestContextWrapper
 	/// <summary>
 	/// Gets the renderer used by the test context.
 	/// </summary>
-	public ITestRenderer Renderer => TestContext?.Renderer ?? throw new InvalidOperationException("The TestContext has not been initialized.");
+	public TestRenderer Renderer => TestContext?.Renderer ?? throw new InvalidOperationException("The TestContext has not been initialized.");
 
 	/// <summary>
 	/// Gets the service collection and service provider that is used when a
diff --git a/src/bunit/TestDoubles/PersistentComponentState/BunitPersistentComponentState.cs b/src/bunit/TestDoubles/PersistentComponentState/BunitPersistentComponentState.cs
@@ -17,7 +17,7 @@ public sealed class BunitPersistentComponentState
 	};
 	private readonly BunitPersistentComponentStateStore store;
 	private readonly Lazy<ComponentStatePersistenceManager> manager;
-	private readonly Lazy<ITestRenderer> renderer;
+	private readonly Lazy<TestRenderer> renderer;
 
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitPersistentComponentState"/> class.
@@ -27,7 +27,7 @@ internal BunitPersistentComponentState(IServiceProvider services)
 	{
 		store = new BunitPersistentComponentStateStore();
 		manager = new Lazy<ComponentStatePersistenceManager>(() => services.GetRequiredService<ComponentStatePersistenceManager>());
-		renderer = new Lazy<ITestRenderer>(() => services.GetRequiredService<TestContext>().Renderer);
+		renderer = new Lazy<TestRenderer>(() => services.GetRequiredService<TestContext>().Renderer);
 	}
 
 	/// <summary>

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`namespace Bunit.Diffing;`
`9`	`9`
`10`	`10`	`/// <summary>`
`11`		`-/// Represents a test HTML comparer, that is configured to work with markup generated by the <see cref="ITestRenderer"/> and <see cref="Htmlizer"/> classes.`
	`11`	`+/// Represents a test HTML comparer, that is configured to work with markup generated by the <see cref="TestRenderer"/> and <see cref="Htmlizer"/> classes.`
`12`	`12`	`/// </summary>`
`13`	`13`	`public sealed class HtmlComparer`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public static Task TriggerEventAsync(this IElement element, string eventName, Ev`
`63`	`63`	`ArgumentNullException.ThrowIfNull(eventName);`
`64`	`64`
`65`	`65`	`var renderer = element.GetTestContext()?.Renderer`
`66`		`- ?? throw new InvalidOperationException($"Blazor events can only be raised on elements rendered with the Blazor test renderer '{nameof(ITestRenderer)}'.");`
	`66`	`+ ?? throw new InvalidOperationException($"Blazor events can only be raised on elements rendered with the Blazor test renderer '{nameof(TestRenderer)}'.");`
`67`	`67`
`68`	`68`	`// TriggerEventsAsync will traverse the DOM tree to find`
`69`	`69`	`// all event handlers that needs to be triggered. This is done`
`@@ -78,7 +78,7 @@ public static Task TriggerEventAsync(this IElement element, string eventName, Ev`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`[SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "HTML events are standardize to lower case and safe in this context.")]`
`81`		`- private static Task TriggerEventsAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
	`81`	`+ private static Task TriggerEventsAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
`82`	`82`	`{`
`83`	`83`	`var isNonBubblingEvent = NonBubblingEvents.Contains(eventName.ToLowerInvariant());`
`84`	`84`	`var unwrappedElement = element.Unwrap();`
`@@ -88,7 +88,7 @@ private static Task TriggerEventsAsync(ITestRenderer renderer, IElement element,`
`88`	`88`	`: TriggerBubblingEventAsync(renderer, unwrappedElement, eventName, eventArgs);`
`89`	`89`	`}`
`90`	`90`
`91`		`- private static Task TriggerNonBubblingEventAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
	`91`	`+ private static Task TriggerNonBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
`92`	`92`	`{`
`93`	`93`	`var eventAttrName = Htmlizer.ToBlazorAttribute(eventName);`
`94`	`94`
`@@ -105,7 +105,7 @@ private static Task TriggerNonBubblingEventAsync(ITestRenderer renderer, IElemen`
`105`	`105`	`throw new MissingEventHandlerException(element, eventName);`
`106`	`106`	`}`
`107`	`107`
`108`		`- private static Task TriggerBubblingEventAsync(ITestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
	`108`	`+ private static Task TriggerBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)`
`109`	`109`	`{`
`110`	`110`	`var eventTasks = GetDispatchEventTasks(renderer, element, eventName, eventArgs);`
`111`	`111`
`@@ -118,7 +118,7 @@ private static Task TriggerBubblingEventAsync(ITestRenderer renderer, IElement e`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`private static List<Task> GetDispatchEventTasks(`
`121`		`- ITestRenderer renderer,`
	`121`	`+ TestRenderer renderer,`
`122`	`122`	`IElement element,`
`123`	`123`	`string eventName,`
`124`	`124`	`EventArgs eventArgs)`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public static void SetParametersAndRender<TComponent>(this IRenderedComponent<TC`
`28`	`28`	`{`
`29`	`29`	`ArgumentNullException.ThrowIfNull(renderedComponent);`
`30`	`30`
`31`		`- var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContext>().Renderer;`
	`31`	`+ var renderer = renderedComponent.Services.GetRequiredService<TestContext>().Renderer;`
`32`	`32`
`33`	`33`	`try`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`namespace Bunit.Rendering;`
`2`	`2`
`3`	`3`	`/// <summary>`
`4`		`-/// Represents an render event from a <see cref="ITestRenderer"/>.`
	`4`	`+/// Represents an render event from a <see cref="TestRenderer"/>.`
`5`	`5`	`/// </summary>`
`6`	`6`	`public sealed class RenderEvent`
`7`	`7`	`{`