Use __invoke instead of apply for stages (#2989)

alanpoulain · web-flow · commit dec408ad877c · 2019-08-19T21:59:30.000+02:00
diff --git a/src/GraphQl/Resolver/Factory/CollectionResolverFactory.php b/src/GraphQl/Resolver/Factory/CollectionResolverFactory.php
@@ -66,7 +66,7 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
             $operationName = $operationName ?? 'query';
             $resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => true, 'is_mutation' => false];
 
-            $collection = $this->readStage->apply($resourceClass, $rootClass, $operationName, $resolverContext);
+            $collection = ($this->readStage)($resourceClass, $rootClass, $operationName, $resolverContext);
             if (!is_iterable($collection)) {
                 throw new \LogicException('Collection from read stage should be iterable.');
             }
@@ -80,14 +80,14 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
                 $collection = $queryResolver($collection, $resolverContext);
             }
 
-            $this->denyAccessStage->apply($resourceClass, $operationName, $resolverContext + [
+            ($this->denyAccessStage)($resourceClass, $operationName, $resolverContext + [
                 'extra_variables' => [
                     'object' => $collection,
                     'previous_object' => \is_object($collection) ? clone $collection : $collection,
                 ],
             ]);
 
-            return $this->serializeStage->apply($collection, $resourceClass, $operationName, $resolverContext);
+            return ($this->serializeStage)($collection, $resourceClass, $operationName, $resolverContext);
         };
     }
 }
diff --git a/src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php b/src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php
@@ -67,27 +67,27 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
 
             $resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => false, 'is_mutation' => true];
 
-            $item = $this->readStage->apply($resourceClass, $rootClass, $operationName, $resolverContext);
+            $item = ($this->readStage)($resourceClass, $rootClass, $operationName, $resolverContext);
             if (null !== $item && !\is_object($item)) {
                 throw new \LogicException('Item from read stage should be a nullable object.');
             }
 
             $previousItem = \is_object($item) ? clone $item : $item;
 
             if ('delete' === $operationName) {
-                $this->denyAccessStage->apply($resourceClass, $operationName, $resolverContext + [
+                ($this->denyAccessStage)($resourceClass, $operationName, $resolverContext + [
                     'extra_variables' => [
                         'object' => $item,
                         'previous_object' => $previousItem,
                     ],
                 ]);
 
-                $item = $this->writeStage->apply($item, $resourceClass, $operationName, $resolverContext);
+                $item = ($this->writeStage)($item, $resourceClass, $operationName, $resolverContext);
 
-                return $this->serializeStage->apply($item, $resourceClass, $operationName, $resolverContext);
+                return ($this->serializeStage)($item, $resourceClass, $operationName, $resolverContext);
             }
 
-            $item = $this->deserializeStage->apply($item, $resourceClass, $operationName, $resolverContext);
+            $item = ($this->deserializeStage)($item, $resourceClass, $operationName, $resolverContext);
 
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
@@ -101,20 +101,20 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
                 }
             }
 
-            $this->denyAccessStage->apply($resourceClass, $operationName, $resolverContext + [
+            ($this->denyAccessStage)($resourceClass, $operationName, $resolverContext + [
                 'extra_variables' => [
                     'object' => $item,
                     'previous_object' => $previousItem,
                 ],
             ]);
 
             if (null !== $item) {
-                $this->validateStage->apply($item, $resourceClass, $operationName, $resolverContext);
+                ($this->validateStage)($item, $resourceClass, $operationName, $resolverContext);
 
-                $persistResult = $this->writeStage->apply($item, $resourceClass, $operationName, $resolverContext);
+                $persistResult = ($this->writeStage)($item, $resourceClass, $operationName, $resolverContext);
             }
 
-            return $this->serializeStage->apply($persistResult ?? $item, $resourceClass, $operationName, $resolverContext);
+            return ($this->serializeStage)($persistResult ?? $item, $resourceClass, $operationName, $resolverContext);
         };
     }
 }
