Additional cleanup based on suggestions from https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/

Author: Bart Koelman

src/Examples/GettingStarted/Program.cs

@@ -3,7 +3,7 @@
 
 namespace GettingStarted
 {
-    public class Program
+    public static class Program
     {
         public static void Main(string[] args)
         {

src/Examples/JsonApiDotNetCoreExample/Definitions/TagHooksDefinition.cs

@@ -11,9 +11,9 @@ public class TagHooksDefinition : ResourceHooksDefinition<Tag>
     {
         public TagHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }
 
-        public override IEnumerable<Tag> BeforeCreate(IResourceHashSet<Tag> affected, ResourcePipeline pipeline)
+        public override IEnumerable<Tag> BeforeCreate(IResourceHashSet<Tag> resources, ResourcePipeline pipeline)
         {
-            return base.BeforeCreate(affected, pipeline);
+            return base.BeforeCreate(resources, pipeline);
         }
 
         public override IEnumerable<Tag> OnReturn(HashSet<Tag> resources, ResourcePipeline pipeline)

src/Examples/JsonApiDotNetCoreExample/Program.cs

@@ -4,7 +4,7 @@
 
 namespace JsonApiDotNetCoreExample
 {
-    public class Program
+    public static class Program
     {
         public static void Main(string[] args)
         {

src/Examples/MultiDbContextExample/Program.cs

@@ -3,7 +3,7 @@
 
 namespace MultiDbContextExample
 {
-    public class Program
+    public static class Program
     {
         public static void Main(string[] args)
         {

src/Examples/NoEntityFrameworkExample/Program.cs

@@ -3,7 +3,7 @@
 
 namespace NoEntityFrameworkExample
 {
-    public class Program
+    public static class Program
     {
         public static void Main(string[] args)
         {

src/Examples/ReportsExample/Program.cs

@@ -3,7 +3,7 @@
 
 namespace ReportsExample
 {
-    public class Program
+    public static class Program
     {
         public static void Main(string[] args)
         {

src/JsonApiDotNetCore/AtomicOperations/LocalIdValidator.cs

@@ -25,6 +25,8 @@ public LocalIdValidator(ILocalIdTracker localIdTracker, IResourceContextProvider
 
         public void Validate(IEnumerable<OperationContainer> operations)
         {
+            ArgumentGuard.NotNull(operations, nameof(operations));
+
             _localIdTracker.Reset();
 
             int operationIndex = 0;

src/JsonApiDotNetCore/Hooks/Internal/Discovery/LoadDatabaseValuesAttribute.cs

@@ -7,9 +7,9 @@ public sealed class LoadDatabaseValuesAttribute : Attribute
     {
         public bool Value { get; }
 
-        public LoadDatabaseValuesAttribute(bool mode = true)
+        public LoadDatabaseValuesAttribute(bool value = true)
         {
-            Value = mode;
+            Value = value;
         }
     }
 }

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

@@ -57,6 +57,8 @@ public IEnumerable<ResourceDiffPair<TResource>> GetDiffs()
         /// <inheritdoc />
         public new HashSet<TResource> GetAffected(Expression<Func<TResource, object>> navigationAction)
         {
+            ArgumentGuard.NotNull(navigationAction, nameof(navigationAction));
+
             var propertyInfo = TypeHelper.ParseNavigationExpression(navigationAction);
             var propertyType = propertyInfo.PropertyType;
             if (TypeHelper.IsOrImplementsInterface(propertyType, typeof(IEnumerable)))

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

@@ -16,9 +16,9 @@ public interface IRelationshipGetters<TLeftResource> where TLeftResource : class
         /// </summary>
         Dictionary<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="relatedResourceType"/>
+        /// Gets a dictionary of all resources that have an affected relationship to type <paramref name="resourceType"/>
         /// </summary>
-        Dictionary<RelationshipAttribute, HashSet<TLeftResource>> GetByRelationship(Type relatedResourceType);
+        Dictionary<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

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

@@ -37,14 +37,16 @@ public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship<T
         }
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type relatedType)
+        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
         {
-            return this.Where(p => p.Key.RightType == relatedType).ToDictionary(p => p.Key, p => p.Value);
+            return this.Where(p => p.Key.RightType == resourceType).ToDictionary(p => p.Key, p => p.Value);
         }
 
         /// <inheritdoc />
         public HashSet<TResource> GetAffected(Expression<Func<TResource, object>> navigationAction)
         {
+            ArgumentGuard.NotNull(navigationAction, nameof(navigationAction));
+
             var property = TypeHelper.ParseNavigationExpression(navigationAction);
             return this.Where(p => p.Key.Property.Name == property.Name).Select(p => p.Value).SingleOrDefault();
         }

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

@@ -37,9 +37,9 @@ internal ResourceHashSet(IEnumerable resources,
 
 
         /// <inheritdoc />
-        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type leftType)
+        public Dictionary<RelationshipAttribute, HashSet<TResource>> GetByRelationship(Type resourceType)
         {
-            return _relationships.GetByRelationship(leftType);
+            return _relationships.GetByRelationship(resourceType);
         }
 
         /// <inheritdoc />

src/JsonApiDotNetCore/Hooks/Internal/ResourceHookExecutor.cs

@@ -405,7 +405,7 @@ private void ValidateHookResponse<T>(IEnumerable<T> returnedList, ResourcePipeli
         {
             if (pipeline == ResourcePipeline.GetSingle && returnedList.Count() > 1)
             {
-                throw new ApplicationException("The returned collection from this hook may contain at most one item in the case of the " +
+                throw new InvalidOperationException("The returned collection from this hook may contain at most one item in the case of the " +
                     pipeline.ToString("G") + " pipeline");
             }
         }

src/JsonApiDotNetCore/Middleware/TraceLogWriter.cs

@@ -42,9 +42,9 @@ private static string FormatMessage(string memberName, object parameters)
 
             builder.Append("Entering ");
             builder.Append(memberName);
-            builder.Append("(");
+            builder.Append('(');
             WriteProperties(builder, parameters);
-            builder.Append(")");
+            builder.Append(')');
 
             return builder.ToString();
         }
@@ -82,9 +82,9 @@ private static void WriteProperty(StringBuilder builder, PropertyInfo property,
             }
             else if (value is string stringValue)
             {
-                builder.Append("\"");
+                builder.Append('"');
                 builder.Append(stringValue);
-                builder.Append("\"");
+                builder.Append('"');
             }
             else
             {

src/JsonApiDotNetCore/Queries/Expressions/SparseFieldTableExpression.cs

@@ -38,13 +38,13 @@ public override string ToString()
             {
                 if (builder.Length > 0)
                 {
-                    builder.Append(",");
+                    builder.Append(',');
                 }
 
                 builder.Append(resource.PublicName);
-                builder.Append("(");
+                builder.Append('(');
                 builder.Append(fields);
-                builder.Append(")");
+                builder.Append(')');
             }
 
             return builder.ToString();

src/JsonApiDotNetCore/Queries/Internal/QueryLayerComposer.cs

@@ -342,6 +342,8 @@ public QueryLayer ComposeForUpdate<TId>(TId id, ResourceContext primaryResource)
         /// <inheritdoc />
         public IEnumerable<(QueryLayer, RelationshipAttribute)> ComposeForGetTargetedSecondaryResourceIds(IIdentifiable primaryResource)
         {
+            ArgumentGuard.NotNull(primaryResource, nameof(primaryResource));
+
             foreach (var relationship in _targetedFields.Relationships)
             {
                 object rightValue = relationship.GetValue(primaryResource);
@@ -358,6 +360,9 @@ public QueryLayer ComposeForUpdate<TId>(TId id, ResourceContext primaryResource)
         /// <inheritdoc />
         public QueryLayer ComposeForGetRelationshipRightIds(RelationshipAttribute relationship, ICollection<IIdentifiable> rightResourceIds)
         {
+            ArgumentGuard.NotNull(relationship, nameof(relationship));
+            ArgumentGuard.NotNull(rightResourceIds, nameof(rightResourceIds));
+
             var rightResourceContext = _resourceContextProvider.GetResourceContext(relationship.RightType);
             var rightIdAttribute = GetIdAttribute(rightResourceContext);
 
@@ -380,6 +385,9 @@ public QueryLayer ComposeForGetRelationshipRightIds(RelationshipAttribute relati
         /// <inheritdoc />
         public QueryLayer ComposeForHasMany<TId>(HasManyAttribute hasManyRelationship, TId leftId, ICollection<IIdentifiable> rightResourceIds)
         {
+            ArgumentGuard.NotNull(hasManyRelationship, nameof(hasManyRelationship));
+            ArgumentGuard.NotNull(rightResourceIds, nameof(rightResourceIds));
+
             var leftResourceContext = _resourceContextProvider.GetResourceContext(hasManyRelationship.LeftType);
             var leftIdAttribute = GetIdAttribute(leftResourceContext);
 

src/JsonApiDotNetCore/Queries/Internal/QueryableBuilding/QueryClauseBuilder.cs

@@ -29,7 +29,7 @@ public override Expression VisitCount(CountExpression expression, TArgument argu
             var propertyExpression = TryGetCollectionCount(collectionExpression);
             if (propertyExpression == null)
             {
-                throw new Exception($"Field '{expression.TargetCollection}' must be a collection.");
+                throw new InvalidOperationException($"Field '{expression.TargetCollection}' must be a collection.");
             }
 
             return propertyExpression;

src/JsonApiDotNetCore/Queries/Internal/QueryableBuilding/SelectClauseBuilder.cs

@@ -194,7 +194,7 @@ private Expression CreateCollectionInitializer(LambdaScope lambdaScope, Property
 
                 if (typedCollectionConstructor == null)
                 {
-                    throw new Exception(
+                    throw new InvalidOperationException(
                         $"Constructor on '{typedCollection.Name}' that accepts '{enumerableOfElementType.Name}' not found.");
                 }
 

src/JsonApiDotNetCore/Queries/Internal/QueryableBuilding/WhereClauseBuilder.cs

@@ -55,7 +55,7 @@ public override Expression VisitCollectionNotEmpty(CollectionNotEmptyExpression
 
             if (elementType == null)
             {
-                throw new Exception("Expression must be a collection.");
+                throw new InvalidOperationException("Expression must be a collection.");
             }
 
             return AnyExtensionMethodCall(elementType, property);
@@ -75,7 +75,7 @@ public override Expression VisitMatchText(MatchTextExpression expression, Type a
 
             if (property.Type != typeof(string))
             {
-                throw new Exception("Expression must be a string.");
+                throw new InvalidOperationException("Expression must be a string.");
             }
 
             Expression text = Visit(expression.TextValue, property.Type);

src/JsonApiDotNetCore/Queries/Internal/SparseFieldSetCache.cs

@@ -106,6 +106,8 @@ public IReadOnlyCollection<AttrAttribute> GetIdAttributeSetForRelationshipQuery(
 
         public IReadOnlyCollection<ResourceFieldAttribute> GetSparseFieldSetForSerializer(ResourceContext resourceContext)
         {
+            ArgumentGuard.NotNull(resourceContext, nameof(resourceContext));
+
             if (!_visitedTable.ContainsKey(resourceContext))
             {
                 var inputFields = _lazySourceTable.Value.ContainsKey(resourceContext)

src/JsonApiDotNetCore/QueryStrings/Internal/FilterQueryStringParameterReader.cs

@@ -58,28 +58,30 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
         /// <inheritdoc />
         public virtual bool CanRead(string parameterName)
         {
+            ArgumentGuard.NotNull(parameterName, nameof(parameterName));
+
             var isNested = parameterName.StartsWith("filter[", StringComparison.Ordinal) && parameterName.EndsWith("]", StringComparison.Ordinal);
             return parameterName == "filter" || isNested;
         }
 
         /// <inheritdoc />
-        public virtual void Read(string parameterName, StringValues parameterValues)
+        public virtual void Read(string parameterName, StringValues parameterValue)
         {
             _lastParameterName = parameterName;
 
-            foreach (string parameterValue in ExtractParameterValues(parameterName, parameterValues))
+            foreach (string value in ExtractParameterValues(parameterValue))
             {
-                ReadSingleValue(parameterName, parameterValue);
+                ReadSingleValue(parameterName, value);
             }
         }
 
-        private IEnumerable<string> ExtractParameterValues(string parameterName, StringValues parameterValues)
+        private IEnumerable<string> ExtractParameterValues(StringValues parameterValues)
         {
             foreach (string parameterValue in parameterValues)
             {
                 if (_options.EnableLegacyFilterNotation)
                 {
-                    foreach (string condition in LegacyConverter.ExtractConditions(parameterName, parameterValue))
+                    foreach (string condition in LegacyConverter.ExtractConditions(parameterValue))
                     {
                         yield return condition;
                     }

src/JsonApiDotNetCore/QueryStrings/Internal/LegacyFilterNotationConverter.cs

@@ -25,8 +25,10 @@ public sealed class LegacyFilterNotationConverter
             ["like:"] = Keywords.Contains
         };
 
-        public IEnumerable<string> ExtractConditions(string parameterName, string parameterValue)
+        public IEnumerable<string> ExtractConditions(string parameterValue)
         {
+            ArgumentGuard.NotNull(parameterValue, nameof(parameterValue));
+
             if (parameterValue.StartsWith(ExpressionPrefix, StringComparison.Ordinal) ||
                 parameterValue.StartsWith(InPrefix, StringComparison.Ordinal) ||
                 parameterValue.StartsWith(NotInPrefix, StringComparison.Ordinal))

src/JsonApiDotNetCore/QueryStrings/Internal/SortQueryStringParameterReader.cs

@@ -47,6 +47,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
         /// <inheritdoc />
         public virtual bool CanRead(string parameterName)
         {
+            ArgumentGuard.NotNull(parameterName, nameof(parameterName));
+
             var isNested = parameterName.StartsWith("sort[", StringComparison.Ordinal) && parameterName.EndsWith("]", StringComparison.Ordinal);
             return parameterName == "sort" || isNested;
         }

src/JsonApiDotNetCore/QueryStrings/Internal/SparseFieldSetQueryStringParameterReader.cs

@@ -48,6 +48,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
         /// <inheritdoc />
         public virtual bool CanRead(string parameterName)
         {
+            ArgumentGuard.NotNull(parameterName, nameof(parameterName));
+
             return parameterName.StartsWith("fields[", StringComparison.Ordinal) && parameterName.EndsWith("]", StringComparison.Ordinal);
         }
 

src/JsonApiDotNetCore/Serialization/Building/LinkBuilder.cs

@@ -112,12 +112,12 @@ private string GetSelfTopLevelLink(ResourceContext resourceContext, Action<Dicti
         {
             var builder = new StringBuilder();
             builder.Append(_request.BasePath);
-            builder.Append("/");
+            builder.Append('/');
             builder.Append(resourceContext.PublicName);
 
             if (_request.PrimaryId != null)
             {
-                builder.Append("/");
+                builder.Append('/');
                 builder.Append(_request.PrimaryId);
             }
 
@@ -128,7 +128,7 @@ private string GetSelfTopLevelLink(ResourceContext resourceContext, Action<Dicti
 
             if (_request.Relationship != null)
             {
-                builder.Append("/");
+                builder.Append('/');
                 builder.Append(_request.Relationship.PublicName);
             }
 

src/JsonApiDotNetCore/Serialization/Client/Internal/IRequestSerializer.cs

@@ -28,13 +28,13 @@ public interface IRequestSerializer
         /// You can use <see cref="IResourceGraph.GetAttributes{TResource}"/>
         /// to conveniently access the desired <see cref="AttrAttribute"/> instances.
         /// </summary>
-        public IReadOnlyCollection<AttrAttribute> AttributesToSerialize { set; }
+        public IReadOnlyCollection<AttrAttribute> AttributesToSerialize { get; set; }
 
         /// <summary>
         /// Sets the relationships that will be included in the serialized request body.
         /// You can use <see cref="IResourceGraph.GetRelationships"/>
         /// to conveniently access the desired <see cref="RelationshipAttribute"/> instances.
         /// </summary>
-        public IReadOnlyCollection<RelationshipAttribute> RelationshipsToSerialize { set; }
+        public IReadOnlyCollection<RelationshipAttribute> RelationshipsToSerialize { get; set; }
     }
 }

src/JsonApiDotNetCore/Serialization/Client/Internal/RequestSerializer.cs

@@ -69,10 +69,10 @@ public string Serialize(IReadOnlyCollection<IIdentifiable> resources)
         }
 
         /// <inheritdoc />
-        public IReadOnlyCollection<AttrAttribute> AttributesToSerialize { private get; set; }
+        public IReadOnlyCollection<AttrAttribute> AttributesToSerialize { get; set; }
 
         /// <inheritdoc />
-        public IReadOnlyCollection<RelationshipAttribute> RelationshipsToSerialize { private get; set; }
+        public IReadOnlyCollection<RelationshipAttribute> RelationshipsToSerialize { get; set; }
 
         /// <summary>
         /// By default, the client serializer includes all attributes in the result,

src/JsonApiDotNetCore/Serialization/Objects/ResourceIdentifierObject.cs

@@ -43,7 +43,7 @@ protected static void WriteMember(StringBuilder builder, string memberName, stri
                 builder.Append(memberName);
                 builder.Append("=\"");
                 builder.Append(memberValue);
-                builder.Append("\"");
+                builder.Append('"');
             }
         }
     }