Merge pull request #163 from lacrossefootwear/bugfix/161

Determine tmpDir path relative to config file when appropriate

Author: shochdoerfer

autoload.php

@@ -9,56 +9,24 @@
  * file that was distributed with this source code.
  */
 
-use bitExpert\PHPStan\Magento\Autoload\Cache\FileCacheStorage;
-use bitExpert\PHPStan\Magento\Autoload\FactoryAutoloader;
-use bitExpert\PHPStan\Magento\Autoload\MockAutoloader;
-use bitExpert\PHPStan\Magento\Autoload\ProxyAutoloader;
-use bitExpert\PHPStan\Magento\Autoload\TestFrameworkAutoloader;
-use Nette\Neon\Neon;
-use PHPStan\Cache\Cache;
-
 // This autoloader implementation supersedes the former \bitExpert\PHPStan\Magento\Autoload\Autoload implementation
-(function (array $argv = []) {
-    // Sadly we don't have access to the parsed phpstan.neon configuration at this point we need to look up the
-    // location of the config file and parse it with the Neon parser to be able to extract the tmpDir definition!
-    $configFile = '';
-    if (count($argv) > 0) {
-        foreach($argv as $idx => $value) {
-            if ((strtolower($value) === '-c') && isset($argv[$idx + 1])) {
-                $configFile = $argv[$idx + 1];
-                break;
-            }
-        }
-    }
-
-    if (empty($configFile)) {
-        $currentWorkingDirectory = getcwd();
-        foreach (['phpstan.neon', 'phpstan.neon.dist'] as $discoverableConfigName) {
-            $discoverableConfigFile = $currentWorkingDirectory . DIRECTORY_SEPARATOR . $discoverableConfigName;
-            if (file_exists($discoverableConfigFile) && is_readable(($discoverableConfigFile))) {
-                $configFile = $discoverableConfigFile;
-                break;
-            }
-        }
-    }
 
-    $tmpDir = sys_get_temp_dir() . '/phpstan';
-    if (!empty($configFile)) {
-        $neonConfig = Neon::decode(file_get_contents($configFile));
-        if(is_array($neonConfig) && isset($neonConfig['parameters']) && isset($neonConfig['parameters']['tmpDir'])) {
-            $tmpDir = $neonConfig['parameters']['tmpDir'];
-        }
+use bitExpert\PHPStan\Magento\Autoload\Autoloader;
+use PHPStan\DependencyInjection\Container;
+
+if (!isset($container) || !$container instanceof Container) {
+    echo 'No container found, or container not of expected type' . PHP_EOL;
+    die(-1);
+}
+
+foreach ($container->getServicesByTag('phpstan.magento.autoloader') as $autoloader) {
+    /** @var Autoloader|object $autoloader */
+    if (!$autoloader instanceof Autoloader) {
+        echo 'Services tagged with \'phpstan.magento.autoloader\' must extend ' .
+            'bitExpert\PHPStan\Magento\Autoload\Autoloader!' . PHP_EOL .
+            get_class($autoloader) . ' does not.' . PHP_EOL;
+        die(-1);
     }
 
-    $cache = new Cache(new FileCacheStorage($tmpDir . '/cache/PHPStan'));
-
-    $mockAutoloader = new MockAutoloader();
-    $testFrameworkAutoloader = new TestFrameworkAutoloader();
-    $factoryAutoloader = new FactoryAutoloader($cache);
-    $proxyAutoloader = new ProxyAutoloader($cache);
-
-    \spl_autoload_register([$mockAutoloader, 'autoload'], true, true);
-    \spl_autoload_register([$testFrameworkAutoloader, 'autoload'], true, false);
-    \spl_autoload_register([$factoryAutoloader, 'autoload'], true, false);
-    \spl_autoload_register([$proxyAutoloader, 'autoload'], true, false);
-})($GLOBALS['argv'] ?? []);
+    $autoloader->register();
+}

extension.neon

@@ -40,3 +40,32 @@ services:
 		class: bitExpert\PHPStan\Magento\Rules\AbstractModelRetrieveCollectionViaFactoryRule
 	-
 		class: bitExpert\PHPStan\Magento\Rules\AbstractModelUseServiceContractRule
+	fileCacheStorage:
+		class: bitExpert\PHPStan\Magento\Autoload\Cache\FileCacheStorage
+		arguments:
+			directory: %tmpDir%/cache/PHPStan
+	autoloaderCache:
+		autowired: false
+		class: PHPStan\Cache\Cache
+		arguments:
+			storage: @fileCacheStorage
+	mockAutoloader:
+		class: bitExpert\PHPStan\Magento\Autoload\MockAutoloader
+		tags:
+			- phpstan.magento.autoloader
+	testFrameworkAutoloader:
+		class: bitExpert\PHPStan\Magento\Autoload\TestFrameworkAutoloader
+		tags:
+			- phpstan.magento.autoloader
+	factoryAutoloader:
+		class: bitExpert\PHPStan\Magento\Autoload\FactoryAutoloader
+		arguments:
+			cache: @autoloaderCache
+		tags:
+			- phpstan.magento.autoloader
+	proxyAutoloader:
+		class: bitExpert\PHPStan\Magento\Autoload\ProxyAutoloader
+		arguments:
+			cache: @autoloaderCache
+		tags:
+			- phpstan.magento.autoloader

phpstan.neon

@@ -34,6 +34,9 @@ parameters:
         -
             message: '~is not covered by backward compatibility promise.~'
             path: tests/bitExpert/PHPStan/Magento/Autoload/ProxyAutoloaderUnitTest.php
+        -
+            message: '~is not covered by backward compatibility promise.~'
+            path: tests/bitExpert/PHPStan/Magento/Autoload/RegistrationUnitTest.php
         -
             message: '~bitExpert\\PHPStan\\Magento\\Rules\\Helper\\SampleModel::__construct\(\) does not call parent constructor~'
             path: tests/bitExpert/PHPStan/Magento/Rules/Helper/SampleModel.php

src/bitExpert/PHPStan/Magento/Autoload/Autoloader.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the phpstan-magento package.
+ *
+ * (c) bitExpert AG
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace bitExpert\PHPStan\Magento\Autoload;
+
+interface Autoloader
+{
+    /**
+     * Begin autoloading
+     */
+    public function register(): void;
+
+    /**
+     * Stop autoloading
+     */
+    public function unregister(): void;
+}

src/bitExpert/PHPStan/Magento/Autoload/FactoryAutoloader.php

@@ -14,7 +14,7 @@
 
 use PHPStan\Cache\Cache;
 
-class FactoryAutoloader
+class FactoryAutoloader implements Autoloader
 {
     /**
      * @var Cache
@@ -94,4 +94,14 @@ protected function getFileContents(string $class): string
             $template
         );
     }
+
+    public function register(): void
+    {
+        \spl_autoload_register([$this, 'autoload'], true, false);
+    }
+
+    public function unregister(): void
+    {
+        spl_autoload_unregister([$this, 'autoload']);
+    }
 }

src/bitExpert/PHPStan/Magento/Autoload/MockAutoloader.php

@@ -16,7 +16,7 @@
  * The MockAutoloader is responsible to load custom mocked classes or interfaces instead of the original Magento classes
  * or interfaces. This is needed as not all interfaces expose all public methods that can be called on those objects.
  */
-class MockAutoloader
+class MockAutoloader implements Autoloader
 {
     public function autoload(string $class): void
     {
@@ -25,4 +25,14 @@ public function autoload(string $class): void
             include($filename);
         }
     }
+
+    public function register(): void
+    {
+        \spl_autoload_register([$this, 'autoload'], true, true);
+    }
+
+    public function unregister(): void
+    {
+        \spl_autoload_unregister([$this, 'autoload']);
+    }
 }

src/bitExpert/PHPStan/Magento/Autoload/ProxyAutoloader.php

@@ -14,7 +14,7 @@
 
 use PHPStan\Cache\Cache;
 
-class ProxyAutoloader
+class ProxyAutoloader implements Autoloader
 {
     /**
      * @var Cache
@@ -158,4 +158,14 @@ protected function getFileContents(string $class): string
             $template
         );
     }
+
+    public function register(): void
+    {
+        \spl_autoload_register([$this, 'autoload'], true, false);
+    }
+
+    public function unregister(): void
+    {
+        \spl_autoload_unregister([$this, 'autoload']);
+    }
 }

src/bitExpert/PHPStan/Magento/Autoload/TestFrameworkAutoloader.php

@@ -16,7 +16,7 @@
  * Autoloader for Magento\TestFramework classes as those are not loaded by Composer by default which makes PHPStan
  * not know about them.
  */
-class TestFrameworkAutoloader
+class TestFrameworkAutoloader implements Autoloader
 {
     public function autoload(string $class): void
     {
@@ -42,4 +42,14 @@ public function autoload(string $class): void
             }
         }
     }
+
+    public function register(): void
+    {
+        \spl_autoload_register([$this, 'autoload'], true, false);
+    }
+
+    public function unregister(): void
+    {
+        \spl_autoload_unregister([$this, 'autoload']);
+    }
 }