diff --git a/src/GraphQl/Resolver/Factory/ItemResolverFactory.php b/src/GraphQl/Resolver/Factory/ItemResolverFactory.php
@@ -61,7 +61,7 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
             $operationName = $operationName ?? 'query';
             $resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => false, 'is_mutation' => false];
 
-            $item = $this->readStage->apply($resourceClass, $rootClass, $operationName, $resolverContext);
+            $item = ($this->readStage)($resourceClass, $rootClass, $operationName, $resolverContext);
             if (null !== $item && !\is_object($item)) {
                 throw new \LogicException('Item from read stage should be a nullable object.');
             }
@@ -77,14 +77,14 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
                 $resourceClass = $this->getResourceClass($item, $resourceClass, $info, sprintf('Custom query resolver "%s"', $queryResolverId).' has to return an item of class %s but returned an item of class %s.');
             }
 
-            $this->denyAccessStage->apply($resourceClass, $operationName, $resolverContext + [
+            ($this->denyAccessStage)($resourceClass, $operationName, $resolverContext + [
                 'extra_variables' => [
                     'object' => $item,
                     'previous_object' => \is_object($item) ? clone $item : $item,
                 ],
             ]);
 
-            return $this->serializeStage->apply($item, $resourceClass, $operationName, $resolverContext);
+            return ($this->serializeStage)($item, $resourceClass, $operationName, $resolverContext);
         };
     }
 
diff --git a/src/GraphQl/Resolver/Stage/DenyAccessStage.php b/src/GraphQl/Resolver/Stage/DenyAccessStage.php
@@ -39,7 +39,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply(string $resourceClass, string $operationName, array $context): void
+    public function __invoke(string $resourceClass, string $operationName, array $context): void
     {
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
diff --git a/src/GraphQl/Resolver/Stage/DenyAccessStageInterface.php b/src/GraphQl/Resolver/Stage/DenyAccessStageInterface.php
@@ -27,5 +27,5 @@ interface DenyAccessStageInterface
     /**
      * @throws Error
      */
-    public function apply(string $resourceClass, string $operationName, array $context): void;
+    public function __invoke(string $resourceClass, string $operationName, array $context): void;
 }
diff --git a/src/GraphQl/Resolver/Stage/DeserializeStage.php b/src/GraphQl/Resolver/Stage/DeserializeStage.php
@@ -42,7 +42,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply($objectToPopulate, string $resourceClass, string $operationName, array $context)
+    public function __invoke($objectToPopulate, string $resourceClass, string $operationName, array $context)
     {
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
         if (!$resourceMetadata->getGraphqlAttribute($operationName, 'deserialize', true, true)) {
diff --git a/src/GraphQl/Resolver/Stage/DeserializeStageInterface.php b/src/GraphQl/Resolver/Stage/DeserializeStageInterface.php
@@ -27,5 +27,5 @@ interface DeserializeStageInterface
      *
      * @return object|null
      */
-    public function apply($objectToPopulate, string $resourceClass, string $operationName, array $context);
+    public function __invoke($objectToPopulate, string $resourceClass, string $operationName, array $context);
 }
diff --git a/src/GraphQl/Resolver/Stage/ReadStage.php b/src/GraphQl/Resolver/Stage/ReadStage.php
@@ -53,7 +53,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply(?string $resourceClass, ?string $rootClass, string $operationName, array $context)
+    public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context)
     {
         $resourceMetadata = $resourceClass ? $this->resourceMetadataFactory->create($resourceClass) : null;
         if ($resourceMetadata && !$resourceMetadata->getGraphqlAttribute($operationName, 'read', true, true)) {
diff --git a/src/GraphQl/Resolver/Stage/ReadStageInterface.php b/src/GraphQl/Resolver/Stage/ReadStageInterface.php
@@ -25,5 +25,5 @@ interface ReadStageInterface
     /**
      * @return object|iterable|null
      */
-    public function apply(?string $resourceClass, ?string $rootClass, string $operationName, array $context);
+    public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context);
 }
