Skip to content

bugfix: improve CollectionShouldHaveElementAt_IndexerShouldBe detection #390

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
merged 1 commit into from
Oct 21, 2024
Merged

bugfix: improve CollectionShouldHaveElementAt_IndexerShouldBe detection #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/FluentAssertions.Analyzers.TestUtils/GenerateCode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ public static string GenericIListExpressionBodyAssertion(string assertion) => Ge
.AppendLine(" {")
.AppendLine(" public bool BooleanProperty { get; set; }")
.AppendLine(" public string Message { get; set; }")
.AppendLine(" public TestComplexClass this[int index] => throw new NotImplementedException();")
.AppendLine(" }")
.AppendLine()
.AppendLine("}")
.ToString();

Expand Down
7 changes: 6 additions & 1 deletion src/FluentAssertions.Analyzers.Tests/Tips/CollectionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ public void CollectionShouldContainSingle_TestAnalyzer_GenericIEnumerableShouldR
[AssertionDiagnostic("actual.ElementAt(k).BooleanProperty.Should().Be(expectedItem.BooleanProperty{0});")]
[AssertionDiagnostic("actual.ElementAt(6).BooleanProperty.Should().Be(expectedItem.BooleanProperty{0});")]
[AssertionDiagnostic("actual.AsEnumerable().ElementAt(k).BooleanProperty.Should().Be(expectedItem.BooleanProperty{0}).And.ToString();")]
[AssertionDiagnostic("actual.AsEnumerable().ElementAt(6).BooleanProperty.Should().Be(expectedItem.BooleanProperty{0}).And.ToString();")]
[AssertionDiagnostic("actual.AsEnumerable().ElementAt(6).BooleanProperty.Should().Be(expectedItem.BooleanProperty{0}).And.ToString();")]
[Implemented]
public void CollectionShouldHaveElementAt_ElementAtIndexShouldBe_TestNoAnalyzer(string assertion) => DiagnosticVerifier.VerifyCSharpDiagnosticUsingAllAnalyzers(GenerateCode.GenericIListCodeBlockAssertion(assertion));

Expand All @@ -793,6 +793,11 @@ public void CollectionShouldContainSingle_TestAnalyzer_GenericIEnumerableShouldR
[Implemented]
public void CollectionShouldHaveElementAt_IndexerShouldBe_TestAnalyzer(string assertion) => VerifyCSharpDiagnosticCodeBlock(assertion, DiagnosticMetadata.CollectionShouldHaveElementAt_IndexerShouldBe);

[DataTestMethod]
[AssertionDiagnostic("var first = actual[0]; first[6].Should().Be(expectedItem{0});")]
[Implemented]
public void CollectionShouldHaveElementAt_IndexerShouldBe_TestNoAnalyzer(string assertion) => DiagnosticVerifier.VerifyCSharpDiagnosticUsingAllAnalyzers(GenerateCode.GenericIListCodeBlockAssertion(assertion));

[DataTestMethod]
[AssertionDiagnostic("actual.Skip(k).First().Should().Be(expectedItem{0});")]
[AssertionDiagnostic("actual.Skip(6).First().Should().Be(expectedItem{0});")]
Expand Down
4 changes: 4 additions & 0 deletions src/FluentAssertions.Analyzers/Tips/FluentAssertionsAnalyzer.Utils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ public FluentAssertionsMetadata(Compilation compilation)
IDictionaryOfT2 = compilation.GetTypeByMetadataName(typeof(IDictionary<,>).FullName);
DictionaryOfT2 = compilation.GetTypeByMetadataName(typeof(Dictionary<,>).FullName);
IReadonlyDictionaryOfT2 = compilation.GetTypeByMetadataName(typeof(IReadOnlyDictionary<,>).FullName);
IListOfT = compilation.GetTypeByMetadataName(typeof(IList<>).FullName);
IReadonlyListOfT = compilation.GetTypeByMetadataName(typeof(IReadOnlyList<>).FullName);
Enumerable = compilation.GetTypeByMetadataName(typeof(Enumerable).FullName);
IEnumerable = compilation.GetTypeByMetadataName(typeof(IEnumerable).FullName);
Math = compilation.GetTypeByMetadataName(typeof(Math).FullName);
Expand All @@ -87,6 +89,8 @@ public FluentAssertionsMetadata(Compilation compilation)
public INamedTypeSymbol IDictionaryOfT2 { get; }
public INamedTypeSymbol DictionaryOfT2 { get; }
public INamedTypeSymbol IReadonlyDictionaryOfT2 { get; }
public INamedTypeSymbol IListOfT { get; }
public INamedTypeSymbol IReadonlyListOfT { get; }
public INamedTypeSymbol BooleanAssertionsOfT1 { get; }
public INamedTypeSymbol NumericAssertionsOfT2 { get; }
public INamedTypeSymbol Enumerable { get; }
Expand Down
1 change: 1 addition & 0 deletions src/FluentAssertions.Analyzers/Tips/FluentAssertionsAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@ private static void AnalyzeInvocation(OperationAnalysisContext context, FluentAs
}
else if (subject.TryGetFirstDescendent<IPropertyReferenceOperation>(out var propertyReference) && propertyReference.Property.IsIndexer)
{
if (!propertyReference.Instance.Type.ImplementsOrIsInterface(metadata.IListOfT) && !propertyReference.Instance.Type.ImplementsOrIsInterface(metadata.IReadonlyListOfT)) return;
if (propertyReference.Instance.Type.ImplementsOrIsInterface(metadata.IDictionaryOfT2) || propertyReference.Instance.Type.ImplementsOrIsInterface(metadata.IReadonlyDictionaryOfT2)) return;

context.ReportDiagnostic(CreateDiagnostic(assertion, DiagnosticMetadata.CollectionShouldHaveElementAt_IndexerShouldBe));
Expand Down
Loading