Improved the generated convention title

Jake Ginnivan · Jake Ginnivan · commit a0a30884e43e · 2013-09-01T11:15:10.000+01:00
diff --git a/TestStack.ConventionTests.Tests/MvcConventions.api_controller_conventions.approved.txt b/TestStack.ConventionTests.Tests/MvcConventions.api_controller_conventions.approved.txt
@@ -1,10 +1,10 @@
-﻿'Api Controllers must be suffixed with Controller' for 'TestAssembly'
----------------------------------------------------------------------
+﻿'Api Controllers must be suffixed with Controller' for 'Types in TestAssembly'
+------------------------------------------------------------------------------
 
 	TestAssembly.Controllers.BarApiControler
 
-'Types named *Controller must inherit from ApiController or Controller' for 'TestAssembly'
-------------------------------------------------------------------------------------------
+'Types named *Controller must inherit from ApiController or Controller' for 'Types in TestAssembly'
+---------------------------------------------------------------------------------------------------
 
 	TestAssembly.Controllers.TestApiController
 	TestAssembly.Controllers.TestController
diff --git a/TestStack.ConventionTests.Tests/MvcConventions.controller_conventions.approved.txt b/TestStack.ConventionTests.Tests/MvcConventions.controller_conventions.approved.txt
@@ -1,10 +1,10 @@
-﻿'Mvc Controllers must be suffixed with Controller' for 'TestAssembly'
----------------------------------------------------------------------
+﻿'Mvc Controllers must be suffixed with Controller' for 'Types in TestAssembly'
+------------------------------------------------------------------------------
 
 	TestAssembly.Controllers.FooControler
 
-'Types named *Controller must inherit from ApiController or Controller' for 'TestAssembly'
-------------------------------------------------------------------------------------------
+'Types named *Controller must inherit from ApiController or Controller' for 'Types in TestAssembly'
+---------------------------------------------------------------------------------------------------
 
 	TestAssembly.Controllers.TestApiController
 	TestAssembly.Controllers.TestController
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj.approved.txt
@@ -1,4 +1,4 @@
-﻿'Project must not reference dlls from bin or obj directories' for 'TestStack.ConventionTests.Tests'
----------------------------------------------------------------------------------------------------
+﻿'Project must not reference dlls from bin or obj directories' for 'Project references in TestStack.ConventionTests.Tests'
+-------------------------------------------------------------------------------------------------------------------------
 
 	bin\Debug\ApprovalTests.dll
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj_with_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj_with_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
-﻿'Project must not reference dlls from bin or obj directories' for 'TestStack.ConventionTests.Tests'
----------------------------------------------------------------------------------------------------
+﻿'Project must not reference dlls from bin or obj directories' for 'Project references in TestStack.ConventionTests.Tests'
+-------------------------------------------------------------------------------------------------------------------------
 
 	bin\Debug\ApprovalTests.dll
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.cs b/TestStack.ConventionTests.Tests/ProjectBasedConventions.cs
@@ -57,7 +57,7 @@ public void scripts_not_embedded_resources()
                 .Returns(XDocument.Parse(Resources.ProjectFileWithInvalidSqlScriptFile));
 
             var projectLocator = Substitute.For<IProjectLocator>();
-            var project = new ProjectFiles(typeof (ProjectBasedConventions).Assembly, projectProvider, projectLocator);
+            var project = new ProjectFileItems(typeof (ProjectBasedConventions).Assembly, projectProvider, projectLocator);
             var ex = Assert.Throws<ConventionFailedException>(() => Convention.Is(new FilesAreEmbeddedResources(".sql"), project));
 
             Approvals.Verify(ex.Message);
