AV1708: Do not use 'Helper' or 'Shared' in type names

Author: Bart Koelman

src/JsonApiDotNetCore/Errors/NonSharedTransactionException.cs renamed to src/JsonApiDotNetCore/Errors/NonParticipatingTransactionException.cs

@@ -8,9 +8,9 @@ namespace JsonApiDotNetCore.Errors
     /// The error that is thrown when a repository does not participate in the overarching transaction during an atomic:operations request.
     /// </summary>
     [PublicAPI]
-    public sealed class NonSharedTransactionException : JsonApiException
+    public sealed class NonParticipatingTransactionException : JsonApiException
     {
-        public NonSharedTransactionException()
+        public NonParticipatingTransactionException()
             : base(new Error(HttpStatusCode.UnprocessableEntity)
             {
                 Title = "Unsupported combination of resource types in atomic:operations request.",

src/JsonApiDotNetCore/Repositories/ResourceRepositoryAccessor.cs

@@ -156,7 +156,7 @@ private object GetWriteRepository(Type resourceType)
 
                 if (repository.TransactionId != _request.TransactionId)
                 {
-                    throw new NonSharedTransactionException();
+                    throw new NonParticipatingTransactionException();
                 }
             }
 

src/JsonApiDotNetCore/TypeHelper.cs

@@ -7,7 +7,10 @@
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
+// TODO: Refactor TypeHelper into separate responsibilities
+
 #pragma warning disable AV1008 // Class should not be static
+#pragma warning disable AV1708 // Type name contains term that should be avoided
 
 namespace JsonApiDotNetCore
 {

test/UnitTests/Internal/TypeAnalysisTests.cs

@@ -0,0 +1,56 @@
+using System;
+using JsonApiDotNetCore;
+using JsonApiDotNetCore.Resources;
+using Xunit;
+
+namespace UnitTests.Internal
+{
+    public sealed class TypeAnalysisTests
+    {
+        [Fact]
+        public void New_Creates_An_Instance_If_T_Implements_Interface()
+        {
+            // Arrange
+            Type type = typeof(Model);
+
+            // Act
+            var instance = (IIdentifiable)TypeHelper.CreateInstance(type);
+
+            // Assert
+            Assert.NotNull(instance);
+            Assert.IsType<Model>(instance);
+        }
+
+        [Fact]
+        public void Implements_Returns_True_If_Type_Implements_Interface()
+        {
+            // Arrange
+            Type type = typeof(Model);
+
+            // Act
+            bool result = TypeHelper.IsOrImplementsInterface(type, typeof(IIdentifiable));
+
+            // Assert
+            Assert.True(result);
+        }
+
+        [Fact]
+        public void Implements_Returns_False_If_Type_DoesNot_Implement_Interface()
+        {
+            // Arrange
+            Type type = typeof(string);
+
+            // Act
+            bool result = TypeHelper.IsOrImplementsInterface(type, typeof(IIdentifiable));
+
+            // Assert
+            Assert.False(result);
+        }
+
+        private sealed class Model : IIdentifiable
+        {
+            public string StringId { get; set; }
+            public string LocalId { get; set; }
+        }
+    }
+}

test/UnitTests/Internal/TypeHelperTests.cs renamed to test/UnitTests/Internal/TypeConversionTests.cs

@@ -1,12 +1,11 @@
 using System;
 using System.Collections.Generic;
 using JsonApiDotNetCore;
-using JsonApiDotNetCore.Resources;
 using Xunit;
 
 namespace UnitTests.Internal
 {
-    public sealed class TypeHelperTests
+    public sealed class TypeConversionTests
     {
         [Fact]
         public void Can_Convert_DateTimeOffsets()
@@ -131,46 +130,6 @@ public void Bad_TimeSpanString_Throws()
             Assert.Throws<FormatException>(action);
         }
 
-        [Fact]
-        public void New_Creates_An_Instance_If_T_Implements_Interface()
-        {
-            // Arrange
-            Type type = typeof(Model);
-
-            // Act
-            var instance = (IIdentifiable)TypeHelper.CreateInstance(type);
-
-            // Assert
-            Assert.NotNull(instance);
-            Assert.IsType<Model>(instance);
-        }
-
-        [Fact]
-        public void Implements_Returns_True_If_Type_Implements_Interface()
-        {
-            // Arrange
-            Type type = typeof(Model);
-
-            // Act
-            bool result = TypeHelper.IsOrImplementsInterface(type, typeof(IIdentifiable));
-
-            // Assert
-            Assert.True(result);
-        }
-
-        [Fact]
-        public void Implements_Returns_False_If_Type_DoesNot_Implement_Interface()
-        {
-            // Arrange
-            Type type = typeof(string);
-
-            // Act
-            bool result = TypeHelper.IsOrImplementsInterface(type, typeof(IIdentifiable));
-
-            // Assert
-            Assert.False(result);
-        }
-
         private enum TestEnum
         {
             Test = 1
@@ -187,11 +146,5 @@ private class BaseType : IType
         private interface IType
         {
         }
-
-        private sealed class Model : IIdentifiable
-        {
-            public string StringId { get; set; }
-            public string LocalId { get; set; }
-        }
     }
 }