Route binding (#18)

* refs #17 Added alternative for binding params
* Update config for phpunit
* Update cs-fixer
* Fix styling

Author: tabuna

.github/workflows/php-cs-fixer.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Run PHP CS Fixer
         uses: docker://oskarstark/php-cs-fixer-ga
         with:
-          args: --config=.php_cs.dist --allow-risky=yes
+          args: --config=.php_cs.dist.php --allow-risky=yes
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4

.gitignore

@@ -7,3 +7,4 @@ coverage
 .idea
 .php_cs
 .php_cs.cache
+.php-cs-fixer.cache

.php_cs.dist renamed to .php_cs.dist.php

@@ -10,35 +10,24 @@
     ->ignoreDotFiles(true)
     ->ignoreVCS(true);
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRules([
-        '@PSR12'                              => true,
-        'declare_strict_types'                => true,
-        'array_syntax'                        => [
-            'syntax' => 'short',
-        ],
-        'ordered_imports'                     => [
-            'sortAlgorithm' => 'alpha',
-        ],
+        '@PSR2'                               => true,
+        'array_syntax'                        => ['syntax' => 'short'],
+        'ordered_imports'                     => ['sort_algorithm' => 'alpha'],
         'no_unused_imports'                   => true,
         'no_whitespace_before_comma_in_array' => true,
         'not_operator_with_successor_space'   => true,
-        'trailing_comma_in_multiline_array'   => true,
+        'trailing_comma_in_multiline'         => ['elements' => ['arrays']],
         'phpdoc_scalar'                       => true,
         'unary_operator_spaces'               => true,
         'binary_operator_spaces'              => [
-            'align_double_arrow' => true,
-            'align_equals'       => false,
+            'operators' => [
+                '=>' => 'align_single_space',
+            ],
         ],
         'blank_line_before_statement'         => [
-            'statements' => [
-                'break',
-                'continue',
-                'declare',
-                'return',
-                'throw',
-                'try',
-            ],
+            'statements' => ['continue', 'declare', 'return', 'throw', 'try'],
         ],
         'phpdoc_separation'                   => true,
         'phpdoc_align'                        => true,
@@ -47,14 +36,13 @@
         'phpdoc_var_without_name'             => true,
         'class_attributes_separation'         => [
             'elements' => [
-                'method',
+                'method' => 'one',
             ],
         ],
         'method_argument_space'               => [
-            'on_multiline'                     => 'ensure_fully_multiline',
-            'keep_multiple_spaces_after_comma' => true,
+            'on_multiline' => 'ignore',
         ],
-        'single_trait_insert_per_statement'   => true,
         'trim_array_spaces'                   => true,
+        'single_trait_insert_per_statement'   => false,
     ])
     ->setFinder($finder);

composer.json

@@ -56,7 +56,10 @@
         "laravel": {
             "providers": [
                 "Sajya\\Server\\ServerServiceProvider"
-            ]
+            ],
+            "aliases": {
+                "RPC": "Sajya\\Server\\Facades\\RPC"
+            }
         }
     }
 }

phpunit.xml.dist

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         backupGlobals="false"
          backupStaticAttributes="false"
          bootstrap="vendor/autoload.php"
          colors="true"
@@ -9,17 +10,21 @@
          processIsolation="false"
          stopOnFailure="false"
          stopOnError="false"
-         verbose="true">
+         verbose="true"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+        <report>
+            <clover outputFile="clover.xml"/>
+        </report>
+    </coverage>
     <testsuites>
         <testsuite name="Unit">
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
     <php>
         <server name="APP_NAME" value="Sajya"/>
         <server name="APP_DEBUG" value="true"/>
@@ -32,7 +37,5 @@
         <server name="QUEUE_CONNECTION" value="sync"/>
         <server name="SESSION_DRIVER" value="array"/>
     </php>
-    <logging>
-        <log type="coverage-clover" target="clover.xml"/>
-    </logging>
+    <logging/>
 </phpunit>

