refactor: fixed typos in code and documentation

egil · egil · commit 8a21a18e3546 · 2022-07-07T16:57:24.000Z
#closes #872 commit 3e4b1bb2f420edd43efceef497d125e41920e315 Author: Egil Hansen <egil@assimilated.dk> Date: Thu Jul 7 16:39:13 2022 +0000 spelling in JSRuntimeUnhandledInvocationExceptionTest commit 68bb875 Merge: cdfbce2 494c2fc Author: Egil Hansen <egil@assimilated.dk> Date: Thu Jul 7 16:35:46 2022 +0000 Merge branch 'main' into typos commit cdfbce2 Merge: 11fbab2 8cf4943 Author: Egil Hansen <egil@assimilated.dk> Date: Tue Jul 5 09:23:22 2022 +0000 Merge branch 'main' into typos commit 11fbab2 Author: Simon Cropp <simon.cropp@gmail.com> Date: Mon Jul 4 10:45:01 2022 +1000 . commit 87e1971 Author: Simon Cropp <simon.cropp@gmail.com> Date: Thu Jun 30 06:30:53 2022 +1000 Update ParameterException.cs commit 56e3c60 Merge: 799820b 41e3308 Author: Steven Giesel <stgiesel35@gmail.com> Date: Wed Jun 29 18:22:47 2022 +0200 Merge branch 'main' into typos commit 799820b Author: Simon Cropp <simon.cropp@gmail.com> Date: Wed Jun 29 19:40:30 2022 +1000 Update ParameterException.cs commit d52ee4e Author: Simon Cropp <simon.cropp@gmail.com> Date: Wed Jun 29 13:47:47 2022 +1000 typos
diff --git a/src/bunit.core/ComponentParameterCollection.cs b/src/bunit.core/ComponentParameterCollection.cs
@@ -213,13 +213,13 @@ public IEnumerator<ComponentParameter> GetEnumerator()
 	/// <inheritdoc/>
 	System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() => GetEnumerator();
 
