Got rid of ConventionReportFailure

Jake Ginnivan · Jake Ginnivan · commit 768b4446a7f9 · 2013-09-01T11:15:12.000+01:00
diff --git a/TestStack.ConventionTests.Tests/ConventionAssertionClassTests.cs b/TestStack.ConventionTests.Tests/ConventionAssertionClassTests.cs
@@ -2,7 +2,6 @@
 {
     using ApprovalTests.Reporters;
     using NUnit.Framework;
-    using TestStack.ConventionTests.Internal;
 
     [TestFixture]
     [UseReporter(typeof(QuietReporter))] //NOTE: Can we take care of this in IsWithApprovedExceptions?
@@ -19,19 +18,14 @@ public void approval_mismatch()
             StringAssert.Contains("does not match approved file", ex.Message);
         }
 
-        public class FakeData : IConventionData
+        class FakeData : IConventionData
         {
             public string Description { get { return "Fake data"; } }
 
             public bool HasData { get { return true; } }
-
-            public ConventionReportFailure Format(string failingData)
-            {
-                return new ConventionReportFailure(failingData);
-            }
         }
 
-        public class FailingConvention : IConvention<FakeData>
+        class FailingConvention : IConvention<FakeData>
         {
             public void Execute(FakeData data, IConventionResultContext result)
             {
diff --git a/TestStack.ConventionTests/Internal/ConventionContext.cs b/TestStack.ConventionTests/Internal/ConventionContext.cs
@@ -33,7 +33,7 @@ ITestResultProcessor IConventionFormatContext.TestResultProcessor
             get { return testResultProcessor; }
         }
 
-        ConventionReportFailure IConventionFormatContext.FormatData(object failingData)
+        string IConventionFormatContext.FormatDataAsString(object failingData)
         {
             IReportDataFormatter formatter = formatters.FirstOrDefault(f => f.CanFormat(failingData));
             if (formatter == null)
@@ -43,7 +43,7 @@ ConventionReportFailure IConventionFormatContext.FormatData(object failingData)
                     " has no formatter, add one with `Convention.Formatters.Add(new MyDataFormatter());`");
             }
 
-            return formatter.Format(failingData);
+            return formatter.FormatString(failingData);
         }
 
         void IConventionResultContext.Is<TResult>(string resultTitle, IEnumerable<TResult> failingData)
diff --git a/TestStack.ConventionTests/Internal/ConventionReportFailure.cs b/TestStack.ConventionTests/Internal/ConventionReportFailure.cs
diff --git a/TestStack.ConventionTests/Internal/IConventionFormatContext.cs b/TestStack.ConventionTests/Internal/IConventionFormatContext.cs
@@ -4,7 +4,7 @@
 
     public interface IConventionFormatContext
     {
-        ConventionReportFailure FormatData(object failingData);
+        string FormatDataAsString(object failingData);
         ITestResultProcessor TestResultProcessor { get; }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/ConventionReportTextRenderer.cs b/TestStack.ConventionTests/Reporting/ConventionReportTextRenderer.cs
@@ -25,7 +25,7 @@ static void RenderItems(ConventionResult resultInfo, StringBuilder stringBuilder
             foreach (var conventionFailure in resultInfo.Data)
             {
                 stringBuilder.Append("\t");
-                stringBuilder.AppendLine(context.FormatData(conventionFailure).ToString());
+                stringBuilder.AppendLine(context.FormatDataAsString(conventionFailure));
             }
         }
     }
diff --git a/TestStack.ConventionTests/Reporting/ConvertibleFormatter.cs b/TestStack.ConventionTests/Reporting/ConvertibleFormatter.cs
@@ -3,7 +3,6 @@ namespace TestStack.ConventionTests.Reporting
     using System;
     using System.Diagnostics;
     using System.Globalization;
