Refactor FactoryAutoloader to use PHPStan Cache

Author: shochdoerfer

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

@@ -12,14 +12,48 @@
 
 namespace bitExpert\PHPStan\Magento\Autoload;
 
+use PHPStan\Cache\Cache;
+
 class FactoryAutoloader
 {
+    /**
+     * @var Cache
+     */
+    private $cache;
+
+    /**
+     * FactoryAutoloader constructor.
+     *
+     * @param Cache $cache
+     */
+    public function __construct(Cache $cache)
+    {
+        $this->cache = $cache;
+    }
+
     public function autoload(string $class): void
     {
         if (!preg_match('#Factory$#', $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 factory file content as Magento would.
+     *
+     * @param $class
+     * @return string
+     */
+    protected function getFileContents($class): string
+    {
         $namespace = explode('\\', ltrim($class, '\\'));
         $factoryClassname = array_pop($namespace);
         $originalClassname = str_replace('Factory', '', $factoryClassname);
@@ -41,16 +75,18 @@ public function autoload(string $class): void
         $template .= "    public function create(array \$data = array()) {}\n";
         $template .= "}\n";
 
-        $template = str_replace(
-            ['{NAMESPACE}', '{CLASSNAME}', '{FACTORY_CLASSNAME}'],
-            [$namespace, $originalClassname, $factoryClassname],
+        return str_replace(
+            [
+                '{NAMESPACE}',
+                '{CLASSNAME}',
+                '{FACTORY_CLASSNAME}'
+            ],
+            [
+                $namespace,
+                $originalClassname,
+                $factoryClassname
+            ],
             $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(), 'PSMF');
-        file_put_contents($tmpFilename, $template, LOCK_EX);
-        include($tmpFilename);
     }
 }

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

@@ -0,0 +1,76 @@
+<?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 FactoryAutoloaderUnitTest extends TestCase
+{
+    /**
+     * @var CacheStorage|\PHPUnit\Framework\MockObject\MockObject
+     */
+    private $storage;
+    /**
+     * @var FactoryAutoloader
+     */
+    private $autoloader;
+
+    public function setUp(): void
+    {
+        $this->storage = $this->createMock(CacheStorage::class);
+        $this->autoloader = new FactoryAutoloader(new Cache($this->storage));
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderIgnoresClassesWithoutFactoryPostfix()
+    {
+        $this->storage->expects($this->never())
+            ->method('load');
+
+        $this->autoloader->autoload('SomeClass');
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderUsesCachedFileWhenFound()
+    {
+        $this->storage->expects($this->once())
+            ->method('load')
+            ->willReturn(__DIR__ . '/HelperFactory.php');
+
+        $this->autoloader->autoload(HelperFactory::class);
+
+        self::assertTrue(class_exists(HelperFactory::class, false));
+    }
+
+    /**
+     * @test
+     */
+    public function autoloaderGeneratesCacheFileWhenNotFoundInCache()
+    {
+        $this->storage->expects($this->atMost(2))
+            ->method('load')
+            ->willReturnOnConsecutiveCalls(null, __DIR__ . '/HelperFactory.php');
+        $this->storage->expects($this->once())
+            ->method('save');
+
+        $this->autoloader->autoload(HelperFactory::class);
+
+        self::assertTrue(class_exists(HelperFactory::class, false));
+    }
+}

tests/bitExpert/PHPStan/Magento/Autoload/HelperFactory.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 HelperFactory
+{
+}