Skip to content

Commit d01c1f2

Browse files
author
Bart Koelman
committed
Renamed ITraversalHelper to INodeNavigator
1 parent dc93930 commit d01c1f2

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

‎src/JsonApiDotNetCore/Configuration/JsonApiApplicationBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ private void AddResourceHooks()
262262
_services.AddScoped(typeof(IResourceHookContainer<>), typeof(ResourceHooksDefinition<>));
263263
_services.AddTransient<IResourceHookExecutor, ResourceHookExecutor>();
264264
_services.AddTransient<IHookExecutorHelper, HookExecutorHelper>();
265-
_services.AddScoped<ITraversalHelper, TraversalHelper>();
265+
_services.AddScoped<INodeNavigator, NodeNavigator>();
266266
_services.AddScoped<IResourceHookExecutorFacade, ResourceHookExecutorFacade>();
267267
}
268268
else

‎src/JsonApiDotNetCore/Hooks/Internal/IResourceHookExecutor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace JsonApiDotNetCore.Hooks.Internal
77
/// <summary>
88
/// Transient service responsible for executing Resource Hooks as defined in <see cref="ResourceHooksDefinition{TResource}" />. See methods in
99
/// <see cref="IReadHookExecutor" />, <see cref="IUpdateHookExecutor" /> and <see cref="IOnReturnHookExecutor" /> for more information. Uses
10-
/// <see cref="TraversalHelper" /> for traversal of nested resource data structures. Uses <see cref="HookExecutorHelper" /> for retrieving meta data
10+
/// <see cref="NodeNavigator" /> for traversal of nested resource data structures. Uses <see cref="HookExecutorHelper" /> for retrieving meta data
1111
/// about hooks, fetching database values and performing other recurring internal operations.
1212
/// </summary>
1313
public interface IResourceHookExecutor : IReadHookExecutor, IUpdateHookExecutor, ICreateHookExecutor, IDeleteHookExecutor, IOnReturnHookExecutor

‎src/JsonApiDotNetCore/Hooks/Internal/ResourceHookExecutor.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ internal sealed class ResourceHookExecutor : IResourceHookExecutor
2626
private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();
2727

2828
private readonly IHookExecutorHelper _executorHelper;
29-
private readonly ITraversalHelper _traversalHelper;
29+
private readonly INodeNavigator _nodeNavigator;
3030
private readonly IEnumerable<IQueryConstraintProvider> _constraintProviders;
3131
private readonly ITargetedFields _targetedFields;
3232
private readonly IResourceGraph _resourceGraph;
3333

34-
public ResourceHookExecutor(IHookExecutorHelper executorHelper, ITraversalHelper traversalHelper, ITargetedFields targetedFields,
34+
public ResourceHookExecutor(IHookExecutorHelper executorHelper, INodeNavigator nodeNavigator, ITargetedFields targetedFields,
3535
IEnumerable<IQueryConstraintProvider> constraintProviders, IResourceGraph resourceGraph)
3636
{
3737
_executorHelper = executorHelper;
38-
_traversalHelper = traversalHelper;
38+
_nodeNavigator = nodeNavigator;
3939
_targetedFields = targetedFields;
4040
_constraintProviders = constraintProviders;
4141
_resourceGraph = resourceGraph;
@@ -86,7 +86,7 @@ public IEnumerable<TResource> BeforeUpdate<TResource>(IEnumerable<TResource> res
8686
result.Node.Reassign(resources);
8787
}
8888

89-
FireNestedBeforeUpdateHooks(pipeline, _traversalHelper.CreateNextLayer(result.Node));
89+
FireNestedBeforeUpdateHooks(pipeline, _nodeNavigator.CreateNextLayer(result.Node));
9090
return resources;
9191
}
9292

@@ -104,7 +104,7 @@ public IEnumerable<TResource> BeforeCreate<TResource>(IEnumerable<TResource> res
104104
result.Node.Reassign(resources);
105105
}
106106

107-
FireNestedBeforeUpdateHooks(pipeline, _traversalHelper.CreateNextLayer(result.Node));
107+
FireNestedBeforeUpdateHooks(pipeline, _nodeNavigator.CreateNextLayer(result.Node));
108108
return resources;
109109
}
110110

