Update UsingCodeFixProvider to support configuration

sharwell · sharwell · commit 6cbdc46c7cb3 · 2015-11-17T08:02:11.000-06:00
This change updates UsingCodeFixProvider to change behavior based on the
usingDirectivesPlacement setting in stylecop.json rather than simply
checking if SA1200 has been disabled.
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/UsingCodeFixProvider.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/UsingCodeFixProvider.cs
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/ReadabilityRules/SA1121CodeFixProvider.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/ReadabilityRules/SA1121CodeFixProvider.cs
@@ -26,24 +26,25 @@ namespace StyleCop.Analyzers.ReadabilityRules
     [Shared]
     internal class SA1121CodeFixProvider : CodeFixProvider
     {
-        private static readonly Dictionary<SpecialType, PredefinedTypeSyntax> PredefinedSpecialTypes = new Dictionary<SpecialType, PredefinedTypeSyntax>
-        {
-            [SpecialType.System_Boolean] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.BoolKeyword)),
-            [SpecialType.System_Byte] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ByteKeyword)),
-            [SpecialType.System_Char] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.CharKeyword)),
-            [SpecialType.System_Decimal] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.DecimalKeyword)),
-            [SpecialType.System_Double] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.DoubleKeyword)),
-            [SpecialType.System_Int16] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ShortKeyword)),
-            [SpecialType.System_Int32] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.IntKeyword)),
-            [SpecialType.System_Int64] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.LongKeyword)),
-            [SpecialType.System_Object] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ObjectKeyword)),
-            [SpecialType.System_SByte] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.SByteKeyword)),
-            [SpecialType.System_Single] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.FloatKeyword)),
-            [SpecialType.System_String] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.StringKeyword)),
-            [SpecialType.System_UInt16] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.UShortKeyword)),
-            [SpecialType.System_UInt32] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.UIntKeyword)),
-            [SpecialType.System_UInt64] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ULongKeyword))
-        };
+        public static ImmutableDictionary<SpecialType, PredefinedTypeSyntax> PredefinedSpecialTypes { get; } =
+            new Dictionary<SpecialType, PredefinedTypeSyntax>
+            {
+                [SpecialType.System_Boolean] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.BoolKeyword)),
+                [SpecialType.System_Byte] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ByteKeyword)),
+                [SpecialType.System_Char] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.CharKeyword)),
+                [SpecialType.System_Decimal] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.DecimalKeyword)),
+                [SpecialType.System_Double] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.DoubleKeyword)),
+                [SpecialType.System_Int16] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ShortKeyword)),
+                [SpecialType.System_Int32] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.IntKeyword)),
+                [SpecialType.System_Int64] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.LongKeyword)),
+                [SpecialType.System_Object] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ObjectKeyword)),
+                [SpecialType.System_SByte] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.SByteKeyword)),
+                [SpecialType.System_Single] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.FloatKeyword)),
+                [SpecialType.System_String] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.StringKeyword)),
+                [SpecialType.System_UInt16] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.UShortKeyword)),
+                [SpecialType.System_UInt32] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.UIntKeyword)),
+                [SpecialType.System_UInt64] = SyntaxFactory.PredefinedType(SyntaxFactory.Token(SyntaxKind.ULongKeyword))
+            }.ToImmutableDictionary();
 
         /// <inheritdoc/>
         public override ImmutableArray<string> FixableDiagnosticIds { get; } =
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1200OutsideNamespaceUnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1200OutsideNamespaceUnitTests.cs
@@ -77,7 +77,7 @@ namespace TestNamespace
 
             await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
-            ////await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -112,7 +112,7 @@ namespace System
 
             await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
-            ////await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -172,7 +172,7 @@ namespace TestNamespace
 
             await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
-            ////await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
         }
 
         /// <summary>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1208UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1208UnitTests.cs
@@ -310,7 +310,6 @@ public async Task TestPreprocessorDirectivesAsync()
 using Microsoft.CodeAnalysis;
 using Microsoft.VisualStudio;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using System.Collections;
 using System.Threading;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1209UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1209UnitTests.cs
@@ -59,7 +59,6 @@ class A
 using System.Linq;
 using System.Net;
 using TasksNamespace = System.Threading.Tasks;
-
 class A
 {
 }";
@@ -249,7 +248,6 @@ public async Task TestPreprocessorDirectivesAsync()
             var fixedTestCode = @"using System;
 using Microsoft.VisualStudio;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using Microsoft.CodeAnalysis;
 using Threads = System.Threading;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1210CombinedSystemDirectivesUnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1210CombinedSystemDirectivesUnitTests.cs
@@ -187,7 +187,6 @@ public async Task TestPreprocessorDirectivesAsync()
             var fixedTestCode = @"using Microsoft.VisualStudio;
 using System;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1210UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1210UnitTests.cs
@@ -291,7 +291,6 @@ public async Task TestPreprocessorDirectivesAsync()
             var fixedTestCode = @"using System;
 using Microsoft.VisualStudio;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1211UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1211UnitTests.cs
@@ -179,7 +179,6 @@ public async Task TestPreprocessorDirectivesAsync()
             var fixedTestCode = @"using System;
 using Microsoft.VisualStudio;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using AThing = System.Threading;
 using BThing = System.Threading.Tasks;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1216UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1216UnitTests.cs
