refactor: moved stub<t> back to bunit.web, removed bunit.web.mock

Author: egil

CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+This release reintroduces `Stub<TComponent>` and related back into the main library, so the "preview" library `bunit.web.mock` is already obsolete. 
+
 ### Added
 
 - Add `ComponentFactories` extensions method that makes it easy to register an instance of a replacement component. By [@egil](https://github.com/egil).

bunit.sln

@@ -59,10 +59,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".workflows", ".workflows",
 		.github\workflows\verification.yml = .github\workflows\verification.yml
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "bunit.web.mock", "src\bunit.web.mock\bunit.web.mock.csproj", "{3B51665F-E515-498A-8A82-BDB623089F9D}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "bunit.web.mock.tests", "tests\bunit.web.mock.tests\bunit.web.mock.tests.csproj", "{050E57C2-C28F-4A9A-B35F-5725068AEF80}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -101,14 +97,6 @@ Global
 		{4CAB561E-0AFF-4516-AB9B-981F94EF1E86}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{4CAB561E-0AFF-4516-AB9B-981F94EF1E86}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{4CAB561E-0AFF-4516-AB9B-981F94EF1E86}.Release|Any CPU.Build.0 = Release|Any CPU
-		{3B51665F-E515-498A-8A82-BDB623089F9D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{3B51665F-E515-498A-8A82-BDB623089F9D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{3B51665F-E515-498A-8A82-BDB623089F9D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{3B51665F-E515-498A-8A82-BDB623089F9D}.Release|Any CPU.Build.0 = Release|Any CPU
-		{050E57C2-C28F-4A9A-B35F-5725068AEF80}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{050E57C2-C28F-4A9A-B35F-5725068AEF80}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{050E57C2-C28F-4A9A-B35F-5725068AEF80}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{050E57C2-C28F-4A9A-B35F-5725068AEF80}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -123,8 +111,6 @@ Global
 		{7972A80F-30DC-4EF4-9294-7D4DD2965882} = {6EA09ED4-B714-4E6F-B0E1-4D987F8AE520}
 		{F61B8A55-3B5B-45FB-8E38-DBF9296B35C7} = {9A2B3B34-D41C-43E8-BC7D-246BEBE48D59}
 		{4CAB561E-0AFF-4516-AB9B-981F94EF1E86} = {6EA09ED4-B714-4E6F-B0E1-4D987F8AE520}
-		{3B51665F-E515-498A-8A82-BDB623089F9D} = {9A2B3B34-D41C-43E8-BC7D-246BEBE48D59}
-		{050E57C2-C28F-4A9A-B35F-5725068AEF80} = {6EA09ED4-B714-4E6F-B0E1-4D987F8AE520}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {24106918-1C86-4769-BDA6-9C80E64CD260}

src/bunit.web.mock/TestDoubles/Components/Stub{TComponent}.cs

@@ -8,12 +8,12 @@ internal sealed class StubComponentFactory : IComponentFactory
 	private static readonly Type StubType = typeof(Stub<>);
 
 	private readonly Predicate<Type> componentTypePredicate;
-	private readonly RenderFragment<IReadOnlyDictionary<string, object>>? replacementTemplate;
+	private readonly object? replacementContent;
 
-	public StubComponentFactory(Predicate<Type> componentTypePredicate, RenderFragment<IReadOnlyDictionary<string, object>>? replacementTemplate = null)
+	public StubComponentFactory(Predicate<Type> componentTypePredicate, object? replacementContent)
 	{
 		this.componentTypePredicate = componentTypePredicate;
-		this.replacementTemplate = replacementTemplate;
+		this.replacementContent = replacementContent;
 	}
 
 	public bool CanCreate(Type componentType)
@@ -22,7 +22,9 @@ public bool CanCreate(Type componentType)
 	public IComponent Create(Type componentType)
 	{
 		var typeToCreate = StubType.MakeGenericType(componentType);
-		return (IComponent)Activator.CreateInstance(typeToCreate, new object?[] { replacementTemplate })!;
+		return replacementContent is not null
+			? (IComponent)Activator.CreateInstance(typeToCreate, new object?[] { replacementContent })!
+			: (IComponent)Activator.CreateInstance(typeToCreate, Array.Empty<object?>())!;
 	}
 }
 #endif

src/bunit.web.mock/bunit.web.mock.csproj

@@ -1,3 +1,4 @@
+#if NET5_0_OR_GREATER
 using Bunit.ComponentFactories;
 using Bunit.TestDoubles;
 
@@ -6,10 +7,8 @@ namespace Bunit;
 /// <summary>
 /// Extension methods for using component doubles.
 /// </summary>
-public static class ComponentFactoryCollectionExtensions
+public static class StubComponentFactoryCollectionExtensions
 {
-	private static readonly RenderFragment<IReadOnlyDictionary<string, object>> NoopReplacementTemplate = _ => _ => { };
-
 	/// <summary>
 	/// Configures bUnit to use replace all components of type <typeparamref name="TComponent"/> (including derived components)
 	/// with a <see cref="Stub{TComponent}"/> component in the render tree.
@@ -19,7 +18,17 @@ public static class ComponentFactoryCollectionExtensions
 	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
 	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
 	public static ComponentFactoryCollection AddStub<TComponent>(this ComponentFactoryCollection factories) where TComponent : IComponent
-		=> AddStub<TComponent>(factories, NoopReplacementTemplate);
+	{
+		if (factories is null)
+			throw new ArgumentNullException(nameof(factories));
+
+		factories.Add(new StubComponentFactory(CreatePredicate(typeof(TComponent)), null));
+
+		return factories;
+
+		static Predicate<Type> CreatePredicate(Type componentTypeToStub)
+			=> componentType => componentType == componentTypeToStub || componentType.IsAssignableTo(componentTypeToStub);
+	}
 
 	/// <summary>
 	/// Configures bUnit to use replace all components of type <typeparamref name="TComponent"/> (including derived components)
@@ -28,16 +37,48 @@ public static ComponentFactoryCollection AddStub<TComponent>(this ComponentFacto
 	/// <remarks>NOTE: This will replace any component of type <typeparamref name="TComponent"/> or components that derives/inherits from it.</remarks>
 	/// <typeparam name="TComponent">The type of component to replace with a <see cref="Stub{TComponent}"/> component.</typeparam>
 	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
-	/// <param name="replacementTemplate">Optional replacement template that will be used to render output instead of the stubbed out component.</param>
+	/// <param name="replacementMarkup">Markup that will be used as render output instead of the stubbed out component.</param>
+	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
+	public static ComponentFactoryCollection AddStub<TComponent>(this ComponentFactoryCollection factories, string replacementMarkup) where TComponent : IComponent
+		=> AddStub<TComponent>(factories, (RenderTreeBuilder b) => b.AddMarkupContent(0, replacementMarkup));
+
+	/// <summary>
+	/// Configures bUnit to use replace all components of type <typeparamref name="TComponent"/> (including derived components)
+	/// with a <see cref="Stub{TComponent}"/> component in the render tree.
+	/// </summary>
+	/// <remarks>NOTE: This will replace any component of type <typeparamref name="TComponent"/> or components that derives/inherits from it.</remarks>
+	/// <typeparam name="TComponent">The type of component to replace with a <see cref="Stub{TComponent}"/> component.</typeparam>
+	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
+	/// <param name="replacementFragment">Replacement render fragment that will be used as render output instead of the stubbed out component.</param>
+	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
+	public static ComponentFactoryCollection AddStub<TComponent>(this ComponentFactoryCollection factories, RenderFragment replacementFragment) where TComponent : IComponent
+	{
+		if (factories is null)
+			throw new ArgumentNullException(nameof(factories));
+
+		factories.Add(new StubComponentFactory(CreatePredicate(typeof(TComponent)), replacementFragment));
+
+		return factories;
+
+		static Predicate<Type> CreatePredicate(Type componentTypeToStub)
+			=> componentType => componentType == componentTypeToStub || componentType.IsAssignableTo(componentTypeToStub);
+	}
+
+	/// <summary>
+	/// Configures bUnit to use replace all components of type <typeparamref name="TComponent"/> (including derived components)
+	/// with a <see cref="Stub{TComponent}"/> component in the render tree.
+	/// </summary>
+	/// <remarks>NOTE: This will replace any component of type <typeparamref name="TComponent"/> or components that derives/inherits from it.</remarks>
+	/// <typeparam name="TComponent">The type of component to replace with a <see cref="Stub{TComponent}"/> component.</typeparam>
+	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
+	/// <param name="replacementTemplate">Replacement template that will be used to render output instead of the stubbed out component.</param>
 	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
 	public static ComponentFactoryCollection AddStub<TComponent>(
 		this ComponentFactoryCollection factories,
-		Func<IReadOnlyDictionary<string, object>, string> replacementTemplate)
+		Func<CapturedParameterView<TComponent>, string> replacementTemplate)
 		where TComponent : IComponent
 	{
-		return AddStub<TComponent>(
-			factories,
-			ps => b => b.AddMarkupContent(0, replacementTemplate(ps)));
+		return AddStub<TComponent>(factories, ps => b => b.AddMarkupContent(0, replacementTemplate(ps)));
 	}
 
 	/// <summary>
@@ -47,14 +88,21 @@ public static ComponentFactoryCollection AddStub<TComponent>(
 	/// <remarks>NOTE: This will replace any component of type <typeparamref name="TComponent"/> or components that derives/inherits from it.</remarks>
 	/// <typeparam name="TComponent">The type of component to replace with a <see cref="Stub{TComponent}"/> component.</typeparam>
 	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
-	/// <param name="replacementTemplate">Optional replacement template that will be used to render output instead of the stubbed out component.</param>
+	/// <param name="replacementTemplate">Replacement template that will be used to render output instead of the stubbed out component.</param>
 	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
 	public static ComponentFactoryCollection AddStub<TComponent>(
 		this ComponentFactoryCollection factories,
-		RenderFragment<IReadOnlyDictionary<string, object>> replacementTemplate)
+		RenderFragment<CapturedParameterView<TComponent>> replacementTemplate)
 		where TComponent : IComponent
 	{
-		return AddStub(factories, CreatePredicate(typeof(TComponent)), replacementTemplate);
+		if (factories is null)
+			throw new ArgumentNullException(nameof(factories));
+		if (replacementTemplate is null)
+			throw new ArgumentNullException(nameof(replacementTemplate));
+
+		factories.Add(new StubComponentFactory(CreatePredicate(typeof(TComponent)), replacementTemplate));
+
+		return factories;
 
 		static Predicate<Type> CreatePredicate(Type componentTypeToStub)
 			=> componentType => componentType == componentTypeToStub || componentType.IsAssignableTo(componentTypeToStub);
@@ -73,44 +121,45 @@ public static ComponentFactoryCollection AddStub(
 		=> AddStub(
 			factories,
 			componentTypePredicate,
-			NoopReplacementTemplate);
+			string.Empty);
 
 	/// <summary>
 	/// Configures bUnit to use replace all components whose type make the <paramref name="componentTypePredicate"/> predicate return <c>true</c>
 	/// with a <see cref="Stub{TComponent}"/> component in the render tree.
 	/// </summary>
 	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
 	/// <param name="componentTypePredicate">The predicate which decides if a component should be replaced with a <see cref="Stub{TComponent}"/> component.</param>
-	/// <param name="replacementTemplate">Optional replacement template that will be used to render output instead of the stubbed out component.</param>
+	/// <param name="replacementMarkup">Replacement markup that will be used to render output instead of the stubbed out components.</param>
 	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
 	public static ComponentFactoryCollection AddStub(
 		this ComponentFactoryCollection factories,
 		Predicate<Type> componentTypePredicate,
-		Func<IReadOnlyDictionary<string, object>, string> replacementTemplate)
+		string replacementMarkup)
 		=> AddStub(
 			factories,
 			componentTypePredicate,
-			ps => b => b.AddMarkupContent(0, replacementTemplate(ps)));
+			b => b.AddMarkupContent(0, replacementMarkup));
 
 	/// <summary>
 	/// Configures bUnit to use replace all components whose type make the <paramref name="componentTypePredicate"/> predicate return <c>true</c>
 	/// with a <see cref="Stub{TComponent}"/> component in the render tree.
 	/// </summary>
 	/// <param name="factories">The bUnit <see cref="ComponentFactoryCollection"/> to configure.</param>
 	/// <param name="componentTypePredicate">The predicate which decides if a component should be replaced with a <see cref="Stub{TComponent}"/> component.</param>
-	/// <param name="replacementTemplate">Optional replacement template that will be used to render output instead of the stubbed out component.</param>
+	/// <param name="replacementFragment">Replacement <see cref="RenderFragment"/> that will be used to render output instead of the stubbed out components.</param>
 	/// <returns>A <see cref="ComponentFactoryCollection"/>.</returns>
 	public static ComponentFactoryCollection AddStub(
 		this ComponentFactoryCollection factories,
 		Predicate<Type> componentTypePredicate,
-		RenderFragment<IReadOnlyDictionary<string, object>> replacementTemplate)
+		RenderFragment replacementFragment)
 	{
 		if (factories is null)
 			throw new ArgumentNullException(nameof(factories));
 		if (componentTypePredicate is null)
 			throw new ArgumentNullException(nameof(componentTypePredicate));
 
-		factories.Add(new StubComponentFactory(componentTypePredicate, replacementTemplate));
+		factories.Add(new StubComponentFactory(componentTypePredicate, replacementFragment));
 		return factories;
 	}
 }
+#endif