#103127

Author: mtyrtov

config/openapi-server-generator.php

@@ -3,6 +3,7 @@
 use Ensi\LaravelOpenApiServerGenerator\Generators\ControllersGenerator;
 use Ensi\LaravelOpenApiServerGenerator\Generators\EnumsGenerator;
 use Ensi\LaravelOpenApiServerGenerator\Generators\PestTestsGenerator;
+use Ensi\LaravelOpenApiServerGenerator\Generators\PoliciesGenerator;
 use Ensi\LaravelOpenApiServerGenerator\Generators\RequestsGenerator;
 use Ensi\LaravelOpenApiServerGenerator\Generators\ResourcesGenerator;
 use Ensi\LaravelOpenApiServerGenerator\Generators\RoutesGenerator;
@@ -37,6 +38,9 @@
             'resources' => [
                 'response_key' => 'data',
             ],
+            'policies' => [
+                'namespace' => ["Controllers" => "Policies"],
+            ],
         ],
     ],
 
@@ -57,6 +61,7 @@
         'routes' => RoutesGenerator::class,
         'pest_tests' => PestTestsGenerator::class,
         'resources' => ResourcesGenerator::class,
+        'policies' => PoliciesGenerator::class,
     ],
 
     /**
@@ -69,6 +74,7 @@
         'routes',
         'pest_tests',
         'resources',
+        'policies',
     ],
 
     'extra_templates_path' => resource_path('openapi-server-generator/templates'),

src/Commands/GenerateServer.php

@@ -14,7 +14,7 @@ class GenerateServer extends Command
     protected $signature = 'openapi:generate-server {--e|entities=}';
 
     /** var @string */
-    protected $description = 'Generate application files from openapi specification files';
+    protected $description = 'Generate application files from openapi specification files [with policies]';
 
     private array $config = [];
 

src/Generators/PoliciesGenerator.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace Ensi\LaravelOpenApiServerGenerator\Generators;
+
+use cebe\openapi\SpecObjectInterface;
+use RuntimeException;
+
+class PoliciesGenerator extends BaseGenerator implements GeneratorInterface
+{
+    public function generate(SpecObjectInterface $specObject): void
+    {
+        $policies = $this->extractPolicies($specObject);
+        $this->createPoliciesFiles($policies, $this->templatesManager->getTemplate('Policy.template'));
+    }
+
+    // TODO: предварительная версия, необходим рефакторинг и доп. проверки
+    protected function extractPolicies(SpecObjectInterface $specObject): array
+    {
+        $openApiData = $specObject->getSerializableData();
+
+        $policies = [];
+        $paths = $openApiData->paths ?: [];
+        foreach ($paths as $routes) {
+            foreach ($routes as $route) {
+                if (!empty($route->{'x-lg-skip-policy-generation'})) {
+                    continue;
+                }
+
+                if (empty($route->{'x-lg-handler'})) {
+                    continue;
+                }
+
+                $response = $route->responses->{403} ?? null;
+                if (!$response) {
+                    continue;
+                }
+
+                $handler = $this->routeHandlerParser->parse($route->{'x-lg-handler'});
+
+                try {
+                    $namespace = $this->getReplacedNamespace($handler->namespace, 'Controllers', 'Policies');
+                    $className = $handler->class . 'Policy';
+                } catch (RuntimeException) {
+                    continue;
+                }
+
+                if (empty($handler->method)) {
+                    continue;
+                }
+
+                if (isset($policies["$namespace\\$className"])) {
+                    $policies["$namespace\\$className"]['methods'][] = $handler->method;
+                } else {
+                    $methods = [$handler->method];
+                    $policies["$namespace\\$className"] = compact('className', 'namespace', 'methods');
+                }
+            }
+        }
+
+        return $policies;
+    }
+
+    // TODO: протестировать
+    protected function createPoliciesFiles(array $policies, string $template): void
+    {
+        foreach ($policies as ['className' => $className, 'namespace' => $namespace, 'methods' => $methods]) {
+            $filePath = $this->getNamespacedFilePath($className, $namespace);
+            if ($this->filesystem->exists($filePath)) {
+                continue;
+            }
+
+            $this->filesystem->put(
+                $filePath,
+                $this->replacePlaceholders($template, [
+                    '{{ namespace }}' => $namespace,
+                    '{{ className }}' => $className,
+                    '{{ methods }}' => $this->convertToString($methods),
+                ])
+            );
+
+            die();
+        }
+    }
+
+    private function convertToString(array $methods): string
+    {
+        $methodsStrings = [];
+
+        foreach ($methods as $method) {
+            $methodsStrings[] = $this->replacePlaceholders(
+                $this->templatesManager->getTemplate('PolicyGate.template'),
+                [
+                    '{{ method }}' => $method,
+                ]
+            );
+        }
+
+        return implode("\n\n    ", $methodsStrings);
+    }
+}

templates/Policy.template

@@ -0,0 +1,15 @@
+<?php
+
+namespace {{ namespace }};
+
+use App\Domain\Auth\Models\User;
+use Ensi\AdminAuthClient\Dto\RightsAccessEnum;
+use Illuminate\Auth\Access\HandlesAuthorization;
+use Illuminate\Auth\Access\Response;
+
+class {{ className }}
+{
+    use HandlesAuthorization;
+
+    {{ methods }}
+}

templates/PolicyGate.template

@@ -0,0 +1,6 @@
+public function {{ method }}(User $user): Response
+    {
+        return $user->allowOneOf([
+            // add rights access from RightsAccessEnum
+        ]);
+    }

tests/PolicyGenerationTest.php

@@ -0,0 +1,13 @@
+<?php
+
+use Ensi\LaravelOpenApiServerGenerator\Commands\GenerateServer;
+use Ensi\LaravelOpenApiServerGenerator\Tests\TestCase;
+use Illuminate\Filesystem\Filesystem;
+use Illuminate\Support\Facades\Config;
+
+use function Pest\Laravel\artisan;
+use function PHPUnit\Framework\assertEqualsCanonicalizing;
+
+test('can generate policy', function () {
+    \PHPUnit\Framework\assertIsBool(true);
+});