style: rename GenericProcessorFactory --> GenericServiceFactory

maurei · maurei · commit 6a186a5d9535 · 2019-10-22T15:11:46.000+02:00
diff --git a/benchmarks/Serialization/JsonApiSerializer_Benchmarks.cs b/benchmarks/Serialization/JsonApiSerializer_Benchmarks.cs
@@ -34,7 +34,7 @@
 //            jsonApiOptions.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
 //            jsonApiContextMock.Setup(m => m.Options).Returns(jsonApiOptions);
 
-//            var genericProcessorFactoryMock = new Mock<IGenericProcessorFactory>();
+//            var genericServiceFactoryMock = new Mock<IgenericServiceFactory>();
 
 //            var documentBuilder = new BaseDocumentBuilder(jsonApiContextMock.Object);
 //            _jsonApiSerializer = new JsonApiSerializer(jsonApiContextMock.Object, documentBuilder);
diff --git a/src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs b/src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs
@@ -154,7 +154,7 @@ public void ConfigureServices()
             _services.AddScoped<IScopedServiceProvider, RequestScopedServiceProvider>();
             _services.AddScoped<IJsonApiWriter, JsonApiWriter>();
             _services.AddScoped<IJsonApiReader, JsonApiReader>();
-            _services.AddScoped<IGenericProcessorFactory, GenericProcessorFactory>();
+            _services.AddScoped<IGenericServiceFactory, genericServiceFactory>();
             _services.AddScoped(typeof(HasManyThroughUpdateHelper<>));
             _services.AddScoped<IQueryParameterDiscovery, QueryParameterDiscovery>();
             _services.AddScoped<ITargetedFields, TargetedFields>();
diff --git a/src/JsonApiDotNetCore/Data/DefaultResourceRepository.cs b/src/JsonApiDotNetCore/Data/DefaultResourceRepository.cs
@@ -25,26 +25,26 @@ public class DefaultResourceRepository<TResource, TId> : IResourceRepository<TRe
         private readonly DbContext _context;
         private readonly DbSet<TResource> _dbSet;
         private readonly IResourceGraph _resourceGraph;
-        private readonly IGenericProcessorFactory _genericProcessorFactory;
+        private readonly IGenericServiceFactory _genericServiceFactory;
 
         public DefaultResourceRepository(
             ITargetedFields targetedFields,
             IDbContextResolver contextResolver,
             IResourceGraph resourceGraph,
-            IGenericProcessorFactory genericProcessorFactory)
-            : this(targetedFields, contextResolver, resourceGraph, genericProcessorFactory, null)
+            IGenericServiceFactory genericServiceFactory)
+            : this(targetedFields, contextResolver, resourceGraph, genericServiceFactory, null)
         { }
 
         public DefaultResourceRepository(
             ITargetedFields targetedFields,
             IDbContextResolver contextResolver,
             IResourceGraph resourceGraph,
-            IGenericProcessorFactory genericProcessorFactory,
+            IGenericServiceFactory genericServiceFactory,
             ILoggerFactory loggerFactory = null)
         {
             _targetedFields = targetedFields;
             _resourceGraph = resourceGraph;
-            _genericProcessorFactory = genericProcessorFactory;
+            _genericServiceFactory = genericServiceFactory;
             _context = contextResolver.GetContext();
             _dbSet = _context.Set<TResource>();
         }
