Various code cleanups in preparation of auto-formatting the codebase (#960)

* Replaced null checks with argument guard

* Added curlies on single-statement branches and loops

* Normalize blank lines around SaveChangesAsync in tests

* use const

* Move types into matching files

* Adapt namespaces to match with directory structure

* Fixed inconsistencies in naming conventions

* Remove redundant parenthesis

* Fixed culture-specific string comparisons

* Use newer syntax for dictionary initializers

* Various additional cleanups

* Manual code cleanups in preparation for reformat

* Extract variable on errors in tests to reduce assertion line length

* Hide decimal precision from tests

* Rewrite ResponseStatusCode tests using Theory

* Fixed naming inconsistencies in tests

* Replace FindAsync usage for consistency with other tests

* Added formatter directives on fakers

* Added formatter directives on DbContext types

* Added FirstWithIdAsync / FirstWithIdOrDefaultAsync to reduce line length on database queries in tests

* Added formatting directives on long database queries in tests

* Reduced line length for links assertions

* Variable naming consistency

* Break up long strings to steer formatter

* Extract constant

* cleanup method

* Fixed naming conventions
Resharper was set to auto-detect, making it ignore configured rules

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

* Use helpers to prevent multiple line breaks in array and list initializers

* Corrected link rendering for hosting inside an IIS application vdir (#955)

Corrected link rendering for hosting inside an IIS application virtual directory

* Update version from 4.0.3 to 4.0.4

* Marked types/members sealed/internal where non-breaking

* Removed redundancies in code

* remove unused tuple elements

* Fixed spelling in comments

* Added formatter directive to ErrorDocumentTests to prevent array chop

* Added [UsedImplicitly] on DbContext classes to suppress suggestions like 'member can be private, set accessor is never used'etc.

* Added [UsedImplicitly] on resource services, repositories, definitions and startups

* Added [UsedImplicitly] on models

* Use discard in empty property setters

* Added missing setter

* Addressed possible NullReferenceException warnings

* Marked assertion methods as such, to suppress warning 'parameter is only used for precondition checks'

Note that one suppression is needed, due to a bug in Resharper

* Addressed possible multiple enumeration warnings

* Suppressed warnings on non-readonly member access in GetHashCode, because these are assigned once at application startup by the resource graph builder and then are considered immutable.

* extra: UsedImplicitly on models

* Added [PublicAPI] on exposed types to suppress warnings like 'type/member can be made internal', 'type has no inheritors and can be marked sealed', 'member is never written to' etc.

* Cleanup Startups

* BenchmarkDotNet runners cannot be sealed

* Suppress cases of unused TResource type parameter, because we register an open generic for them to enable different implementations per resource type.

* Additional cleanup and annotations based on warnings and suggestions

* AV1755: Async method name should end with [Task]Async

* AV1739: Use underscores for unused lambda parameters

* AV1568: Parameter value is overwritten in method body

* AV1535: Block scope in case clauses

* AV1522: Multiple assignments in single statement

* AV1532: Avoid nested loops

* AV1010: Member hides inherited member

* AV1130: Use collection interface as return type

* Fixed: Without the [CustomAssertion] attribute, Fluent Assertions would find the line that calls Subject.StatusCode.Should().Be() and treat the Subject variable as the subject-under-test (SUT). But by applying this attribute, it will ignore this invocation and instead find the SUT by looking for a call to Should().HaveStatusCode() and use the response variable instead.

Author: Bart Koelman

benchmarks/BenchmarkResource.cs

@@ -1,8 +1,10 @@
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace Benchmarks
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class BenchmarkResource : Identifiable
     {
         [Attr(PublicName = BenchmarkResourcePublicNames.NameAttr)] 
@@ -11,16 +13,4 @@ public sealed class BenchmarkResource : Identifiable
         [HasOne]
         public SubResource Child { get; set; }
     }
-
-    public class SubResource : Identifiable
-    {
-        [Attr]
-        public string Value { get; set; }
-    }
-
-    internal static class BenchmarkResourcePublicNames
-    {
-        public const string NameAttr = "full-name";
-        public const string Type = "simple-types";
-    }
 }

benchmarks/BenchmarkResourcePublicNames.cs

@@ -0,0 +1,8 @@
+namespace Benchmarks
+{
+    internal static class BenchmarkResourcePublicNames
+    {
+        public const string NameAttr = "full-name";
+        public const string Type = "simple-types";
+    }
+}

benchmarks/LinkBuilder/LinkBuilderGetNamespaceFromPathBenchmarks.cs

@@ -4,6 +4,7 @@
 
 namespace Benchmarks.LinkBuilder
 {
+    // ReSharper disable once ClassCanBeSealed.Global
     [MarkdownExporter, SimpleJob(launchCount: 3, warmupCount: 10, targetCount: 20), MemoryDiagnoser]
     public class LinkBuilderGetNamespaceFromPathBenchmarks
     {
@@ -17,7 +18,7 @@ public class LinkBuilderGetNamespaceFromPathBenchmarks
         [Benchmark]
         public void UsingReadOnlySpan() => GetNamespaceFromPathUsingReadOnlySpan(RequestPath, ResourceName);
 
-        public static string GetNamespaceFromPathUsingStringSplit(string path, string resourceName)
+        private static void GetNamespaceFromPathUsingStringSplit(string path, string resourceName)
         {
             StringBuilder namespaceBuilder = new StringBuilder(path.Length);
             string[] segments = path.Split('/');
@@ -33,10 +34,10 @@ public static string GetNamespaceFromPathUsingStringSplit(string path, string re
                 namespaceBuilder.Append(segments[index]);
             }
 
-            return namespaceBuilder.ToString();
+            _ = namespaceBuilder.ToString();
         }
 
-        public static string GetNamespaceFromPathUsingReadOnlySpan(string path, string resourceName)
+        private static void GetNamespaceFromPathUsingReadOnlySpan(string path, string resourceName)
         {
             ReadOnlySpan<char> resourceNameSpan = resourceName.AsSpan();
             ReadOnlySpan<char> pathSpan = path.AsSpan();
@@ -57,14 +58,12 @@ public static string GetNamespaceFromPathUsingReadOnlySpan(string path, string r
                             bool hasDelimiterAfterSegment = pathSpan.Length >= lastCharacterIndex + 1 && pathSpan[lastCharacterIndex].Equals(PathDelimiter);
                             if (isAtEnd || hasDelimiterAfterSegment)
                             {
-                                return pathSpan.Slice(0, index).ToString();
+                                _ = pathSpan.Slice(0, index).ToString();
                             }
                         }
                     }
                 }
             }
-
-            return string.Empty;
         }
     }
 }

