Cleanup dead and duplicate code; moved essential registration to top-level namespace

Author: Bart Koelman

src/Examples/GettingStarted/Startup.cs

@@ -1,7 +1,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.EntityFrameworkCore;
-using JsonApiDotNetCore.Extensions;
+using JsonApiDotNetCore;
 
 namespace GettingStarted
 {

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -6,6 +6,7 @@
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
 using System;
+using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Query;
 using JsonApiDotNetCoreExample.Services;
@@ -42,7 +43,7 @@ public virtual void ConfigureServices(IServiceCollection services)
                 .AddJsonApi(ConfigureJsonApiOptions, discovery => discovery.AddCurrentAssembly());
 
             // once all tests have been moved to WebApplicationFactory format we can get rid of this line below
-            services.AddClientSerialization(); 
+            services.AddClientSerialization();
         }
 
         protected virtual void ConfigureJsonApiOptions(JsonApiOptions options)

src/Examples/NoEntityFrameworkExample/Startup.cs

@@ -1,5 +1,5 @@
 using System;
-using JsonApiDotNetCore.Extensions;
+using JsonApiDotNetCore;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;

src/Examples/ReportsExample/Startup.cs

@@ -1,4 +1,4 @@
-using JsonApiDotNetCore.Extensions;
+using JsonApiDotNetCore;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs

@@ -1,6 +1,7 @@
 using System;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Data;
+using JsonApiDotNetCore.Extensions.EntityFrameworkCore;
 using JsonApiDotNetCore.Formatters;
 using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal;
@@ -29,12 +30,12 @@ namespace JsonApiDotNetCore.Builders
     /// A utility class that builds a JsonApi application. It registers all required services
     /// and allows the user to override parts of the startup configuration.
     /// </summary>
