Extract collaborators from spec instead of scan soruce files 🚀

Author: akondas

extension.neon

@@ -7,6 +7,5 @@ extensions:
     phpspec: Proget\PHPStan\PhpSpec\DependencyInjection\PhpSpecDynamicMethodReturnTypeExtensionCreator
 
 parameters:
-    phpspecSourceFiles:
-        - 'src/'
-        - 'tests/'
+    specDirs:
+        - 'spec/'

src/DependencyInjection/PhpSpecDynamicMethodReturnTypeExtensionCreator.php

@@ -6,7 +6,8 @@
 
 use Nette\DI\CompilerExtension;
 use Nette\DI\ServiceDefinition;
-use Proget\PHPStan\PhpSpec\Locator\SourceClassLocator;
+use Proget\PHPStan\PhpSpec\Extractor\CollaboratorExtractor;
+use Proget\PHPStan\PhpSpec\Locator\SpecClassLocator;
 use Proget\PHPStan\PhpSpec\Reflection\CollaboratorDynamicMethodReturnTypeExtension;
 
 final class PhpSpecDynamicMethodReturnTypeExtensionCreator extends CompilerExtension
@@ -15,18 +16,18 @@ public function beforeCompile()
     {
         $builder = $this->getContainerBuilder();
         $workingDir = $this->getContainerBuilder()->parameters['currentWorkingDirectory'];
-        $classes = (new SourceClassLocator())->locate(array_map(function (string $dir) use ($workingDir) {
+        $specClasses = (new SpecClassLocator())->locate(array_map(function (string $dir) use ($workingDir) {
             return $workingDir.DIRECTORY_SEPARATOR.ltrim($dir, DIRECTORY_SEPARATOR);
-        }, $this->getContainerBuilder()->parameters['phpspecSourceFiles']));
+        }, $this->getContainerBuilder()->parameters['specDirs']));
 
-        foreach ($classes as $class) {
+        foreach ((new CollaboratorExtractor())->extract($specClasses) as $class) {
             $definition = new ServiceDefinition();
             $definition->addTag('phpstan.broker.dynamicMethodReturnTypeExtension');
             $definition->setType(CollaboratorDynamicMethodReturnTypeExtension::class);
             $definition->setArguments([$class]);
 
             $builder->addDefinition(
-                'collaborator.'.strtolower((string) preg_replace('/[^a-zA-Z0-9]+/', '', (string) $class)),
+                'collaborator.'.strtolower((string) preg_replace('/[^a-zA-Z0-9]+/', '', $class)),
                 $definition
             );
         }

src/Extractor/CollaboratorExtractor.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proget\PHPStan\PhpSpec\Extractor;
+
+final class CollaboratorExtractor
+{
+    /**
+     * @param string[] $classes
+     *
+     * @return string[]
+     */
+    public function extract(array $classes): array
+    {
+        $collaborators = [];
+        foreach ($classes as $className) {
+            $reflection = new \ReflectionClass($className);
+            $this->extractFromMethods($reflection->getMethods(\ReflectionMethod::IS_PUBLIC), $collaborators);
+        }
+
+        return array_unique($collaborators);
+    }
+
+    /**
+     * @param \ReflectionMethod[] $methods
+     * @param string[]            $collaborators
+     */
+    private function extractFromMethods(array $methods, array &$collaborators): void
+    {
+        foreach ($methods as $method) {
+            if (!preg_match('/^(it|its)[^a-zA-Z]/', $method->getName())) {
+                continue;
+            }
+            $this->extractFromAttributes($method->getParameters(), $collaborators);
+        }
+    }
+
+    /**
+     * @param \ReflectionParameter[] $parameters
+     * @param string[]               $collaborators
+     */
+    private function extractFromAttributes(array $parameters, array &$collaborators): void
+    {
+        foreach ($parameters as $parameter) {
+            $type = $parameter->getType();
+            if ($type !== null) {
+                $collaborators[] = $type->getName();
+            }
+        }
+    }
+}

src/Locator/SourceClassLocator.php src/Locator/SpecClassLocator.phpsrc/Locator/SourceClassLocator.php renamed to src/Locator/SpecClassLocator.php

@@ -7,23 +7,19 @@
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
-final class SourceClassLocator
+final class SpecClassLocator
 {
     public function locate(array $dirs): array
     {
-        $finder = new Finder();
+        $finder = (new Finder())->in($dirs)->name('*.php');
 
-        $nonFinalClasses = [];
-        foreach (iterator_to_array($finder->in($dirs)->name('*.php')->files()) as $file) {
-            $className = $this->getClassName($file);
-            if ($className === null || (new \ReflectionClass($className))->isFinal()) {
-                continue;
-            }
-
-            $nonFinalClasses[] = $className;
-        }
+        $classes = array_map(function (SplFileInfo $fileInfo): string {
+            return (string) $this->getClassName($fileInfo);
+        }, iterator_to_array($finder->files()));
 
-        return $nonFinalClasses;
+        return array_values(array_filter($classes, function (string $className): bool {
+            return preg_match('/Spec$/', $className) !== false;
+        }));
     }
 
     private function getClassName(SplFileInfo $fileInfo): ?string
@@ -44,7 +40,7 @@ private function getClassName(SplFileInfo $fileInfo): ?string
                 }
             }
 
-            if ($tokens[$i][0] === T_CLASS || $tokens[$i][0] === T_INTERFACE) {
+            if ($tokens[$i][0] === T_CLASS) {
                 for ($j = $i + 1; $j < $count; ++$j) {
                     if ($tokens[$j] === '{') {
                         return $namespace.$tokens[$i + 2][1];