@@ -258,7 +258,7 @@ public async Task UpdateRelationshipsAsync(object parent, RelationshipAttribute
         {
             if (relationship is HasManyThroughAttribute hasManyThrough)
             {
-                var helper = _genericProcessorFactory.GetProcessor<IHasManyThroughUpdateHelper>(typeof(HasManyThroughUpdateHelper<>), hasManyThrough.ThroughType);
+                var helper = _genericServiceFactory.Get<IHasManyThroughUpdateHelper>(typeof(HasManyThroughUpdateHelper<>), hasManyThrough.ThroughType);
                 await helper.UpdateAsync((IIdentifiable)parent, hasManyThrough, relationshipIds);
                 return;
             }
@@ -424,17 +424,17 @@ public class DefaultResourceRepository<TResource> : DefaultResourceRepository<TR
         public DefaultResourceRepository(ITargetedFields targetedFields,
                                        IDbContextResolver contextResolver,
                                        IResourceGraph contextEntityProvider,
-                                       IGenericProcessorFactory genericProcessorFactory)
-            : base(targetedFields, contextResolver, contextEntityProvider, genericProcessorFactory)
+                                       IGenericServiceFactory genericServiceFactory)
+            : base(targetedFields, contextResolver, contextEntityProvider, genericServiceFactory)
         {
         }
 
         public DefaultResourceRepository(ITargetedFields targetedFields,
                                        IDbContextResolver contextResolver,
                                        IResourceGraph contextEntityProvider,
-                                       IGenericProcessorFactory genericProcessorFactory,
+                                       IGenericServiceFactory genericServiceFactory,
                                        ILoggerFactory loggerFactory = null)
-            : base(targetedFields, contextResolver, contextEntityProvider, genericProcessorFactory, loggerFactory)
+            : base(targetedFields, contextResolver, contextEntityProvider, genericServiceFactory, loggerFactory)
         {
         }
     }
diff --git a/src/JsonApiDotNetCore/Internal/Generics/GenericServiceFactory.cs b/src/JsonApiDotNetCore/Internal/Generics/GenericServiceFactory.cs
@@ -8,7 +8,7 @@ namespace JsonApiDotNetCore.Internal.Generics
     /// are not known until runtime. The typical use case would be for
     /// accessing relationship data or resolving operations processors.
     /// </summary>
-    public interface IGenericProcessorFactory
+    public interface IGenericServiceFactory
     {
         /// <summary>
         /// Constructs the generic type and locates the service, then casts to TInterface
@@ -18,7 +18,7 @@ public interface IGenericProcessorFactory
         ///     GetProcessor&lt;IGenericProcessor&gt;(typeof(GenericProcessor&lt;&gt;), typeof(TResource));
         /// </code>
         /// </example>
-        TInterface GetProcessor<TInterface>(Type openGenericType, Type resourceType);
+        TInterface Get<TInterface>(Type openGenericType, Type resourceType);
 
         /// <summary>
         /// Constructs the generic type and locates the service, then casts to TInterface
@@ -28,25 +28,25 @@ public interface IGenericProcessorFactory
         ///     GetProcessor&lt;IGenericProcessor&gt;(typeof(GenericProcessor&lt;,&gt;), typeof(TResource), typeof(TId));
         /// </code>
         /// </example>
-        TInterface GetProcessor<TInterface>(Type openGenericType, Type resourceType, Type keyType);
+        TInterface Get<TInterface>(Type openGenericType, Type resourceType, Type keyType);
     }
 
