feat(graphql)!: Universal builder property resolver (#120)

Closes: #87

packages/graphql/README.md

@@ -102,14 +102,18 @@ Represents [JSON](https://json.org) string.
 
 # Scout
 
-[Scout](https://laravel.com/docs/scout) is also supported 🤩. By default `@searchBy`/`@sortBy` will convert nested/related properties into dot string: eg `{user: {name: asc}}` will be converted into `user.name`. You can redefine this behavior by [`FieldResolver`](./src/Builder/Contracts/Scout/FieldResolver.php):
+[Scout](https://laravel.com/docs/scout) is also supported 🤩. You just need to add [`@search`](https://lighthouse-php.com/master/api-reference/directives.html#search) directive to an argument.
+
+# Builder property name
+
+By default `@searchBy`/`@sortBy` will convert nested/related properties into dot string: eg `{user: {name: asc}}` will be converted into `user.name`. You can redefine this behavior by [`BuilderPropertyResolver`](./src/Builder/Contracts/BuilderPropertyResolver.php):
 
 ```php
 // AppProvider
 
 $this->app->bind(
-    LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scout\FieldResolver::class,
-    MyScoutColumnResolver::class,
+    LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver::class,
+    MyBuilderPropertyResolver::class,
 );
 ```
 

packages/graphql/UPGRADE.md

@@ -66,6 +66,8 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
     ];
     ```
 
+* [ ] If you are using `LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scout\FieldResolver`, use `LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver` instead. 🤝
+
 ## API
 
 This section is actual only if you are extending the package. Please review and update (listed the most significant changes only):
@@ -89,5 +91,5 @@ This section is actual only if you are extending the package. Please review and
 * [ ] To get `BuilderInfo` instance within Operator the `LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context` should be used instead of `LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator`:
 
     ```php
-    $context->get(\LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulation\AstManipulation::class)?->builderInfo
+    $context->get(\LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulationBuilderInfo::class)?->builderInfo
     ```

packages/graphql/src/Builder/Contexts/AstManipulation.php → packages/graphql/src/Builder/Contexts/AstManipulationBuilderInfo.php

@@ -4,9 +4,9 @@
 
 use LastDragon_ru\LaraASP\GraphQL\Builder\BuilderInfo;
 
-class AstManipulation {
+class AstManipulationBuilderInfo {
     public function __construct(
-        public readonly BuilderInfo $builderInfo,
+        public readonly BuilderInfo $value,
     ) {
         // empty
     }

packages/graphql/src/Builder/Contracts/BuilderPropertyResolver.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\GraphQL\Builder\Contracts;
+
+use LastDragon_ru\LaraASP\GraphQL\Builder\Property;
+
+/**
+ * Convert {@see Property} into builder property.
+ */
+interface BuilderPropertyResolver {
+    public function getProperty(object $builder, Property $property): string;
+}

packages/graphql/src/Builder/Contracts/Scout/FieldResolver.php

@@ -3,10 +3,15 @@
 namespace LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scout;
 
 use Illuminate\Database\Eloquent\Model;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Property;
 
 /**
  * Convert nested property into Scout field.
+ *
+ * @deprecated 5.4.0 Please use {@see BuilderPropertyResolver} instead.
+ *
+ * @see BuilderPropertyResolver
  */
 interface FieldResolver {
     public function getField(Model $model, Property $property): string;

packages/graphql/src/Builder/Defaults/BuilderPropertyResolver.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\GraphQL\Builder\Defaults;
+
+use Laravel\Scout\Builder as ScoutBuilder;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver as BuilderPropertyResolverContract;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scout\FieldResolver as ScoutFieldResolver;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Property;
+use Override;
+
+use function implode;
+
+/**
+ * @internal
+ */
+final class BuilderPropertyResolver implements BuilderPropertyResolverContract {
+    public function __construct(
+        private readonly ?ScoutFieldResolver $resolver = null,
+    ) {
+        // empty
+    }
+
+    #[Override]
+    public function getProperty(object $builder, Property $property): string {
+        return $builder instanceof ScoutBuilder && $this->resolver
+            ? $this->resolver->getField($builder->model, $property)
+            : implode('.', $property->getPath());
+    }
+}

packages/graphql/src/Builder/Directives/HandlerDirective.php

@@ -17,7 +17,7 @@
 use Laravel\Scout\Builder as ScoutBuilder;
 use LastDragon_ru\LaraASP\GraphQL\Builder\BuilderInfoDetector;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulation;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulationBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context as ContextContract;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Handler;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
@@ -45,7 +45,7 @@
 use function reset;
 
 /**
- * @see AstManipulation
+ * @see AstManipulationBuilderInfo
  */
 abstract class HandlerDirective extends BaseDirective implements Handler {
     use WithManipulator;
@@ -223,9 +223,7 @@ public function manipulateArgDefinition(
 
         // Argument
         $context = (new Context())->override([
-            AstManipulation::class => new AstManipulation(
-                builderInfo: $builder,
-            ),
+            AstManipulationBuilderInfo::class => new AstManipulationBuilderInfo($builder),
         ]);
         $source  = $this->getFieldArgumentSource($manipulator, $parentType, $parentField, $argDefinition);
         $type    = $this->getArgDefinitionType($manipulator, $documentAST, $source, $context);

packages/graphql/src/Builder/Directives/OperatorDirective.php

@@ -3,6 +3,7 @@
 namespace LastDragon_ru\LaraASP\GraphQL\Builder\Directives;
 
 use GraphQL\Language\DirectiveLocation;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scope;
 use Nuwave\Lighthouse\Schema\DirectiveLocator;
@@ -13,7 +14,9 @@
 use function is_a;
 
 abstract class OperatorDirective extends BaseDirective implements Operator {
-    public function __construct() {
+    public function __construct(
+        protected readonly BuilderPropertyResolver $resolver,
+    ) {
         // empty
     }
 

packages/graphql/src/Builder/Manipulator.php

@@ -22,7 +22,7 @@
 use GraphQL\Type\Definition\Type;
 use Illuminate\Container\Container;
 use Illuminate\Support\Str;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulation;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulationBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scope;
@@ -147,7 +147,7 @@ public function getTypeOperators(string $scope, string $type, Context $context,
         }
 
         // Builder?
-        $builder = $context->get(AstManipulation::class)?->builderInfo->getBuilder();
+        $builder = $context->get(AstManipulationBuilderInfo::class)?->value->getBuilder();
 
         if (!$builder) {
             return [];

packages/graphql/src/Builder/ManipulatorTest.php

@@ -5,7 +5,7 @@
 use GraphQL\Type\Definition\CustomScalarType;
 use GraphQL\Type\Definition\ObjectType;
 use Illuminate\Container\Container;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulation;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulationBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context as ContextContract;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Handler;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
@@ -193,8 +193,8 @@ public function getScope(): string {
 
         // Manipulator
         $context     = (new Context())->override([
-            AstManipulation::class => new AstManipulation(
-                builderInfo: new BuilderInfo($builder::class, $builder::class),
+            AstManipulationBuilderInfo::class => new AstManipulationBuilderInfo(
+                new BuilderInfo($builder::class, $builder::class),
             ),
         ]);
         $document    = Container::getInstance()->make(ASTBuilder::class)->documentAST();

packages/graphql/src/Builder/Property.php

@@ -8,7 +8,6 @@
 use function array_slice;
 use function array_values;
 use function end;
-use function explode;
 use function implode;
 
 class Property implements Stringable {
@@ -37,7 +36,7 @@ public function getPath(): array {
     }
 
     public function getChild(string $name): static {
-        return new static(...$this->path, ...explode(static::Separator, $name));
+        return new static(...$this->path, ...[$name]);
     }
 
     public function getParent(): static {

packages/graphql/src/Builder/Types/InputObject.php

@@ -9,7 +9,7 @@
 use GraphQL\Language\BlockString;
 use GraphQL\Language\Parser;
 use GraphQL\Type\Definition\Type;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulation;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contexts\AstManipulationBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scope;
@@ -166,7 +166,7 @@ protected function getFieldDefinition(
         Context $context,
     ): ?InputValueDefinitionNode {
         // Builder?
-        $builder = $context->get(AstManipulation::class)?->builderInfo->getBuilder();
+        $builder = $context->get(AstManipulationBuilderInfo::class)?->value->getBuilder();
 
         if (!$builder) {
             return null;
@@ -222,7 +222,7 @@ protected function getFieldDirectiveOperator(
         Context $context,
     ): ?Operator {
         // Builder?
-        $builder = $context->get(AstManipulation::class)?->builderInfo->getBuilder();
+        $builder = $context->get(AstManipulationBuilderInfo::class)?->value->getBuilder();
 
         if (!$builder) {
             return null;

packages/graphql/src/Provider.php

@@ -6,9 +6,9 @@
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Support\ServiceProvider;
 use LastDragon_ru\LaraASP\Core\Provider\WithConfig;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Scout\FieldResolver as ScoutFieldResolverContract;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderPropertyResolver as BuilderPropertyResolverContract;
+use LastDragon_ru\LaraASP\GraphQL\Builder\Defaults\BuilderPropertyResolver;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Scout\DefaultFieldResolver as ScoutFieldResolver;
 use LastDragon_ru\LaraASP\GraphQL\Printer\DirectiveResolver;
 use LastDragon_ru\LaraASP\GraphQL\SearchBy\Definitions\SearchByDirective;
 use LastDragon_ru\LaraASP\GraphQL\SearchBy\Operators as SearchByOperators;
@@ -67,7 +67,7 @@ static function (): array {
     protected function registerBindings(): void {
         $this->app->scopedIf(SorterFactoryContract::class, SorterFactory::class);
         $this->app->scopedIf(StreamFactoryContract::class, StreamFactory::class);
-        $this->app->scopedIf(ScoutFieldResolverContract::class, ScoutFieldResolver::class);
+        $this->app->scopedIf(BuilderPropertyResolverContract::class, BuilderPropertyResolver::class);
     }
 
     protected function registerOperators(): void {