src/Binding.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sajya\Server;
+
+use Closure;
+use Illuminate\Container\Container;
+use Illuminate\Routing\RouteBinding;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
+use Sajya\Server\Http\Request;
+
+class Binding
+{
+    /**
+     * The IoC container instance.
+     *
+     * @var \Illuminate\Container\Container
+     */
+    protected $container;
+
+    /**
+     * The registered route value binders.
+     *
+     * @var array
+     */
+    protected $binders = [];
+
+    /**
+     * Application constructor.
+     *
+     * @param Container $container
+     */
+    public function __construct(Container $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * Register a model binder for a wildcard.
+     *
+     * @param string        $key
+     * @param string        $class
+     * @param \Closure|null $callback
+     *
+     * @return void
+     */
+    public function model(string $key, string $class, Closure $callback = null)
+    {
+        $this->bind($key, RouteBinding::forModel($this->container, $class, $callback));
+    }
+
+    /**
+     * Add a new route parameter binder.
+     *
+     * @param string         $key
+     * @param Closure|string $binder
+     *
+     * @return void
+     */
+    public function bind(string $key, $binder)
+    {
+        $this->binders[$key] = RouteBinding::forCallback(
+            $this->container, $binder
+        );
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return array
+     */
+    public function bindResolve(Request $request): array
+    {
+        $possibleBindings = Arr::dot($request->getParams());
+
+        return collect($possibleBindings)
+            ->map(fn ($value, string $key) => with($value, $this->binders[$key] ?? null))
+            ->mapWithKeys(function ($value, string $key) {
+                $nameForArgument = (string)Str::of($key)->replace('.', '_')->camel();
+
+                return [$nameForArgument => $value];
+            })
+            ->toArray();
+    }
+}

src/Facades/RPC.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sajya\Server\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use Sajya\Server\Binding;
+
+/**
+ * Class RPC
+ *
+ * @method static void bind(string $key, string|callable $binder)
+ * @method static void model(string $key, string $class, \Closure|null $callback = null)
+ *
+ * @see \Sajya\Server\Binding
+ */
+class RPC extends Facade
+{
+    /**
+     * Initiate a mock expectation on the facade.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor(): string
+    {
+        return Binding::class;
+    }
+}

src/Guide.php

@@ -104,8 +104,8 @@ public function handleProcedure(Request $request, bool $notification): Response
         }
 
         $result = $notification
-            ? HandleProcedure::dispatchAfterResponse($procedure)
-            : HandleProcedure::dispatchNow($procedure);
+            ? HandleProcedure::dispatchAfterResponse($procedure, $request)
+            : HandleProcedure::dispatchNow($procedure, $request);
 
         return $this->makeResponse($result, $request);
     }

src/HandleProcedure.php

@@ -16,28 +16,34 @@
 use Sajya\Server\Exceptions\InternalErrorException;
 use Sajya\Server\Exceptions\InvalidParams;
 use Sajya\Server\Exceptions\RuntimeRpcException;
+use Sajya\Server\Facades\RPC;
+use Sajya\Server\Http\Request;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
 class HandleProcedure implements ShouldQueue
 {
-    use Dispatchable;
-    use InteractsWithQueue;
-    use Queueable;
-    use SerializesModels;
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
     /**
      * @var string
      */
     protected string $procedure;
 
+    /**
+     * @var Request
+     */
+    protected $request;
+
     /**
      * Create a new job instance.
      *
-     * @param string $procedure
+     * @param string  $procedure
+     * @param Request $request
      */
-    public function __construct(string $procedure)
+    public function __construct(string $procedure, Request $request)
     {
         $this->procedure = $procedure;
+        $this->request = $request;
     }
 
     /**
@@ -48,7 +54,7 @@ public function __construct(string $procedure)
     public function handle()
     {
         try {
-            return App::call($this->procedure);
+            return App::call($this->procedure, RPC::bindResolve($this->request));
         } catch (HttpException | RuntimeException | Exception $exception) {
             $message = $exception->getMessage();
 

src/ServerServiceProvider.php

@@ -37,11 +37,13 @@ public function register(): void
         $this->commands($this->commands);
         $this->registerViews();
 
-        Route::macro('rpc', fn(string $uri, array $procedures = [], string $delimiter = null) => Route::post($uri, [JsonRpcController::class, '__invoke'])
+        Route::macro('rpc', fn (string $uri, array $procedures = [], string $delimiter = null) => Route::post($uri, [JsonRpcController::class, '__invoke'])
             ->setDefaults([
                 'procedures' => $procedures,
                 'delimiter'  => $delimiter,
             ]));
+
+        $this->app->singleton(Binding::class, fn ($container) => new Binding($container));
     }
 
     /**

tests/Expected/Requests/testBindDeepValue.json

@@ -0,0 +1,12 @@
+{
+    "jsonrpc": "2.0",
+    "method": "binding@deepValue",
+    "params": {
+        "name": {
+            "deep": {
+                "value": "Alexandr"
+            }
+        }
+    },
+    "id": 1
+}

tests/Expected/Requests/testBindModel.json

@@ -0,0 +1,8 @@
+{
+    "jsonrpc": "2.0",
+    "method": "binding@getModel",
+    "params": {
+        "fixtureModel": 13
+    },
+    "id": 1
+}

tests/Expected/Requests/testBindSubtract.json

@@ -0,0 +1,9 @@
+{
+    "jsonrpc": "2.0",
+    "method": "binding@subtract",
+    "params": {
+        "a": 4,
+        "b": 2
+    },
+    "id": 1
+}

tests/Expected/Requests/testBindSubtractRewriteBind.json

@@ -0,0 +1,9 @@
+{
+    "jsonrpc": "2.0",
+    "method": "binding@subtract",
+    "params": {
+        "a": 4,
+        "b": 2
+    },
+    "id": 1
+}

tests/Expected/Responses/testBindDeepValue.json

@@ -0,0 +1,5 @@
+{
+    "id": "1",
+    "result": "Alexandr",
+    "jsonrpc": "2.0"
+}

tests/Expected/Responses/testBindModel.json

@@ -0,0 +1,5 @@
+{
+    "id": "1",
+    "result": "bind-13",
+    "jsonrpc": "2.0"
+}

tests/Expected/Responses/testBindSubtract.json

@@ -0,0 +1,5 @@
+{
+    "id": "1",
+    "result": 2,
+    "jsonrpc": "2.0"
+}

tests/Expected/Responses/testBindSubtractRewriteBind.json

@@ -0,0 +1,5 @@
+{
+    "id": "1",
+    "result": 98,
+    "jsonrpc": "2.0"
+}