ASP001 handle parameter with type.

Author: JohanLarsson

AspNetCoreAnalyzers.Tests/ASP001ParameterNameTests/ValidCode.cs

@@ -65,6 +65,118 @@ public async Task<IActionResult> GetOrder(int id)
             AnalyzerAssert.Valid(Analyzer, order, db, code);
         }
 
+        [Test]
+        public void ImplicitOptionalFromRoute()
+        {
+            var order = @"
+namespace ValidCode
+{
+    public class Order
+    {
+        public int Id { get; set; }
+    }
+}";
+
+            var db = @"
+namespace ValidCode
+{
+    using Microsoft.EntityFrameworkCore;
+
+    public class Db : DbContext
+    {
+        public DbSet<Order> Orders { get; set; }
+    }
+}";
+            var code = @"
+namespace ValidCode
+{
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.EntityFrameworkCore;
+
+    [ApiController]
+    public class OrdersController : Controller
+    {
+        private readonly Db db;
+
+        public OrdersController(Db db)
+        {
+            this.db = db;
+        }
+
+        [HttpGet(""api/orders/{id?}"")]
+        public async Task<IActionResult> GetOrder(int? id)
+        {
+            var match = id == null 
+                            ? await this.db.Orders.FirstOrDefaultAsync()
+                            : await this.db.Orders.FirstOrDefaultAsync(x => x.Id == id);
+            if (match == null)
+            {
+                return this.NotFound();
+            }
+
+            return this.Ok(match);
+        }
+    }
+}";
+            AnalyzerAssert.Valid(Analyzer, order, db, code);
+        }
+
+        [Test]
+        public void ImplicitTypedFromRoute()
+        {
+            var order = @"
+namespace ValidCode
+{
+    public class Order
+    {
+        public int Id { get; set; }
+    }
+}";
+
+            var db = @"
+namespace ValidCode
+{
+    using Microsoft.EntityFrameworkCore;
+
+    public class Db : DbContext
+    {
+        public DbSet<Order> Orders { get; set; }
+    }
+}";
+            var code = @"
+namespace ValidCode
+{
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.EntityFrameworkCore;
+
+    [ApiController]
+    public class OrdersController : Controller
+    {
+        private readonly Db db;
+
+        public OrdersController(Db db)
+        {
+            this.db = db;
+        }
+
+        [HttpGet(""api/orders/{id:int}"")]
+        public async Task<IActionResult> GetOrder(int id)
+        {
+            var match = await this.db.Orders.FirstOrDefaultAsync(x => x.Id == id);
+            if (match == null)
+            {
+                return this.NotFound();
+            }
+
+            return this.Ok(match);
+        }
+    }
+}";
+            AnalyzerAssert.Valid(Analyzer, order, db, code);
+        }
+
         [Test]
         public void ExplicitFromRoute()
         {

AspNetCoreAnalyzers/ASP001ParameterName.cs

@@ -10,7 +10,7 @@ internal static class ASP001ParameterName
             id: DiagnosticId,
             title: "The parameter name does not match the url parameter.",
             messageFormat: "The parameter name does not match the url parameter.",
-            category: AnalyzerCategory.Correctness,
+            category: AnalyzerCategory.Routing,
             defaultSeverity: DiagnosticSeverity.Hidden,
             isEnabledByDefault: true,
             description: "The parameter name does not match the url parameter.",

AspNetCoreAnalyzers/ASP002MissingParameter.cs

@@ -10,7 +10,7 @@ internal static class ASP002MissingParameter
             id: DiagnosticId,
             title: "The method has no corresponding parameter.",
             messageFormat: "The method has no corresponding parameter.",
-            category: AnalyzerCategory.Correctness,
+            category: AnalyzerCategory.Routing,
             defaultSeverity: DiagnosticSeverity.Hidden,
             isEnabledByDefault: true,
             description: "The method has no corresponding parameter.",

AspNetCoreAnalyzers/AnalyzerCategory.cs

@@ -2,6 +2,6 @@ namespace AspNetCoreAnalyzers
 {
     internal static class AnalyzerCategory
     {
-        internal const string Correctness = "AspNetCoreAnalyzers.Correctness";
+        internal const string Routing = "AspNetCoreAnalyzers.Routing";
     }
 }

AspNetCoreAnalyzers/Analyzers/AttributeAnalyzer.cs

@@ -84,6 +84,17 @@ private static bool TryGetParameterName(string text, out string name)
                 end--;
             }
 
+            for (var i = start; i < end; i++)
+            {
+                switch (text[i])
+                {
+                    case '?':
+                    case ':':
+                        end = i;
+                        break;
+                }
+            }
+
             name = text.Substring(start, end - start);
             return true;
         }

documentation/ASP001.md

@@ -17,7 +17,7 @@
   </tr>
   <tr>
     <td>Category</td>
-    <td>AspNetCoreAnalyzers.Correctness</td>
+    <td>AspNetCoreAnalyzers.Routing</td>
   </tr>
   <tr>
     <td>Code</td>
@@ -88,7 +88,7 @@ Or put this at the top of the file to disable all instances.
 ### Via attribute `[SuppressMessage]`.
 
 ```C#
-[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Correctness", 
+[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing", 
     "ASP001:The parameter name does not match the url parameter.", 
     Justification = "Reason...")]
 ```

documentation/ASP002.md

@@ -17,7 +17,7 @@
   </tr>
   <tr>
     <td>Category</td>
-    <td>AspNetCoreAnalyzers.Correctness</td>
+    <td>AspNetCoreAnalyzers.Routing</td>
   </tr>
   <tr>
     <td>Code</td>
@@ -74,7 +74,7 @@ Or put this at the top of the file to disable all instances.
 ### Via attribute `[SuppressMessage]`.
 
 ```C#
-[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Correctness", 
+[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing", 
     "ASP002:The method has no corresponding parameter.", 
     Justification = "Reason...")]
 ```