Ignore obsolete usages in the enum extensions (#111)

andrewlock · Oct 20, 2024 · 95dd7ee · 95dd7ee
1 parent dd27676
commit 95dd7ee
Show file tree

Hide file tree

Showing 43 changed files with 3,353 additions and 21 deletions.
diff --git a/src/NetEscapades.EnumGenerators/SourceGenerationHelper.cs b/src/NetEscapades.EnumGenerators/SourceGenerationHelper.cs
@@ -148,6 +148,8 @@ namespace ").Append(enumToGenerate.Namespace).Append(@"
         var fullyQualifiedName = $"global::{enumToGenerate.FullyQualifiedName}";
 
         sb.Append(@"
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref=""").Append(fullyQualifiedName).Append($@""" />
     /// </summary>
@@ -887,7 +889,9 @@ public static string[] GetNames()
         sb.Append(@"
             };
         }
-    }");
+    }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums");
         if (!string.IsNullOrEmpty(enumToGenerate.Namespace))
         {
             sb.Append(@"
@@ -919,6 +923,9 @@ public InterceptsLocationAttribute(int version, string data)
                     }
                 }
             }
+
+            #pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+            #pragma warning disable CS0618 // Ignore usages of obsolete members or enums
             namespace NetEscapades.EnumGenerators
             {
                 static file class EnumInterceptors
@@ -970,6 +977,8 @@ static file class EnumInterceptors
             $$"""
                   }
               }
+              #pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+              #pragma warning restore CS0618 // Ignore usages of obsolete members or enums
               """);
         return sb.ToString();
 

diff --git a/tests/NetEscapades.EnumGenerators.IntegrationTests/Enums.cs b/tests/NetEscapades.EnumGenerators.IntegrationTests/Enums.cs
@@ -133,6 +133,7 @@ public enum StringTesting
     {
         [System.ComponentModel.Description("Quotes \"")]   Quotes,
         [System.ComponentModel.Description(@"Literal Quotes """)]   LiteralQuotes,
+        [Obsolete]
         [System.ComponentModel.Description("Backslash \\")]   Backslash,
         [System.ComponentModel.Description(@"LiteralBackslash \")]   BackslashLiteral,
         [System.ComponentModel.Description("Line\nBreak")]   LineBreak,

diff --git a/tests/NetEscapades.EnumGenerators.Interceptors.IntegrationTests/Enums.cs b/tests/NetEscapades.EnumGenerators.Interceptors.IntegrationTests/Enums.cs
@@ -82,6 +82,9 @@ public enum StringTesting
 
         [System.ComponentModel.Description(@"LiteralBackslash \")]
         BackslashLiteral,
+
+        [System.ComponentModel.Description("Line\nBreak")]
+        LineBreak,
     }
 
     [EnumExtensions(IsInterceptable = false)]

diff --git a/tests/NetEscapades.EnumGenerators.Interceptors.IntegrationTests/InterceptorTests.cs b/tests/NetEscapades.EnumGenerators.Interceptors.IntegrationTests/InterceptorTests.cs
@@ -60,8 +60,10 @@ void AssertValue(EnumWithDisplayNameInNamespace value)
 #endif
     public void CallingToStringIsIntercepted_StringTesting()
     {
+#pragma warning disable CS0612
         var result1 = StringTesting.Backslash.ToString();
         var result2 = StringTesting.Backslash.ToStringFast();
+#pragma warning restore CS0612
         Assert.Equal(result1, result2);
     }
 

diff --git a/tests/NetEscapades.EnumGenerators.Tests/EnumGeneratorTests.cs b/tests/NetEscapades.EnumGenerators.Tests/EnumGeneratorTests.cs
@@ -426,4 +426,96 @@ public Task CanGenerateExternalEnumExtensionsWithCustomNamespaceAndName()
         Assert.Empty(diagnostics);
         return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
     }
+
+    [Fact]
+    public Task DoesNotGenerateWarningsForObsoleteMembers_CS0612_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                [Obsolete]
+                Second,
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
+
+    [Fact]
+    public Task DoesNotGenerateWarningsForObsoleteMembers_CS0618_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                [Obsolete("This is obsolete")]
+                Second,
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
+
+    [Fact]
+    public Task DoesNotGenerateWarningsForObsoleteEnums_CS0612_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [Obsolete]
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                Second,
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
+
+    [Fact]
+    public Task DoesNotGenerateWarningsForObsoleteEnums_CS0618_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [Obsolete("This is obsolete", false)]
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                Second,
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
 }
diff --git a/tests/NetEscapades.EnumGenerators.Tests/InterceptorTests.cs b/tests/NetEscapades.EnumGenerators.Tests/InterceptorTests.cs
@@ -447,6 +447,94 @@ public void MyTest()
         return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
     }
 
+    [Fact]
+    public Task DoesNotGenerateWarningsForUseOfObsoleteEnums_CS0612_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                [Obsolete]
+                Second,
+            }
+
+            [EnumExtensions]
+            public enum OtherEnum
+            {
+                First,
+                Second,
+            }
+            
+            internal class InnerClass
+            {
+                public void MyTest()
+                {
+            #pragma warning disable CS0612
+            #pragma warning disable CS0618
+                    var var1 = OtherEnum.Second.ToString();
+                    var var2 = MyEnum.Second.ToString();
+            #pragma warning restore CS0612
+            #pragma warning restore CS0618
+                }
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
+
+
+    [Fact]
+    public Task DoesNotGenerateWarningsForUseOfObsoleteEnums_CS0618_Issue97()
+    {
+        const string input =
+            """
+            using System;
+            using NetEscapades.EnumGenerators;
+
+            [EnumExtensions]
+            public enum MyEnum
+            {
+                First,
+                [Obsolete("This is obsolete")]
+                Second,
+            }
+
+            [EnumExtensions]
+            [Obsolete("This is obsolete")]
+            public enum OtherEnum
+            {
+                First,
+                Second,
+            }
+            
+            internal class InnerClass
+            {
+                public void MyTest()
+                {
+            #pragma warning disable CS0612
+            #pragma warning disable CS0618
+                    var var1 = OtherEnum.Second.ToString();
+                    var var2 = MyEnum.Second.ToString();
+            #pragma warning restore CS0612
+            #pragma warning restore CS0618
+                }
+            }
+
+            """;
+        var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
+
+        Assert.Empty(diagnostics);
+        return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
+    }
+
     [Fact]
     public Task DoesNotInterceptToStringWhenOldCsharp()
     {

diff --git a/...ts/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsForFlagsEnum_Params.verified.txt b/...ts/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsForFlagsEnum_Params.verified.txt
@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by the NetEscapades.EnumGenerators source generator
 //
@@ -14,6 +14,8 @@ using System;
 
 namespace MyTestNameSpace
 {
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref="global::MyTestNameSpace.MyEnum" />
     /// </summary>
@@ -518,4 +520,6 @@ namespace MyTestNameSpace
             };
         }
     }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums
 }
