Add Title property to Error class. (#7)

Choc13 · web-flow · commit 6e60239f38c3 · 2019-03-26T10:45:55.000Z
diff --git a/Winton.DomainModelling.Abstractions.sln b/Winton.DomainModelling.Abstractions.sln
@@ -6,7 +6,12 @@ MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{859C9252-D63B-4ECB-9AB5-0BA8415C76AE}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
+		.travis.yml = .travis.yml
+		appveyor.yml = appveyor.yml
+		CONTRIBUTING.md = CONTRIBUTING.md
 		GitVersion.yml = GitVersion.yml
+		icon.jpg = icon.jpg
+		LICENSE = LICENSE
 		README.md = README.md
 		stylecop.json = stylecop.json
 	EndProjectSection
diff --git a/src/Winton.DomainModelling.Abstractions/Error.cs b/src/Winton.DomainModelling.Abstractions/Error.cs
@@ -21,16 +21,23 @@ public class Error
         /// <summary>
         ///     Initializes a new instance of the <see cref="Error" /> class.
         /// </summary>
+        /// <param name="title">The title for this type of error.</param>
         /// <param name="detail">The detail that describes the error.</param>
         /// <returns>A new instance of <see cref="Error" />.</returns>
-        public Error(string detail)
+        public Error(string title, string detail)
         {
+            Title = title;
             Detail = detail;
         }
 
         /// <summary>
         ///     Gets the detail that describes the error.
         /// </summary>
         public string Detail { get; }
+
+        /// <summary>
+        ///     Gets the title of the error. This should be the same for all instances of the same error type.
+        /// </summary>
+        public string Title { get; }
     }
 }
diff --git a/src/Winton.DomainModelling.Abstractions/NotFoundError.cs b/src/Winton.DomainModelling.Abstractions/NotFoundError.cs
@@ -15,7 +15,7 @@ public class NotFoundError : Error
         /// <param name="detail">The detail that describes the error.</param>
         /// <returns>A new instance of <see cref="NotFoundError" />.</returns>
         public NotFoundError(string detail)
-            : base(detail)
+            : base("Not found", detail)
         {
         }
     }
diff --git a/src/Winton.DomainModelling.Abstractions/UnauthorizedError.cs b/src/Winton.DomainModelling.Abstractions/UnauthorizedError.cs
@@ -15,7 +15,7 @@ public class UnauthorizedError : Error
         /// <param name="detail">The detail that describes the error.</param>
         /// <returns>A new instance of <see cref="UnauthorizedError" />.</returns>
         public UnauthorizedError(string detail)
-            : base(detail)
+            : base("Unauthorized", detail)
         {
         }
     }
diff --git a/test/Winton.DomainModelling.Abstractions.Tests/AsyncResultExtensionsTests.cs b/test/Winton.DomainModelling.Abstractions.Tests/AsyncResultExtensionsTests.cs
@@ -23,9 +23,9 @@ public sealed class Then : AsyncResultExtensionsTests
                 },
                 new object[]
                 {
-                    Task.FromResult<Result<int>>(new Failure<int>(new Error("Boom!"))),
+                    Task.FromResult<Result<int>>(new Failure<int>(new Error("Error", "Boom!"))),
                     new Func<int, Result<int>>(i => new Success<int>(i + 1)),
-                    new Failure<int>(new Error("Boom!"))
+                    new Failure<int>(new Error("Error", "Boom!"))
                 }
             };
 
@@ -39,9 +39,9 @@ public sealed class Then : AsyncResultExtensionsTests
                 },
                 new object[]
                 {
-                    Task.FromResult<Result<int>>(new Failure<int>(new Error("Boom!"))),
+                    Task.FromResult<Result<int>>(new Failure<int>(new Error("Error", "Boom!"))),
                     new Func<int, Task<Result<int>>>(i => Task.FromResult<Result<int>>(new Success<int>(i + 1))),
-                    new Failure<int>(new Error("Boom!"))
+                    new Failure<int>(new Error("Error", "Boom!"))
                 }
             };
 
