#104744

Author: Kapitanov Andrey

src/Generators/PoliciesGenerator.php

@@ -4,6 +4,7 @@
 
 use cebe\openapi\SpecObjectInterface;
 use Ensi\LaravelOpenApiServerGenerator\DTO\ParsedRouteHandler;
+use Ensi\LaravelOpenApiServerGenerator\Utils\ClassParser;
 use InvalidArgumentException;
 use RuntimeException;
 use stdClass;
@@ -70,6 +71,13 @@ 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)) {
+                $class = $this->classParser->parse("$namespace\\$className");
+
+                $newPolicies = $this->convertMethodsToString($methods, $class);
+                if (!empty($newPolicies)) {
+                    $class->addMethods($newPolicies);
+                }
+
                 continue;
             }
 
@@ -104,17 +112,31 @@ private function handlerValidation(ParsedRouteHandler $handler): bool
         };
     }
 
-    private function convertMethodsToString(array $methods): string
+    private function convertMethodsToString(array $methods, ?ClassParser $class = null): string
     {
         $methodsStrings = [];
 
         foreach ($methods as $method) {
+            if ($class?->hasMethod($method)) {
+                continue;
+            }
+
             $methodsStrings[] = $this->replacePlaceholders(
                 $this->templatesManager->getTemplate('PolicyGate.template'),
                 ['{{ method }}' => $method]
             );
         }
 
+        if ($class) {
+            $existMethods = $class->getMethods();
+            foreach ($existMethods as $methodName => $method) {
+                if (!in_array($methodName, $methods) && !$class->isTraitMethod($methodName)) {
+                    $className = $class->getClassName();
+                    console_warning("Warning: метод {$className}::{$methodName} отсутствует в спецификации или не может возвращать 403 ошибку");
+                }
+            }
+        }
+
         return implode("\n\n    ", $methodsStrings);
     }
 }

src/Utils/ClassParser.php

@@ -13,6 +13,7 @@ class ClassParser
     public ReflectionClass $ref;
 
     protected ?Collection $methods = null;
+    protected ?Collection $traits = null;
 
     public function __construct(
         protected Filesystem $filesystem,
@@ -27,6 +28,11 @@ public function parse(string $className): self
         return $this;
     }
 
+    public function getClassName(): string
+    {
+        return $this->ref->getName();
+    }
+
     public function isEmpty(): bool
     {
         return $this->getMethods()->isEmpty();
@@ -41,6 +47,53 @@ public function getMethods(): Collection
         return $this->methods;
     }
 
