Simpler registration for resource definitions

Author: Bart Koelman

src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs

@@ -5,6 +5,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Repositories;
+using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Building;
 using JsonApiDotNetCore.Serialization.Client.Internal;
 using JsonApiDotNetCore.Services;
@@ -101,6 +102,19 @@ public static IServiceCollection AddResourceRepository<TRepository>(this IServic
             return services;
         }
 
+        /// <summary>
+        /// Adds IoC container registrations for the various JsonApiDotNetCore resource definition interfaces, such as
+        /// <see cref="IResourceDefinition{TResource}" /> and <see cref="IResourceDefinition{TResource,TId}" />.
+        /// </summary>
+        public static IServiceCollection AddResourceDefinition<TResourceDefinition>(this IServiceCollection services)
+        {
+            ArgumentGuard.NotNull(services, nameof(services));
+
+            RegisterForConstructedType(services, typeof(TResourceDefinition), ServiceDiscoveryFacade.ResourceDefinitionInterfaces);
+
+            return services;
+        }
+
         private static void RegisterForConstructedType(IServiceCollection services, Type implementationType, IEnumerable<Type> openGenericInterfaces)
         {
             bool seenCompatibleInterface = false;

test/JsonApiDotNetCoreExampleTests/IntegrationTests/AtomicOperations/Meta/AtomicResourceMetaTests.cs

@@ -1,14 +1,12 @@
-using System;
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
 using FluentAssertions;
 using FluentAssertions.Extensions;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExample.Controllers;
 using JsonApiDotNetCoreExampleTests.Startups;
-using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -27,8 +25,8 @@ public AtomicResourceMetaTests(ExampleIntegrationTestContext<TestableStartup<Ope
 
             testContext.ConfigureServicesAfterStartup(services =>
             {
-                services.AddScoped<IResourceDefinition<MusicTrack, Guid>, MusicTrackMetaDefinition>();
-                services.AddScoped<IResourceDefinition<TextLanguage, Guid>, TextLanguageMetaDefinition>();
+                services.AddResourceDefinition<MusicTrackMetaDefinition>();
+                services.AddResourceDefinition<TextLanguageMetaDefinition>();
             });
         }
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/AtomicOperations/QueryStrings/AtomicQueryStringTests.cs

@@ -6,7 +6,6 @@
 using FluentAssertions;
 using FluentAssertions.Extensions;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExample.Controllers;
 using JsonApiDotNetCoreExampleTests.Startups;
@@ -38,7 +37,7 @@ public AtomicQueryStringTests(ExampleIntegrationTestContext<TestableStartup<Oper
                     UtcNow = FrozenTime
                 });
 
-                services.AddScoped<IResourceDefinition<MusicTrack, Guid>, MusicTrackReleaseDefinition>();
+                services.AddResourceDefinition<MusicTrackReleaseDefinition>();
             });
 
             var options = (JsonApiOptions)testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();

test/JsonApiDotNetCoreExampleTests/IntegrationTests/AtomicOperations/ResourceDefinitions/AtomicSparseFieldSetResourceDefinitionTests.cs

@@ -3,6 +3,7 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using FluentAssertions;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExample.Controllers;
@@ -28,7 +29,7 @@ public AtomicSparseFieldSetResourceDefinitionTests(ExampleIntegrationTestContext
             testContext.ConfigureServicesAfterStartup(services =>
             {
                 services.AddSingleton<LyricPermissionProvider>();
-                services.AddScoped<IResourceDefinition<Lyric, long>, LyricTextDefinition>();
+                services.AddResourceDefinition<LyricTextDefinition>();
                 services.AddScoped(typeof(IResourceChangeTracker<>), typeof(NeverSameResourceChangeTracker<>));
             });
         }

test/JsonApiDotNetCoreExampleTests/IntegrationTests/EagerLoading/EagerLoadingTests.cs

@@ -2,11 +2,10 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using FluentAssertions;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExampleTests.Startups;
 using Microsoft.EntityFrameworkCore;
-using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -27,7 +26,7 @@ public EagerLoadingTests(ExampleIntegrationTestContext<TestableStartup<EagerLoad
 
             testContext.ConfigureServicesAfterStartup(services =>
             {
-                services.AddScoped<IResourceDefinition<Building>, BuildingResourceDefinition>();
+                services.AddResourceDefinition<BuildingResourceDefinition>();
             });
         }
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Meta/ResourceMetaTests.cs

@@ -3,10 +3,9 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using FluentAssertions;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExampleTests.Startups;
-using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -26,7 +25,7 @@ public ResourceMetaTests(ExampleIntegrationTestContext<TestableStartup<SupportDb
 
             testContext.ConfigureServicesAfterStartup(services =>
             {
-                services.AddScoped<IResourceDefinition<SupportTicket>, SupportTicketDefinition>();
+                services.AddResourceDefinition<SupportTicketDefinition>();
             });
         }
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/ResourceDefinitionQueryCallbackTests.cs

@@ -5,7 +5,6 @@
 using FluentAssertions;
 using FluentAssertions.Extensions;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExampleTests.Startups;
 using Microsoft.Extensions.DependencyInjection;