diff --git a/test/Winton.DomainModelling.Abstractions.Tests/FailureTests.cs b/test/Winton.DomainModelling.Abstractions.Tests/FailureTests.cs
@@ -14,25 +14,25 @@ public sealed class Combine : FailureTests
             [Fact]
             private void ShouldCombineErrorsIfTheOtherResultIsAFailure()
             {
-                var failure = new Failure<int>(new Error("Ka"));
+                var failure = new Failure<int>(new Error("Error", "Ka"));
 
                 Result<int> combined = failure.Combine(
-                    new Failure<int>(new Error("Boom!")),
+                    new Failure<int>(new Error("Error", "Boom!")),
                     (i, j) => i + j,
-                    (error, otherError) => new Error($"{error.Detail}-{otherError.Detail}"));
+                    (error, otherError) => new Error("Error", $"{error.Detail}-{otherError.Detail}"));
 
-                combined.Should().BeEquivalentTo(new Failure<int>(new Error("Ka-Boom!")));
+                combined.Should().BeEquivalentTo(new Failure<int>(new Error("Error", "Ka-Boom!")));
             }
 
             [Fact]
             private void ShouldReturnFailureWithOriginalErrorIfOtherIsASuccess()
             {
-                var failure = new Failure<int>(new Error("Ka"));
+                var failure = new Failure<int>(new Error("Error", "Ka"));
 
                 Result<int> combined = failure.Combine(
                     new Success<int>(2),
                     (i, j) => i + j,
-                    (error, otherError) => new Error($"{error.Detail}-{otherError.Detail}"));
+                    (error, otherError) => new Error("Error", $"{error.Detail}-{otherError.Detail}"));
 
                 combined.Should().BeEquivalentTo(failure);
             }
@@ -43,7 +43,7 @@ public sealed class Match : FailureTests
             [Fact]
             private void ShouldInvokeOnFailureFunc()
             {
-                var failure = new Failure<int>(new Error("Boom!"));
+                var failure = new Failure<int>(new Error("Error", "Boom!"));
 
                 bool matchedFailure = failure.Match(_ => false, _ => true);
 
@@ -56,7 +56,7 @@ public sealed class Select : FailureTests
             [Fact]
             private void ShouldReturnOriginalFailure()
             {
-                var failure = new Failure<int>(new Error("Boom!"));
+                var failure = new Failure<int>(new Error("Error", "Boom!"));
 
                 Result<string> result = failure.Select(i => $"{i}");
 
@@ -66,7 +66,7 @@ private void ShouldReturnOriginalFailure()
             [Fact]
             private async Task ShouldReturnOriginalFailureAsynchronously()
             {
-                var failure = new Failure<int>(new Error("Boom!"));
+                var failure = new Failure<int>(new Error("Error", "Boom!"));
 
                 Result<string> result = await failure.Select(i => Task.FromResult($"{i}"));
 
@@ -79,7 +79,7 @@ public sealed class Then : FailureTests
             [Fact]
             private void ShouldReturnFailureWithOriginalError()
             {
-                var failure = new Failure<int>(new Error("Boom!"));
+                var failure = new Failure<int>(new Error("Error", "Boom!"));
 
                 Result<int> result = failure.Then(i => new Success<int>(i + 1));
 
@@ -95,7 +95,7 @@ async Task<Result<int>> OnSuccess(int i)
                     return new Success<int>(i + 1);
                 }
 
-                var failure = new Failure<int>(new Error("Boom!"));
+                var failure = new Failure<int>(new Error("Error", "Boom!"));
 
                 Result<int> result = await failure.Then(OnSuccess);
 
diff --git a/test/Winton.DomainModelling.Abstractions.Tests/SuccessTests.cs b/test/Winton.DomainModelling.Abstractions.Tests/SuccessTests.cs
@@ -19,7 +19,7 @@ private void ShouldCombineDataElementsIfOtherResultIsASuccess()
                 Result<int> combined = success.Combine(
                     new Success<int>(2),
                     (i, j) => i + j,
-                    (error, otherError) => new Error($"{error.Detail}-{otherError.Detail}"));
+                    (error, otherError) => new Error("Error", $"{error.Detail}-{otherError.Detail}"));
 
                 combined.Should().BeEquivalentTo(new Success<int>(3));
             }
@@ -28,12 +28,12 @@ private void ShouldCombineDataElementsIfOtherResultIsASuccess()
             private void ShouldReturnFailureWithOtherErrorIfTheOtherResultIsAFailure()
             {
                 var success = new Success<int>(1);
-                var otherResult = new Failure<int>(new Error("Boom!"));
+                var otherResult = new Failure<int>(new Error("Error", "Boom!"));
 
                 Result<int> combined = success.Combine(
                     otherResult,
                     (i, j) => i + j,
-                    (error, otherError) => new Error($"{error.Detail}-{otherError.Detail}"));
+                    (error, otherError) => new Error("Error", $"{error.Detail}-{otherError.Detail}"));
 
                 combined.Should().BeEquivalentTo(otherResult);
             }

Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,23 @@ public class Error`
`21`	`21`	`/// <summary>`
`22`	`22`	`/// Initializes a new instance of the <see cref="Error" /> class.`
`23`	`23`	`/// </summary>`
	`24`	`+ /// <param name="title">The title for this type of error.</param>`