+    public function getTraits(): Collection
+    {
+        if (!$this->traits) {
+            $this->traits = collect($this->ref->getTraits())->map(function (ReflectionClass $trait) {
+                return collect($trait->getMethods())->pluck('name');
+            });
+        }
+
+        return $this->traits;
+    }
+
+    public function isTraitMethod(string $methodName): bool
+    {
+        $traits = $this->getTraits();
+
+        return $traits->contains(fn (Collection $methods) => $methods->contains($methodName));
+    }
+
+    public function addMethods(string $methods): void
+    {
+        if (empty($methods)) {
+            return;
+        }
+
+        $lines = [];
+        $currentLine = 0;
+        $endLine = $this->getEndLine();
+        $filePath = $this->getFileName();
+
+        foreach ($this->filesystem->lines($filePath) as $line) {
+            $currentLine++;
+            if ($currentLine === $endLine) {
+                $lines[] = "";
+                $lines[] = "    $methods";
+                $lines[] = "}";
+
+                break;
+            }
+
+            $lines[] = $line;
+        }
+
+        $contents = implode(PHP_EOL, $lines);
+
+        $this->filesystem->put($filePath, $contents);
+    }
+
     public function hasMethod(string $methodName): bool
     {
         return $this->getMethods()->has($methodName);

tests/ControllerParserTest.php renamed to tests/ClassParserTest.php

@@ -2,10 +2,12 @@
 
 use Ensi\LaravelOpenApiServerGenerator\Tests\expects\Controllers\LaravelEmptyController;
 use Ensi\LaravelOpenApiServerGenerator\Tests\expects\Controllers\LaravelExistsController;
+use Ensi\LaravelOpenApiServerGenerator\Tests\expects\Policies\LaravelPolicy;
+use Ensi\LaravelOpenApiServerGenerator\Tests\expects\Policies\LaravelWithoutTraitPolicy;
 use Ensi\LaravelOpenApiServerGenerator\Utils\ClassParser;
 use Illuminate\Filesystem\Filesystem;
 
-test('Controller check isEmpty success', function (string $namespace, bool $result) {
+test('ClassParser check isEmpty success', function (string $namespace, bool $result) {
     $filesystem = $this->mock(Filesystem::class);
 
     $parser = new ClassParser($filesystem);
@@ -17,7 +19,7 @@
     [LaravelEmptyController::class, true],
 ]);
 
-test('Controller check getMethods success', function (string $namespace, array $result) {
+test('ClassParser check getMethods success', function (string $namespace, array $result) {
     $filesystem = $this->mock(Filesystem::class);
 
     $parser = new ClassParser($filesystem);
@@ -31,7 +33,7 @@
     [LaravelEmptyController::class, []],
 ]);
 
-test('Controller check hasMethod success', function (string $namespace, string $method, bool $result) {
+test('ClassParser check hasMethod success', function (string $namespace, string $method, bool $result) {
     $filesystem = $this->mock(Filesystem::class);
 
     $parser = new ClassParser($filesystem);
@@ -45,7 +47,7 @@
     [LaravelEmptyController::class, 'search', false],
 ]);
 
-test('Controller check getLines success', function (string $namespace, int $start, int $end) {
+test('ClassParser check getLines success', function (string $namespace, int $start, int $end) {
     $filesystem = $this->mock(Filesystem::class);
 
     $parser = new ClassParser($filesystem);
@@ -58,7 +60,37 @@
     [LaravelEmptyController::class, 5, 10],
 ]);
 
-test('Controller check getFileName success', function (string $namespace) {
+test('ClassParser check isTraitMethod success', function (string $namespace, string $method, bool $result) {
+    $filesystem = $this->mock(Filesystem::class);
+
+    $parser = new ClassParser($filesystem);
+    $parser->parse($namespace);
+
+    expect($parser->isTraitMethod($method))->toBe($result);
+})->with([
+    [LaravelPolicy::class, 'allow', true],
+    [LaravelPolicy::class, 'search', false],
+    [LaravelPolicy::class, 'get', false],
+
+    [LaravelWithoutTraitPolicy::class, 'allow', false],
+    [LaravelWithoutTraitPolicy::class, 'search', false],
+    [LaravelWithoutTraitPolicy::class, 'get', false],
+]);
+
+test('ClassParser check getClassName success', function (string $namespace) {
+    $filesystem = $this->mock(Filesystem::class);
+
+    $parser = new ClassParser($filesystem);
+    $parser->parse($namespace);
+
+    expect($parser->getClassName())->toBe($namespace);
+})->with([
+        [LaravelPolicy::class],
+        [LaravelExistsController::class],
+        [LaravelEmptyController::class],
+]);
+
+test('ClassParser check getFileName success', function (string $namespace) {
     $filesystem = $this->mock(Filesystem::class);
 
     $parser = new ClassParser($filesystem);
@@ -72,7 +104,7 @@
     [LaravelEmptyController::class],
 ]);
 
-test('Controller check getContentWithAdditionalMethods success', function (
+test('ClassParser check getContentWithAdditionalMethods success', function (
     string $namespace,
     string $expect,
     string $additional = "",

tests/expects/Policies/LaravelPolicy.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Ensi\LaravelOpenApiServerGenerator\Tests\expects\Policies;
+
+use Illuminate\Auth\Access\HandlesAuthorization;
+use Illuminate\Auth\Access\Response;
+
+class LaravelPolicy
+{
+    use HandlesAuthorization;
+
+    public function search(): Response
+    {
+        return Response::allow();
+    }
+}

tests/expects/Policies/LaravelWithoutTraitPolicy.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Ensi\LaravelOpenApiServerGenerator\Tests\expects\Policies;
+
+use Illuminate\Auth\Access\Response;
+
+class LaravelWithoutTraitPolicy
+{
+    public function search(): Response
+    {
+        return Response::allow();
+    }
+}