Skip to content

Rework required attributes #11971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DustinCampbell merged 7 commits into from
Jun 24, 2025
Merged

Rework required attributes #11971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b3a0270
Un-nest and rename NameComparisonMode and ValueComparisonMode enums
DustinCampbell Jun 18, 2025
bfc675c
Clean up TestRequiredAttributeDescriptorBuilderExtensions
DustinCampbell Jun 18, 2025
a3b435b
Introduce RequiredAttributeDescriptorFlags
DustinCampbell Jun 18, 2025
ec2963e
Compute RequiredAttribute.DisplayName
DustinCampbell Jun 18, 2025
50dac13
Remove RequiredAttributeDescriptor.Metadata property
DustinCampbell Jun 18, 2025
2df2ff5
Update JSON files and increment serialization format version
DustinCampbell Jun 18, 2025
dfc3dce
Make enums byte-sized
DustinCampbell Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 52 additions & 103 deletions ...piler/Microsoft.AspNetCore.Razor.Language/legacyTest/Legacy/TagHelperBlockRewriterTest.cs
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 4 additions & 8 deletions ...Compiler/Microsoft.AspNetCore.Razor.Language/test/DefaultRazorTagHelperBinderPhaseTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,10 @@ public void Execute_DirectiveWithoutQuotes_RewritesTagHelpers_TagHelperMatchesEl
[
ruleBuilder => ruleBuilder
.RequireAttributeDescriptor(attribute => attribute
.Name("a")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)),
.Name("a", RequiredAttributeNameComparison.FullMatch)),
ruleBuilder => ruleBuilder
.RequireAttributeDescriptor(attribute => attribute
.Name("b")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)),
.Name("b", RequiredAttributeNameComparison.FullMatch)),
]);

var content = @"
Expand Down Expand Up @@ -309,12 +307,10 @@ public void Execute_DirectiveWithQuotes_RewritesTagHelpers_TagHelperMatchesEleme
[
ruleBuilder => ruleBuilder
.RequireAttributeDescriptor(attribute => attribute
.Name("a")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)),
.Name("a", RequiredAttributeNameComparison.FullMatch)),
ruleBuilder => ruleBuilder
.RequireAttributeDescriptor(attribute => attribute
.Name("b")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)),
.Name("b", RequiredAttributeNameComparison.FullMatch)),
]);

var content = @"
Expand Down
83 changes: 14 additions & 69 deletions ...Microsoft.AspNetCore.Razor.Language/test/DefaultRequiredAttributeDescriptorBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using Xunit;
using static Microsoft.AspNetCore.Razor.Language.CommonMetadata;

namespace Microsoft.AspNetCore.Razor.Language;

Expand All @@ -12,87 +11,33 @@ public class DefaultRequiredAttributeDescriptorBuilderTest
public void Build_DisplayNameIsName_NameComparisonFullMatch()
{
// Arrange
var tagHelperBuilder = new TagHelperDescriptorBuilder(TagHelperConventions.DefaultKind, "TestTagHelper", "Test");
var tagMatchingRuleBuilder = new TagMatchingRuleDescriptorBuilder(tagHelperBuilder);
var builder = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);

builder
.Name("asp-action")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch);
var builder = TagHelperDescriptorBuilder.Create(TagHelperConventions.DefaultKind, "TestTagHelper", "Test")
.TagMatchingRuleDescriptor(rule => rule
.RequireAttributeDescriptor(attribute => attribute
.Name("asp-action", RequiredAttributeNameComparison.FullMatch)));

// Act
var descriptor = builder.Build();
var tagHelper = builder.Build();
var attribute = tagHelper.TagMatchingRules[0].Attributes[0];

// Assert
Assert.Equal("asp-action", descriptor.DisplayName);
Assert.Equal("asp-action", attribute.DisplayName);
}

[Fact]
public void Build_DisplayNameIsNameWithDots_NameComparisonPrefixMatch()
{
// Arrange
var tagHelperBuilder = new TagHelperDescriptorBuilder(TagHelperConventions.DefaultKind, "TestTagHelper", "Test");
var tagMatchingRuleBuilder = new TagMatchingRuleDescriptorBuilder(tagHelperBuilder);
var builder = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);

builder
.Name("asp-route-")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.PrefixMatch);

// Act
var descriptor = builder.Build();

// Assert
Assert.Equal("asp-route-...", descriptor.DisplayName);
}

[Fact]
public void Metadata_Same()
{
// When SetMetadata is called on multiple builders with the same metadata collection,
// they should share the instance.

// Arrange
var tagHelperBuilder = new TagHelperDescriptorBuilder(TagHelperConventions.DefaultKind, "TestTagHelper", "Test");
var tagMatchingRuleBuilder = new TagMatchingRuleDescriptorBuilder(tagHelperBuilder);

var metadata = MetadataCollection.Create(PropertyName("SomeProperty"));

var builder1 = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);
var builder2 = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);