benchmarks/Program.cs

@@ -5,7 +5,7 @@
 
 namespace Benchmarks
 {
-    internal class Program
+    internal static class Program
     {
         private static void Main(string[] args)
         {

benchmarks/Query/QueryParserBenchmarks.cs

@@ -1,7 +1,7 @@
 using System;
-using System.Collections.Generic;
 using System.ComponentModel.Design;
 using BenchmarkDotNet.Attributes;
+using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.QueryStrings;
@@ -13,6 +13,7 @@
 
 namespace Benchmarks.Query
 {
+    // ReSharper disable once ClassCanBeSealed.Global
     [MarkdownExporter, SimpleJob(launchCount: 3, warmupCount: 10, targetCount: 20), MemoryDiagnoser]
     public class QueryParserBenchmarks
     {
@@ -43,11 +44,8 @@ private static QueryStringReader CreateQueryParameterDiscoveryForSort(IResourceG
             JsonApiRequest request, IJsonApiOptions options, FakeRequestQueryStringAccessor queryStringAccessor)
         {
             var sortReader = new SortQueryStringParameterReader(request, resourceGraph);
-            
-            var readers = new List<IQueryStringParameterReader>
-            {
-                sortReader
-            };
+
+            var readers = sortReader.AsEnumerable();
 
             return new QueryStringReader(options, queryStringAccessor, readers, NullLoggerFactory.Instance);
         }
@@ -65,10 +63,7 @@ private static QueryStringReader CreateQueryParameterDiscoveryForAll(IResourceGr
             var defaultsReader = new DefaultsQueryStringParameterReader(options);
             var nullsReader = new NullsQueryStringParameterReader(options);
 
-            var readers = new List<IQueryStringParameterReader>
-            {
-                includeReader, filterReader, sortReader, sparseFieldSetReader, paginationReader, defaultsReader, nullsReader
-            };
+            var readers = ArrayFactory.Create<IQueryStringParameterReader>(includeReader, filterReader, sortReader, sparseFieldSetReader, paginationReader, defaultsReader, nullsReader);
 
             return new QueryStringReader(options, queryStringAccessor, readers, NullLoggerFactory.Instance);
         }
@@ -94,15 +89,21 @@ public void DescendingSort()
         [Benchmark]
         public void ComplexQuery() => Run(100, () =>
         {
-            var queryString = $"?filter[{BenchmarkResourcePublicNames.NameAttr}]=abc,eq:abc&sort=-{BenchmarkResourcePublicNames.NameAttr}&include=child&page[size]=1&fields[{BenchmarkResourcePublicNames.Type}]={BenchmarkResourcePublicNames.NameAttr}";
+            const string resourceName = BenchmarkResourcePublicNames.Type;
+            const string attrName = BenchmarkResourcePublicNames.NameAttr;
+
+            var queryString = $"?filter[{attrName}]=abc,eq:abc&sort=-{attrName}&include=child&page[size]=1&fields[{resourceName}]={attrName}";
 
             _queryStringAccessor.SetQueryString(queryString);
             _queryStringReaderForAll.ReadAll(null);
         });
 
-        private void Run(int iterations, Action action) { 
+        private void Run(int iterations, Action action)
+        {
             for (int i = 0; i < iterations; i++)
+            {
                 action();
+            }
         }
 
         private sealed class FakeRequestQueryStringAccessor : IRequestQueryStringAccessor

benchmarks/Serialization/JsonApiDeserializerBenchmarks.cs

@@ -12,6 +12,7 @@
 
 namespace Benchmarks.Serialization
 {
+    // ReSharper disable once ClassCanBeSealed.Global
     [MarkdownExporter]
     public class JsonApiDeserializerBenchmarks
     {
@@ -23,10 +24,7 @@ public class JsonApiDeserializerBenchmarks
                 Id = "1",
                 Attributes = new Dictionary<string, object>
                 {
-                    {
-                        "name",
-                        Guid.NewGuid().ToString()
-                    }
+                    ["name"] = Guid.NewGuid().ToString()
                 }
             }
         });
@@ -39,7 +37,10 @@ public JsonApiDeserializerBenchmarks()
             IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
             var targetedFields = new TargetedFields();
             var request = new JsonApiRequest();
-            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, new ResourceFactory(new ServiceContainer()), targetedFields, new HttpContextAccessor(), request, options);
+            var resourceFactory = new ResourceFactory(new ServiceContainer());
+            var httpContextAccessor = new HttpContextAccessor();
+
+            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, resourceFactory, targetedFields, httpContextAccessor, request, options);
         }
 
         [Benchmark]

benchmarks/Serialization/JsonApiSerializerBenchmarks.cs

@@ -11,10 +11,11 @@
 
 namespace Benchmarks.Serialization
 {
+    // ReSharper disable once ClassCanBeSealed.Global
     [MarkdownExporter]
     public class JsonApiSerializerBenchmarks
     {
-        private static readonly BenchmarkResource _content = new BenchmarkResource
+        private static readonly BenchmarkResource Content = new BenchmarkResource
         {
             Id = 123,
             Name = Guid.NewGuid().ToString()
@@ -53,6 +54,6 @@ private static FieldsToSerialize CreateFieldsToSerialize(IResourceGraph resource
         }
 
         [Benchmark]
-        public object SerializeSimpleObject() => _jsonApiSerializer.Serialize(_content);
+        public object SerializeSimpleObject() => _jsonApiSerializer.Serialize(Content);
     }
 }

benchmarks/SubResource.cs

@@ -0,0 +1,13 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace Benchmarks
+{
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
+    public sealed class SubResource : Identifiable
+    {
+        [Attr]
+        public string Value { get; set; }
+    }
+}

src/Examples/GettingStarted/Data/SampleDbContext.cs

@@ -1,8 +1,10 @@
 using GettingStarted.Models;
+using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 
 namespace GettingStarted.Data
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public class SampleDbContext : DbContext
     {
         public DbSet<Book> Books { get; set; }

src/Examples/GettingStarted/Models/Book.cs

@@ -1,8 +1,10 @@
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace GettingStarted.Models
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class Book : Identifiable
     {
         [Attr]

src/Examples/GettingStarted/Models/Person.cs

@@ -1,9 +1,11 @@
 using System.Collections.Generic;
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace GettingStarted.Models
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class Person : Identifiable
     {
         [Attr]

src/Examples/GettingStarted/Program.cs

@@ -3,14 +3,14 @@
 
 namespace GettingStarted
 {
-    public class Program
+    internal static class Program
     {
         public static void Main(string[] args)
         {
             CreateHostBuilder(args).Build().Run();
         }
 
-        public static IHostBuilder CreateHostBuilder(string[] args) =>
+        private static IHostBuilder CreateHostBuilder(string[] args) =>
             Host.CreateDefaultBuilder(args)
                 .ConfigureWebHostDefaults(webBuilder =>
                 {

src/Examples/GettingStarted/Startup.cs

@@ -1,5 +1,6 @@
 using GettingStarted.Data;
 using GettingStarted.Models;
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.EntityFrameworkCore;
@@ -27,6 +28,7 @@ public void ConfigureServices(IServiceCollection services)
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        [UsedImplicitly]
         public void Configure(IApplicationBuilder app, SampleDbContext context)
         {
             context.Database.EnsureDeleted();

src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs

@@ -1,8 +1,12 @@
+using JetBrains.Annotations;
 using JsonApiDotNetCoreExample.Models;
 using Microsoft.EntityFrameworkCore;
 
+// @formatter:wrap_chained_method_calls chop_always
+
 namespace JsonApiDotNetCoreExample.Data
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class AppDbContext : DbContext
     {
         public DbSet<TodoItem> TodoItems { get; set; }
@@ -37,7 +41,7 @@ protected override void OnModelCreating(ModelBuilder builder)
                 .OnDelete(DeleteBehavior.Cascade);
 
             builder.Entity<TodoItem>()
-                .HasMany(t => t.ChildrenTodos)
+                .HasMany(t => t.ChildTodoItems)
                 .WithOne(t => t.ParentTodo);
 
             builder.Entity<Passport>()

src/Examples/JsonApiDotNetCoreExample/Definitions/ArticleHooksDefinition.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Hooks.Internal.Execution;
@@ -10,7 +11,8 @@
 
 namespace JsonApiDotNetCoreExample.Definitions
 {
-    public class ArticleHooksDefinition : ResourceHooksDefinition<Article>
+    [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+    public sealed class ArticleHooksDefinition : ResourceHooksDefinition<Article>
     {
         public ArticleHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }
 

src/Examples/JsonApiDotNetCoreExample/Definitions/LockableHooksDefinition.cs

@@ -25,7 +25,8 @@ protected void DisallowLocked(IEnumerable<T> resources)
                 {
                     throw new JsonApiException(new Error(HttpStatusCode.Forbidden)
                     {
-                        Title = $"You are not allowed to update fields or relationships of locked resource of type '{_resourceGraph.GetResourceContext<T>().PublicName}'."
+                        Title = "You are not allowed to update fields or relationships of " +
+                            $"locked resource of type '{_resourceGraph.GetResourceContext<T>().PublicName}'."
                     });
                 }
             }

src/Examples/JsonApiDotNetCoreExample/Definitions/PassportHooksDefinition.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Hooks.Internal.Execution;
@@ -9,7 +10,8 @@
 
 namespace JsonApiDotNetCoreExample.Definitions
 {
-    public class PassportHooksDefinition : LockableHooksDefinition<Passport>
+    [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+    public sealed class PassportHooksDefinition : LockableHooksDefinition<Passport>
     {
         public PassportHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
         {

src/Examples/JsonApiDotNetCoreExample/Definitions/PersonHooksDefinition.cs

@@ -1,12 +1,14 @@
 using System.Collections.Generic;
 using System.Linq;
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Hooks.Internal.Execution;
 using JsonApiDotNetCoreExample.Models;
 
 namespace JsonApiDotNetCoreExample.Definitions
 {
-    public class PersonHooksDefinition : LockableHooksDefinition<Person>
+    [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+    public sealed class PersonHooksDefinition : LockableHooksDefinition<Person>
     {
         public PersonHooksDefinition(IResourceGraph resourceGraph) : base(resourceGraph) { }