Merge pull request #2 in TECHBUS/winton.domainmodelling.abstractions from feature/BT-6528 to master

* commit '5305b81eefc2f5a38c775f8b24521262d1c5cc33':
  Add solution items to VS.
  Add domain exceptions.

Author: Matthew Thornton

Winton.DomainModelling.Abstractions.sln

@@ -7,9 +7,18 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{697902B3-26B
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{02075BDC-A66D-4346-8093-2F2667660F36}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Winton.DomainModelling.Abstractions", "src\Winton.DomainModelling.Abstractions\Winton.DomainModelling.Abstractions.csproj", "{4CC49F58-367B-4E87-8925-49D913FA7BD1}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Winton.DomainModelling.Abstractions", "src\Winton.DomainModelling.Abstractions\Winton.DomainModelling.Abstractions.csproj", "{4CC49F58-367B-4E87-8925-49D913FA7BD1}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Winton.DomainModelling.Abstractions.Tests", "test\Winton.DomainModelling.Abstractions.Tests\Winton.DomainModelling.Abstractions.Tests.csproj", "{8FD5A9B0-44ED-470F-A0F0-721E55B5790D}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Winton.DomainModelling.Abstractions.Tests", "test\Winton.DomainModelling.Abstractions.Tests\Winton.DomainModelling.Abstractions.Tests.csproj", "{8FD5A9B0-44ED-470F-A0F0-721E55B5790D}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{859C9252-D63B-4ECB-9AB5-0BA8415C76AE}"
+	ProjectSection(SolutionItems) = preProject
+		.gitignore = .gitignore
+		GitVersionConfig.yaml = GitVersionConfig.yaml
+		Jenkinsfile = Jenkinsfile
+		README.md = README.md
+		stylecop.json = stylecop.json
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

src/Winton.DomainModelling.Abstractions/DomainException.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace Winton.DomainModelling
+{
+    /// <inheritdoc />
+    /// <summary>
+    ///     Represents domain errors.
+    /// </summary>
+    public class DomainException : Exception
+    {
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="DomainException" /> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public DomainException(string message)
+            : base(message)
+        {
+        }
+    }
+}

src/Winton.DomainModelling.Abstractions/EntityNotFoundException.cs

@@ -0,0 +1,23 @@
+using System;
+
+namespace Winton.DomainModelling
+{
+    /// <inheritdoc />
+    /// <summary>
+    ///     An error indicating that an entity could not be found.
+    /// </summary>
+    /// <typeparam name="TEntity">The type of entity.</typeparam>
+    /// <typeparam name="TEntityId">The type of entity id.</typeparam>
+    public class EntityNotFoundException<TEntity, TEntityId> : DomainException
+        where TEntity : Entity<TEntityId>
+        where TEntityId : IEquatable<TEntityId>
+    {
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="EntityNotFoundException{TEntity, TEntityId}" /> class.
+        /// </summary>
+        public EntityNotFoundException()
+            : base($"The specified {typeof(TEntity).Name} could not be found.")
+        {
+        }
+    }
+}

src/Winton.DomainModelling.Abstractions/UnauthorizedException.cs

@@ -0,0 +1,18 @@
+namespace Winton.DomainModelling
+{
+    /// <inheritdoc />
+    /// <summary>
+    ///     An error indicating that the action being performed is not authorized.
+    /// </summary>
+    public class UnauthorizedException : DomainException
+    {
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="UnauthorizedException" /> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        public UnauthorizedException(string message)
+            : base(message)
+        {
+        }
+    }
+}

stylecop.json

@@ -1,24 +1,22 @@
 {
-  "$schema":
-    "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/1.0.2/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
-  "settings": {
-    "documentationRules": {
-      "documentExposedElements": false,
-      "documentInterfaces": false,
-      "documentInternalElements": false,
-      "xmlHeader": false
-    },
-    "maintainabilityRules": {
-      "topLevelTypes": [
-        "class",
-        "enum",
-        "interface",
-        "struct"
-      ]
-    },
-    "orderingRules": {
-      "blankLinesBetweenUsingGroups": "omit",
-      "usingDirectivesPlacement": "outsideNamespace"
+    "$schema":
+        "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/1.0.2/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
+    "settings": {
+        "documentationRules": {
+            "documentInternalElements": false,
+            "xmlHeader": false
+        },
+        "maintainabilityRules": {
+            "topLevelTypes": [
+                "class",
+                "enum",
+                "interface",
+                "struct"
+            ]
+        },
+        "orderingRules": {
+            "blankLinesBetweenUsingGroups": "omit",
+            "usingDirectivesPlacement": "outsideNamespace"
+        }
     }
-  }
 }

test/Winton.DomainModelling.Abstractions.Tests/DomainExceptionTests.cs

@@ -0,0 +1,21 @@
+using FluentAssertions;
+using Xunit;
+
+namespace Winton.DomainModelling
+{
+    public class DomainExceptionTests
+    {
+        public sealed class Message : DomainExceptionTests
+        {
+            [Theory]
+            [InlineData("Test")]
+            [InlineData("Foo")]
+            private void ShouldSetMessageFromConstructor(string message)
+            {
+                var exception = new DomainException(message);
+
+                exception.Message.Should().Be(message);
+            }
+        }
+    }
+}

test/Winton.DomainModelling.Abstractions.Tests/EntityNotFoundExceptionTests.cs

@@ -0,0 +1,25 @@
+using FluentAssertions;
+using Xunit;
+
+namespace Winton.DomainModelling
+{
+    public class EntityNotFoundExceptionTests
+    {
+        [Fact]
+        private void ShouldSetMessageBasedOnTypeOfEntity()
+        {
+            var exception = new EntityNotFoundException<TestEntity, int>();
+
+            exception.Message.Should().Be("The specified TestEntity could not be found.");
+        }
+
+        // ReSharper disable once ClassNeverInstantiated.Local
+        private sealed class TestEntity : Entity<int>
+        {
+            public TestEntity(int id)
+                : base(id)
+            {
+            }
+        }
+    }
+}

test/Winton.DomainModelling.Abstractions.Tests/UnauthorizedExceptionTests.cs

@@ -0,0 +1,21 @@
+using FluentAssertions;
+using Xunit;
+
+namespace Winton.DomainModelling
+{
+    public class UnauthorizedExceptionTests
+    {
+        public sealed class Message : UnauthorizedExceptionTests
+        {
+            [Theory]
+            [InlineData("Test")]
+            [InlineData("Foo")]
+            private void ShouldSetMessageFromConstructor(string message)
+            {
+                var exception = new UnauthorizedException(message);
+
+                exception.Message.Should().Be(message);
+            }
+        }
+    }
+}