@@ -157,7 +157,7 @@ public IEnumerable<TResource> OnReturn<TResource>(IEnumerable<TResource> resourc
157157
result.Node.Reassign(resources);
158158
}
159159

160-
TraverseNodesInLayer(_traversalHelper.CreateNextLayer(result.Node), ResourceHook.OnReturn, (nextContainer, nextNode) =>
160+
TraverseNodesInLayer(_nodeNavigator.CreateNextLayer(result.Node), ResourceHook.OnReturn, (nextContainer, nextNode) =>
161161
{
162162
IEnumerable filteredUniqueSet = CallHook(nextContainer, ResourceHook.OnReturn, ArrayFactory.Create<object>(nextNode.UniqueResources, pipeline));
163163
nextNode.UpdateUnique(filteredUniqueSet);
@@ -178,7 +178,7 @@ public void AfterRead<TResource>(IEnumerable<TResource> resources, ResourcePipel
178178
result.Container.AfterRead((HashSet<TResource>)result.Node.UniqueResources, pipeline);
179179
}
180180

181-
TraverseNodesInLayer(_traversalHelper.CreateNextLayer(result.Node), ResourceHook.AfterRead, (nextContainer, nextNode) =>
181+
TraverseNodesInLayer(_nodeNavigator.CreateNextLayer(result.Node), ResourceHook.AfterRead, (nextContainer, nextNode) =>
182182
{
183183
CallHook(nextContainer, ResourceHook.AfterRead, ArrayFactory.Create<object>(nextNode.UniqueResources, pipeline, true));
184184
});
@@ -195,7 +195,7 @@ public void AfterCreate<TResource>(IEnumerable<TResource> resources, ResourcePip
195195
result.Container.AfterCreate((HashSet<TResource>)result.Node.UniqueResources, pipeline);
196196
}
197197

198-
TraverseNodesInLayer(_traversalHelper.CreateNextLayer(result.Node), ResourceHook.AfterUpdateRelationship,
198+
TraverseNodesInLayer(_nodeNavigator.CreateNextLayer(result.Node), ResourceHook.AfterUpdateRelationship,
199199
(nextContainer, nextNode) => FireAfterUpdateRelationship(nextContainer, nextNode, pipeline));
200200
}
201201

@@ -210,7 +210,7 @@ public void AfterUpdate<TResource>(IEnumerable<TResource> resources, ResourcePip
210210
result.Container.AfterUpdate((HashSet<TResource>)result.Node.UniqueResources, pipeline);
211211
}
212212

213-
TraverseNodesInLayer(_traversalHelper.CreateNextLayer(result.Node), ResourceHook.AfterUpdateRelationship,
213+
TraverseNodesInLayer(_nodeNavigator.CreateNextLayer(result.Node), ResourceHook.AfterUpdateRelationship,
214214
(nextContainer, nextNode) => FireAfterUpdateRelationship(nextContainer, nextNode, pipeline));
215215
}
216216

@@ -238,7 +238,7 @@ public void AfterDelete<TResource>(IEnumerable<TResource> resources, ResourcePip
238238
private GetHookResult<TResource> GetHook<TResource>(ResourceHook target, IEnumerable<TResource> resources)
239239
where TResource : class, IIdentifiable
240240
{
241-
RootNode<TResource> node = _traversalHelper.CreateRootNode(resources);
241+
RootNode<TResource> node = _nodeNavigator.CreateRootNode(resources);
242242
IResourceHookContainer<TResource> container = _executorHelper.GetResourceHookContainer<TResource>(target);
243243

244244
return new GetHookResult<TResource>(container, node);
@@ -257,7 +257,7 @@ private void TraverseNodesInLayer(IEnumerable<IResourceNode> currentLayer, Resou
257257

258258
TraverseNextLayer(nextLayer, action, target);
259259

260-
nextLayer = _traversalHelper.CreateNextLayer(nextLayer.ToList());
260+
nextLayer = _nodeNavigator.CreateNextLayer(nextLayer.ToList());
261261
}
262262
}
263263

‎src/JsonApiDotNetCore/Hooks/Internal/Traversal/ITraversalHelper.cs renamed to ‎src/JsonApiDotNetCore/Hooks/Internal/Traversal/INodeNavigator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace JsonApiDotNetCore.Hooks.Internal.Traversal
55
{
6-
internal interface ITraversalHelper
6+
internal interface INodeNavigator
77
{
88
/// <summary>
99
/// Creates the next layer

‎src/JsonApiDotNetCore/Hooks/Internal/Traversal/TraversalHelper.cs renamed to ‎src/JsonApiDotNetCore/Hooks/Internal/Traversal/NodeNavigator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace JsonApiDotNetCore.Hooks.Internal.Traversal
1515
/// breadth-first-traversal It creates nodes for each layer. Typically, the first layer is homogeneous (all resources have the same type), and further
1616
/// nodes can be mixed.
1717
/// </summary>
18-
internal sealed class TraversalHelper : ITraversalHelper
18+
internal sealed class NodeNavigator : INodeNavigator
1919
{
2020
private static readonly HooksObjectFactory ObjectFactory = new HooksObjectFactory();
2121
private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();
@@ -34,7 +34,7 @@ internal sealed class TraversalHelper : ITraversalHelper
3434
/// </summary>
3535
private Dictionary<RightType, HashSet<IIdentifiable>> _processedResources;
3636

37-
public TraversalHelper(IResourceGraph resourceGraph, ITargetedFields targetedFields)
37+
public NodeNavigator(IResourceGraph resourceGraph, ITargetedFields targetedFields)
3838
{
3939
_targetedFields = targetedFields;
4040
_resourceGraph = resourceGraph;

‎test/UnitTests/ResourceHooks/HooksTestsSetup.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ protected TestObjectsA<TPrimary> CreateTestObjects<TPrimary>(IHooksDiscovery<TPr
5555
SetupProcessorFactoryForResourceDefinition(gpfMock, primaryResource.Object, primaryDiscovery);
5656

5757
var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
58-
var traversalHelper = new TraversalHelper(ResourceGraph, ufMock.Object);
58+
var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
5959
var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
6060

6161
return new TestObjectsA<TPrimary>(hookExecutor, primaryResource);
@@ -82,7 +82,7 @@ protected TestObjectsB<TPrimary, TSecondary> CreateTestObjects<TPrimary, TSecond
8282
SetupProcessorFactoryForResourceDefinition(gpfMock, secondaryResource.Object, secondaryDiscovery, dbContext, resourceGraph);
8383

8484
var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
85-
var traversalHelper = new TraversalHelper(ResourceGraph, ufMock.Object);
85+
var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
8686
var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
8787

8888
return new TestObjectsB<TPrimary, TSecondary>(constraintsMock, ufMock, hookExecutor, primaryResource, secondaryResource);
@@ -114,7 +114,7 @@ protected TestObjectsC<TPrimary, TFirstSecondary, TSecondSecondary> CreateTestOb
114114
SetupProcessorFactoryForResourceDefinition(gpfMock, secondSecondaryResource.Object, secondSecondaryDiscovery, dbContext, resourceGraph);
115115

116116
var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
117-
var traversalHelper = new TraversalHelper(ResourceGraph, ufMock.Object);
117+
var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
118118
var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
119119

120120
return new TestObjectsC<TPrimary, TFirstSecondary, TSecondSecondary>(constraintsMock, hookExecutor, primaryResource, firstSecondaryResource,

0 commit comments

Comments
 (0)