-    public class JsonApiApplicationBuilder
+    internal sealed class JsonApiApplicationBuilder
     {
         private readonly JsonApiOptions _options = new JsonApiOptions();
-        internal IResourceGraphBuilder _resourceGraphBuilder;
-        internal bool _usesDbContext;
-        internal readonly IServiceCollection _services;
+        private IResourceGraphBuilder _resourceGraphBuilder;
+        private bool _usesDbContext;
+        private readonly IServiceCollection _services;
         private IServiceDiscoveryFacade _serviceDiscoveryFacade;
         private readonly IMvcCoreBuilder _mvcBuilder;
 
@@ -47,7 +48,10 @@ public JsonApiApplicationBuilder(IServiceCollection services, IMvcCoreBuilder mv
         /// <summary>
         /// Executes the action provided by the user to configure <see cref="JsonApiOptions"/>
         /// </summary>
-        public void ConfigureJsonApiOptions(Action<JsonApiOptions> configureOptions) => configureOptions(_options);
+        public void ConfigureJsonApiOptions(Action<JsonApiOptions> options)
+        {
+            options?.Invoke(_options);
+        }
 
         /// <summary>
         /// Configures built-in .NET Core MVC (things like middleware, routing). Most of this configuration can be adjusted for the developers' need.
@@ -90,16 +94,25 @@ public void ConfigureMvc()
         /// </summary>
         public void AutoDiscover(Action<IServiceDiscoveryFacade> autoDiscover)
         {
-            autoDiscover(_serviceDiscoveryFacade);
+            autoDiscover?.Invoke(_serviceDiscoveryFacade);
+        }
+
+        public void ConfigureResourcesFromDbContext<TDbContext>(Action<IResourceGraphBuilder> resources)
+            where TDbContext : DbContext
+        {
+            _resourceGraphBuilder.AddDbContext<TDbContext>();
+            _usesDbContext = true;
+            _services.AddScoped<IDbContextResolver, DbContextResolver<TDbContext>>();
+
+            ConfigureResources(resources);
         }
 
         /// <summary>
         /// Executes the action provided by the user to configure the resources using <see cref="IResourceGraphBuilder"/>
         /// </summary>
-        /// <param name="resourceGraphBuilder"></param>
-        public void ConfigureResources(Action<IResourceGraphBuilder> resourceGraphBuilder)
+        public void ConfigureResources(Action<IResourceGraphBuilder> resources)
         {
-            resourceGraphBuilder(_resourceGraphBuilder);
+            resources?.Invoke(_resourceGraphBuilder);
         }
 
         /// <summary>

src/JsonApiDotNetCore/Data/DbContextResolver.cs

@@ -2,12 +2,12 @@
 
 namespace JsonApiDotNetCore.Data
 {
-    public sealed class DbContextResolver<TContext> : IDbContextResolver
-        where TContext : DbContext
+    public sealed class DbContextResolver<TDbContext> : IDbContextResolver
+        where TDbContext : DbContext
     {
-        private readonly TContext _context;
+        private readonly TDbContext _context;
 
-        public DbContextResolver(TContext context)
+        public DbContextResolver(TDbContext context)
         {
             _context = context;
         }

src/JsonApiDotNetCore/Extensions/IApplicationBuilderExtensions.cs renamed to src/JsonApiDotNetCore/Extensions/ApplicationBuilderExtensions.cs

@@ -6,29 +6,26 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
-namespace JsonApiDotNetCore.Extensions
+namespace JsonApiDotNetCore
 {
-    // ReSharper disable once InconsistentNaming
-    public static class IApplicationBuilderExtensions
+    public static class ApplicationBuilderExtensions
     {
         /// <summary>
-        /// Runs several internal JsonApiDotNetCore services to ensure proper configuration and registers required middlewares. 
-        /// The <paramref name="skipRegisterMiddleware"/> can be used to skip any middleware registration, in which case the developer
-        /// is responsible for registering middleware that are required for JsonApiDotNetCore.
+        /// Validates the resource graph and optionally registers the JsonApiDotNetCore middleware.
         /// </summary>
-        /// <param name="app"></param>
-        /// <param name="skipRegisterMiddleware">Indicates if JsonApiDotNetCore should skip middleware registration. This enables a user to take full control of middleware registration.</param>
-        /// <param name="useAuthentication">Indicates if .NET Core authentication middleware should be registered. Ignored when <paramref name="skipRegisterMiddleware"/> is set to true.</param>
-        /// <param name="useAuthorization">Indicates if .NET Core authentication middleware should be registered. Ignored when <paramref name="skipRegisterMiddleware"/> is set to true.</param>
+        /// <remarks>
+        /// The <paramref name="skipRegisterMiddleware"/> can be used to skip any middleware registration, in which case the developer
+        /// is responsible for registering required middleware.
+        /// </remarks>
+        /// <param name="skipRegisterMiddleware">Indicates to not register any middleware. This enables callers to take full control of middleware registration order.</param>
+        /// <param name="useAuthentication">Indicates if 'app.UseAuthentication()' should be called. Ignored when <paramref name="skipRegisterMiddleware"/> is set to true.</param>
+        /// <param name="useAuthorization">Indicates if 'app.UseAuthorization()' should be called. Ignored when <paramref name="skipRegisterMiddleware"/> is set to true.</param>
         /// <example>
-        /// This example illustrate which required middlewares should be registered when using the <paramref name="skipRegisterMiddleware"/> option.
+        /// The next example illustrates how to manually register middleware.
         /// <code>
         /// app.UseJsonApi(skipRegisterMiddleware: true);
-        /// // JADNC requires routing
         /// app.UseRouting();
-        /// // JADNC requires CurrentRequestMiddleware 
         /// app.UseMiddleware{CurrentRequestMiddleware}();
-        /// // JANDC requires the endpoint feature enabled as follows
         /// app.UseEndpoints(endpoints => endpoints.MapControllers());
         /// </code>
         /// </example>
@@ -41,7 +38,8 @@ public static void UseJsonApi(this IApplicationBuilder app, bool skipRegisterMid
                 inverseRelationshipResolver?.Resolve();
             }
 
-            if (!skipRegisterMiddleware) {
+            if (!skipRegisterMiddleware) 
+            {
                 // An endpoint is selected and set on the HttpContext if a match is found
                 app.UseRouting();
 
@@ -65,12 +63,12 @@ public static void UseJsonApi(this IApplicationBuilder app, bool skipRegisterMid
 
         private static void LogResourceGraphValidations(IApplicationBuilder app)
         {
-            var logger = app.ApplicationServices.GetService(typeof(ILogger<ResourceGraphBuilder>)) as ILogger;
-            var resourceGraph = app.ApplicationServices.GetService(typeof(IResourceGraph)) as ResourceGraph;
+            var logger = (ILogger)app.ApplicationServices.GetService(typeof(ILogger<ResourceGraphBuilder>));
+            var resourceGraph = (ResourceGraph)app.ApplicationServices.GetService(typeof(IResourceGraph));
 
             if (logger != null)
             {
-                resourceGraph?.ValidationResults.ForEach((v) => logger.Log(v.LogLevel, null, v.Message));
+                resourceGraph?.ValidationResults.ForEach(v => logger.Log(v.LogLevel, null, v.Message));
             }
         }
     }

src/JsonApiDotNetCore/Extensions/DbContextExtensions.cs

@@ -11,30 +11,11 @@ namespace JsonApiDotNetCore.Extensions
 {
     public static class DbContextExtensions
     {
-        /// <summary>
-        /// Get the DbSet when the model type is unknown until runtime
-        /// </summary>
-        public static IQueryable<object> Set(this DbContext context, Type t)
-            => (IQueryable<object>)context
-                .GetType()
-                .GetMethod("Set")
-                .MakeGenericMethod(t) // TODO: will caching help runtime performance?
-                .Invoke(context, null);
-
-        /// <summary>
-        /// Determines whether or not EF is already tracking an entity of the same Type and Id
-        /// </summary>
-        public static bool EntityIsTracked(this DbContext context, IIdentifiable entity)
-        {
-            return GetTrackedEntity(context, entity) != null;
-        }
-
-
         /// <summary>
         /// Determines whether or not EF is already tracking an entity of the same Type and Id
         /// and returns that entity.
         /// </summary>
-        public static IIdentifiable GetTrackedEntity(this DbContext context, IIdentifiable entity)
+        internal static IIdentifiable GetTrackedEntity(this DbContext context, IIdentifiable entity)
         {
             if (entity == null)
                 throw new ArgumentNullException(nameof(entity));
@@ -49,7 +30,6 @@ public static IIdentifiable GetTrackedEntity(this DbContext context, IIdentifiab
             return (IIdentifiable)trackedEntries?.Entity;
         }
 
-
         /// <summary>
         /// Gets the current transaction or creates a new one.
         /// If a transaction already exists, commit, rollback and dispose

src/JsonApiDotNetCore/Extensions/IEnumerableExtensions.cs renamed to src/JsonApiDotNetCore/Extensions/EnumerableExtensions.cs

@@ -1,10 +1,10 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using JsonApiDotNetCore.Query;
 
 namespace JsonApiDotNetCore.Extensions
 {
-    public static class IEnumerableExtensions
+    public static class EnumerableExtensions
     {
         /// <summary>
         /// gets the first element of type <typeparamref name="TImplementedService"/> if it exists and casts the result to that.

src/JsonApiDotNetCore/Extensions/IQueryableExtensions.cs renamed to src/JsonApiDotNetCore/Extensions/QueryableExtensions.cs

@@ -11,8 +11,7 @@
 
 namespace JsonApiDotNetCore.Extensions
 {
-    // ReSharper disable once InconsistentNaming
-    public static class IQueryableExtensions
+    public static class QueryableExtensions
     {
         private static MethodInfo _containsMethod;
         private static MethodInfo ContainsMethod