Merge pull request #46 from JakeGinnivan/AddedConventionReason

Adds convention reason to conventions, useful for the living documentati...

Author: kkozmic

TestStack.ConventionTests.Autofac/CanResolveAllRegisteredServices.cs

@@ -1,10 +1,10 @@
 namespace TestStack.ConventionTests.Autofac
 {
+    using global::Autofac;
+    using global::Autofac.Core;
     using System;
     using System.Collections.Generic;
     using System.Linq;
-    using global::Autofac;
-    using global::Autofac.Core;
 
     public class CanResolveAllRegisteredServices : IConvention<AutofacRegistrations>
     {
@@ -37,6 +37,14 @@ public void Execute(AutofacRegistrations data, IConventionResultContext result)
             result.Is("Can resolve all types registered with Autofac", failingTypes);
         }
 
+        public string ConventionReason
+        {
+            get
+            {
+                return "Container resolution failings are runtime exceptions, this convention allows you to detect missing registrations faster!";
+            }
+        }
+
         private IEnumerable<Type> GetGenericFactoryTypes(AutofacRegistrations data, IComponentRegistration componentRegistration)
         {
             return from ctorParameter in data.GetRegistrationCtorParameters(componentRegistration)

TestStack.ConventionTests.Autofac/ServicesShouldOnlyHaveDependenciesWithLesserLifetime.cs

@@ -1,7 +1,7 @@
 namespace TestStack.ConventionTests.Autofac
 {
-    using System.Collections.Generic;
     using global::Autofac.Core;
+    using System.Collections.Generic;
     using TestStack.ConventionTests.ConventionData;
 
     public class ServicesShouldOnlyHaveDependenciesWithLesserLifetime : IConvention<AutofacRegistrations>
@@ -37,5 +37,10 @@ public void Execute(AutofacRegistrations data, IConventionResultContext result)
 
             result.Is("Components should not depend on with greater lifetimes", exceptions);
         }
+
+        public string ConventionReason
+        {
+            get { return @"When classes with larger lifetimes depend on classes with smaller lifetimes this often indicates an error and can lead to subtle bugs"; }
+        }
     }
 }

TestStack.ConventionTests.Tests/ConventionAssertionClassTests.cs

@@ -31,6 +31,11 @@ public void Execute(FakeData data, IConventionResultContext result)
             {
                 result.Is("Header", new[] {"Different"});
             }
+
+            public string ConventionReason
+            {
+                get { return "Because fail.."; }
+            }
         }
     }
 }

TestStack.ConventionTests.Tests/ConventionFixture.cs

@@ -25,6 +25,8 @@ public void Execute(Types data, IConventionResultContext result)
                 // Oops, I forgot to set the result
             }
 
+            public string ConventionReason { get { return "Convention does not set result for testing"; } }
+
             bool IsBroken(Type type)
             {
                 return true;

TestStack.ConventionTests.Tests/TestConventions/CollectionsRelationsConvention.cs

@@ -29,6 +29,11 @@ from item in GetItemTypes(collection)
             result.Is("Some title", collectionToItemLookup);
         }
 
+        public string ConventionReason
+        {
+            get { return "Test convention"; }
+        }
+
         IEnumerable<Type> GetItemTypes(Type type)
         {
             return from @interface in type.GetInterfaces()

TestStack.ConventionTests/Convention.cs

@@ -3,7 +3,6 @@
     using System;
     using System.Collections.Generic;
     using System.Reflection;
-    using System.Text.RegularExpressions;
     using TestStack.ConventionTests.ConventionData;
     using TestStack.ConventionTests.Internal;
     using TestStack.ConventionTests.Reporting;

TestStack.ConventionTests/Conventions/AllClassesHaveDefaultConstructor.cs

@@ -10,5 +10,10 @@ public void Execute(Types data, IConventionResultContext result)
             result.Is("Types must have a default constructor",
                 data.TypesToVerify.Where(t => t.HasDefaultConstructor() == false));
         }
+
+        public string ConventionReason
+        {
+            get { return "This convention is useful when classes need to be proxied (nHibernate/Entity Framework entities), which need a public or protected constructor"; }
+        }
     }
 }

TestStack.ConventionTests/Conventions/AllMethodsAreVirtual.cs

@@ -9,5 +9,10 @@ public void Execute(Types data, IConventionResultContext result)
         {
             result.Is("Methods must be virtual", data.TypesToVerify.SelectMany(t => t.NonVirtualMethods()));
         }
+
+        public string ConventionReason
+        {
+            get { return "This convention is useful when classes need to be proxied (nHibernate entities), which need members to be virtual"; }
+        }
     }
 }

TestStack.ConventionTests/Conventions/ClassTypeHasSpecificNamespace.cs

@@ -41,6 +41,11 @@ public void Execute(Types data, IConventionResultContext result)
                 data.TypesToVerify);
         }
 
+        public string ConventionReason
+        {
+            get { return "To simplify project structure and allow developers to know where this type of class should live in the project"; }
+        }
+
         bool TypeLivesInSpecifiedNamespace(Type t)
         {
             return t.Namespace == null || t.Namespace.StartsWith(namespaceToCheck);

TestStack.ConventionTests/Conventions/FilesAreEmbeddedResources.cs

@@ -18,5 +18,7 @@ public void Execute(ProjectFileItems data, IConventionResultContext result)
                 string.Format("{0} Files must be embedded resources", FileExtension),
                 data.Items.Where(s => s.FilePath.EndsWith(FileExtension) && s.ReferenceType != "EmbeddedResource"));
         }
+
+        public string ConventionReason { get { return "Many files are added as 'Content' to visual studio projects, this convention enforces files with an extension are correctly set as Embedded Resources"; } }
     }
 }