-    using TestStack.ConventionTests.Internal;
 
     public class ConvertibleFormatter : IReportDataFormatter
     {
@@ -12,11 +11,11 @@ public bool CanFormat(object failingData)
             return failingData is IConvertible;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
             var convertible = failingData as IConvertible;
             Debug.Assert(convertible != null, "convertible != null");
-            return new ConventionReportFailure(convertible.ToString(CultureInfo.InvariantCulture));
+            return convertible.ToString(CultureInfo.InvariantCulture);
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/DefaultFormatter.cs b/TestStack.ConventionTests/Reporting/DefaultFormatter.cs
@@ -27,7 +27,7 @@ string Describe(PropertyInfo property)
 
         public string[] DesribeItem(object result, IConventionFormatContext context)
         {
-            return properties.Select(p => context.FormatData(p.GetValue(result, null)).ToString()).ToArray();
+            return properties.Select(p => context.FormatDataAsString(p.GetValue(result, null)).ToString()).ToArray();
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/FallbackFormatter.cs b/TestStack.ConventionTests/Reporting/FallbackFormatter.cs
@@ -1,18 +1,17 @@
 ﻿namespace TestStack.ConventionTests.Reporting
 {
-    using TestStack.ConventionTests.Internal;
-
     public class FallbackFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
             return true;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
-            // TODO: for now
-            return new ConventionReportFailure(failingData.ToString());
+            if (failingData == null)
+                return "<null>";
+            return failingData.ToString();
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/IReportDataFormatter.cs b/TestStack.ConventionTests/Reporting/IReportDataFormatter.cs
@@ -1,10 +1,8 @@
 ﻿namespace TestStack.ConventionTests.Reporting
 {
-    using TestStack.ConventionTests.Internal;
-
     public interface IReportDataFormatter
     {
         bool CanFormat(object failingData);
-        ConventionReportFailure Format(object failingData);
+        string FormatString(object failingData);
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/MethodInfoDataFormatter.cs b/TestStack.ConventionTests/Reporting/MethodInfoDataFormatter.cs
@@ -1,22 +1,19 @@
-namespace TestStack.ConventionTests.Reporting
+namespace TestStack.ConventionTests.Reporting
 {
-    using System.ComponentModel;
     using System.Reflection;
-    using ApprovalTests.Namers;
-    using TestStack.ConventionTests.Internal;
 
-    public class MethodInfoDataFormatter : IReportDataFormatter
-    {
-        public bool CanFormat(object failingData)
-        {
-            return failingData is MethodInfo;
-        }
-
-        public ConventionReportFailure Format(object failingData)
-        {
-            var methodInfo = (MethodInfo)failingData;
-
-            return new ConventionReportFailure(methodInfo.DeclaringType + "." + methodInfo.Name);
-        }
-    }
+    public class MethodInfoDataFormatter : IReportDataFormatter
+    {
+        public bool CanFormat(object failingData)
+        {
+            return failingData is MethodInfo;
+        }
+
+        public string FormatString(object failingData)
+        {
+            var methodInfo = (MethodInfo)failingData;
+
+            return methodInfo.DeclaringType + "." + methodInfo.Name;
+        }
+    }
 }
diff --git a/TestStack.ConventionTests/Reporting/ProjectFileFormatter.cs b/TestStack.ConventionTests/Reporting/ProjectFileFormatter.cs
@@ -1,18 +1,17 @@
 namespace TestStack.ConventionTests.Reporting
 {
-    using TestStack.ConventionTests.ConventionData;
-    using TestStack.ConventionTests.Internal;
-
+    using TestStack.ConventionTests.ConventionData;
+
     public class ProjectFileFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
             return failingData is ProjectFileItem;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
-            return new ConventionReportFailure(((ProjectFileItem)failingData).FilePath);
+            return ((ProjectFileItem)failingData).FilePath;
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/ProjectReferenceFormatter.cs b/TestStack.ConventionTests/Reporting/ProjectReferenceFormatter.cs
@@ -1,18 +1,17 @@
 namespace TestStack.ConventionTests.Reporting
 {
-    using TestStack.ConventionTests.ConventionData;
-    using TestStack.ConventionTests.Internal;
-
+    using TestStack.ConventionTests.ConventionData;
+
     public class ProjectReferenceFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
             return failingData is ProjectReference;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
-            return new ConventionReportFailure(((ProjectReference)failingData).ReferencedPath);
+            return ((ProjectReference)failingData).ReferencedPath;
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/StringDataFormatter.cs b/TestStack.ConventionTests/Reporting/StringDataFormatter.cs
@@ -1,17 +1,15 @@
 ﻿namespace TestStack.ConventionTests.Reporting
-{
-    using TestStack.ConventionTests.Internal;
-
+{
     public class StringDataFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
             return failingData is string;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
-            return new ConventionReportFailure((string)failingData);
+            return (string)failingData;
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/TypeDataFormatter.cs b/TestStack.ConventionTests/Reporting/TypeDataFormatter.cs
@@ -1,18 +1,17 @@
 namespace TestStack.ConventionTests.Reporting
 {
-    using System;
-    using TestStack.ConventionTests.Internal;
-
+    using System;
+
     public class TypeDataFormatter : IReportDataFormatter
     {
         public bool CanFormat(object failingData)
         {
             return failingData is Type;
         }
 
-        public ConventionReportFailure Format(object failingData)
+        public string FormatString(object failingData)
         {
-            return new ConventionReportFailure(((Type)failingData).FullName);
+            return ((Type)failingData).FullName;
         }
     }
 }
diff --git a/TestStack.ConventionTests/TestStack.ConventionTests.csproj b/TestStack.ConventionTests/TestStack.ConventionTests.csproj
@@ -64,7 +64,6 @@
     <Compile Include="IConventionResultContext.cs" />
     <Compile Include="Conventions\ApiControllerNamingAndBaseClassConvention.cs" />
     <Compile Include="Conventions\MvcControllerNameAndBaseClassConvention.cs" />
-    <Compile Include="Internal\ConventionReportFailure.cs" />
     <Compile Include="Internal\ConventionContext.cs" />
     <Compile Include="Internal\ConventionResult.cs" />
     <Compile Include="Internal\ConventionTestsApprovalTextWriter.cs" />

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`{`
`3`	`3`	`using ApprovalTests.Reporters;`
`4`	`4`	`using NUnit.Framework;`
`5`		`- using TestStack.ConventionTests.Internal;`
`6`	`5`
`7`	`6`	`[TestFixture]`
`8`	`7`	`[UseReporter(typeof(QuietReporter))] //NOTE: Can we take care of this in IsWithApprovedExceptions?`
`@@ -19,19 +18,14 @@ public void approval_mismatch()`
`19`	`18`	`StringAssert.Contains("does not match approved file", ex.Message);`
`20`	`19`	`}`
`21`	`20`
`22`		`- public class FakeData : IConventionData`
	`21`	`+ class FakeData : IConventionData`
`23`	`22`	`{`
`24`	`23`	`public string Description { get { return "Fake data"; } }`
`25`	`24`
`26`	`25`	`public bool HasData { get { return true; } }`
`27`		`-`
`28`		`- public ConventionReportFailure Format(string failingData)`
`29`		`- {`
`30`		`- return new ConventionReportFailure(failingData);`
`31`		`- }`
`32`	`26`	`}`
`33`	`27`
`34`		`- public class FailingConvention : IConvention<FakeData>`
	`28`	`+ class FailingConvention : IConvention<FakeData>`
`35`	`29`	`{`
`36`	`30`	`public void Execute(FakeData data, IConventionResultContext result)`
`37`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ ITestResultProcessor IConventionFormatContext.TestResultProcessor`
`33`	`33`	`get { return testResultProcessor; }`
`34`	`34`	`}`
`35`	`35`
`36`		`- ConventionReportFailure IConventionFormatContext.FormatData(object failingData)`
	`36`	`+ string IConventionFormatContext.FormatDataAsString(object failingData)`
`37`	`37`	`{`
`38`	`38`	`IReportDataFormatter formatter = formatters.FirstOrDefault(f => f.CanFormat(failingData));`
`39`	`39`	`if (formatter == null)`
`@@ -43,7 +43,7 @@ ConventionReportFailure IConventionFormatContext.FormatData(object failingData)`
`43`	`43`	" has no formatter, add one with `Convention.Formatters.Add(new MyDataFormatter());`");
`44`	`44`	`}`
`45`	`45`
`46`		`- return formatter.Format(failingData);`
	`46`	`+ return formatter.FormatString(failingData);`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`void IConventionResultContext.Is<TResult>(string resultTitle, IEnumerable<TResult> failingData)`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`public interface IConventionFormatContext`
`6`	`6`	`{`
`7`		`- ConventionReportFailure FormatData(object failingData);`
	`7`	`+ string FormatDataAsString(object failingData);`
`8`	`8`	`ITestResultProcessor TestResultProcessor { get; }`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ static void RenderItems(ConventionResult resultInfo, StringBuilder stringBuilder`
`25`	`25`	`foreach (var conventionFailure in resultInfo.Data)`
`26`	`26`	`{`
`27`	`27`	`stringBuilder.Append("\t");`
`28`		`- stringBuilder.AppendLine(context.FormatData(conventionFailure).ToString());`
	`28`	`+ stringBuilder.AppendLine(context.FormatDataAsString(conventionFailure));`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@ namespace TestStack.ConventionTests.Reporting`
`3`	`3`	`using System;`
`4`	`4`	`using System.Diagnostics;`
`5`	`5`	`using System.Globalization;`
`6`		`- using TestStack.ConventionTests.Internal;`
`7`	`6`
`8`	`7`	`public class ConvertibleFormatter : IReportDataFormatter`
`9`	`8`	`{`
`@@ -12,11 +11,11 @@ public bool CanFormat(object failingData)`
`12`	`11`	`return failingData is IConvertible;`
`13`	`12`	`}`
`14`	`13`
`15`		`- public ConventionReportFailure Format(object failingData)`
	`14`	`+ public string FormatString(object failingData)`
`16`	`15`	`{`
`17`	`16`	`var convertible = failingData as IConvertible;`
`18`	`17`	`Debug.Assert(convertible != null, "convertible != null");`
`19`		`- return new ConventionReportFailure(convertible.ToString(CultureInfo.InvariantCulture));`
	`18`	`+ return convertible.ToString(CultureInfo.InvariantCulture);`
`20`	`19`	`}`
`21`	`20`	`}`
`22`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ string Describe(PropertyInfo property)`
`27`	`27`
`28`	`28`	`public string[] DesribeItem(object result, IConventionFormatContext context)`
`29`	`29`	`{`
`30`		`- return properties.Select(p => context.FormatData(p.GetValue(result, null)).ToString()).ToArray();`
	`30`	`+ return properties.Select(p => context.FormatDataAsString(p.GetValue(result, null)).ToString()).ToArray();`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,17 @@`
`1`	`1`	`namespace TestStack.ConventionTests.Reporting`
`2`	`2`	`{`
`3`		`- using TestStack.ConventionTests.Internal;`
`4`		`-`
`5`	`3`	`public class FallbackFormatter : IReportDataFormatter`
`6`	`4`	`{`
`7`	`5`	`public bool CanFormat(object failingData)`
`8`	`6`	`{`
`9`	`7`	`return true;`
`10`	`8`	`}`
`11`	`9`
`12`		`- public ConventionReportFailure Format(object failingData)`
	`10`	`+ public string FormatString(object failingData)`
`13`	`11`	`{`
`14`		`- // TODO: for now`
`15`		`- return new ConventionReportFailure(failingData.ToString());`
	`12`	`+ if (failingData == null)`
	`13`	`+ return "<null>";`
	`14`	`+ return failingData.ToString();`
`16`	`15`	`}`
`17`	`16`	`}`
`18`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,8 @@`
`1`	`1`	`namespace TestStack.ConventionTests.Reporting`
`2`	`2`	`{`
`3`		`- using TestStack.ConventionTests.Internal;`
`4`		`-`
`5`	`3`	`public interface IReportDataFormatter`
`6`	`4`	`{`
`7`	`5`	`bool CanFormat(object failingData);`
`8`		`- ConventionReportFailure Format(object failingData);`
	`6`	`+ string FormatString(object failingData);`
`9`	`7`	`}`
`10`	`8`	`}`