AV1710: Add exception for User.UserName (#149)

bkoelman · Feb 6, 2024 · eca228d · eca228d
1 parent 4772eff
commit eca228d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/...rpGuidelinesAnalyzer.Test/Specs/Naming/DoNotIncludeContainingTypeNameInMemberNameSpecs.cs b/...rpGuidelinesAnalyzer.Test/Specs/Naming/DoNotIncludeContainingTypeNameInMemberNameSpecs.cs
@@ -214,6 +214,23 @@ class Order
         await VerifyGuidelineDiagnosticAsync(source);
     }
 
+    [Fact]
+    internal async Task When_User_class_contains_UserName_property_it_must_be_skipped()
+    {
+        // Arrange
+        ParsedSourceCode source = new TypeSourceCodeBuilder()
+            .InGlobalScope(@"
+                class User
+                {
+                    string UserName { get; set; }
+                }
+            ")
+            .Build();
+
+        // Act and assert
+        await VerifyGuidelineDiagnosticAsync(source);
+    }
+
     [Fact]
     internal async Task When_event_name_contains_class_name_it_must_be_reported()
     {
@@ -344,7 +361,7 @@ static Employee()
     }
 
     [Fact]
-    internal async Task When_class_contains_static_destructor_it_must_be_skipped()
+    internal async Task When_class_contains_destructor_it_must_be_skipped()
     {
         // Arrange
         ParsedSourceCode source = new TypeSourceCodeBuilder()

diff --git a/...harpGuidelinesAnalyzer/Rules/Naming/DoNotIncludeContainingTypeNameInMemberNameAnalyzer.cs b/...harpGuidelinesAnalyzer/Rules/Naming/DoNotIncludeContainingTypeNameInMemberNameAnalyzer.cs
@@ -61,11 +61,16 @@ private static void AnalyzeMemberName([NotNull] string containingTypeName, Symbo
         {
             string memberName = context.Symbol.MemberNameWithoutExplicitInterfacePrefix();
 
-            if (memberName.Contains(containingTypeName))
+            if (memberName.Contains(containingTypeName) && !IsUserNameInUserType(containingTypeName, memberName))
             {
                 var diagnostic = Diagnostic.Create(Rule, context.Symbol.Locations[0], context.Symbol.Kind, context.Symbol.Name, containingTypeName);
                 context.ReportDiagnostic(diagnostic);
             }
         }
+
+        private static bool IsUserNameInUserType([NotNull] string containingTypeName, [NotNull] string memberName)
+        {
+            return containingTypeName == "User" && memberName.ToLowerInvariant() == "username";
+        }
     }
 }