refactor: Renamed TestRenderer to BunitRenderer

Author: linkdotnet

src/bunit/Asserting/MarkupMatchesAssertExtensions.cs

@@ -274,7 +274,7 @@ public static void MarkupMatches(this RenderedFragment actual, RenderFragment ex
 
 		// TODO: This will be obsolete with: https://github.com/bUnit-dev/bUnit/issues/1018
 		// As the renderer would be transient we don't have to new up an instance
-		using var renderer = new TestRenderer(
+		using var renderer = new BunitRenderer(
 			actual.Services.GetRequiredService<IRenderedComponentActivator>(),
 			actual.Services.GetRequiredService<TestServiceProvider>(),
 			actual.Services.GetRequiredService<ILoggerFactory>());

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="TestRenderer"/> and <see cref="Htmlizer"/> classes.
+/// Represents a test HTML comparer, that is configured to work with markup generated by the <see cref="BunitRenderer"/> and <see cref="Htmlizer"/> classes.
 /// </summary>
 public sealed class HtmlComparer
 {

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(TestRenderer)}'.");
+			?? throw new InvalidOperationException($"Blazor events can only be raised on elements rendered with the Blazor test renderer '{nameof(BunitRenderer)}'.");
 
 		// 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(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerEventsAsync(BunitRenderer 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(TestRenderer renderer, IElement element,
 			: TriggerBubblingEventAsync(renderer, unwrappedElement, eventName, eventArgs);
 	}
 
-	private static Task TriggerNonBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerNonBubblingEventAsync(BunitRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
 	{
 		var eventAttrName = Htmlizer.ToBlazorAttribute(eventName);
 
@@ -105,7 +105,7 @@ private static Task TriggerNonBubblingEventAsync(TestRenderer renderer, IElement
 		throw new MissingEventHandlerException(element, eventName);
 	}
 
-	private static Task TriggerBubblingEventAsync(TestRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
+	private static Task TriggerBubblingEventAsync(BunitRenderer renderer, IElement element, string eventName, EventArgs eventArgs)
 	{
 		var eventTasks = GetDispatchEventTasks(renderer, element, eventName, eventArgs);
 
@@ -118,7 +118,7 @@ private static Task TriggerBubblingEventAsync(TestRenderer renderer, IElement el
 	}
 
 	private static List<Task> GetDispatchEventTasks(
-		TestRenderer renderer,
+		BunitRenderer renderer,
 		IElement element,
 		string eventName,
 		EventArgs eventArgs)

src/bunit/Extensions/TestRendererExtensions.cs renamed to src/bunit/Extensions/BunitRendererExtensions.cs

@@ -3,10 +3,10 @@
 namespace Bunit.Extensions;
 
 /// <summary>
-/// Helper methods that make it easier to work directly with a <see cref="TestRenderer"/>
+/// Helper methods that make it easier to work directly with a <see cref="BunitRenderer"/>
 /// in bUnit web.
 /// </summary>
-public static class TestRendererExtensions
+public static class BunitRendererExtensions
 {
 	/// <summary>
 	/// Renders a <typeparamref name="TComponent"/> with the parameters <paramref name="parameters"/> passed to it.
@@ -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="RenderedComponent{TComponent}"/> that provides access to the rendered component.</returns>
-	public static RenderedComponent<TComponent> RenderComponent<TComponent>(this TestRenderer renderer, params ComponentParameter[] parameters)
+	public static RenderedComponent<TComponent> RenderComponent<TComponent>(this BunitRenderer renderer, params ComponentParameter[] parameters)
 		where TComponent : IComponent
 	{
 		ArgumentNullException.ThrowIfNull(renderer);
@@ -34,7 +34,7 @@ public static RenderedComponent<TComponent> RenderComponent<TComponent>(this Tes
 	/// <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="RenderedComponent{TComponent}"/> that provides access to the rendered component.</returns>
-	public static RenderedComponent<TComponent> RenderComponent<TComponent>(this TestRenderer renderer, Action<ComponentParameterCollectionBuilder<TComponent>> parameterBuilder)
+	public static RenderedComponent<TComponent> RenderComponent<TComponent>(this BunitRenderer renderer, Action<ComponentParameterCollectionBuilder<TComponent>> parameterBuilder)
 		where TComponent : IComponent
 	{
 		ArgumentNullException.ThrowIfNull(renderer);

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="TestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="BunitRenderer"/>.
 	/// </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 RenderedFragment renderedFragment, Action wo
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="BunitRenderer"/>.
 	/// </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 RenderedFragment renderedFragment, Func<Task
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="BunitRenderer"/>.
 	/// </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 RenderedFragment renderedFragment, Fun
 	}
 
 	/// <summary>
-	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="TestRenderer"/>.
+	/// Invokes the given <paramref name="workItem"/> in the context of the associated <see cref="BunitRenderer"/>.
 	/// </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>

src/bunit/Extensions/WaitForHelpers/WaitForHelper.cs

@@ -15,7 +15,7 @@ public abstract class WaitForHelper<T> : IDisposable
 	private readonly Func<(bool CheckPassed, T Content)> completeChecker;
 	private readonly RenderedFragment renderedFragment;
 	private readonly ILogger<WaitForHelper<T>> logger;
-	private readonly TestRenderer renderer;
+	private readonly BunitRenderer renderer;
 	private bool isDisposed;
 	private int checkCount;
 	private Exception? capturedException;

src/bunit/Rendering/BunitHtmlParser.cs

@@ -25,7 +25,7 @@ public sealed class BunitHtmlParser : IDisposable
 
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitHtmlParser"/> class
-	/// with a AngleSharp context without a <see cref="TestRenderer"/> registered.
+	/// with a AngleSharp context without a <see cref="BunitRenderer"/> registered.
 	/// </summary>
 	public BunitHtmlParser()
 		: this(Configuration.Default.WithCss().With(new HtmlComparer())) { }

src/bunit/Rendering/TestRenderer.cs renamed to src/bunit/Rendering/BunitRenderer.cs

@@ -6,20 +6,20 @@
 namespace Bunit.Rendering;
 
 /// <summary>
-/// Represents a bUnit <see cref="TestRenderer"/> used to render Blazor components and fragments during bUnit tests.
+/// Represents a bUnit <see cref="BunitRenderer"/> used to render Blazor components and fragments during bUnit tests.
 /// </summary>
-public sealed class TestRenderer : Renderer
+public sealed class BunitRenderer : Renderer
 {
 	[UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_isBatchInProgress")]
-	extern static ref bool GetIsBatchInProgressField(Renderer renderer);
+	private static extern ref bool GetIsBatchInProgressField(Renderer renderer);
 
 	[UnsafeAccessor(UnsafeAccessorKind.Method, Name = "SetDirectParameters")]
-	extern static void CallSetDirectParameters(ComponentState componentState, ParameterView parameters);
+	private static extern void CallSetDirectParameters(ComponentState componentState, ParameterView parameters);
 
 	private readonly object renderTreeUpdateLock = new();
 	private readonly Dictionary<int, RenderedFragment> renderedComponents = new();
 	private readonly List<RootComponent> rootComponents = new();
-	private readonly ILogger<TestRenderer> logger;
+	private readonly ILogger<BunitRenderer> logger;
 	private readonly IRenderedComponentActivator activator;
 	private bool disposed;
 	private TaskCompletionSource<Exception> unhandledExceptionTsc = new(TaskCreationOptions.RunContinuationsAsynchronously);
@@ -39,7 +39,10 @@ private bool IsBatchInProgress
 		}
 	}
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Gets a <see cref="Task{Exception}"/>, which completes when an unhandled exception
+	/// is thrown during the rendering of a component, that is caught by the renderer.
+	/// </summary>
 	public Task<Exception> UnhandledException => unhandledExceptionTsc.Task;
 
 	/// <inheritdoc/>
@@ -51,32 +54,41 @@ private bool IsBatchInProgress
 	internal int RenderCount { get; private set; }
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="TestRenderer"/> class.
+	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public TestRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory)
+	public BunitRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory)
 		: base(services, loggerFactory, new BunitComponentActivator(services.GetRequiredService<ComponentFactoryCollection>(), null))
 	{
-		logger = loggerFactory.CreateLogger<TestRenderer>();
+		logger = loggerFactory.CreateLogger<BunitRenderer>();
 		activator = renderedComponentActivator;
 		ElementReferenceContext = new WebElementReferenceContext(services.GetRequiredService<IJSRuntime>());
 	}
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="TestRenderer"/> class.
+	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public TestRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
+	public BunitRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
 		: base(services, loggerFactory, new BunitComponentActivator(services.GetRequiredService<ComponentFactoryCollection>(), componentActivator))
 	{
-		logger = loggerFactory.CreateLogger<TestRenderer>();
+		logger = loggerFactory.CreateLogger<BunitRenderer>();
 		activator = renderedComponentActivator;
 		ElementReferenceContext = new WebElementReferenceContext(services.GetRequiredService<IJSRuntime>());
 	}
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Renders the <paramref name="renderFragment"/>.
+	/// </summary>
+	/// <param name="renderFragment">The <see cref="Microsoft.AspNetCore.Components.RenderFragment"/> to render.</param>
+	/// <returns>A <see cref="RenderedFragment"/> that provides access to the rendered <paramref name="renderFragment"/>.</returns>
 	public RenderedFragment RenderFragment(RenderFragment renderFragment)
 		=> Render(renderFragment, id => activator.CreateRenderedFragment(id));
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Renders a <typeparamref name="TComponent"/> with the <paramref name="parameters"/> passed to it.
+	/// </summary>
+	/// <typeparam name="TComponent">The type of component to render.</typeparam>
+	/// <param name="parameters">The parameters to pass to the component.</param>
+	/// <returns>A <see cref="RenderedComponent{TComponent}"/> that provides access to the rendered component.</returns>
 	public RenderedComponent<TComponent> RenderComponent<TComponent>(ComponentParameterCollection parameters)
 		where TComponent : IComponent
 	{
@@ -86,14 +98,26 @@ public RenderedComponent<TComponent> RenderComponent<TComponent>(ComponentParame
 		return Render(renderFragment, id => activator.CreateRenderedComponent<TComponent>(id));
 	}
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Notifies the renderer that an event has occurred.
+	/// </summary>
+	/// <param name="eventHandlerId">The <see cref="RenderTreeFrame.AttributeEventHandlerId"/> value from the original event attribute.</param>
+	/// <param name="fieldInfo">Information that the renderer can use to update the state of the existing render tree to match the UI.</param>
+	/// <param name="eventArgs">Arguments to be passed to the event handler.</param>
+	/// <returns>A <see cref="Task"/> which will complete once all asynchronous processing related to the event has completed.</returns>
 	public new Task DispatchEventAsync(
 		ulong eventHandlerId,
 		EventFieldInfo fieldInfo,
 		EventArgs eventArgs) => DispatchEventAsync(eventHandlerId, fieldInfo, eventArgs, ignoreUnknownEventHandlers: false);
 
-	/// <exception cref="ObjectDisposedException"></exception>
-	/// <inheritdoc/>
+	/// <summary>
+	/// Notifies the renderer that an event has occurred.
+	/// </summary>
+	/// <param name="eventHandlerId">The <see cref="RenderTreeFrame.AttributeEventHandlerId"/> value from the original event attribute.</param>
+	/// <param name="fieldInfo">Information that the renderer can use to update the state of the existing render tree to match the UI.</param>
+	/// <param name="eventArgs">Arguments to be passed to the event handler.</param>
+	/// <param name="ignoreUnknownEventHandlers">Set to true to ignore the <see cref="UnknownEventHandlerIdException"/>.</param>
+	/// <returns>A <see cref="Task"/> which will complete once all asynchronous processing related to the event has completed.</returns>
 	public new Task DispatchEventAsync(
 		ulong eventHandlerId,
 		EventFieldInfo fieldInfo,
@@ -142,7 +166,11 @@ public RenderedComponent<TComponent> RenderComponent<TComponent>(ComponentParame
 		}
 	}
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Performs a depth-first search for the first <typeparamref name="TComponent"/> child component of the <paramref name="parentComponent"/>.
+	/// </summary>
+	/// <typeparam name="TComponent">Type of component to find.</typeparam>
+	/// <param name="parentComponent">Parent component to search.</param>
 	public RenderedComponent<TComponent> FindComponent<TComponent>(RenderedFragment parentComponent)
 		where TComponent : IComponent
 	{
@@ -152,12 +180,18 @@ public RenderedComponent<TComponent> FindComponent<TComponent>(RenderedFragment
 			: throw new ComponentNotFoundException(typeof(TComponent));
 	}
 
-	/// <inheritdoc/>
+	/// <summary>
+	/// Performs a depth-first search for all <typeparamref name="TComponent"/> child components of the <paramref name="parentComponent"/>.
+	/// </summary>
+	/// <typeparam name="TComponent">Type of components to find.</typeparam>
+	/// <param name="parentComponent">Parent component to search.</param>
 	public IReadOnlyList<RenderedComponent<TComponent>> FindComponents<TComponent>(RenderedFragment parentComponent)
 		where TComponent : IComponent
 		=> FindComponents<TComponent>(parentComponent, int.MaxValue);
 
-	/// <inheritdoc />
+	/// <summary>
+	/// Disposes all components rendered by the <see cref="BunitRenderer" />.
+	/// </summary>
 	public void DisposeComponents()
 	{
 		ObjectDisposedException.ThrowIf(disposed, this);
@@ -225,7 +259,7 @@ internal Task SetDirectParametersAsync(RenderedFragment renderedComponent, Param
 
 		return result;
 
-		static void SetDirectParametersViaComponentState(TestRenderer renderer, int componentId, in ParameterView parameters)
+		static void SetDirectParametersViaComponentState(BunitRenderer renderer, int componentId, in ParameterView parameters)
 		{
 			var componentState = renderer.GetComponentState(componentId);
 			CallSetDirectParameters(componentState, parameters);
@@ -534,8 +568,10 @@ private ArrayRange<RenderTreeFrame> GetOrLoadRenderTreeFrame(RenderTreeFrameDict
 	}
 
 	/// <inheritdoc/>
-	protected override void HandleException([NotNull] Exception exception)
+	protected override void HandleException(Exception exception)
 	{
+		ArgumentNullException.ThrowIfNull(exception);
+
 		if (disposed)
 			return;