@@ -67,7 +67,7 @@ public void scripts_not_embedded_resources()
         public void scripts_not_embedded_resources_with_approved_exceptions()
         {
             var projectLocator = Substitute.For<IProjectLocator>();
-            var project = new ProjectFiles(typeof (ProjectBasedConventions).Assembly, projectProvider, projectLocator);
+            var project = new ProjectFileItems(typeof (ProjectBasedConventions).Assembly, projectProvider, projectLocator);
             projectProvider
                 .LoadProjectDocument(Arg.Any<string>())
                 .Returns(XDocument.Parse(Resources.ProjectFileWithInvalidSqlScriptFile));
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources.approved.txt
@@ -1,4 +1,4 @@
-﻿'.sql Files must be embedded resources' for 'TestStack.ConventionTests.Tests'
------------------------------------------------------------------------------
+﻿'.sql Files must be embedded resources' for 'Project file items in TestStack.ConventionTests.Tests'
+---------------------------------------------------------------------------------------------------
 
 	Scripts\Script2.sql
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources_with_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources_with_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
-﻿'.sql Files must be embedded resources' for 'TestStack.ConventionTests.Tests'
------------------------------------------------------------------------------
+﻿'.sql Files must be embedded resources' for 'Project file items in TestStack.ConventionTests.Tests'
+---------------------------------------------------------------------------------------------------
 
 	Scripts\Script2.sql
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt
@@ -1,5 +1,5 @@
-﻿'Types must have a default constructor' for 'nHibernate Entitites'
-------------------------------------------------------------------
+﻿'Types must have a default constructor' for 'Types in nHibernate Entitites'
+---------------------------------------------------------------------------
 
 	TestAssembly.ClassWithNoDefaultCtor
 	TestAssembly.ClassWithPrivateDefaultCtor
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor_wth_approved_exceptions.approved.txt
@@ -1,5 +1,5 @@
-﻿'Types must have a default constructor' for 'nHibernate Entitites'
-------------------------------------------------------------------
+﻿'Types must have a default constructor' for 'Types in nHibernate Entitites'
+---------------------------------------------------------------------------
 
 	TestAssembly.ClassWithNoDefaultCtor
 	TestAssembly.ClassWithPrivateDefaultCtor
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt
@@ -1,4 +1,4 @@
-﻿'Methods must be virtual' for 'nHibernate Entitites'
-----------------------------------------------------
+﻿'Methods must be virtual' for 'Types in nHibernate Entitites'
+-------------------------------------------------------------
 
 	TestAssembly.SampleDomainClass.TestNonVirtual
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual_wth_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
-﻿'Methods must be virtual' for 'nHibernate Entitites'
-----------------------------------------------------
+﻿'Methods must be virtual' for 'Types in nHibernate Entitites'
+-------------------------------------------------------------
 
 	TestAssembly.SampleDomainClass.TestNonVirtual
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace.approved.txt
@@ -1,9 +1,9 @@
-﻿'Dtos must be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly'
--------------------------------------------------------------------------
+﻿'Dtos must be under the 'TestAssembly.Dtos' namespace' for 'Types in TestAssembly'
+----------------------------------------------------------------------------------
 
 	TestAssembly.SomeDto
 
-'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly'
----------------------------------------------------------------------------------
+'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'Types in TestAssembly'
+------------------------------------------------------------------------------------------
 
 	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
-﻿'Dtos must be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly'
--------------------------------------------------------------------------
+﻿'Dtos must be under the 'TestAssembly.Dtos' namespace' for 'Types in TestAssembly'
+----------------------------------------------------------------------------------
 
 	TestAssembly.SomeDto
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions1.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions1.approved.txt
@@ -1,4 +1,4 @@
-﻿'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly'
----------------------------------------------------------------------------------
+﻿'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'Types in TestAssembly'
+------------------------------------------------------------------------------------------
 
 	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests/Convention.cs b/TestStack.ConventionTests/Convention.cs
@@ -4,6 +4,7 @@
     using System.Collections.Generic;
     using System.IO;
     using System.Reflection;
+    using System.Text.RegularExpressions;
     using TestStack.ConventionTests.Internal;
     using TestStack.ConventionTests.Reporting;
 
@@ -53,14 +54,6 @@ public static void Is<TDataSource>(IConvention<TDataSource> convention, TDataSou
             Execute(convention, data, processors.ToArray());
         }
 
-        static void Execute<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
-            IResultsProcessor[] processors)
-            where TDataSource : IConventionData
-        {
-            var context = new ConventionContext(data.Description, Formatters, processors);
-            context.Execute(convention, data);
-        }
-
         public static void IsWithApprovedExeptions<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
             params IResultsProcessor[] extraResultProcessors)
             where TDataSource : IConventionData
@@ -74,5 +67,18 @@ public static void IsWithApprovedExeptions<TDataSource>(IConvention<TDataSource>
             };
             Execute(convention, data, processors.ToArray());
         }
+
+        static void Execute<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
+            IResultsProcessor[] processors)
+            where TDataSource : IConventionData
+        {
+            var context = new ConventionContext(string.Format("{0} in {1}", ToSentenceCase(data.GetType().Name), data.Description), Formatters, processors);
+            context.Execute(convention, data);
+        }
+
+        static string ToSentenceCase(string str)
+        {
+            return Regex.Replace(str, "[a-z][A-Z]", m => m.Value[0] + " " + char.ToLower(m.Value[1]));
+        }
     }
 }