-	private static object WrapTemplates(Type templateParamterType, ComponentParameter[] templateParameters)
+	private static object WrapTemplates(Type templateParameterType, ComponentParameter[] templateParameters)
 	{
 		// gets the generic argument to RenderFragment<>, e.g. string with RenderFragment<string>
-		var templateType = templateParamterType.GetGenericArguments()[0];
+		var templateType = templateParameterType.GetGenericArguments()[0];
 
 		// this creates an invokable version of CreateTemplateWrapper with the
-		// generic type set to tmeplateType, e.g. CreateTemplateWrapper<string>
+		// generic type set to templateType, e.g. CreateTemplateWrapper<string>
 		var templateWrapper = CreateTemplateWrapperMethod.MakeGenericMethod(templateType);
 
 		// BANG: since CreateTemplateWrapper<T> will never return null BANG (!) is safe here
diff --git a/src/bunit.core/Extensions/ComponentFactoryCollectionExtensions.cs b/src/bunit.core/Extensions/ComponentFactoryCollectionExtensions.cs
@@ -8,8 +8,8 @@ namespace Bunit;
 /// </summary>
 public static class ComponentFactoryCollectionExtensions
 {
-	/// <summary>	
-	/// Configures bUunit to substitute all components of type <typeparamref name="TComponent"/>
+	/// <summary>
+	/// Configures bUnit to substitute all components of type <typeparamref name="TComponent"/>
 	/// with components of type <typeparamref name="TSubstituteComponent"/>.
 	/// </summary>
 	/// <typeparam name="TComponent">Type of component to replace.</typeparam>
@@ -81,7 +81,7 @@ public static ComponentFactoryCollection Add<TComponent>(this ComponentFactoryCo
 	}
 
 	/// <summary>
-	/// Configures bUnit to substitute components whose type matches the <paramref name="condition"/>, 
+	/// Configures bUnit to substitute components whose type matches the <paramref name="condition"/>,
 	/// with components created by the provided component <paramref name="factory"/>.
 	/// </summary>
 	/// <remarks>
diff --git a/src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs b/src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs
@@ -111,7 +111,7 @@ private Task<T> CreateWaitTask(IRenderedFragmentBase renderedFragment, TimeSpan?
 
 		// Two to failure conditions, that the renderer captures an unhandled
 		// exception from a component or itself, or that the timeout is reached,
-		// are executed on the renderes schedular, to ensure that OnAfterRender
+		// are executed on the renderes scheduler, to ensure that OnAfterRender
 		// and the continuations does not happen at the same time.
 		var failureTask = renderer.Dispatcher.InvokeAsync(() =>
 		{
diff --git a/src/bunit.web/JSInterop/InvocationHandlers/Implementation/JSObjectReferenceInvocationHandler.cs b/src/bunit.web/JSInterop/InvocationHandlers/Implementation/JSObjectReferenceInvocationHandler.cs
@@ -1,6 +1,4 @@
 #if NET5_0_OR_GREATER
-using System.Diagnostics.CodeAnalysis;
-using Microsoft.JSInterop;
 
 namespace Bunit.JSInterop.InvocationHandlers.Implementation;
 
@@ -19,7 +17,7 @@ internal sealed class JSObjectReferenceInvocationHandler : JSRuntimeInvocationHa
 	/// <summary>
 	/// Initializes a new instance of the <see cref="JSObjectReferenceInvocationHandler"/> class.
 	/// </summary>
-	[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable ressources, it just implements the methods to be compatible with the interfaces it implements.")]
+	[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable resources, it just implements the methods to be compatible with the interfaces it implements.")]
 	public JSObjectReferenceInvocationHandler(BunitJSInterop parent, InvocationMatcher invocationMatcher, bool isCatchAllHandler)
 		: base(invocationMatcher, isCatchAllHandler)
 	{
diff --git a/src/bunit.web/JSInterop/InvocationHandlers/Implementation/LooseModeJSObjectReferenceInvocationHandler.cs b/src/bunit.web/JSInterop/InvocationHandlers/Implementation/LooseModeJSObjectReferenceInvocationHandler.cs
@@ -1,6 +1,4 @@
 #if NET5_0_OR_GREATER
-using System.Diagnostics.CodeAnalysis;
-using Microsoft.JSInterop;
 
 namespace Bunit.JSInterop.InvocationHandlers.Implementation;
 
@@ -10,7 +8,7 @@ namespace Bunit.JSInterop.InvocationHandlers.Implementation;
 /// </summary>
 internal sealed class LooseModeJSObjectReferenceInvocationHandler : JSRuntimeInvocationHandler<IJSObjectReference>
 {
-	[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable ressources, it just implements the methods to be compatible with the interfaces it implements.")]
+	[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable resources, it just implements the methods to be compatible with the interfaces it implements.")]
 	internal LooseModeJSObjectReferenceInvocationHandler(BunitJSInterop parent)
 		: base(_ => parent.Mode == JSRuntimeMode.Loose, isCatchAllHandler: true)
 	{
diff --git a/src/bunit.web/Rendering/RenderedComponent.cs b/src/bunit.web/Rendering/RenderedComponent.cs
@@ -30,7 +30,7 @@ internal RenderedComponent(int componentId, TComponent instance, RenderTreeFrame
 	protected override void OnRender(RenderEvent renderEvent)
 	{
 		// checks if this is the first render, and if it is
-		// tries to find the TCompoent in the render event
+		// tries to find the TComponent in the render event
 		if (instance is null)
 		{
 			SetComponentAndID(renderEvent);
diff --git a/tests/bunit.core.tests/Rendering/TestRendererTest.cs b/tests/bunit.core.tests/Rendering/TestRendererTest.cs
@@ -15,9 +15,9 @@ public TestRendererTest(ITestOutputHelper outputHelper)
 	public void Test004()
 	{
 		var sut = Services.GetRequiredService<ITestRenderer>();
-		RenderFragment thowingFragment = b => { b.OpenComponent<ThrowsDuringSetParams>(0); b.CloseComponent(); };
+		RenderFragment throwingFragment = b => { b.OpenComponent<ThrowsDuringSetParams>(0); b.CloseComponent(); };
 
-		Should.Throw<InvalidOperationException>(() => sut.RenderFragment(thowingFragment))
+		Should.Throw<InvalidOperationException>(() => sut.RenderFragment(throwingFragment))
 			.Message.ShouldBe(ThrowsDuringSetParams.EXCEPTION.Message);
 	}
 
diff --git a/tests/bunit.core.tests/TestDoubles/PersistentComponentState/FakePersistentComponentStateTest.cs b/tests/bunit.core.tests/TestDoubles/PersistentComponentState/FakePersistentComponentStateTest.cs
@@ -57,7 +57,7 @@ public void Test012()
 
 		fakeState.TriggerOnPersisting();
 
-		fakeState.TryTake<WeatherForecast[]>(PersistentComponentStateSample.PersistanceKey, out var actual).ShouldBeTrue();
+		fakeState.TryTake<WeatherForecast[]>(PersistentComponentStateSample.PersistenceKey, out var actual).ShouldBeTrue();
 		actual.ShouldBeEquivalentTo(cut.Instance.Forecasts);
 	}
 
diff --git a/tests/bunit.testassets/SampleComponents/EventBubbles.cs b/tests/bunit.testassets/SampleComponents/EventBubbles.cs
@@ -7,9 +7,9 @@ public class EventBubbles : ComponentBase
 	[Parameter] public string ChildElementType { get; set; } = "div";
 	[Parameter] public bool ChildElementDisabled { get; set; }
 	[Parameter] public string? EventName { get; set; }
-	[Parameter] public bool GrandParentStopPropergation { get; set; }
-	[Parameter] public bool ParentStopPropergation { get; set; }
-	[Parameter] public bool ChildStopPropergation { get; set; }
+	[Parameter] public bool GrandParentStopPropagation { get; set; }
+	[Parameter] public bool ParentStopPropagation { get; set; }
+	[Parameter] public bool ChildStopPropagation { get; set; }
 	public int GrandParentTriggerCount { get; private set; }
 	public int ParentTriggerCount { get; private set; }
 	public int ChildTriggerCount { get; private set; }
@@ -22,18 +22,18 @@ protected override void BuildRenderTree(RenderTreeBuilder builder)
 		builder.OpenElement(0, "div");
 		builder.AddAttribute(1, EventName, EventCallback.Factory.Create<EventArgs>(this, (_) => GrandParentTriggerCount++));
 		builder.AddAttribute(2, "id", "grand-parent");
-		builder.AddEventStopPropagationAttribute(3, EventName, GrandParentStopPropergation);
+		builder.AddEventStopPropagationAttribute(3, EventName, GrandParentStopPropagation);
 
 		builder.OpenElement(10, "div");
 		builder.AddAttribute(11, EventName, EventCallback.Factory.Create<EventArgs>(this, (_) => ParentTriggerCount++));
 		builder.AddAttribute(12, "id", "parent");
-		builder.AddEventStopPropagationAttribute(13, EventName, ParentStopPropergation);
+		builder.AddEventStopPropagationAttribute(13, EventName, ParentStopPropagation);
 
 		builder.OpenElement(20, ChildElementType);
 
 		builder.AddAttribute(21, EventName, EventCallback.Factory.Create<EventArgs>(this, (_) => ChildTriggerCount++));
 		builder.AddAttribute(22, "id", "child");
-		builder.AddEventStopPropagationAttribute(23, EventName, ChildStopPropergation);
+		builder.AddEventStopPropagationAttribute(23, EventName, ChildStopPropagation);
 		if (ChildElementDisabled)
 		{
 			builder.AddAttribute(24, "disabled", "disabled");
diff --git a/tests/bunit.testassets/SampleComponents/PersistentComponentStateSample.razor.cs b/tests/bunit.testassets/SampleComponents/PersistentComponentStateSample.razor.cs
@@ -2,7 +2,7 @@ namespace Bunit.TestAssets.SampleComponents
 {
 	public partial class PersistentComponentStateSample
 	{
-		public const string PersistanceKey = "fetchdata";
+		public const string PersistenceKey = "fetchdata";
 
 		public WeatherForecast[] Forecasts { get; private set; }
 
@@ -12,7 +12,7 @@ public partial class PersistentComponentStateSample
 		protected override void OnInitialized()
 		{
 			State.RegisterOnPersisting(PersistForecasts);
-			if (!State.TryTakeFromJson<WeatherForecast[]>(PersistanceKey, out var data))
+			if (!State.TryTakeFromJson<WeatherForecast[]>(PersistenceKey, out var data))
 			{
 				Forecasts = CreateForecasts();
 			}
@@ -24,7 +24,7 @@ protected override void OnInitialized()
 
 		private Task PersistForecasts()
 		{
-			State.PersistAsJson(PersistanceKey, Forecasts);
+			State.PersistAsJson(PersistenceKey, Forecasts);
 			return Task.CompletedTask;
 		}
 
diff --git a/tests/bunit.web.tests/Asserting/CompareToDiffingExtensionsTest.cs b/tests/bunit.web.tests/Asserting/CompareToDiffingExtensionsTest.cs
@@ -1,4 +1,4 @@
-using Bunit.TestUtililities;
+using Bunit.TestUtilities;
 
 namespace Bunit;
 
diff --git a/tests/bunit.web.tests/EventDispatchExtensions/GeneralEventDispatchExtensionsTest.cs b/tests/bunit.web.tests/EventDispatchExtensions/GeneralEventDispatchExtensionsTest.cs
@@ -114,7 +114,7 @@ public async Task Test111()
 	{
 		var cut = RenderComponent<EventBubbles>(ps => ps
 			.Add(p => p.EventName, "onclick")
-			.Add(p => p.ChildStopPropergation, true));
+			.Add(p => p.ChildStopPropagation, true));
 
 		await cut.Find("#child").TriggerEventAsync("onclick", EventArgs.Empty);
 
@@ -128,7 +128,7 @@ public async Task Test112()
 	{
 		var cut = RenderComponent<EventBubbles>(ps => ps
 			.Add(p => p.EventName, "onclick")
-			.Add(p => p.ParentStopPropergation, true));
+			.Add(p => p.ParentStopPropagation, true));
 
 		await cut.Find("#child").TriggerEventAsync("onclick", EventArgs.Empty);
 
diff --git a/tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.cs b/tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.cs
diff --git a/tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.net5.cs b/tests/bunit.web.tests/JSInterop/JSRuntimeUnhandledInvocationExceptionTest.net5.cs
diff --git a/tests/bunit.web.tests/TestContextTest.cs b/tests/bunit.web.tests/TestContextTest.cs
diff --git a/tests/bunit.web.tests/TestDoubles/NavigationManager/FakeNavigationManagerTest.cs b/tests/bunit.web.tests/TestDoubles/NavigationManager/FakeNavigationManagerTest.cs
diff --git a/tests/bunit.web.tests/TestUtilities/JSRuntimeInvocationAssertionHelpers.cs b/tests/bunit.web.tests/TestUtilities/JSRuntimeInvocationAssertionHelpers.cs
diff --git a/tests/bunit.web.tests/TestUtilities/MockingHelpers.cs b/tests/bunit.web.tests/TestUtilities/MockingHelpers.cs

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ private Task<T> CreateWaitTask(IRenderedFragmentBase renderedFragment, TimeSpan?`
`111`	`111`
`112`	`112`	`// Two to failure conditions, that the renderer captures an unhandled`
`113`	`113`	`// exception from a component or itself, or that the timeout is reached,`
`114`		`- // are executed on the renderes schedular, to ensure that OnAfterRender`
	`114`	`+ // are executed on the renderes scheduler, to ensure that OnAfterRender`
`115`	`115`	`// and the continuations does not happen at the same time.`
`116`	`116`	`var failureTask = renderer.Dispatcher.InvokeAsync(() =>`
`117`	`117`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,4 @@`
`1`	`1`	`#if NET5_0_OR_GREATER`
`2`		`-using System.Diagnostics.CodeAnalysis;`
`3`		`-using Microsoft.JSInterop;`
`4`	`2`
`5`	`3`	`namespace Bunit.JSInterop.InvocationHandlers.Implementation;`
`6`	`4`
`@@ -10,7 +8,7 @@ namespace Bunit.JSInterop.InvocationHandlers.Implementation;`
`10`	`8`	`/// </summary>`
`11`	`9`	`internal sealed class LooseModeJSObjectReferenceInvocationHandler : JSRuntimeInvocationHandler<IJSObjectReference>`
`12`	`10`	`{`
`13`		`- [SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable ressources, it just implements the methods to be compatible with the interfaces it implements.")]`
	`11`	`+ [SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "BunitJSObjectReference doesn't have any disposable resources, it just implements the methods to be compatible with the interfaces it implements.")]`
`14`	`12`	`internal LooseModeJSObjectReferenceInvocationHandler(BunitJSInterop parent)`
`15`	`13`	`: base(_ => parent.Mode == JSRuntimeMode.Loose, isCatchAllHandler: true)`
`16`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ internal RenderedComponent(int componentId, TComponent instance, RenderTreeFrame`
`30`	`30`	`protected override void OnRender(RenderEvent renderEvent)`
`31`	`31`	`{`
`32`	`32`	`// checks if this is the first render, and if it is`
`33`		`- // tries to find the TCompoent in the render event`
	`33`	`+ // tries to find the TComponent in the render event`
`34`	`34`	`if (instance is null)`
`35`	`35`	`{`
`36`	`36`	`SetComponentAndID(renderEvent);`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,9 @@ public TestRendererTest(ITestOutputHelper outputHelper)`
`15`	`15`	`public void Test004()`
`16`	`16`	`{`
`17`	`17`	`var sut = Services.GetRequiredService<ITestRenderer>();`
`18`		`- RenderFragment thowingFragment = b => { b.OpenComponent<ThrowsDuringSetParams>(0); b.CloseComponent(); };`
	`18`	`+ RenderFragment throwingFragment = b => { b.OpenComponent<ThrowsDuringSetParams>(0); b.CloseComponent(); };`
`19`	`19`
`20`		`- Should.Throw<InvalidOperationException>(() => sut.RenderFragment(thowingFragment))`
	`20`	`+ Should.Throw<InvalidOperationException>(() => sut.RenderFragment(throwingFragment))`
`21`	`21`	`.Message.ShouldBe(ThrowsDuringSetParams.EXCEPTION.Message);`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public void Test012()`
`57`	`57`
`58`	`58`	`fakeState.TriggerOnPersisting();`
`59`	`59`
`60`		`- fakeState.TryTake<WeatherForecast[]>(PersistentComponentStateSample.PersistanceKey, out var actual).ShouldBeTrue();`
	`60`	`+ fakeState.TryTake<WeatherForecast[]>(PersistentComponentStateSample.PersistenceKey, out var actual).ShouldBeTrue();`
`61`	`61`	`actual.ShouldBeEquivalentTo(cut.Instance.Forecasts);`
`62`	`62`	`}`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace Bunit.TestAssets.SampleComponents`
`2`	`2`	`{`
`3`	`3`	`public partial class PersistentComponentStateSample`
`4`	`4`	`{`
`5`		`- public const string PersistanceKey = "fetchdata";`
	`5`	`+ public const string PersistenceKey = "fetchdata";`
`6`	`6`
`7`	`7`	`public WeatherForecast[] Forecasts { get; private set; }`
`8`	`8`
`@@ -12,7 +12,7 @@ public partial class PersistentComponentStateSample`
`12`	`12`	`protected override void OnInitialized()`
`13`	`13`	`{`
`14`	`14`	`State.RegisterOnPersisting(PersistForecasts);`
`15`		`- if (!State.TryTakeFromJson<WeatherForecast[]>(PersistanceKey, out var data))`
	`15`	`+ if (!State.TryTakeFromJson<WeatherForecast[]>(PersistenceKey, out var data))`
`16`	`16`	`{`
`17`	`17`	`Forecasts = CreateForecasts();`
`18`	`18`	`}`
`@@ -24,7 +24,7 @@ protected override void OnInitialized()`
`24`	`24`
`25`	`25`	`private Task PersistForecasts()`
`26`	`26`	`{`
`27`		`- State.PersistAsJson(PersistanceKey, Forecasts);`
	`27`	`+ State.PersistAsJson(PersistenceKey, Forecasts);`
`28`	`28`	`return Task.CompletedTask;`
`29`	`29`	`}`
`30`	`30`