feat(Testing): Add new attribute for mark interface for automatic gen…

…erated expectation
wrk-flow · Dec 20, 2023 · 1d7492e · 1d7492e
1 parent d7912fb
commit 1d7492e
Show file tree

Hide file tree

Showing 12 changed files with 309 additions and 35 deletions.
diff --git a/src/Testing/Actions/ComposerAutoloadAbsoluteAction.php b/src/Testing/Actions/ComposerAutoloadAbsoluteAction.php
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaraStrict\Testing\Actions;
+
+use Illuminate\Filesystem\Filesystem;
+use LaraStrict\Testing\Contracts\GetBasePathForStubsActionContract;
+use LaraStrict\Testing\Services\ComposerJsonDataService;
+
+final class ComposerAutoloadAbsoluteAction
+{
+    /**
+     * @var array<string, string>
+     */
+    private array $dirs;
+
+    public function __construct(
+        private readonly ComposerJsonDataService $getComposerJsonDataAction,
+        private readonly Filesystem $filesystem,
+        GetBasePathForStubsActionContract $getBasePathForStubsAction,
+    ) {
+        $this->dirs = $this->makeDirs($getBasePathForStubsAction->execute());
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function execute(?string $path = null): array
+    {
+        if ($path !== null) {
+            $this->dirs += $this->loadNewComposer($path);
+        }
+
+        return $this->dirs;
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    private function makeDirs(string $basePath): array
+    {
+        $data = $this->getComposerJsonDataAction->data($basePath);
+        $dirs = [];
+
+        if (isset($data['autoload']['psr-4']) && is_array($data['autoload']['psr-4'])) {
+            foreach ($data['autoload']['psr-4'] as $ns => $path) {
+                $dirs[$ns] = $basePath . DIRECTORY_SEPARATOR . trim((string) $path, '\\/');
+            }
+        }
+
+        return $dirs;
+    }
+
+    private function loadNewComposer(string $path): array
+    {
+        if ($this->filesystem->isFile($path)) {
+            $path = $this->filesystem->dirname($path);
+        } elseif ($this->filesystem->isDirectory($path) === false) {
+            throw new \Exception(sprintf('The path is not dir "%s".', $path));
+        }
+
+        while ($this->getComposerJsonDataAction->isExist($path) === false) {
+            $path = $this->filesystem->dirname($path);
+        }
+
+        return $this->makeDirs($path);
+    }
+}
diff --git a/src/Testing/Actions/GetDevNamespaceForStubsAction.php b/src/Testing/Actions/GetDevNamespaceForStubsAction.php
@@ -11,7 +11,7 @@
 
 class GetDevNamespaceForStubsAction implements GetNamespaceForStubsActionContract
 {
-    public function execute(Command $command, string $basePath, string $inputClass): NamespaceEntity
+    public function execute(Command $command, string $inputClass): NamespaceEntity
     {
         // We want to place Laravel assert / expectations to Laravel Folder.
 

diff --git a/src/Testing/Actions/GetNamespaceForStubsAction.php b/src/Testing/Actions/GetNamespaceForStubsAction.php
@@ -5,10 +5,10 @@
 namespace LaraStrict\Testing\Actions;
 
 use Illuminate\Console\Command;
-use Illuminate\Filesystem\Filesystem;
 use LaraStrict\Testing\Constants\StubConstants;
 use LaraStrict\Testing\Contracts\GetNamespaceForStubsActionContract;
 use LaraStrict\Testing\Entities\NamespaceEntity;
+use LaraStrict\Testing\Services\ComposerJsonDataService;
 use LogicException;
 
 class GetNamespaceForStubsAction implements GetNamespaceForStubsActionContract
@@ -17,14 +17,14 @@ class GetNamespaceForStubsAction implements GetNamespaceForStubsActionContract
     final public const ComposerPsr4 = 'psr-4';
 
     public function __construct(
-        private readonly Filesystem $filesystem,
+        private readonly ComposerJsonDataService $getComposerJsonDataAction,
     ) {
     }
 
-    public function execute(Command $command, string $basePath, string $inputClass): NamespaceEntity
+    public function execute(Command $command, string $inputClass): NamespaceEntity
     {
         // Ask for which namespace which to use for "tests"
-        $composer = $this->getComposerJsonData($basePath);
+        $composer = $this->getComposerJsonDataAction->data();
         $autoLoad = $this->getComposerDevAutoLoad($composer);
         if ($autoLoad !== []) {
             if (count($autoLoad) === 1) {
@@ -47,11 +47,6 @@ public function execute(Command $command, string $basePath, string $inputClass):
         return new NamespaceEntity($folder, $baseNamespace);
     }
 
-    protected function getComposerJsonData(string $basePath): mixed
-    {
-        return json_decode($this->filesystem->get($basePath . '/composer.json'), true, 512, JSON_THROW_ON_ERROR);
-    }
-
     private function getComposerDevAutoLoad(array $composer): array
     {
         if (isset($composer[self::ComposerAutoLoadDev])

diff --git a/src/Testing/Actions/PathToClassAction.php b/src/Testing/Actions/PathToClassAction.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaraStrict\Testing\Actions;
+
+use Exception;
+
+final class PathToClassAction
+{
+    public function __construct(
+        private readonly ComposerAutoloadAbsoluteAction $composerAutoloadAbsoluteAction,
+    ) {
+    }
+
+    public function execute(string $path): string
+    {
+        $dirs = $this->composerAutoloadAbsoluteAction->execute();
+
+        $class = $this->replacePathToClass($dirs, $path);
+        if ($class === null) {
+            $dirs = $this->composerAutoloadAbsoluteAction->execute($path);
+            $class = $this->replacePathToClass($dirs, $path);
+
+            if ($class === null) {
+                throw new Exception(sprintf('Path "%s" not found in composer psr-4.', $path));
+            }
+        }
+
+        return $class;
+    }
+
+    private function replacePathToClass(array $dirs, string $path): ?string
+    {
+        foreach ($dirs as $ns => $dir) {
+            if (str_starts_with($path, $dir) === false) {
+                continue;
+            }
+
+            $class = preg_replace_callback(
+                sprintf('~^%s[/\\\](?<path>.*)\.php$~', preg_quote($dir, '~')),
+                static fn (array $matches) => $ns . strtr($matches['path'], [
+                    '/' => '\\',
+                ]),
+                $path
+            );
+            assert(is_string($class));
+
+            return $class;
+        }
+
+        return null;
+    }
+}
diff --git a/src/Testing/Attributes/TestAssert.php b/src/Testing/Attributes/TestAssert.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaraStrict\Testing\Attributes;
+
+use Attribute;
+
+#[Attribute]
+final class TestAssert
+{
+}
diff --git a/src/Testing/Commands/MakeExpectationCommand.php b/src/Testing/Commands/MakeExpectationCommand.php
@@ -8,15 +8,17 @@
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
 use LaraStrict\Testing\Actions\ParsePhpDocAction;
+use LaraStrict\Testing\Actions\PathToClassAction;
 use LaraStrict\Testing\Assert\AbstractExpectationCallsMap;
+use LaraStrict\Testing\Attributes\TestAssert;
 use LaraStrict\Testing\Constants\StubConstants;
+use LaraStrict\Testing\Contracts\FinderFactoryContract;
 use LaraStrict\Testing\Contracts\GetBasePathForStubsActionContract;
 use LaraStrict\Testing\Contracts\GetNamespaceForStubsActionContract;
 use LaraStrict\Testing\Entities\AssertFileStateEntity;
 use LaraStrict\Testing\Entities\PhpDocEntity;
 use LaraStrict\Testing\Enums\PhpType;
 use LogicException;
-use Nette\PhpGenerator\ClassLike;
 use Nette\PhpGenerator\ClassType;
 use Nette\PhpGenerator\Factory;
 use Nette\PhpGenerator\Literal;
@@ -33,21 +35,24 @@
 use ReflectionType;
 use ReflectionUnionType;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Finder\Finder;
 
 #[AsCommand(name: 'make:expectation', description: 'Make expectation class for given class')]
 class MakeExpectationCommand extends Command
 {
     private const HookProperty = '_hook';
 
     protected $signature = 'make:expectation
-        {class : Class name of path to class using PSR-4 specs}
+        {class : Class name of path to class using PSR-4 specs or use all keyword}
     ';
 
     public function handle(
         Filesystem $filesystem,
         GetBasePathForStubsActionContract $getBasePathAction,
         GetNamespaceForStubsActionContract $getFolderAndNamespaceForStubsAction,
         ParsePhpDocAction $parsePhpDocAction,
+        FinderFactoryContract $finderFactory,
+        PathToClassAction $pathToClassAction,
     ): int {
         if (class_exists(ClassType::class) === false) {
             $message = 'First install package that is required:';
@@ -61,12 +66,43 @@ public function handle(
 
         $basePath = $getBasePathAction->execute();
 
-        $inputClass = $this->getInputClass($basePath, $filesystem);
+        /** @phpstan-var class-string|string $class */
+        $class = (string) $this->input->getArgument('class');
+
+        if ($class === 'all') {
+            $inputClasses = $this->findAllClasses($finderFactory->create(), $pathToClassAction);
+        } else {
+            $inClass = $this->normalizeToClass($class, $basePath, $filesystem, $pathToClassAction);
+            $inputClasses = $inClass === null ? [] : [$inClass];
+        }
 
-        if ($inputClass === null) {
+        if ($inputClasses === []) {
             return 1;
         }
 
+        foreach ($inputClasses as $inputClass) {
+            $this->generateExpectationFiles(
+                $inputClass,
+                $getFolderAndNamespaceForStubsAction,
+                $basePath,
+                $filesystem,
+                $parsePhpDocAction
+            );
+        }
+
+        return 0;
+    }
+
+    /**
+     * @param class-string $inputClass
+     */
+    public function generateExpectationFiles(
+        string $inputClass,
+        GetNamespaceForStubsActionContract $getFolderAndNamespaceForStubsAction,
+        string $basePath,
+        Filesystem $filesystem,
+        ParsePhpDocAction $parsePhpDocAction
+    ): void {
         $class = new ReflectionClass($inputClass);
 
         $methods = $class->getMethods(ReflectionMethod::IS_PUBLIC);
@@ -76,7 +112,7 @@ public function handle(
         }
 
         // Ask for which namespace which to use for "tests"
-        $namespace = $getFolderAndNamespaceForStubsAction->execute($this, $basePath, $inputClass);
+        $namespace = $getFolderAndNamespaceForStubsAction->execute($this, $inputClass);
 
         // 1. The first part of namespace should is in 99% App => app. We need to create a valid
         // namespace in tests folder, lets remove the first namespace and rebuild the correct
@@ -175,8 +211,6 @@ className: $assertClassName,
                 fileContents: $printer->printFile($assertFileState->file)
             );
         }
-
-        return 0;
     }
 
     /**
@@ -479,11 +513,25 @@ protected function canReturnExpectation(ReflectionNamedType $returnType): bool
     /**
      * @return class-string|null
      */
-    private function getInputClass(string $basePath, Filesystem $filesystem): ?string
+    private function checkInterface(string $class): ?string
     {
-        /** @phpstan-var class-string|string $class */
-        $class = (string) $this->input->getArgument('class');
+        if (class_exists($class) === false && interface_exists($class) === false) {
+            $this->writeError(sprintf('Provided class does not exists [%s]', $class));
+            return null;
+        }
+
+        return $class;
+    }
 
+    /**
+     * @return class-string|null
+     */
+    private function normalizeToClass(
+        string $class,
+        string $basePath,
+        Filesystem $filesystem,
+        PathToClassAction $pathToClassAction
+    ): ?string {
         if (str_ends_with($class, '.php')) {
             $fullPath = $basePath . '/' . $class;
 
@@ -492,23 +540,34 @@ private function getInputClass(string $basePath, Filesystem $filesystem): ?strin
                 return null;
             }
 
-            $file = PhpFile::fromCode($filesystem->get($fullPath));
+            return $pathToClassAction->execute($fullPath);
+        }
 
-            /** @phpstan-var array<class-string, ClassLike> $classes */
-            $classes = $file->getClasses();
-            if ($classes === []) {
-                $this->writeError(sprintf('Provided file does not contain any class [%s]', $class));
-                return null;
-            }
+        return $this->checkInterface($class);
+    }
 
-            $class = array_keys($classes)[0];
-        }
+    /**
+     * @return array<class-string>
+     */
+    private function findAllClasses(Finder $finder, PathToClassAction $pathToClassAction): array
+    {
+        $classes = [];
+        foreach ($finder as $file) {
+            $interface = $pathToClassAction->execute($file->getRealPath());
+            require_once $file->getPathname();
 
-        if (class_exists($class) === false && interface_exists($class) === false) {
-            $this->writeError(sprintf('Provided class does not exists [%s]', $class));
-            return null;
+            if (interface_exists($interface, false) === false) {
+                continue;
+            }
+
+            $classReflection = new ReflectionClass($interface);
+            $attributes = $classReflection->getAttributes(TestAssert::class);
+            if ($attributes === []) {
+                continue;
+            }
+            $classes[] = $interface;
         }
 
-        return $class;
+        return $classes;
     }
 }
diff --git a/src/Testing/Contracts/FinderFactoryContract.php b/src/Testing/Contracts/FinderFactoryContract.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaraStrict\Testing\Contracts;
+
+use Symfony\Component\Finder\Finder;
+
+interface FinderFactoryContract
+{
+    public function create(): Finder;
+}
diff --git a/src/Testing/Contracts/GetNamespaceForStubsActionContract.php b/src/Testing/Contracts/GetNamespaceForStubsActionContract.php
@@ -9,5 +9,5 @@
 
 interface GetNamespaceForStubsActionContract
 {
-    public function execute(Command $command, string $basePath, string $inputClass): NamespaceEntity;
+    public function execute(Command $command, string $inputClass): NamespaceEntity;
 }