builder1.SetMetadata(metadata);
builder2.SetMetadata(metadata);

// Act
var descriptor1 = builder1.Build();
var descriptor2 = builder2.Build();

// Assert
Assert.Same(descriptor1.Metadata, descriptor2.Metadata);
}

[Fact]
public void Metadata_NotSame()
{
// When Metadata is accessed on multiple builders with the same metadata,
// they do not share the instance.

// Arrange
var tagHelperBuilder = new TagHelperDescriptorBuilder(TagHelperConventions.DefaultKind, "TestTagHelper", "Test");
var tagMatchingRuleBuilder = new TagMatchingRuleDescriptorBuilder(tagHelperBuilder);

var builder1 = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);
var builder2 = new RequiredAttributeDescriptorBuilder(tagMatchingRuleBuilder);

builder1.Metadata.Add(PropertyName("SomeProperty"));
builder2.Metadata.Add(PropertyName("SomeProperty"));
var builder = TagHelperDescriptorBuilder.Create(TagHelperConventions.DefaultKind, "TestTagHelper", "Test")
.TagMatchingRuleDescriptor(rule => rule
.RequireAttributeDescriptor(attribute => attribute
.Name("asp-route-", RequiredAttributeNameComparison.PrefixMatch)));

// Act
var descriptor1 = builder1.Build();
var descriptor2 = builder2.Build();
var tagHelper = builder.Build();
var attribute = tagHelper.TagMatchingRules[0].Attributes[0];

// Assert
Assert.NotSame(descriptor1.Metadata, descriptor2.Metadata);
Assert.Equal("asp-route-...", attribute.DisplayName);
}
}
36 changes: 12 additions & 24 deletions ...ler/Microsoft.AspNetCore.Razor.Language/test/IntegrationTests/TestTagHelperDescriptors.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,8 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("href")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)
.Value("~/")
.ValueComparisonMode(RequiredAttributeDescriptor.ValueComparisonMode.FullMatch)),
.Name("href", RequiredAttributeNameComparison.FullMatch)
.Value("~/", RequiredAttributeValueComparison.FullMatch)),
}),
CreateTagHelperDescriptor(
tagName: "a",
Expand All @@ -129,15 +127,11 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("href")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)
.Value("~/")
.ValueComparisonMode(RequiredAttributeDescriptor.ValueComparisonMode.PrefixMatch))
.Name("href", RequiredAttributeNameComparison.FullMatch)
.Value("~/", RequiredAttributeValueComparison.PrefixMatch))
.RequireAttributeDescriptor(attribute => attribute
.Name("href")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)
.Value("?hello=world")
.ValueComparisonMode(RequiredAttributeDescriptor.ValueComparisonMode.SuffixMatch)),
.Name("href", RequiredAttributeNameComparison.FullMatch)
.Value("?hello=world", RequiredAttributeValueComparison.SuffixMatch)),
}),
CreateTagHelperDescriptor(
tagName: "input",
Expand All @@ -151,10 +145,8 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("type")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)
.Value("text")
.ValueComparisonMode(RequiredAttributeDescriptor.ValueComparisonMode.FullMatch)),
.Name("type", RequiredAttributeNameComparison.FullMatch)
.Value("text", RequiredAttributeValueComparison.FullMatch)),
}),
CreateTagHelperDescriptor(
tagName: "input",
Expand All @@ -168,8 +160,7 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("ty")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.PrefixMatch)),
.Name("ty", RequiredAttributeNameComparison.PrefixMatch)),
}),
CreateTagHelperDescriptor(
tagName: "*",
Expand All @@ -179,10 +170,8 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("href")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)
.Value("~/")
.ValueComparisonMode(RequiredAttributeDescriptor.ValueComparisonMode.PrefixMatch)),
.Name("href", RequiredAttributeNameComparison.FullMatch)
.Value("~/", RequiredAttributeValueComparison.PrefixMatch)),
}),
CreateTagHelperDescriptor(
tagName: "*",
Expand All @@ -192,8 +181,7 @@ public static IEnumerable<TagHelperDescriptor> CssSelectorTagHelperDescriptors
{
builder => builder
.RequireAttributeDescriptor(attribute => attribute
.Name("type")
.NameComparisonMode(RequiredAttributeDescriptor.NameComparisonMode.FullMatch)),
.Name("type", RequiredAttributeNameComparison.FullMatch)),
}),
};
}
Expand Down
Loading