`24`	`25`	`/// <param name="detail">The detail that describes the error.</param>`
`25`	`26`	`/// <returns>A new instance of <see cref="Error" />.</returns>`
`26`		`- public Error(string detail)`
	`27`	`+ public Error(string title, string detail)`
`27`	`28`	`{`
	`29`	`+ Title = title;`
`28`	`30`	`Detail = detail;`
`29`	`31`	`}`
`30`	`32`
`31`	`33`	`/// <summary>`
`32`	`34`	`/// Gets the detail that describes the error.`
`33`	`35`	`/// </summary>`
`34`	`36`	`public string Detail { get; }`
	`37`	`+`
	`38`	`+ /// <summary>`
	`39`	`+ /// Gets the title of the error. This should be the same for all instances of the same error type.`
	`40`	`+ /// </summary>`
	`41`	`+ public string Title { get; }`
`35`	`42`	`}`
`36`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class NotFoundError : Error`
`15`	`15`	`/// <param name="detail">The detail that describes the error.</param>`
`16`	`16`	`/// <returns>A new instance of <see cref="NotFoundError" />.</returns>`
`17`	`17`	`public NotFoundError(string detail)`
`18`		`- : base(detail)`
	`18`	`+ : base("Not found", detail)`
`19`	`19`	`{`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class UnauthorizedError : Error`
`15`	`15`	`/// <param name="detail">The detail that describes the error.</param>`
`16`	`16`	`/// <returns>A new instance of <see cref="UnauthorizedError" />.</returns>`
`17`	`17`	`public UnauthorizedError(string detail)`
`18`		`- : base(detail)`
	`18`	`+ : base("Unauthorized", detail)`
`19`	`19`	`{`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ public sealed class Then : AsyncResultExtensionsTests`
`23`	`23`	`},`
`24`	`24`	`new object[]`
`25`	`25`	`{`
`26`		`- Task.FromResult<Result<int>>(new Failure<int>(new Error("Boom!"))),`
	`26`	`+ Task.FromResult<Result<int>>(new Failure<int>(new Error("Error", "Boom!"))),`
`27`	`27`	`new Func<int, Result<int>>(i => new Success<int>(i + 1)),`
`28`		`- new Failure<int>(new Error("Boom!"))`
	`28`	`+ new Failure<int>(new Error("Error", "Boom!"))`
`29`	`29`	`}`
`30`	`30`	`};`
`31`	`31`
`@@ -39,9 +39,9 @@ public sealed class Then : AsyncResultExtensionsTests`
`39`	`39`	`},`
`40`	`40`	`new object[]`
`41`	`41`	`{`
`42`		`- Task.FromResult<Result<int>>(new Failure<int>(new Error("Boom!"))),`
	`42`	`+ Task.FromResult<Result<int>>(new Failure<int>(new Error("Error", "Boom!"))),`
`43`	`43`	`new Func<int, Task<Result<int>>>(i => Task.FromResult<Result<int>>(new Success<int>(i + 1))),`
`44`		`- new Failure<int>(new Error("Boom!"))`
	`44`	`+ new Failure<int>(new Error("Error", "Boom!"))`
`45`	`45`	`}`
`46`	`46`	`};`
`47`	`47`