Simplified ApiControllerConvention by inheiriting from MvcControllerConvention

Author: Jake Ginnivan

TestStack.ConventionTests.Tests/MvcConventions.api_controller_conventions.approved.txt

@@ -1,5 +1,5 @@
-Failed: 'WebApi controllers must be suffixed with Controller' for 'TestAssembly'
---------------------------------------------------------------------------------
+Failed: 'Api Controllers must be suffixed with Controller' for 'TestAssembly'
+-----------------------------------------------------------------------------
 
 	TestAssembly.Controllers.BarApiControler
 

TestStack.ConventionTests.Tests/MvcConventions.controller_conventions.approved.txt

@@ -1,4 +1,4 @@
-Failed: 'Mvc controllers must be suffixed with Controller' for 'TestAssembly'
+Failed: 'Mvc Controllers must be suffixed with Controller' for 'TestAssembly'
 -----------------------------------------------------------------------------
 
 	TestAssembly.Controllers.FooControler

TestStack.ConventionTests/Conventions/ApiControllerConvention.cs

@@ -1,40 +1,20 @@
 namespace TestStack.ConventionTests.Conventions
 {
     using System;
+    using System.Collections.Generic;
     using System.Linq;
     using TestStack.ConventionTests.ConventionData;
 
-    public class ApiControllerConvention : IConvention<Types>
+    public class ApiControllerConvention : MvcControllerConvention
     {
-        public void Execute(Types data, IConventionResult result)
+        protected override IEnumerable<Type> GetControllers(Types data)
         {
-            var controllers = data.TypesToVerify.Where(IsWebApiController);
-            var typesWhichDoNotEndInController = controllers.Where(c => !c.Name.EndsWith("Controller"));
-
-            var typesWhichEndInController = data.TypesToVerify.Where(t => t.Name.EndsWith("Controller"));
-            var controllersWhichDoNotInheritFromController =
-                typesWhichEndInController.Where(t => !IsMvcController(t) && !IsWebApiController(t));
-
-            result.IsSymmetric(
-                "WebApi controllers must be suffixed with Controller", typesWhichDoNotEndInController,
-                "Types named *Controller must inherit from ApiController or Controller",
-                controllersWhichDoNotInheritFromController);
-        }
-
-        static bool IsMvcController(Type arg)
-        {
-            var isController = arg.FullName == "System.Web.Mvc.Controller";
-            if (arg.BaseType == null)
-                return isController;
-            return isController || IsMvcController(arg.BaseType);
+            return data.TypesToVerify.Where(IsWebApiController);
         }
 
-        static bool IsWebApiController(Type arg)
+        protected override string GetControllerTypeName()
         {
-            var isController = arg.FullName == "System.Web.Http.ApiController";
-            if (arg.BaseType == null)
-                return isController;
-            return isController || IsWebApiController(arg.BaseType);
+            return "Api Controller";
         }
     }
 }

TestStack.ConventionTests/Conventions/MvcControllerConvention.cs

@@ -1,26 +1,37 @@
 namespace TestStack.ConventionTests.Conventions
 {
     using System;
+    using System.Collections.Generic;
     using System.Linq;
     using TestStack.ConventionTests.ConventionData;
 
     public class MvcControllerConvention : IConvention<Types>
     {
-        public void Execute(Types data, IConventionResult result)
+        public void Execute(Types data, IConventionResultContext result)
         {
-            var controllers = data.TypesToVerify.Where(IsMvcController);
+            var controllers = GetControllers(data);
             var typesWhichDoNotEndInController = controllers.Where(c => !c.Name.EndsWith("Controller"));
 
             var typesWhichEndInController = data.TypesToVerify.Where(t => t.Name.EndsWith("Controller"));
             var controllersWhichDoNotInheritFromController =
                 typesWhichEndInController.Where(t => !IsMvcController(t) && !IsWebApiController(t));
 
             result.IsSymmetric(
-                "Mvc controllers must be suffixed with Controller", typesWhichDoNotEndInController,
+                GetControllerTypeName() + "s must be suffixed with Controller", typesWhichDoNotEndInController,
                 "Types named *Controller must inherit from ApiController or Controller",
                 controllersWhichDoNotInheritFromController);
         }
 
+        protected virtual string GetControllerTypeName()
+        {
+            return "Mvc Controller";
+        }
+
+        protected virtual IEnumerable<Type> GetControllers(Types data)
+        {
+            return data.TypesToVerify.Where(IsMvcController);
+        }
+
         static bool IsMvcController(Type arg)
         {
             var isController = arg.FullName == "System.Web.Mvc.Controller";
@@ -29,7 +40,7 @@ static bool IsMvcController(Type arg)
             return isController || IsMvcController(arg.BaseType);
         }
 
-        static bool IsWebApiController(Type arg)
+        protected static bool IsWebApiController(Type arg)
         {
             var isController = arg.FullName == "System.Web.Http.ApiController";
             if (arg.BaseType == null)

TestStack.ConventionTests/TestStack.ConventionTests.csproj

@@ -63,7 +63,6 @@
     <Compile Include="IConventionResultContext.cs" />
     <Compile Include="Conventions\ApiControllerConvention.cs" />
     <Compile Include="Conventions\MvcControllerConvention.cs" />
-    <Compile Include="IConventionResult.cs" />
     <Compile Include="Internal\ConventionReportFailure.cs" />
     <Compile Include="Internal\ConventionContext.cs" />
     <Compile Include="Internal\ConventionResult.cs" />