diff --git a/src/GraphQl/Resolver/Stage/SerializeStage.php b/src/GraphQl/Resolver/Stage/SerializeStage.php
@@ -46,7 +46,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array
+    public function __invoke($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array
     {
         $isCollection = $context['is_collection'];
         $isMutation = $context['is_mutation'];
diff --git a/src/GraphQl/Resolver/Stage/SerializeStageInterface.php b/src/GraphQl/Resolver/Stage/SerializeStageInterface.php
@@ -25,5 +25,5 @@ interface SerializeStageInterface
     /**
      * @param object|iterable|null $itemOrCollection
      */
-    public function apply($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array;
+    public function __invoke($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array;
 }
diff --git a/src/GraphQl/Resolver/Stage/ValidateStage.php b/src/GraphQl/Resolver/Stage/ValidateStage.php
@@ -40,7 +40,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply($object, string $resourceClass, string $operationName, array $context): void
+    public function __invoke($object, string $resourceClass, string $operationName, array $context): void
     {
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
         if (!$resourceMetadata->getGraphqlAttribute($operationName, 'validate', true, true)) {
diff --git a/src/GraphQl/Resolver/Stage/ValidateStageInterface.php b/src/GraphQl/Resolver/Stage/ValidateStageInterface.php
@@ -29,5 +29,5 @@ interface ValidateStageInterface
      *
      * @throws Error
      */
-    public function apply($object, string $resourceClass, string $operationName, array $context): void;
+    public function __invoke($object, string $resourceClass, string $operationName, array $context): void;
 }
diff --git a/src/GraphQl/Resolver/Stage/WriteStage.php b/src/GraphQl/Resolver/Stage/WriteStage.php
@@ -41,7 +41,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function apply($data, string $resourceClass, string $operationName, array $context)
+    public function __invoke($data, string $resourceClass, string $operationName, array $context)
     {
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
         if (null === $data || !$resourceMetadata->getGraphqlAttribute($operationName, 'write', true, true)) {
diff --git a/src/GraphQl/Resolver/Stage/WriteStageInterface.php b/src/GraphQl/Resolver/Stage/WriteStageInterface.php
@@ -27,5 +27,5 @@ interface WriteStageInterface
      *
      * @return object|null
      */
-    public function apply($data, string $resourceClass, string $operationName, array $context);
+    public function __invoke($data, string $resourceClass, string $operationName, array $context);
 }
diff --git a/tests/GraphQl/Resolver/Factory/CollectionResolverFactoryTest.php b/tests/GraphQl/Resolver/Factory/CollectionResolverFactoryTest.php
@@ -80,19 +80,19 @@ public function testResolve(): void
         $this->requestStackProphecy->getCurrentRequest()->willReturn($request);
 
         $readStageCollection = [new \stdClass()];
-        $this->readStageProphecy->apply($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
+        $this->readStageProphecy->__invoke($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
 
         $this->resourceMetadataFactoryProphecy->create($resourceClass)->willReturn(new ResourceMetadata());
 
-        $this->denyAccessStageProphecy->apply($resourceClass, $operationName, $resolverContext + [
+        $this->denyAccessStageProphecy->__invoke($resourceClass, $operationName, $resolverContext + [
             'extra_variables' => [
                 'object' => $readStageCollection,
                 'previous_object' => $readStageCollection,
             ],
         ])->shouldBeCalled();
 
         $serializeStageData = ['serialized'];
-        $this->serializeStageProphecy->apply($readStageCollection, $resourceClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($serializeStageData);
+        $this->serializeStageProphecy->__invoke($readStageCollection, $resourceClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($serializeStageData);
 
         $this->assertSame($serializeStageData, ($this->collectionResolverFactory)($resourceClass, $rootClass, $operationName)($source, $args, null, $info));
     }
@@ -132,7 +132,7 @@ public function testResolveBadReadStageCollection(): void
         $resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => true, 'is_mutation' => false];
 
         $readStageCollection = new \stdClass();
-        $this->readStageProphecy->apply($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
+        $this->readStageProphecy->__invoke($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
 
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage('Collection from read stage should be iterable.');
@@ -151,7 +151,7 @@ public function testResolveCustom(): void
         $resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => true, 'is_mutation' => false];
 
         $readStageCollection = [new \stdClass()];
-        $this->readStageProphecy->apply($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
+        $this->readStageProphecy->__invoke($resourceClass, $rootClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($readStageCollection);
 
         $this->resourceMetadataFactoryProphecy->create($resourceClass)->willReturn(
             (new ResourceMetadata())->withGraphql([$operationName => ['collection_query' => 'query_resolver_id']])
@@ -163,15 +163,15 @@ public function testResolveCustom(): void
             return $customCollection;
         });
 
-        $this->denyAccessStageProphecy->apply($resourceClass, $operationName, $resolverContext + [
+        $this->denyAccessStageProphecy->__invoke($resourceClass, $operationName, $resolverContext + [
             'extra_variables' => [
                 'object' => $customCollection,
                 'previous_object' => $customCollection,
             ],
         ])->shouldBeCalled();
 
         $serializeStageData = ['serialized'];
-        $this->serializeStageProphecy->apply($customCollection, $resourceClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($serializeStageData);
+        $this->serializeStageProphecy->__invoke($customCollection, $resourceClass, $operationName, $resolverContext)->shouldBeCalled()->willReturn($serializeStageData);
 
         $this->assertSame($serializeStageData, ($this->collectionResolverFactory)($resourceClass, $rootClass, $operationName)($source, $args, null, $info));
     }
diff --git a/tests/GraphQl/Resolver/Factory/ItemMutationResolverFactoryTest.php b/tests/GraphQl/Resolver/Factory/ItemMutationResolverFactoryTest.php
diff --git a/tests/GraphQl/Resolver/Factory/ItemResolverFactoryTest.php b/tests/GraphQl/Resolver/Factory/ItemResolverFactoryTest.php
diff --git a/tests/GraphQl/Resolver/Stage/DenyAccessStageTest.php b/tests/GraphQl/Resolver/Stage/DenyAccessStageTest.php
diff --git a/tests/GraphQl/Resolver/Stage/DeserializeStageTest.php b/tests/GraphQl/Resolver/Stage/DeserializeStageTest.php
diff --git a/tests/GraphQl/Resolver/Stage/ReadStageTest.php b/tests/GraphQl/Resolver/Stage/ReadStageTest.php
diff --git a/tests/GraphQl/Resolver/Stage/SerializeStageTest.php b/tests/GraphQl/Resolver/Stage/SerializeStageTest.php
diff --git a/tests/GraphQl/Resolver/Stage/ValidateStageTest.php b/tests/GraphQl/Resolver/Stage/ValidateStageTest.php
diff --git a/tests/GraphQl/Resolver/Stage/WriteStageTest.php b/tests/GraphQl/Resolver/Stage/WriteStageTest.php

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul`
`66`	`66`	`$operationName = $operationName ?? 'query';`
`67`	`67`	`$resolverContext = ['source' => $source, 'args' => $args, 'info' => $info, 'is_collection' => true, 'is_mutation' => false];`
`68`	`68`
`69`		`- $collection = $this->readStage->apply($resourceClass, $rootClass, $operationName, $resolverContext);`
	`69`	`+ $collection = ($this->readStage)($resourceClass, $rootClass, $operationName, $resolverContext);`
`70`	`70`	`if (!is_iterable($collection)) {`
`71`	`71`	`throw new \LogicException('Collection from read stage should be iterable.');`
`72`	`72`	`}`
`@@ -80,14 +80,14 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul`
`80`	`80`	`$collection = $queryResolver($collection, $resolverContext);`
`81`	`81`	`}`
`82`	`82`
`83`		`- $this->denyAccessStage->apply($resourceClass, $operationName, $resolverContext + [`
	`83`	`+ ($this->denyAccessStage)($resourceClass, $operationName, $resolverContext + [`
`84`	`84`	`'extra_variables' => [`
`85`	`85`	`'object' => $collection,`
`86`	`86`	`'previous_object' => \is_object($collection) ? clone $collection : $collection,`
`87`	`87`	`],`
`88`	`88`	`]);`
`89`	`89`
`90`		`- return $this->serializeStage->apply($collection, $resourceClass, $operationName, $resolverContext);`
	`90`	`+ return ($this->serializeStage)($collection, $resourceClass, $operationName, $resolverContext);`
`91`	`91`	`};`
`92`	`92`	`}`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa`
`39`	`39`	`/**`
`40`	`40`	`* {@inheritdoc}`
`41`	`41`	`*/`
`42`		`- public function apply(string $resourceClass, string $operationName, array $context): void`
	`42`	`+ public function __invoke(string $resourceClass, string $operationName, array $context): void`
`43`	`43`	`{`
`44`	`44`	`$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,5 @@ interface DenyAccessStageInterface`
`27`	`27`	`/**`
`28`	`28`	`* @throws Error`
`29`	`29`	`*/`
`30`		`- public function apply(string $resourceClass, string $operationName, array $context): void;`
	`30`	`+ public function __invoke(string $resourceClass, string $operationName, array $context): void;`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa`
`42`	`42`	`/**`
`43`	`43`	`* {@inheritdoc}`
`44`	`44`	`*/`
`45`		`- public function apply($objectToPopulate, string $resourceClass, string $operationName, array $context)`
	`45`	`+ public function __invoke($objectToPopulate, string $resourceClass, string $operationName, array $context)`
`46`	`46`	`{`
`47`	`47`	`$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);`
`48`	`48`	`if (!$resourceMetadata->getGraphqlAttribute($operationName, 'deserialize', true, true)) {`
Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,5 @@ interface DeserializeStageInterface`
`27`	`27`	`*`
`28`	`28`	`* @return object\|null`
`29`	`29`	`*/`
`30`		`- public function apply($objectToPopulate, string $resourceClass, string $operationName, array $context);`
	`30`	`+ public function __invoke($objectToPopulate, string $resourceClass, string $operationName, array $context);`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa`
`53`	`53`	`/**`
`54`	`54`	`* {@inheritdoc}`
`55`	`55`	`*/`
`56`		`- public function apply(?string $resourceClass, ?string $rootClass, string $operationName, array $context)`
	`56`	`+ public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context)`
`57`	`57`	`{`
`58`	`58`	`$resourceMetadata = $resourceClass ? $this->resourceMetadataFactory->create($resourceClass) : null;`
`59`	`59`	`if ($resourceMetadata && !$resourceMetadata->getGraphqlAttribute($operationName, 'read', true, true)) {`
Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,5 @@ interface ReadStageInterface`
`25`	`25`	`/**`
`26`	`26`	`* @return object\|iterable\|null`
`27`	`27`	`*/`
`28`		`- public function apply(?string $resourceClass, ?string $rootClass, string $operationName, array $context);`
	`28`	`+ public function __invoke(?string $resourceClass, ?string $rootClass, string $operationName, array $context);`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa`
`46`	`46`	`/**`
`47`	`47`	`* {@inheritdoc}`
`48`	`48`	`*/`
`49`		`- public function apply($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array`
	`49`	`+ public function __invoke($itemOrCollection, string $resourceClass, string $operationName, array $context): ?array`
`50`	`50`	`{`
`51`	`51`	`$isCollection = $context['is_collection'];`
`52`	`52`	`$isMutation = $context['is_mutation'];`