tests/bitExpert/PHPStan/Magento/Autoload/RegistrationUnitTest.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the phpstan-magento package.
+ *
+ * (c) bitExpert AG
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace bitExpert\PHPStan\Magento\Autoload;
+
+use PHPStan\Cache\Cache;
+use PHPUnit\Framework\TestCase;
+
+class RegistrationUnitTest extends TestCase
+{
+    /**
+     * @test
+     * @dataProvider provideAutoloaders()
+     */
+    public function autoloadersCanRegisterAndUnregister(Autoloader $autoloader): void
+    {
+        /** @var array<callable> $initialAutoloadFunctions */
+        $initialAutoloadFunctions = spl_autoload_functions();
+
+        $autoloader->register();
+        /** @var array<callable> $registerAutoloadFunctions */
+        $registerAutoloadFunctions = spl_autoload_functions();
+        static::assertCount(count($initialAutoloadFunctions) + 1, $registerAutoloadFunctions);
+
+        $autoloader->unregister();
+        /** @var array<callable> $unregisterAutoloadFunctions */
+        $unregisterAutoloadFunctions = spl_autoload_functions();
+        static::assertCount(count($initialAutoloadFunctions), $unregisterAutoloadFunctions);
+    }
+
+    /**
+     * @return array<array<Autoloader>>
+     */
+    public function provideAutoloaders(): array
+    {
+        $cache = new Cache($this->getMockBuilder(\PHPStan\Cache\CacheStorage::class)->getMock());
+
+        return [
+            [new FactoryAutoloader($cache)],
+            [new MockAutoloader()],
+            [new ProxyAutoloader($cache)],
+            [new TestFrameworkAutoloader()]
+        ];
+    }
+}