Code cleanup (#691)

* Fixed: XML comment is not placed on a valid language element

* Fixed: Convert to method group

* Fixed: Use null propagation

* Fixed: Use string interpolation expression

* Fixed: Use lambda expression

* Fixed: Convert to compound assignment

* Fixed: Convert to 'using' declaration

* Fixed: Use 'await using'

* Fixed: Convert to '?:' expression

* Fixed: Merge conditional expression

* Fixed: Use object initializer

* Fixed: Qualifier is redundant

* Fixed: Using directive is not required by the code and can be safely removed

* Fixed: Redundant explicit array type specification

* Fixed: Type argument specification is redundant

* Fixed: Comparison with true is redundant

* Fixed: Redundant string interpolation

* Fixed: Conditional access qualifier expression is known to be not null

* Fixed: Empty object or collection initializer list is redundant

* Fixed: Redundant explicit array creation in argument of 'params' parameter

* Fixed: Type cast is redundant

* Fixed: The parameter {name} has the same default value

* Fixed: Empty argument list is redundant

* Fixed: Expression is always null

* Fixed: Value assigned is not used in any execution path

* Fixed: Redundant 'IEnumerable.Cast<T>' call

* Fixed: '??' right operand is always null

* Fixed: Redundant 'Object.ToString()' call

* Fixed: Qualifier 'base.' is redundant

* Fixed: The field is always assigned before being used and can be converted to local variable

* Fixed: Merge cast with type check

* Fixed: Replace with single call to First(..)

* Fixed: Replace 'Enumerable.Count()' invocation with collection count property access

* Fixed: Use format specifier

* Fixed: Field is assigned but its value is never used

* Fixed: Field can be made readonly

* Fixed: Redundant method override

* Fixed: Method is never used

* Fixed: Base interface is redundant

* Fixed: Field is never used

* Fixed: Local variable is never used

* Fixed: Method return value is never used

* Fixed: Constructor is never used

* Fixed: shared instance is never used

* Fixed: Parameter is never used

* Fixed: Method is never used

* Fixed: Initializing field/property by default value is redundant

* Fixed: Redundant base constructor call

* Fixed: parameter hides outer local variable with the same name

* Fixed: Cannot resolve symbol 'dynamic'

* Fixed: Possible unintended reference comparison

* Fixed: Co-variant array conversion can cause run-time exception on write operation

* Fixed: Return value of pure method is not used

* Fixed: Auto-property can be made get-only

* Fixed: Inconsistent body style: use expression-bodied property

* Fixed: Empty statement is redundant

* Fixed: Local variable can be declared in inner scope

* Fixed: Join declaration and assignment

* Fixed: Convert constructor to protected in abstract class

* Fixed: Replace with single call to FirstOrDefault/Count

* Fixed: Use single deconstruction declaration

* Fixed: Removed unused using directives

* Fixed a few obvious naming violations

* Fixed: Virtual member that is never overridden

* Removed DefaultPageSize/RequestedPageSize from IPageService because where the calculated value comes from is an implementation detail and should not be exposed to external code that uses paging.

* Fixed: Initializing property by default value is redundant

* Reduced accessibility for some non-public types/members

* Fixed: missing checkbox in Solution Configuration Manager

* Made non-public (and a few public) types sealed

* Fixed: Inconsistent modifiers style

* Removed reference to xunit from benchmarks project, so that 'dotnet test' does not try to run tests from it

* Empty commit to retry cibuild

* Update IQueryableExtensions.cs

Co-authored-by: Maurits Moeys <maurei@users.noreply.github.com>

Author: Bart Koelman

JsonApiDotnetCore.sln

@@ -108,6 +108,7 @@ Global
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Debug|x86.ActiveCfg = Debug|Any CPU
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Debug|x86.Build.0 = Debug|Any CPU
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Release|Any CPU.Build.0 = Release|Any CPU
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Release|x64.ActiveCfg = Release|Any CPU
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Release|x64.Build.0 = Release|Any CPU
 		{DF0FCFB2-CB12-44BA-BBB5-1BE0BCFCD14C}.Release|x86.ActiveCfg = Release|Any CPU

benchmarks/BenchmarkResource.cs

@@ -2,7 +2,7 @@
 
 namespace Benchmarks
 {
-    public class BenchmarkResource : Identifiable
+    public sealed class BenchmarkResource : Identifiable
     {
         [Attr(BenchmarkResourcePublicNames.NameAttr)] 
         public string Name { get; set; }
@@ -17,7 +17,7 @@ public class SubResource : Identifiable
         public string Value { get; set; }
     }
 
-    public static class BenchmarkResourcePublicNames
+    internal static class BenchmarkResourcePublicNames
     {
         public const string NameAttr = "full-name";
         public const string Type = "simple-types";

benchmarks/Benchmarks.csproj

@@ -6,7 +6,6 @@
   <ItemGroup>
     <PackageReference Include="BenchmarkDotNet" Version="0.12.0" />
     <PackageReference Include="moq" Version="$(MoqVersion)" />
-    <PackageReference Include="xunit" Version="$(xUnitVersion)" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="../src/JsonApiDotNetCore/JsonApiDotNetCore.csproj" />

benchmarks/Program.cs

@@ -5,9 +5,9 @@
 
 namespace Benchmarks
 {
-    class Program
+    internal class Program
     {
-        static void Main(string[] args)
+        private static void Main(string[] args)
         {
             var switcher = new BenchmarkSwitcher(new[]
             {

src/Examples/GettingStarted/Controllers/ArticlesController.cs

@@ -6,7 +6,7 @@
 
 namespace GettingStarted
 {
-    public class ArticlesController : JsonApiController<Article>
+    public sealed class ArticlesController : JsonApiController<Article>
     {
         public ArticlesController(
             IJsonApiOptions jsonApiOptions,

src/Examples/GettingStarted/Controllers/PeopleController.cs

@@ -6,7 +6,7 @@
 
 namespace GettingStarted
 {
-    public class PeopleController : JsonApiController<Person>
+    public sealed class PeopleController : JsonApiController<Person>
     {
         public PeopleController(
             IJsonApiOptions jsonApiOptions,

src/Examples/GettingStarted/Models/Article.cs

@@ -2,12 +2,12 @@
 
 namespace GettingStarted.Models
 {
-    public class Article : Identifiable
+    public sealed class Article : Identifiable
     {
         [Attr]
         public string Title { get; set; }
         [HasOne]
         public Person Author { get; set; }
         public int AuthorId { get; set; }
     }
-}
+}

src/Examples/GettingStarted/Models/Person.cs

@@ -3,11 +3,11 @@
 
 namespace GettingStarted.Models
 {
-    public class Person : Identifiable
+    public sealed class Person : Identifiable
     {
         [Attr] 
         public string Name { get; set; }
         [HasMany] 
         public List<Article> Articles { get; set; }
     }
-}
+}

src/Examples/GettingStarted/ResourceDefinitionExample/Model.cs

@@ -2,7 +2,7 @@
 
 namespace GettingStarted.ResourceDefinitionExample
 {
-    public class Model : Identifiable
+    public sealed class Model : Identifiable
     {
         [Attr]
         public string DoNotExpose { get; set; }

src/Examples/GettingStarted/ResourceDefinitionExample/ModelDefinition.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Models;
 

src/Examples/GettingStarted/ResourceDefinitionExample/ModelsController.cs

@@ -5,7 +5,7 @@
 
 namespace GettingStarted.ResourceDefinitionExample
 {
-    public class ModelsController : JsonApiController<Model>
+    public sealed class ModelsController : JsonApiController<Model>
     {
         public ModelsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/GettingStarted/Startup.cs

@@ -5,7 +5,7 @@
 
 namespace GettingStarted
 {
-    public class Startup
+    public sealed class Startup
     {
         public void ConfigureServices(IServiceCollection services)
         {

src/Examples/JsonApiDotNetCoreExample/Controllers/ArticlesController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class ArticlesController : JsonApiController<Article>
+    public sealed class ArticlesController : JsonApiController<Article>
     {
         public ArticlesController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/CamelCasedModelsController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class KebabCasedModelsController : JsonApiController<KebabCasedModel>
+    public sealed class KebabCasedModelsController : JsonApiController<KebabCasedModel>
     {
         public KebabCasedModelsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/PassportsController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class PassportsController : JsonApiController<Passport>
+    public sealed class PassportsController : JsonApiController<Passport>
     {
         public PassportsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/PeopleController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class PeopleController : JsonApiController<Person>
+    public sealed class PeopleController : JsonApiController<Person>
     {
         public PeopleController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/PersonRolesController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class PersonRolesController : JsonApiController<PersonRole>
+    public sealed class PersonRolesController : JsonApiController<PersonRole>
     {
         public PersonRolesController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/TagsController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class TagsController : JsonApiController<Tag>
+    public sealed class TagsController : JsonApiController<Tag>
     {
         public TagsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/TestValuesController.cs

@@ -8,7 +8,7 @@ public class TestValuesController : ControllerBase
         [HttpGet]
         public IActionResult Get()
         {
-            var result = new string[] { "value" };
+            var result = new[] { "value" };
             return Ok(result);
         }
     }

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoCollectionsController.cs

@@ -12,9 +12,9 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class TodoCollectionsController : JsonApiController<TodoItemCollection, Guid>
+    public sealed class TodoCollectionsController : JsonApiController<TodoItemCollection, Guid>
     {
-        readonly IDbContextResolver _dbResolver;
+        private readonly IDbContextResolver _dbResolver;
 
         public TodoCollectionsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class TodoItemsController : JsonApiController<TodoItem>
+    public sealed class TodoItemsController : JsonApiController<TodoItem>
     {
         public TodoItemsController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsCustomController.cs

@@ -28,31 +28,28 @@ public CustomJsonApiController(
             IJsonApiOptions options,
             IResourceService<T, int> resourceService,
             ILoggerFactory loggerFactory)
-            : base(options, resourceService, loggerFactory)
+            : base(options, resourceService)
         {
         }
     }
 
     public class CustomJsonApiController<T, TId>
     : ControllerBase where T : class, IIdentifiable<TId>
     {
-        private readonly ILogger _logger;
         private readonly IJsonApiOptions _options;
         private readonly IResourceService<T, TId> _resourceService;
 
-        protected IActionResult Forbidden()
+        private IActionResult Forbidden()
         {
             return new StatusCodeResult(403);
         }
 
         public CustomJsonApiController(
             IJsonApiOptions options,
-            IResourceService<T, TId> resourceService,
-            ILoggerFactory loggerFactory)
+            IResourceService<T, TId> resourceService)
         {
             _options = options;
             _resourceService = resourceService;
-            _logger = loggerFactory.CreateLogger<JsonApiController<T, TId>>();
         }
 
         public CustomJsonApiController(
@@ -62,14 +59,14 @@ public CustomJsonApiController(
         }
 
         [HttpGet]
-        public virtual async Task<IActionResult> GetAsync()
+        public async Task<IActionResult> GetAsync()
         {
             var entities = await _resourceService.GetAsync();
             return Ok(entities);
         }
 
         [HttpGet("{id}")]
-        public virtual async Task<IActionResult> GetAsync(TId id)
+        public async Task<IActionResult> GetAsync(TId id)
         {
             var entity = await _resourceService.GetAsync(id);
 
@@ -80,7 +77,7 @@ public virtual async Task<IActionResult> GetAsync(TId id)
         }
 
         [HttpGet("{id}/relationships/{relationshipName}")]
-        public virtual async Task<IActionResult> GetRelationshipsAsync(TId id, string relationshipName)
+        public async Task<IActionResult> GetRelationshipsAsync(TId id, string relationshipName)
         {
             var relationship = _resourceService.GetRelationshipAsync(id, relationshipName);
             if (relationship == null)
@@ -90,14 +87,14 @@ public virtual async Task<IActionResult> GetRelationshipsAsync(TId id, string re
         }
 
         [HttpGet("{id}/{relationshipName}")]
-        public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string relationshipName)
+        public async Task<IActionResult> GetRelationshipAsync(TId id, string relationshipName)
         {
             var relationship = await _resourceService.GetRelationshipAsync(id, relationshipName);
             return Ok(relationship);
         }
 
         [HttpPost]
-        public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
+        public async Task<IActionResult> PostAsync([FromBody] T entity)
         {
             if (entity == null)
                 return UnprocessableEntity();
@@ -111,7 +108,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
         }
 
         [HttpPatch("{id}")]
-        public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
+        public async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
         {
             if (entity == null)
                 return UnprocessableEntity();
@@ -125,14 +122,14 @@ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
         }
 
         [HttpPatch("{id}/relationships/{relationshipName}")]
-        public virtual async Task<IActionResult> PatchRelationshipsAsync(TId id, string relationshipName, [FromBody] List<ResourceObject> relationships)
+        public async Task<IActionResult> PatchRelationshipsAsync(TId id, string relationshipName, [FromBody] List<ResourceObject> relationships)
         {
             await _resourceService.UpdateRelationshipsAsync(id, relationshipName, relationships);
             return Ok();
         }
 
         [HttpDelete("{id}")]
-        public virtual async Task<IActionResult> DeleteAsync(TId id)
+        public async Task<IActionResult> DeleteAsync(TId id)
         {
             var wasDeleted = await _resourceService.DeleteAsync(id);
 

src/Examples/JsonApiDotNetCoreExample/Controllers/UsersController.cs

@@ -6,7 +6,7 @@
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    public class UsersController : JsonApiController<User>
+    public sealed class UsersController : JsonApiController<User>
     {
         public UsersController(
             IJsonApiOptions jsonApiOptions,
@@ -16,7 +16,7 @@ public UsersController(
         { }
     }
 
-    public class SuperUsersController : JsonApiController<SuperUser>
+    public sealed class SuperUsersController : JsonApiController<SuperUser>
     {
         public SuperUsersController(
             IJsonApiOptions jsonApiOptions,

src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs

@@ -3,7 +3,7 @@
 
 namespace JsonApiDotNetCoreExample.Data
 {
-    public class AppDbContext : DbContext
+    public sealed class AppDbContext : DbContext
     {
         public DbSet<TodoItem> TodoItems { get; set; }
         public DbSet<Passport> Passports { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/Article.cs

@@ -4,7 +4,7 @@
 
 namespace JsonApiDotNetCoreExample.Models
 {
-    public class Article : Identifiable
+    public sealed class Article : Identifiable
     {
         [Attr]
         public string Name { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/ArticleTag.cs

@@ -2,7 +2,7 @@
 
 namespace JsonApiDotNetCoreExample.Models
 {
-    public class ArticleTag
+    public sealed class ArticleTag
     {
         public int ArticleId { get; set; }
         public Article Article { get; set; }
@@ -24,4 +24,4 @@ public class IdentifiableArticleTag : Identifiable
 
         public string SomeMetaData { get; set; }
     }
-}
+}

src/Examples/JsonApiDotNetCoreExample/Models/Author.cs

@@ -3,7 +3,7 @@
 
 namespace JsonApiDotNetCoreExample.Models
 {
-    public class Author : Identifiable
+    public sealed class Author : Identifiable
     {
         [Attr]
         public string Name { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/Passport.cs

@@ -2,12 +2,12 @@
 
 namespace JsonApiDotNetCoreExample.Models
 {
-    public class Passport : Identifiable
+    public sealed class Passport : Identifiable
     {
-        public virtual int? SocialSecurityNumber { get; set; }
-        public virtual bool IsLocked { get; set; }
+        public int? SocialSecurityNumber { get; set; }
+        public bool IsLocked { get; set; }
 
         [HasOne]
-        public virtual Person Person { get; set; }
+        public Person Person { get; set; }
     }
-}
+}