diff --git a/TestStack.ConventionTests/ConventionData/AbstractProjectData.cs b/TestStack.ConventionTests/ConventionData/AbstractProjectData.cs
@@ -2,7 +2,6 @@
 {
     using System.Reflection;
     using System.Xml.Linq;
-    using TestStack.ConventionTests.Conventions;
     using TestStack.ConventionTests.Internal;
 
     public abstract class AbstractProjectData : IConventionData
diff --git a/TestStack.ConventionTests/ConventionData/ProjectFileItem.cs b/TestStack.ConventionTests/ConventionData/ProjectFileItem.cs
@@ -1,6 +1,6 @@
 ﻿namespace TestStack.ConventionTests.ConventionData
 {
-    public class ProjectFile
+    public class ProjectFileItem
     {
         public string FilePath { get; set; }
         public string ReferenceType { get; set; }
diff --git a/TestStack.ConventionTests/ConventionData/ProjectFileItems.cs b/TestStack.ConventionTests/ConventionData/ProjectFileItems.cs
@@ -5,14 +5,17 @@
     using System.Xml.Linq;
     using TestStack.ConventionTests.Internal;
 
-    public class ProjectFiles : AbstractProjectData
+    /// <summary>
+    /// Items/Files in a .*proj project file
+    /// </summary>
+    public class ProjectFileItems : AbstractProjectData
     {
-        public ProjectFiles(Assembly assembly, IProjectProvider projectProvider = null, IProjectLocator projectLocator = null)
+        public ProjectFilesItems(Assembly assembly, IProjectProvider projectProvider = null, IProjectLocator projectLocator = null)
             : base(assembly, projectProvider, projectLocator)
         {
         }
 
-        public ProjectFile[] Files
+        public ProjectFileItem[] Items
         {
             get
             {
@@ -23,7 +26,7 @@ public ProjectFile[] Files
                     .Elements(XName.Get("ItemGroup", msbuild))
                     .Elements()
                     .Select(refElem =>
-                        new ProjectFile
+                        new ProjectFileItem
                         {
                             ReferenceType = refElem.Name.LocalName,
                             FilePath = refElem.Attribute("Include").Value
diff --git a/TestStack.ConventionTests/Conventions/FilesAreEmbeddedResources.cs b/TestStack.ConventionTests/Conventions/FilesAreEmbeddedResources.cs
@@ -3,7 +3,7 @@
     using System.Linq;
     using TestStack.ConventionTests.ConventionData;
 
-    public class FilesAreEmbeddedResources : IConvention<ProjectFiles>
+    public class FilesAreEmbeddedResources : IConvention<ProjectFileItems>
     {
         public FilesAreEmbeddedResources(string fileExtension)
         {
@@ -12,11 +12,11 @@ public FilesAreEmbeddedResources(string fileExtension)
 
         public string FileExtension { get; private set; }
 
-        public void Execute(ProjectFiles data, IConventionResultContext result)
+        public void Execute(ProjectFileItems data, IConventionResultContext result)
         {
             result.Is(
                 string.Format("{0} Files must be embedded resources", FileExtension),
-                data.Files.Where(s => s.FilePath.EndsWith(FileExtension) && s.ReferenceType != "EmbeddedResource"));
+                data.Items.Where(s => s.FilePath.EndsWith(FileExtension) && s.ReferenceType != "EmbeddedResource"));
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/ProjectFileFormatter.cs b/TestStack.ConventionTests/Reporting/ProjectFileFormatter.cs
@@ -7,12 +7,12 @@ public class ProjectFileFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
-            return failingData is ProjectFile;
+            return failingData is ProjectFileItem;
         }
 
         public ConventionReportFailure Format(object failingData)
         {
-            return new ConventionReportFailure(((ProjectFile)failingData).FilePath);
+            return new ConventionReportFailure(((ProjectFileItem)failingData).FilePath);
         }
     }
 }
diff --git a/TestStack.ConventionTests/TestStack.ConventionTests.csproj b/TestStack.ConventionTests/TestStack.ConventionTests.csproj
@@ -81,8 +81,8 @@
     <Compile Include="Reporting\ThrowOnFailureResultsProcessor.cs" />
     <Compile Include="Conventions\ClassTypeHasSpecificNamespace.cs" />
     <Compile Include="Conventions\ConventionSourceInvalidException.cs" />
-    <Compile Include="ConventionData\ProjectFile.cs" />
-    <Compile Include="ConventionData\ProjectFiles.cs" />
+    <Compile Include="ConventionData\ProjectFileItem.cs" />
+    <Compile Include="ConventionData\ProjectFileItems.cs" />
     <Compile Include="ConventionData\ProjectReference.cs" />
     <Compile Include="ConventionData\ProjectReferences.cs" />
     <Compile Include="IConventionData.cs" />
