Rename attribute and use generic version

Author: linkdotnet

docs/site/docs/extensions/bunit-generators.md

@@ -60,7 +60,7 @@ To use the generator, the **Interceptor** feature has to be used inside the cspr
 
 Due to the usage of **Interceptors** the generator is only available for .NET 8.0 and above. The generator does create a `partial` class, so it can be extended with custom logic if needed.
 
-## Component stub generator via `StubAttribute`
+## Component stub generator via `ComponentStubAttribute`
 
 This generator adds the ability to automatically generate stubs for a given type via an attribute.
 The general setup for the given component above looks like this:
@@ -77,7 +77,7 @@ public class FeatureTests : TestContext
     }    
 }
 
-[Stub(typeof(ThirdPartyText))]
+[ComponentStub<ThirdPartyText>]
 internal partial class ThidPartyStub { }
 ```
 

src/bunit.generators/README.md

@@ -52,7 +52,7 @@ To use the generator, the **Interceptor** feature has to be used inside the cspr
 
 This limits the usage to .NET 8 and above.
 
-## `StubAttribute`
+## `ComponentStubAttribute`
 This generator adds the ability to automatically generate stubs for a given type via an attribute.
 The general setup for the given component above looks like this:
 ```csharp
@@ -68,7 +68,7 @@ public class FeatureTests : TestContext
     }    
 }
 
-[Stub(typeof(ThirdPartyText))]
+[ComponentStub<ThirdPartyText>)]
 internal partial class ThidPartyStub { }
 ```
 

src/bunit.generators/Web.Stubs/AttributeStubGenerator/ComponentStubAttribute.cs

@@ -0,0 +1,19 @@
+namespace Bunit.Web.Stubs.AttributeStubGenerator;
+
+internal static class ComponentStubAttribute
+{
+	public static string ComponentStubAttributeSource = """
+	                                                    #if NET5_0_OR_GREATER
+	                                                    namespace Bunit;
+
+	                                                    /// <summary>
+	                                                    /// Indicates that the component will be enriched by a generated class.
+	                                                    /// </summary>
+	                                                    [global::System.AttributeUsage(global::System.AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
+	                                                    internal sealed class ComponentStubAttribute<T> : global::System.Attribute
+	                                                        where T : global::Microsoft.AspNetCore.Components.IComponent
+	                                                    {
+	                                                    }
+	                                                    #endif
+	                                                    """;
+}

…eStubGenerator/StubAttributeGenerator.cs …rator/ComponentStubAttributeGenerator.cssrc/bunit.generators/Web.Stubs/AttributeStubGenerator/StubAttributeGenerator.cs renamed to src/bunit.generators/Web.Stubs/AttributeStubGenerator/ComponentStubAttributeGenerator.cs src/bunit.generators/Web.Stubs/AttributeStubGenerator/StubAttributeGenerator.cs renamed to src/bunit.generators/Web.Stubs/AttributeStubGenerator/ComponentStubAttributeGenerator.cs

@@ -10,32 +10,36 @@ namespace Bunit.Web.Stubs.AttributeStubGenerator;
 /// Generator that creates a stub of a marked component.
 /// </summary>
 [Generator]
-public class StubAttributeGenerator : IIncrementalGenerator
+public class ComponentStubAttributeGenerator : IIncrementalGenerator
 {
-	private const string AttributeFullQualifiedName = "Bunit.StubAttribute";
+	private const string AttributeFullQualifiedName = "Bunit.ComponentStubAttribute`1";
 
 	/// <inheritdoc />
 	public void Initialize(IncrementalGeneratorInitializationContext context)
 	{
 		context.RegisterPostInitializationOutput(ctx => ctx.AddSource(
-			"StubAttribute.g.cs",
-			SourceText.From(StubAttribute.StubAttributeSource, Encoding.UTF8)));
+			"ComponentStubAttribute.g.cs",
+			SourceText.From(ComponentStubAttribute.ComponentStubAttributeSource, Encoding.UTF8)));
 
 		var classesToStub = context.SyntaxProvider
 			.ForAttributeWithMetadataName(
 				AttributeFullQualifiedName,
-				predicate: static (s, _) => s is ClassDeclarationSyntax c && c.AttributeLists.SelectMany(a => a.Attributes).Any(at => at.Name.ToString() == "Stub"),
+				predicate: static (s, _) => IsClassWithComponentStubAttribute(s),
 				transform: static (ctx, _) => GetStubClassInfo(ctx))
 			.Where(static m => m is not null);
 
-
 		context.RegisterSourceOutput(
 			classesToStub,
 			static (spc, source) => Execute(source, spc));
 	}
 
+	private static bool IsClassWithComponentStubAttribute(SyntaxNode s) =>
+		s is ClassDeclarationSyntax c && c.AttributeLists.SelectMany(a => a.Attributes)
+			.Any(at => at.Name.ToString().Contains("ComponentStub"));
+
 	private static StubClassInfo GetStubClassInfo(GeneratorAttributeSyntaxContext context)
 	{
+#pragma warning disable RS1035
 		foreach (var attribute in context.TargetSymbol.GetAttributes())
 		{
 			if (context.TargetSymbol is not ITypeSymbol stubbedType)
@@ -47,8 +51,8 @@ private static StubClassInfo GetStubClassInfo(GeneratorAttributeSyntaxContext co
 			var className = context.TargetSymbol.Name;
 			var visibility = context.TargetSymbol.DeclaredAccessibility.ToString().ToLower();
 
-			var originalTypeToStub = attribute.ConstructorArguments.FirstOrDefault().Value;
-			if (originalTypeToStub is not ITypeSymbol originalType)
+			var originalTypeToStub = attribute.AttributeClass?.TypeArguments.FirstOrDefault();
+			if (originalTypeToStub is null)
 			{
 				continue;
 			}
@@ -57,7 +61,7 @@ private static StubClassInfo GetStubClassInfo(GeneratorAttributeSyntaxContext co
 			{
 				ClassName = className,
 				Namespace = namespaceName,
-				TargetType = originalType,
+				TargetType = originalTypeToStub,
 				Visibility = visibility
 			};
 		}
@@ -107,7 +111,7 @@ private static void Execute(StubClassInfo classInfo, SourceProductionContext con
 
 		if (hasSomethingToStub)
 		{
-			context.AddSource($"{classInfo.ClassName}Stub.g.cs", sourceBuilder.ToString());
+			context.AddSource($"{classInfo.ClassName}.g.cs", sourceBuilder.ToString());
 		}
 	}
 }

src/bunit.generators/Web.Stubs/AttributeStubGenerator/StubAttribute.cs

@@ -63,7 +63,7 @@ public void Generated_stub_via_attribute_has_same_parameters()
 	}
 }
 
-[Stub(typeof(ButtonComponent))]
+[ComponentStub<ButtonComponent>]
 public partial class ButtonComponentStub
 {
 }