-    public class GenericProcessorFactory : IGenericProcessorFactory
+    public class GenericServiceFactory : IGenericServiceFactory
     {
         private readonly IServiceProvider _serviceProvider;
 
-        public GenericProcessorFactory(IScopedServiceProvider serviceProvider)
+        public GenericServiceFactory(IScopedServiceProvider serviceProvider)
         {
             _serviceProvider = serviceProvider;
         }
 
-        public TInterface GetProcessor<TInterface>(Type openGenericType, Type resourceType)
-            => GetProcessorInternal<TInterface>(openGenericType, resourceType);
+        public TInterface Get<TInterface>(Type openGenericType, Type resourceType)
+            => GetInternal<TInterface>(openGenericType, resourceType);
 
-        public TInterface GetProcessor<TInterface>(Type openGenericType, Type resourceType, Type keyType)
-            => GetProcessorInternal<TInterface>(openGenericType, resourceType, keyType);
+        public TInterface Get<TInterface>(Type openGenericType, Type resourceType, Type keyType)
+            => GetInternal<TInterface>(openGenericType, resourceType, keyType);
 
-        private TInterface GetProcessorInternal<TInterface>(Type openGenericType, params Type[] types)
+        private TInterface GetInternal<TInterface>(Type openGenericType, params Type[] types)
         {
             var concreteType = openGenericType.MakeGenericType(types);
 
diff --git a/src/JsonApiDotNetCore/Internal/Generics/HasManyThroughUpdateHelper.cs b/src/JsonApiDotNetCore/Internal/Generics/HasManyThroughUpdateHelper.cs
@@ -12,18 +12,17 @@ namespace JsonApiDotNetCore.Internal.Generics
 {
     /// <summary>
     /// A special helper service that gets instantiated for the right-type of a many-to-many relationship and is responsible for
-    /// processing updates for that relationships
+    /// processing updates for that relationships.
     /// </summary>
     public interface IHasManyThroughUpdateHelper
     {
+        /// <summary>
+        /// Processes updates of has many through relationship.
+        /// </summary>
         Task UpdateAsync(IIdentifiable parent, HasManyThroughAttribute relationship, IEnumerable<string> relationshipIds);
     }
 
-    /// <summary>
-    /// A special processor that gets instantiated for a generic type (&lt;T&gt;)
-    /// when the actual type is not known until runtime. Specifically, this is used for updating
-    /// relationships.
-    /// </summary>
+    /// <inheritdoc/>
     public class HasManyThroughUpdateHelper<T> : IHasManyThroughUpdateHelper where T : class
     {
         private readonly DbContext _context;
@@ -32,6 +31,7 @@ public HasManyThroughUpdateHelper(IDbContextResolver contextResolver)
             _context = contextResolver.GetContext();
         }
 
+        /// <inheritdoc/>
         public virtual async Task UpdateAsync(IIdentifiable parent, HasManyThroughAttribute relationship, IEnumerable<string> relationshipIds)
         {
             // we need to create a transaction for the HasManyThrough case so we can get and remove any existing
diff --git a/test/UnitTests/ResourceHooks/ResourceHooksTestsSetup.cs b/test/UnitTests/ResourceHooks/ResourceHooksTestsSetup.cs
@@ -141,9 +141,9 @@ protected List<TodoItem> CreateTodoWithOwner()
 
     public class HooksTestsSetup : HooksDummyData
     {
-        (Mock<ITargetedFields>, Mock<IIncludeService>, Mock<IGenericProcessorFactory>, IJsonApiOptions) CreateMocks()
+        (Mock<ITargetedFields>, Mock<IIncludeService>, Mock<IGenericServiceFactory>, IJsonApiOptions) CreateMocks()
         {
-            var pfMock = new Mock<IGenericProcessorFactory>();
+            var pfMock = new Mock<IGenericServiceFactory>();
             var ufMock = new Mock<ITargetedFields>();
             var iqsMock = new Mock<IIncludeService>();
             var optionsMock = new JsonApiOptions { LoaDatabaseValues = false };
@@ -156,7 +156,7 @@ public class HooksTestsSetup : HooksDummyData
             // creates the resource definition mock and corresponding ImplementedHooks discovery instance
             var mainResource = CreateResourceDefinition(mainDiscovery);
 
-            // mocking the GenericProcessorFactory and JsonApiContext and wiring them up.
+            // mocking the genericServiceFactory and JsonApiContext and wiring them up.
             var (ufMock, iqMock, gpfMock, options) = CreateMocks();
 
             SetupProcessorFactoryForResourceDefinition(gpfMock, mainResource.Object, mainDiscovery, null);
@@ -181,7 +181,7 @@ public class HooksTestsSetup : HooksDummyData
             var mainResource = CreateResourceDefinition(mainDiscovery);
             var nestedResource = CreateResourceDefinition(nestedDiscovery);
 
-            // mocking the GenericProcessorFactory and JsonApiContext and wiring them up.
+            // mocking the genericServiceFactory and JsonApiContext and wiring them up.
             var (ufMock, iqMock, gpfMock, options) = CreateMocks();
 
             var dbContext = repoDbContextOptions != null ? new AppDbContext(repoDbContextOptions) : null;
@@ -212,7 +212,7 @@ public class HooksTestsSetup : HooksDummyData
             var firstNestedResource = CreateResourceDefinition(firstNestedDiscovery);
             var secondNestedResource = CreateResourceDefinition(secondNestedDiscovery);
 
-            // mocking the GenericProcessorFactory and JsonApiContext and wiring them up.
+            // mocking the genericServiceFactory and JsonApiContext and wiring them up.
             var (ufMock, iqMock, gpfMock, options) = CreateMocks();
 
             var dbContext = repoDbContextOptions != null ? new AppDbContext(repoDbContextOptions) : null;
@@ -311,17 +311,17 @@ void MockHooks<TModel>(Mock<IResourceHookContainer<TModel>> resourceDefinition)
         }
 
         void SetupProcessorFactoryForResourceDefinition<TModel>(
-        Mock<IGenericProcessorFactory> processorFactory,
+        Mock<IGenericServiceFactory> processorFactory,
         IResourceHookContainer<TModel> modelResource,
         IHooksDiscovery<TModel> discovery,
         AppDbContext dbContext = null
         )
         where TModel : class, IIdentifiable<int>
         {
-            processorFactory.Setup(c => c.GetProcessor<IResourceHookContainer>(typeof(ResourceDefinition<>), typeof(TModel)))
+            processorFactory.Setup(c => c.Gett<<IResourceHookContainer>(typeof(ResourceDefinition<>), typeof(TModel)))
             .Returns(modelResource);
 
-            processorFactory.Setup(c => c.GetProcessor<IHooksDiscovery>(typeof(IHooksDiscovery<>), typeof(TModel)))
+            processorFactory.Setup(c => c.Gett<<IHooksDiscovery>(typeof(IHooksDiscovery<>), typeof(TModel)))
             .Returns(discovery);
 
             if (dbContext != null)
@@ -330,7 +330,7 @@ void SetupProcessorFactoryForResourceDefinition<TModel>(
                 if (idType == typeof(int))
                 {
                     IResourceReadRepository<TModel, int> repo = CreateTestRepository<TModel>(dbContext);
-                    processorFactory.Setup(c => c.GetProcessor<IResourceReadRepository<TModel, int>>(typeof(IResourceReadRepository<,>), typeof(TModel), typeof(int))).Returns(repo);
+                    processorFactory.Setup(c => c.Gett<<IResourceReadRepository<TModel, int>>(typeof(IResourceReadRepository<,>), typeof(TModel), typeof(int))).Returns(repo);
                 }
                 else
                 {

Original file line number	Diff line number	Diff line change
`@@ -12,18 +12,17 @@ namespace JsonApiDotNetCore.Internal.Generics`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`	`14`	`/// A special helper service that gets instantiated for the right-type of a many-to-many relationship and is responsible for`
`15`		`- /// processing updates for that relationships`
	`15`	`+ /// processing updates for that relationships.`
`16`	`16`	`/// </summary>`
`17`	`17`	`public interface IHasManyThroughUpdateHelper`
`18`	`18`	`{`
	`19`	`+ /// <summary>`
	`20`	`+ /// Processes updates of has many through relationship.`
	`21`	`+ /// </summary>`
`19`	`22`	`Task UpdateAsync(IIdentifiable parent, HasManyThroughAttribute relationship, IEnumerable<string> relationshipIds);`
`20`	`23`	`}`
`21`	`24`
`22`		`- /// <summary>`
`23`		`- /// A special processor that gets instantiated for a generic type (<T>)`
`24`		`- /// when the actual type is not known until runtime. Specifically, this is used for updating`
`25`		`- /// relationships.`
`26`		`- /// </summary>`
	`25`	`+ /// <inheritdoc/>`
`27`	`26`	`public class HasManyThroughUpdateHelper<T> : IHasManyThroughUpdateHelper where T : class`
`28`	`27`	`{`
`29`	`28`	`private readonly DbContext _context;`
`@@ -32,6 +31,7 @@ public HasManyThroughUpdateHelper(IDbContextResolver contextResolver)`
`32`	`31`	`_context = contextResolver.GetContext();`
`33`	`32`	`}`
`34`	`33`
	`34`	`+ /// <inheritdoc/>`
`35`	`35`	`public virtual async Task UpdateAsync(IIdentifiable parent, HasManyThroughAttribute relationship, IEnumerable<string> relationshipIds)`
`36`	`36`	`{`
`37`	`37`	`// we need to create a transaction for the HasManyThrough case so we can get and remove any existing`