Merge pull request #3610 from sharwell/optimize-sa1141

Optimize SA1141

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1141CSharp7UnitTests.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-#nullable disable
-
 namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
 {
     using System.Threading;
@@ -33,28 +31,28 @@ public async Task ValidateMemberDeclarationsWithValueTuplesAsync()
 
 public class TestClass
 {
-    public ValueTuple<int, int> TestMethod(ValueTuple<double, double> value)
+    public [|ValueTuple<int, int>|] TestMethod([|ValueTuple<double, double>|] value)
     {
         throw new NotImplementedException();
     }
 
-    public System.ValueTuple<(int, int), int> TestMethod2(int p1, ValueTuple<System.ValueTuple<long, long>, long> p2, (ValueTuple<string, string>, string) p3)
+    public [|System.ValueTuple<(int, int), int>|] TestMethod2(int p1, [|ValueTuple<System.ValueTuple<long, long>, long>|] p2, ([|ValueTuple<string, string>|], string) p3)
     {
         throw new NotImplementedException();
     }
 
-    public System.ValueTuple<int, int> TestProperty1 { get; set; }
+    public [|System.ValueTuple<int, int>|] TestProperty1 { get; set; }
 
-    public System.Collections.Generic.List<ValueTuple<int, int>> TestProperty2 { get; set; }
+    public System.Collections.Generic.List<[|ValueTuple<int, int>|]> TestProperty2 { get; set; }
 
-    public System.ValueTuple<int, long> this[int i] { get { return (1, 1l); } set { } }
+    public [|System.ValueTuple<int, long>|] this[int i] { get { return (1, 1l); } set { } }
 
-    public static explicit operator TestClass(System.ValueTuple<int, int> p1)
+    public static explicit operator TestClass([|System.ValueTuple<int, int>|] p1)
     {
         throw new NotImplementedException();
     }
 
-    public static implicit operator System.ValueTuple<int, int>(TestClass p1)
+    public static implicit operator [|System.ValueTuple<int, int>|](TestClass p1)
     {
         throw new NotImplementedException();
     }
@@ -93,21 +91,7 @@ public static implicit operator (int, int)(TestClass p1)
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                Diagnostic().WithLocation(5, 12),
-                Diagnostic().WithLocation(5, 44),
-                Diagnostic().WithLocation(10, 12),
-                Diagnostic().WithLocation(10, 67),
-                Diagnostic().WithLocation(10, 120),
-                Diagnostic().WithLocation(15, 12),
-                Diagnostic().WithLocation(17, 44),
-                Diagnostic().WithLocation(19, 12),
-                Diagnostic().WithLocation(21, 47),
-                Diagnostic().WithLocation(26, 37),
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -118,28 +102,32 @@ public static implicit operator (int, int)(TestClass p1)
         public async Task ValidateValueTupleObjectCreationAsync()
         {
             var testCode = @"using System;
+using VT = System.ValueTuple;
 
 public class TestClass
 {
     public void TestMethod()
     {
-        var test1 = new ValueTuple<int, int>(1, 2);
-        var test2 = new System.ValueTuple<int, int>(1, 2);
-        var test3 = new ValueTuple<ValueTuple<int, int>, int>(new ValueTuple<int, int>(3, 4), 2);
-        var test4 = new System.ValueTuple<int, System.ValueTuple<int, int>>(1, new System.ValueTuple<int, int>(2, 3));
-        var test5 = (new ValueTuple<int, int>(3, 4), 2);
-        var test6 = new System.ValueTuple<int, System.ValueTuple<int, int>>(1, (2, 3));
-        var test7 = ValueTuple.Create(1, 2);
-        var test8 = ValueTuple.Create<int, double>(1, 2);
-        var test9 = System.ValueTuple.Create(1, new ValueTuple<int, double>(2, 3));
-        var test10 = ValueTuple.Create(ValueTuple.Create(1, 2, 3), 4);
-        var test11 = new ValueTuple<int, ValueTuple<int, int>>(1, ValueTuple.Create(2, 3));
-        var test12 = new System.ValueTuple<byte, int>(1, 2);
+        var test1 = [|new ValueTuple<int, int>(1, 2)|];
+        var test2 = [|new System.ValueTuple<int, int>(1, 2)|];
+        var test3 = [|new ValueTuple<ValueTuple<int, int>, int>([|new ValueTuple<int, int>(3, 4)|], 2)|];
+        var test4 = [|new System.ValueTuple<int, System.ValueTuple<int, int>>(1, [|new System.ValueTuple<int, int>(2, 3)|])|];
+        var test5 = ([|new ValueTuple<int, int>(3, 4)|], 2);
+        var test6 = [|new System.ValueTuple<int, System.ValueTuple<int, int>>(1, (2, 3))|];
+        var test7 = [|ValueTuple.Create|](1, 2);
+        var test7B = [|VT.Create|](1, 2);
+        var test8 = [|ValueTuple.Create<int, double>|](1, 2);
+        var test8B = [|VT.Create<int, double>|](1, 2);
+        var test9 = [|System.ValueTuple.Create|](1, [|new ValueTuple<int, double>(2, 3)|]);
+        var test10 = [|ValueTuple.Create|]([|ValueTuple.Create|](1, 2, 3), 4);
+        var test11 = [|new ValueTuple<int, ValueTuple<int, int>>(1, [|ValueTuple.Create|](2, 3))|];
+        var test12 = [|new System.ValueTuple<byte, int>(1, 2)|];
     }
 }
 ";
 
             var fixedCode = @"using System;
+using VT = System.ValueTuple;
 
 public class TestClass
 {
@@ -152,7 +140,9 @@ public void TestMethod()
         var test5 = ((3, 4), 2);
         var test6 = (1, (2, 3));
         var test7 = (1, 2);
+        var test7B = (1, 2);
         var test8 = (1, (double)2);
+        var test8B = (1, (double)2);
         var test9 = (1, (2, (double)3));
         var test10 = ((1, 2, 3), 4);
         var test11 = (1, (2, 3));
@@ -161,28 +151,7 @@ public void TestMethod()
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                Diagnostic().WithLocation(7, 21),
-                Diagnostic().WithLocation(8, 21),
-                Diagnostic().WithLocation(9, 21),
-                Diagnostic().WithLocation(9, 63),
-                Diagnostic().WithLocation(10, 21),
-                Diagnostic().WithLocation(10, 80),
-                Diagnostic().WithLocation(11, 22),
-                Diagnostic().WithLocation(12, 21),
-                Diagnostic().WithLocation(13, 21),
-                Diagnostic().WithLocation(14, 21),
-                Diagnostic().WithLocation(15, 21),
-                Diagnostic().WithLocation(15, 49),
-                Diagnostic().WithLocation(16, 22),
-                Diagnostic().WithLocation(16, 40),
-                Diagnostic().WithLocation(17, 22),
-                Diagnostic().WithLocation(17, 67),
-                Diagnostic().WithLocation(18, 22),
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -330,8 +299,8 @@ public class TestClass
 {
     public void TestMethod(object input)
     {
-        var test1 = (ValueTuple<int, int>)input;
-        var test2 = (System.ValueTuple<System.ValueTuple<int, long>, byte>)input;
+        var test1 = ([|ValueTuple<int, int>|])input;
+        var test2 = ([|System.ValueTuple<System.ValueTuple<int, long>, byte>|])input;
     }
 }
 ";
@@ -348,13 +317,7 @@ public void TestMethod(object input)
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                Diagnostic().WithLocation(7, 22),
-                Diagnostic().WithLocation(8, 22),
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -370,8 +333,8 @@ public class TestClass
 {
     public void TestMethod()
     {
-        var test1 = default(ValueTuple<int, int>);
-        var test2 = default(System.ValueTuple<System.ValueTuple<int, long>, byte>);
+        var test1 = default([|ValueTuple<int, int>|]);
+        var test2 = default([|System.ValueTuple<System.ValueTuple<int, long>, byte>|]);
     }
 }
 ";
@@ -388,13 +351,7 @@ public void TestMethod()
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                Diagnostic().WithLocation(7, 29),
-                Diagnostic().WithLocation(8, 29),
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -408,7 +365,7 @@ public async Task ValidateValueTupleUsageInDelegateAsync()
 
 public class TestClass
 {
-    public delegate System.ValueTuple<int, bool> TestDelegate(ValueTuple<int, ValueTuple<int, long>> arg1, (long, double) arg2, (long, System.ValueTuple<bool, bool>) arg3);
+    public delegate [|System.ValueTuple<int, bool>|] TestDelegate([|ValueTuple<int, ValueTuple<int, long>>|] arg1, (long, double) arg2, (long, [|System.ValueTuple<bool, bool>|]) arg3);
 }
 ";
 
@@ -420,14 +377,7 @@ public class TestClass
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                Diagnostic().WithLocation(5, 21),
-                Diagnostic().WithLocation(5, 63),
-                Diagnostic().WithLocation(5, 136),
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1142CSharp7UnitTests.cs

@@ -1,14 +1,13 @@
 // Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-#nullable disable
-
 namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
 {
     using System.Threading;
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.ReadabilityRules;
+    using StyleCop.Analyzers.Test.ReadabilityRules;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
         StyleCop.Analyzers.ReadabilityRules.SA1142ReferToTupleElementsByName,
@@ -19,7 +18,7 @@ namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
     /// </summary>
     /// <seealso cref="SA1142ReferToTupleElementsByName"/>
     /// <seealso cref="SA1142CodeFixProvider"/>
-    public partial class SA1142CSharp7UnitTests
+    public partial class SA1142CSharp7UnitTests : SA1142UnitTests
     {
         /// <summary>
         /// Validate that tuple fields that are referenced by their name will not produce any diagnostics.
@@ -78,12 +77,7 @@ public int TestMethod2((int nameA, (int subNameA, int subNameB) nameB) p1)
 }
 ";
 
-            DiagnosticResult[] expectedDiagnostics =
-            {
-                // diagnostics are specified inline
-            };
-
-            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1141UnitTests.cs

@@ -44,7 +44,5 @@ public ValueTuple<int, int> TestMethod(ValueTuple<double, double> value)
 
             await VerifyCSharpDiagnosticAsync(LanguageVersion.CSharp6, testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
-
-        //// TODO: Make sure that all paths are covered!
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1142UnitTests.cs

@@ -0,0 +1,49 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.ReadabilityRules
+{
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
+    using StyleCop.Analyzers.ReadabilityRules;
+    using Xunit;
+    using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
+        StyleCop.Analyzers.ReadabilityRules.SA1142ReferToTupleElementsByName,
+        StyleCop.Analyzers.ReadabilityRules.SA1142CodeFixProvider>;
+
+    /// <summary>
+    /// This class contains the unit tests for SA1142.
+    /// </summary>
+    /// <seealso cref="SA1142ReferToTupleElementsByName"/>
+    /// <seealso cref="SA1142CodeFixProvider"/>
+    public class SA1142UnitTests
+    {
+        /// <summary>
+        /// Verify that ValueTuple names referenced by their metadata name will not produce diagnostics when no other
+        /// name is available.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task ValidateFieldNameReferencesWithoutReplacementAsync()
+        {
+            var testCode = @"using System;
+
+public class TestClass
+{
+    public int TestMethod1(ValueTuple<int, int> p1)
+    {
+        return p1.Item1 + p1.Item2 + p1.ToString().Length;
+    }
+
+    public int TestMethod2(ValueTuple<int, ValueTuple<int, int>> p1)
+    {
+        return p1.Item1 + p1.Item2.Item1 + p1.Item2.Item2;
+    }
+}
+";
+
+            await VerifyCSharpFixAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, testCode, CancellationToken.None).ConfigureAwait(false);
+        }
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/LanguageFeatureHelpers.cs

@@ -5,6 +5,7 @@
 
 namespace StyleCop.Analyzers.Helpers
 {
+    using System.Diagnostics.CodeAnalysis;
     using Microsoft.CodeAnalysis.CSharp;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.Lightup;
@@ -14,6 +15,17 @@ namespace StyleCop.Analyzers.Helpers
     /// </summary>
     internal static class LanguageFeatureHelpers
     {
+        /// <summary>
+        /// Checks if the tuple language feature is supported.
+        /// </summary>
+        /// <param name="context">The analysis context that will be checked.</param>
+        /// <returns>True if tuples are supported by the compiler.</returns>
+        [SuppressMessage("MicrosoftCodeAnalysisPerformance", "RS1012:Start action has no registered actions", Justification = "This is not a start action method.")]
+        internal static bool SupportsTuples(this CompilationStartAnalysisContext context)
+        {
+            return context.Compilation is CSharpCompilation { LanguageVersion: >= LanguageVersionEx.CSharp7 };
+        }
+
         /// <summary>
         /// Checks if the tuple language feature is supported.
         /// </summary>