AV1130: Use collection interface as return type

Author: Bart Koelman

CodingGuidelines.ruleset

@@ -6,7 +6,7 @@
     <Rule Id="AV1506" Action="Warning" />
     <Rule Id="AV1507" Action="Warning" />
     <Rule Id="AV1008" Action="Warning" />
-    <Rule Id="AV1130" Action="Info" />
+    <Rule Id="AV1130" Action="Warning" />
     <Rule Id="AV1135" Action="Info" />
     <Rule Id="AV1536" Action="None" />
     <Rule Id="AV1537" Action="None" />
@@ -28,4 +28,4 @@
     <Rule Id="AV2310" Action="Info" />
     <Rule Id="AV2318" Action="Info" />
   </Rules>
-</RuleSet>
+</RuleSet>

src/JsonApiDotNetCore/ArrayFactory.cs

@@ -1,4 +1,5 @@
 #pragma warning disable AV1008 // Class should not be static
+#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
 
 namespace JsonApiDotNetCore
 {

src/JsonApiDotNetCore/CollectionExtensions.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using JetBrains.Annotations;
@@ -17,5 +18,21 @@ public static bool IsNullOrEmpty<T>(this IEnumerable<T> source)
 
             return !source.Any();
         }
+
+        public static int FindIndex<T>(this IList<T> source, Predicate<T> match)
+        {
+            ArgumentGuard.NotNull(source, nameof(source));
+            ArgumentGuard.NotNull(match, nameof(match));
+
+            for (int index = 0; index < source.Count; index++)
+            {
+                if (match(source[index]))
+                {
+                    return index;
+                }
+            }
+
+            return -1;
+        }
     }
 }

src/JsonApiDotNetCore/Hooks/Internal/Execution/DiffableResourceHashSet.cs

@@ -17,10 +17,10 @@ public sealed class DiffableResourceHashSet<TResource> : ResourceHashSet<TResour
     {
         private readonly HashSet<TResource> _databaseValues;
         private readonly bool _databaseValuesLoaded;
-        private readonly Dictionary<PropertyInfo, HashSet<TResource>> _updatedAttributes;
+        private readonly IDictionary<PropertyInfo, HashSet<TResource>> _updatedAttributes;
 
         public DiffableResourceHashSet(HashSet<TResource> requestResources, HashSet<TResource> databaseResources,
-            Dictionary<RelationshipAttribute, HashSet<TResource>> relationships, Dictionary<PropertyInfo, HashSet<TResource>> updatedAttributes)
+            IDictionary<RelationshipAttribute, HashSet<TResource>> relationships, IDictionary<PropertyInfo, HashSet<TResource>> updatedAttributes)
             : base(requestResources, relationships)
         {
             _databaseValues = databaseResources;
@@ -32,12 +32,10 @@ public DiffableResourceHashSet(HashSet<TResource> requestResources, HashSet<TRes
         /// Used internally by the ResourceHookExecutor to make live a bit easier with generics
         /// </summary>
         internal DiffableResourceHashSet(IEnumerable requestResources, IEnumerable databaseResources,
-            Dictionary<RelationshipAttribute, IEnumerable> relationships, ITargetedFields targetedFields)
+            IDictionary<RelationshipAttribute, IEnumerable> relationships, ITargetedFields targetedFields)
             : this((HashSet<TResource>)requestResources, (HashSet<TResource>)databaseResources,
-                TypeHelper.ConvertRelationshipDictionary<TResource>(relationships),
-                targetedFields.Attributes == null
-                    ? null
-                    : TypeHelper.ConvertAttributeDictionary(targetedFields.Attributes, (HashSet<TResource>)requestResources))
+                relationships.ToDictionary(pair => pair.Key, pair => (HashSet<TResource>)pair.Value),
+                targetedFields.Attributes?.ToDictionary(attr => attr.Property, _ => (HashSet<TResource>)requestResources))
         {
         }
 

src/JsonApiDotNetCore/Hooks/Internal/Execution/HookExecutorHelper.cs

@@ -202,7 +202,7 @@ private IResourceReadRepository<TResource, TId> GetRepository<TResource, TId>()
             return _genericProcessorFactory.Get<IResourceReadRepository<TResource, TId>>(typeof(IResourceReadRepository<,>), typeof(TResource), typeof(TId));
         }
 
-        public Dictionary<RelationshipAttribute, IEnumerable> LoadImplicitlyAffected(Dictionary<RelationshipAttribute, IEnumerable> leftResourcesByRelation,
+        public IDictionary<RelationshipAttribute, IEnumerable> LoadImplicitlyAffected(IDictionary<RelationshipAttribute, IEnumerable> leftResourcesByRelation,
             IEnumerable existingRightResources = null)
         {
             List<IIdentifiable> existingRightResourceList = existingRightResources?.Cast<IIdentifiable>().ToList();

src/JsonApiDotNetCore/Hooks/Internal/Execution/IByAffectedRelationships.cs

@@ -15,6 +15,6 @@ public interface IByAffectedRelationships<TRightResource> : IRelationshipGetters
         /// <summary>
         /// Gets a dictionary of affected resources grouped by affected relationships.
         /// </summary>
-        Dictionary<RelationshipAttribute, HashSet<TRightResource>> AffectedRelationships { get; }
+        IDictionary<RelationshipAttribute, HashSet<TRightResource>> AffectedRelationships { get; }
     }
 }

src/JsonApiDotNetCore/Hooks/Internal/Execution/IHookExecutorHelper.cs