@@ -154,7 +154,6 @@ public async Task TestPreprocessorDirectivesAsync()
 using Microsoft.VisualStudio;
 using static System.String;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using System.Threading;
 using System.Threading.Tasks;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1217UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1217UnitTests.cs
@@ -211,7 +211,6 @@ public async Task TestPreprocessorDirectivesAsync()
 using Microsoft.VisualStudio;
 using static System.Tuple;
 using MyList = System.Collections.Generic.List<int>;
-
 #if true
 using static System.Math;
 using static System.String;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/UsingCodeFixProviderCombinedSystemDirectivesUnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/UsingCodeFixProviderCombinedSystemDirectivesUnitTests.cs
@@ -6,6 +6,7 @@ namespace StyleCop.Analyzers.Test.OrderingRules
     using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
+    using Analyzers.Settings.ObjectModel;
     using Microsoft.CodeAnalysis.CodeFixes;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.OrderingRules;
@@ -18,7 +19,7 @@ namespace StyleCop.Analyzers.Test.OrderingRules
     /// </summary>
     public class UsingCodeFixProviderCombinedSystemDirectivesUnitTests : CodeFixVerifier
     {
-        private bool suppressSA1200;
+        private UsingDirectivesPlacement usingDirectivesPlacement;
 
         /// <summary>
         /// Verifies that the code fix will properly reorder using statements.
@@ -136,7 +137,7 @@ public class Bar
 using System.Collections.Generic;
 using static System.Math;
 using static System.String;
-using MyFunc = System.Func<int,bool>;
+using MyFunc = System.Func<int, bool>;
 using SystemAction = System.Action;
 
 namespace NamespaceName
@@ -147,7 +148,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -186,7 +187,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -229,7 +230,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -272,7 +273,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -399,14 +400,25 @@ public class Bar
         /// <inheritdoc/>
         protected override IEnumerable<string> GetDisabledDiagnostics()
         {
-            if (this.suppressSA1200)
-            {
-                yield return SA1200UsingDirectivesMustBePlacedCorrectly.DiagnosticId;
-            }
-
             yield return SA1208SystemUsingDirectivesMustBePlacedBeforeOtherUsingDirectives.DiagnosticId;
         }
 
+        /// <inheritdoc/>
+        protected override string GetSettings()
+        {
+            string testSettings = $@"
+{{
+  ""settings"": {{
+    ""orderingRules"": {{
+      ""usingDirectivesPlacement"": ""{this.usingDirectivesPlacement}""
+    }}
+  }}
+}}
+";
+
+            return testSettings;
+        }
+
         /// <inheritdoc/>
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/UsingCodeFixProviderUnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/UsingCodeFixProviderUnitTests.cs
@@ -6,6 +6,7 @@ namespace StyleCop.Analyzers.Test.OrderingRules
     using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
+    using Analyzers.Settings.ObjectModel;
     using Microsoft.CodeAnalysis.CodeFixes;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.OrderingRules;
@@ -17,7 +18,7 @@ namespace StyleCop.Analyzers.Test.OrderingRules
     /// </summary>
     public class UsingCodeFixProviderUnitTests : CodeFixVerifier
     {
-        private bool suppressSA1200;
+        private UsingDirectivesPlacement usingDirectivesPlacement;
 
         /// <summary>
         /// Verifies that the code fix will properly reorder using statements.
@@ -135,7 +136,7 @@ public class Bar
 using Microsoft.CodeAnalysis;
 using static System.Math;
 using static System.String;
-using MyFunc = System.Func<int,bool>;
+using MyFunc = System.Func<int, bool>;
 using SystemAction = System.Action;
 
 namespace Foo
@@ -146,7 +147,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -185,7 +186,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -228,7 +229,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -271,7 +272,7 @@ public class Bar
 }
 ";
 
-            this.suppressSA1200 = true;
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.OutsideNamespace;
             await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
@@ -570,12 +571,19 @@ public class Haddock { }
         }
 
         /// <inheritdoc/>
-        protected override IEnumerable<string> GetDisabledDiagnostics()
+        protected override string GetSettings()
         {
-            if (this.suppressSA1200)
-            {
-                yield return SA1200UsingDirectivesMustBePlacedCorrectly.DiagnosticId;
-            }
+            string testSettings = $@"
+{{
+  ""settings"": {{
+    ""orderingRules"": {{
+      ""usingDirectivesPlacement"": ""{this.usingDirectivesPlacement}""
+    }}
+  }}
+}}
+";
+
+            return testSettings;
         }
 
         /// <inheritdoc/>

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ namespace TestNamespace`
`77`	`77`
`78`	`78`	`await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);`
`79`	`79`	`await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);`
`80`		`- ////await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);`
	`80`	`+ await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/// <summary>`
`@@ -112,7 +112,7 @@ namespace System`
`112`	`112`
`113`	`113`	`await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);`
`114`	`114`	`await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);`
`115`		`- ////await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);`
	`115`	`+ await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`/// <summary>`
`@@ -172,7 +172,7 @@ namespace TestNamespace`
`172`	`172`
`173`	`173`	`await this.VerifyCSharpDiagnosticAsync(testCode, expectedResults, CancellationToken.None).ConfigureAwait(false);`
`174`	`174`	`await this.VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);`
`175`		`- ////await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);`
	`175`	`+ await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);`
`176`	`176`	`}`
`177`	`177`
`178`	`178`	`/// <summary>`