diff --git a/...Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInChildNamespace.verified.txt b/...Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInChildNamespace.verified.txt
@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by the NetEscapades.EnumGenerators source generator
 //
@@ -14,6 +14,8 @@ using System;
 
 namespace MyTestNameSpace
 {
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref="global::MyTestNameSpace.MyEnum" />
     /// </summary>
@@ -488,4 +490,6 @@ namespace MyTestNameSpace
             };
         }
     }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums
 }
diff --git a/...ests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInGlobalNamespace.verified.txt b/...ests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInGlobalNamespace.verified.txt
@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by the NetEscapades.EnumGenerators source generator
 //
@@ -12,6 +12,8 @@
 using System;
 #endif
 
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref="global::MyEnum" />
     /// </summary>
@@ -485,4 +487,6 @@ using System;
                 nameof(global::MyEnum.Second),
             };
         }
-    }
+    }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums
diff --git a/...rs.Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInNestedClass.verified.txt b/...rs.Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsInNestedClass.verified.txt
@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by the NetEscapades.EnumGenerators source generator
 //
@@ -14,6 +14,8 @@ using System;
 
 namespace MyTestNameSpace
 {
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref="global::MyTestNameSpace.InnerClass.MyEnum" />
     /// </summary>
@@ -488,4 +490,6 @@ namespace MyTestNameSpace
             };
         }
     }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums
 }
diff --git a/...s.Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsWithCustomName.verified.txt b/...s.Tests/Snapshots/EnumGeneratorTests.CanGenerateEnumExtensionsWithCustomName.verified.txt
@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by the NetEscapades.EnumGenerators source generator
 //
@@ -14,6 +14,8 @@ using System;
 
 namespace MyTestNameSpace
 {
+#pragma warning disable CS0612 // Ignore usages of obsolete members or enums
+#pragma warning disable CS0618 // Ignore usages of obsolete members or enums
     /// <summary>
     /// Extension methods for <see cref="global::MyTestNameSpace.MyEnum" />
     /// </summary>
@@ -488,4 +490,6 @@ namespace MyTestNameSpace
             };
         }
     }
+#pragma warning restore CS0612 // Ignore usages of obsolete members or enums
+#pragma warning restore CS0618 // Ignore usages of obsolete members or enums
 }