@@ -31,7 +31,7 @@ IResourceHookContainer<TResource> GetResourceHookContainer<TResource>(ResourceHo
         /// <returns>
         /// The implicitly affected resources by relationship
         /// </returns>
-        Dictionary<RelationshipAttribute, IEnumerable> LoadImplicitlyAffected(Dictionary<RelationshipAttribute, IEnumerable> leftResourcesByRelation,
+        IDictionary<RelationshipAttribute, IEnumerable> LoadImplicitlyAffected(IDictionary<RelationshipAttribute, IEnumerable> leftResourcesByRelation,
             IEnumerable existingRightResources = null);
 
         /// <summary>

src/JsonApiDotNetCore/Hooks/Internal/Execution/IRelationshipGetters.cs

@@ -17,17 +17,19 @@ public interface IRelationshipGetters<TLeftResource>
         /// <summary>
         /// Gets a dictionary of all resources that have an affected relationship to type <typeparamref name="TLeftResource" />
         /// </summary>
-        Dictionary<RelationshipAttribute, HashSet<TLeftResource>> GetByRelationship<TRightResource>()
+        IDictionary<RelationshipAttribute, HashSet<TLeftResource>> GetByRelationship<TRightResource>()
             where TRightResource : class, IIdentifiable;
 
         /// <summary>
         /// Gets a dictionary of all resources that have an affected relationship to type <paramref name="resourceType" />
         /// </summary>
-        Dictionary<RelationshipAttribute, HashSet<TLeftResource>> GetByRelationship(Type resourceType);
+        IDictionary<RelationshipAttribute, HashSet<TLeftResource>> GetByRelationship(Type resourceType);
 
         /// <summary>
         /// Gets a collection of all the resources for the property within <paramref name="navigationAction" /> has been affected by the request
         /// </summary>
+#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
         HashSet<TLeftResource> GetAffected(Expression<Func<TLeftResource, object>> navigationAction);
+#pragma warning restore AV1130 // Return type in method signature should be a collection interface instead of a concrete type
     }
 }

src/JsonApiDotNetCore/Hooks/Internal/Execution/RelationshipsDictionary.cs

@@ -24,28 +24,28 @@ public class RelationshipsDictionary<TResource> : Dictionary<RelationshipAttribu
         /// <param name="relationships">
         /// Relationships.
         /// </param>
-        public RelationshipsDictionary(Dictionary<RelationshipAttribute, HashSet<TResource>> relationships)
+        public RelationshipsDictionary(IDictionary<RelationshipAttribute, HashSet<TResource>> relationships)
             : base(relationships)
         {
         }
 
         /// <summary>
         /// Used internally by the ResourceHookExecutor to make life a bit easier with generics
         /// </summary>
-        internal RelationshipsDictionary(Dictionary<RelationshipAttribute, IEnumerable> relationships)
-            : this(TypeHelper.ConvertRelationshipDictionary<TResource>(relationships))
+        internal RelationshipsDictionary(IDictionary<RelationshipAttribute, IEnumerable> relationships)
+            : this(relationships.ToDictionary(pair => pair.Key, pair => (HashSet<TResource>)pair.Value))
         {
         }
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship<TRelatedResource>()
+        public IDictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship<TRelatedResource>()
             where TRelatedResource : class, IIdentifiable
         {
             return GetByRelationship(typeof(TRelatedResource));
         }
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
+        public IDictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
         {
             return this.Where(pair => pair.Key.RightType == resourceType).ToDictionary(pair => pair.Key, pair => pair.Value);
         }

src/JsonApiDotNetCore/Hooks/Internal/Execution/ResourceHashSet.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using System.Linq.Expressions;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
@@ -19,9 +20,9 @@ public class ResourceHashSet<TResource> : HashSet<TResource>, IResourceHashSet<T
         private readonly RelationshipsDictionary<TResource> _relationships;
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> AffectedRelationships => _relationships;
+        public IDictionary<RelationshipAttribute, HashSet<TResource>> AffectedRelationships => _relationships;
 
-        public ResourceHashSet(HashSet<TResource> resources, Dictionary<RelationshipAttribute, HashSet<TResource>> relationships)
+        public ResourceHashSet(HashSet<TResource> resources, IDictionary<RelationshipAttribute, HashSet<TResource>> relationships)
             : base(resources)
         {
             _relationships = new RelationshipsDictionary<TResource>(relationships);
@@ -30,19 +31,19 @@ public ResourceHashSet(HashSet<TResource> resources, Dictionary<RelationshipAttr
         /// <summary>
         /// Used internally by the ResourceHookExecutor to make live a bit easier with generics
         /// </summary>
-        internal ResourceHashSet(IEnumerable resources, Dictionary<RelationshipAttribute, IEnumerable> relationships)
-            : this((HashSet<TResource>)resources, TypeHelper.ConvertRelationshipDictionary<TResource>(relationships))
+        internal ResourceHashSet(IEnumerable resources, IDictionary<RelationshipAttribute, IEnumerable> relationships)
+            : this((HashSet<TResource>)resources, relationships.ToDictionary(pair => pair.Key, pair => (HashSet<TResource>)pair.Value))
         {
         }
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
+        public IDictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
         {
             return _relationships.GetByRelationship(resourceType);
         }
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship<TRightResource>()
+        public IDictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship<TRightResource>()
             where TRightResource : class, IIdentifiable
         {
             return GetByRelationship(typeof(TRightResource));