Refactor ProxyAutoloader to use PHPStan Cache

Author: shochdoerfer

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

@@ -12,14 +12,49 @@
 
 namespace bitExpert\PHPStan\Magento\Autoload;
 
+use PHPStan\Cache\Cache;
+
 class ProxyAutoloader
 {
+    /**
+     * @var Cache
+     */
+    private $cache;
+
+    /**
+     * ProxyAutoloader constructor.
+     *
+     * @param Cache $cache
+     */
+    public function __construct(Cache $cache)
+    {
+        $this->cache = $cache;
+    }
+
     public function autoload(string $class): void
     {
         if (!preg_match('#\\\Proxy#', $class)) {
             return;
         }
 
+        $cacheFilename = $this->cache->load($class, '');
+        if ($cacheFilename === null) {
+            $this->cache->save($class, '', $this->getFileContents($class));
+            $cacheFilename = $this->cache->load($class, '');
+        }
+
+        require_once($cacheFilename);
+    }
+
+    /**
+     * Generate the proxy file content as Magento would.
+     *
+     * @param string $class
+     * @return string
+     * @throws \ReflectionException
+     */
+    protected function getFileContents(string $class): string
+    {
         $namespace = explode('\\', ltrim($class, '\\'));
         $proxyClassname = array_pop($namespace);
         $proxyBaseClass = '';
@@ -95,7 +130,7 @@ public function autoload(string $class): void
         $template .= "{METHODS}";
         $template .= "}\n";
 
-        $template = str_replace(
+        return str_replace(
             [
                 '{NAMESPACE}',
                 '{CLASSNAME}',
@@ -114,11 +149,5 @@ public function autoload(string $class): void
             ],
             $template
         );
-
-        // we need to store the generated file on disk as PHPStan will try to access the file in several ways. Just
-        // eval'ing the php code to make the class available won't work!
-        $tmpFilename = tempnam(sys_get_temp_dir(), 'PSMP');
-        file_put_contents($tmpFilename, $template, LOCK_EX);
-        include($tmpFilename);
     }
 }

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

@@ -0,0 +1,20 @@
+<?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;
+
+/**
+ * Dummy class that can be loaded via the Autoloader in the test cases.
+ */
+class HelperProxy
+{
+}

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

@@ -0,0 +1,80 @@
+<?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 PHPStan\Cache\CacheStorage;
+use PHPUnit\Framework\TestCase;
+
+class ProxyAutoloaderUnitTest extends TestCase
+{
+    /**
+     * @var CacheStorage|\PHPUnit\Framework\MockObject\MockObject
+     */
+    private $storage;
+    /**
+     * @var ProxyAutoloader
+     */
+    private $autoloader;
+
+    public function setUp(): void
+    {
+        $this->storage = $this->createMock(CacheStorage::class);
+        $this->autoloader = new ProxyAutoloader(new Cache($this->storage));
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderIgnoresClassesWithoutProxyPostfix()
+    {
+        $this->storage->expects($this->never())
+            ->method('load');
+
+        $this->autoloader->autoload('SomeClass');
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderUsesCachedFileWhenFound()
+    {
+        $this->storage->expects($this->once())
+            ->method('load')
+            ->willReturn(__DIR__ . '/HelperProxy.php');
+
+        $this->autoloader->autoload('\bitExpert\PHPStan\Magento\Autoload\Helper\Proxy');
+
+        self::assertTrue(class_exists(HelperProxy::class, false));
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderGeneratesCacheFileWhenNotFoundInCache()
+    {
+        // little hack: the proxy autoloader will use Reflection to look for a class without the \Proxy prefix,
+        // to avoid having another stub class file, we define an class alias here
+        class_alias('\bitExpert\PHPStan\Magento\Autoload\HelperProxy', '\bitExpert\PHPStan\Magento\Autoload\Helper');
+
+        $this->storage->expects($this->atMost(2))
+            ->method('load')
+            ->willReturnOnConsecutiveCalls(null, __DIR__ . '/HelperProxy.php');
+        $this->storage->expects($this->once())
+            ->method('save');
+
+        $this->autoloader->autoload('\bitExpert\PHPStan\Magento\Autoload\Helper\Proxy');
+
+        self::assertTrue(class_exists(HelperProxy::class, false));
+    }
+}