@@ -27,7 +26,7 @@ public ResourceDefinitionQueryCallbackTests(ExampleIntegrationTestContext<Testab
 
             testContext.ConfigureServicesAfterStartup(services =>
             {
-                services.AddScoped<IResourceDefinition<CallableResource>, CallableResourceDefinition>();
+                services.AddResourceDefinition<CallableResourceDefinition>();
                 services.AddSingleton<IUserRolesService, FakeUserRolesService>();
             });
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/SoftDeletion/SoftDeletionTests.cs

@@ -4,10 +4,9 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using FluentAssertions;
-using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCoreExampleTests.Startups;
-using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -26,8 +25,8 @@ public SoftDeletionTests(ExampleIntegrationTestContext<TestableStartup<SoftDelet
 
             testContext.ConfigureServicesAfterStartup(services =>
             {
-                services.AddScoped<IResourceDefinition<Company>, SoftDeletionResourceDefinition<Company>>();
-                services.AddScoped<IResourceDefinition<Department>, SoftDeletionResourceDefinition<Department>>();
+                services.AddResourceDefinition<SoftDeletionResourceDefinition<Company>>();
+                services.AddResourceDefinition<SoftDeletionResourceDefinition<Department>>();
             });
         }
 

test/UnitTests/Extensions/ServiceCollectionExtensionsTests.cs

@@ -170,6 +170,34 @@ public void AddResourceRepository_Registers_All_LongForm_Repository_Interfaces()
             Assert.IsType<GuidResourceRepository>(provider.GetRequiredService(typeof(IResourceWriteRepository<GuidResource, Guid>)));
         }
 
+        [Fact]
+        public void AddResourceDefinition_Registers_Shorthand_Definition_Interface()
+        {
+            // Arrange
+            var services = new ServiceCollection();
+
+            // Act
+            services.AddResourceDefinition<IntResourceDefinition>();
+
+            // Assert
+            ServiceProvider provider = services.BuildServiceProvider();
+            Assert.IsType<IntResourceDefinition>(provider.GetRequiredService(typeof(IResourceDefinition<IntResource>)));
+        }
+
+        [Fact]
+        public void AddResourceDefinition_Registers_LongForm_Definition_Interface()
+        {
+            // Arrange
+            var services = new ServiceCollection();
+
+            // Act
+            services.AddResourceDefinition<GuidResourceDefinition>();
+
+            // Assert
+            ServiceProvider provider = services.BuildServiceProvider();
+            Assert.IsType<GuidResourceDefinition>(provider.GetRequiredService(typeof(IResourceDefinition<GuidResource, Guid>)));
+        }
+
         [Fact]
         public void AddJsonApi_With_Context_Uses_Resource_Type_Name_If_NoOtherSpecified()
         {
@@ -421,6 +449,154 @@ public Task RemoveFromToManyRelationshipAsync(GuidResource primaryResource, ISet
             }
         }
 
+        [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+        private sealed class IntResourceDefinition : IResourceDefinition<IntResource>
+        {
+            public IReadOnlyCollection<IncludeElementExpression> OnApplyIncludes(IReadOnlyCollection<IncludeElementExpression> existingIncludes)
+            {
+                throw new NotImplementedException();
+            }
+
+            public FilterExpression OnApplyFilter(FilterExpression existingFilter)
+            {
+                throw new NotImplementedException();
+            }
+
+            public SortExpression OnApplySort(SortExpression existingSort)
+            {
+                throw new NotImplementedException();
+            }
+
+            public PaginationExpression OnApplyPagination(PaginationExpression existingPagination)
+            {
+                throw new NotImplementedException();
+            }
+
+            public SparseFieldSetExpression OnApplySparseFieldSet(SparseFieldSetExpression existingSparseFieldSet)
+            {
+                throw new NotImplementedException();
+            }
+
+            public QueryStringParameterHandlers<IntResource> OnRegisterQueryableHandlersForQueryStringParameters()
+            {
+                throw new NotImplementedException();
+            }
+
+            public IDictionary<string, object> GetMeta(IntResource resource)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnInitializeResourceAsync(IntResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeCreateResourceAsync(IntResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterCreateResourceAsync(IntResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeUpdateResourceAsync(IntResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterUpdateResourceAsync(IntResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeDeleteResourceAsync(int id, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterDeleteResourceAsync(int id, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+        }
+
+        [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+        private sealed class GuidResourceDefinition : IResourceDefinition<GuidResource, Guid>
+        {
+            public IReadOnlyCollection<IncludeElementExpression> OnApplyIncludes(IReadOnlyCollection<IncludeElementExpression> existingIncludes)
+            {
+                throw new NotImplementedException();
+            }
+
+            public FilterExpression OnApplyFilter(FilterExpression existingFilter)
+            {
+                throw new NotImplementedException();
+            }
+
+            public SortExpression OnApplySort(SortExpression existingSort)
+            {
+                throw new NotImplementedException();
+            }
+
+            public PaginationExpression OnApplyPagination(PaginationExpression existingPagination)
+            {
+                throw new NotImplementedException();
+            }
+
+            public SparseFieldSetExpression OnApplySparseFieldSet(SparseFieldSetExpression existingSparseFieldSet)
+            {
+                throw new NotImplementedException();
+            }
+
+            public QueryStringParameterHandlers<GuidResource> OnRegisterQueryableHandlersForQueryStringParameters()
+            {
+                throw new NotImplementedException();
+            }
+
+            public IDictionary<string, object> GetMeta(GuidResource resource)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnInitializeResourceAsync(GuidResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeCreateResourceAsync(GuidResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterCreateResourceAsync(GuidResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeUpdateResourceAsync(GuidResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterUpdateResourceAsync(GuidResource resource, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnBeforeDeleteResourceAsync(Guid id, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+
+            public Task OnAfterDeleteResourceAsync(Guid id, CancellationToken cancellationToken)
+            {
+                throw new NotImplementedException();
+            }
+        }
+
         [UsedImplicitly(ImplicitUseTargetFlags.Members)]
         private sealed class TestContext : DbContext
         {