Merge pull request #3083 from pantosha/fix-2941

Fix SA1008 on line end

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/SpacingRules/TokenSpacingCodeFixProvider.cs

@@ -239,9 +239,10 @@ private static void UpdateReplaceMap(Dictionary<SyntaxToken, SyntaxToken> replac
 
                 case TokenSpacingProperties.ActionRemove:
                     triviaList = token.TrailingTrivia.AddRange(nextToken.LeadingTrivia);
+                    bool preserveLayout = layout == TokenSpacingProperties.LayoutPreserve;
 
                     UpdateReplaceMap(replaceMap, token, t => t.WithTrailingTrivia());
-                    UpdateReplaceMap(replaceMap, nextToken, t => t.WithLeadingTrivia(triviaList.WithoutLeadingWhitespace(true)));
+                    UpdateReplaceMap(replaceMap, nextToken, t => t.WithLeadingTrivia(triviaList.WithoutLeadingWhitespace(endOfLineIsWhitespace: !preserveLayout)));
                     break;
                 }
 

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1008UnitTests.cs

@@ -137,11 +137,61 @@ public void TestMethod1(
             int z)
         {
         }
+
+        public void TestMethod2 (
+            int x,
+            int y,
+            int z)
+        {
+        }
+
+        // Opening parenthesis followed by space
+        public void TestMethod3( 
+            int x,
+            int y,
+            int z)
+        {
+        }
     }
 }
 ";
 
-            await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            var fixedTestCode = @"namespace TestNamespace
+{
+    public class TestClass
+    {
+        public void TestMethod1(
+            int x,
+            int y,
+            int z)
+        {
+        }
+
+        public void TestMethod2(
+            int x,
+            int y,
+            int z)
+        {
+        }
+
+        // Opening parenthesis followed by space
+        public void TestMethod3(
+            int x,
+            int y,
+            int z)
+        {
+        }
+    }
+}
+";
+
+            DiagnosticResult[] expectedDiagnostics =
+            {
+                Diagnostic(DescriptorNotPreceded).WithLocation(12, 33),
+                Diagnostic(DescriptorNotFollowed).WithLocation(20, 32),
+            };
+
+            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -781,6 +831,72 @@ public TestClass()
             await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that spacing for multiline argument lists is handled properly.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestMultiLineArgumentListAsync()
+        {
+            var testCode = @"using System;
+
+namespace TestNamespace
+{
+    public class TestClass
+    {
+        public TestClass(int x, int y)
+        {
+            var s1 = new String(
+                'a',
+                x);
+
+            var s2 = new String (
+                'a',
+                y);
+
+            // Opening parenthesis followed by space
+            var s3 = new String( 
+                'a',
+                x);
+        }
+    }
+}
+";
+
+            var fixedTestCode = @"using System;
+
+namespace TestNamespace
+{
+    public class TestClass
+    {
+        public TestClass(int x, int y)
+        {
+            var s1 = new String(
+                'a',
+                x);
+
+            var s2 = new String(
+                'a',
+                y);
+
+            // Opening parenthesis followed by space
+            var s3 = new String(
+                'a',
+                x);
+        }
+    }
+}
+";
+
+            DiagnosticResult[] expectedDiagnostics =
+            {
+                Diagnostic(DescriptorNotPreceded).WithLocation(13, 33),
+                Diagnostic(DescriptorNotFollowed).WithLocation(18, 32),
+            };
+
+            await VerifyCSharpFixAsync(testCode, expectedDiagnostics, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <summary>
         /// Verifies that spacing for while statements is handled properly.
         /// </summary>

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1008OpeningParenthesisMustBeSpacedCorrectly.cs

@@ -92,12 +92,6 @@ private static void HandleOpenParenToken(SyntaxTreeAnalysisContext context, Synt
                 return;
             }
 
-            if (token.IsLastInLine())
-            {
-                // ignore open parenthesis when last on line.
-                return;
-            }
-
             var prevToken = token.GetPreviousToken();
 
             // Don't check leading spaces when preceded by a keyword that is already handled by SA1000
@@ -268,7 +262,7 @@ private static void HandleOpenParenToken(SyntaxTreeAnalysisContext context, Synt
 
             if (token.IsFollowedByWhitespace())
             {
-                context.ReportDiagnostic(Diagnostic.Create(DescriptorNotFollowed, token.GetLocation(), TokenSpacingProperties.RemoveFollowing));
+                context.ReportDiagnostic(Diagnostic.Create(DescriptorNotFollowed, token.GetLocation(), TokenSpacingProperties.RemoveFollowingPreserveLayout));
             }
         }
     }

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/TokenSpacingProperties.cs

@@ -61,5 +61,11 @@ internal static class TokenSpacingProperties
             ImmutableDictionary<string, string>.Empty
                 .SetItem(LocationKey, LocationFollowing)
                 .SetItem(ActionKey, ActionRemove);
+
+        internal static ImmutableDictionary<string, string> RemoveFollowingPreserveLayout { get; } =
+            ImmutableDictionary<string, string>.Empty
+                .SetItem(LocationKey, LocationFollowing)
+                .SetItem(ActionKey, ActionRemove)
+                .SetItem(LayoutKey, LayoutPreserve);
     }
 }