Add CacheHandlerInstantiationRule

Author: paulbalandan

README.md

@@ -11,6 +11,7 @@ This extension provides the following features:
 
 * Provides precise return types for `config()` and `model()` functions.
 * Checks if the string argument passed to `config()` or `model()` function is a valid class string extending `CodeIgniter\Config\BaseConfig` or `CodeIgniter\Model`, respectively. This can be turned off by setting `codeigniter.checkArgumentTypeOfFactories: false` in your `phpstan.neon`.
+* Disallows instantiating cache handlers using `new` and suggests to use the `CacheFactory` class instead.
 
 ## Installation
 

extension.neon

@@ -35,3 +35,6 @@ services:
 conditionalTags:
   CodeIgniter\PHPStan\Rules\Functions\FactoriesFunctionArgumentTypeRule:
     phpstan.rules.rule: %codeigniter.checkArgumentTypeOfFactories%
+
+rules:
+  - CodeIgniter\PHPStan\Rules\Classes\CacheHandlerInstantiationRule

phpstan.neon.dist

@@ -11,13 +11,13 @@ parameters:
   excludePaths:
     analyseAndScan:
       - src/ComposerScripts.php
+      - tests/Fixtures
   tmpDir: build/phpstan
   bootstrapFiles:
     - vendor/codeigniter4/framework/system/Test/bootstrap.php
   codeigniter:
     additionalModelNamespaces:
       - CodeIgniter\PHPStan\Tests\Fixtures\Type
-    checkArgumentTypeOfFactories: false
   checkTooWideReturnTypesInProtectedAndPublicMethods: true
   checkUninitializedProperties: true
   checkImplicitMixed: true

src/Rules/Classes/CacheHandlerInstantiationRule.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) 2023 CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\PHPStan\Rules\Classes;
+
+use CodeIgniter\Cache\CacheFactory;
+use CodeIgniter\Cache\CacheInterface;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+/**
+ * @implements Rule<Node\Expr\New_>
+ */
+final class CacheHandlerInstantiationRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Expr\New_::class;
+    }
+
+    /**
+     * @param Node\Expr\New_ $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! $node->class instanceof Node\Name) {
+            return [];
+        }
+
+        $objectType = new ObjectType((string) $node->class);
+        $reflection = $objectType->getClassReflection();
+
+        if ($reflection === null) {
+            return [];
+        }
+
+        if (! (new ObjectType(CacheInterface::class))->isSuperTypeOf($objectType)->yes()) {
+            return [];
+        }
+
+        if ($scope->isInClass() && $scope->getClassReflection()->getName() === CacheFactory::class) {
+            return [];
+        }
+
+        return [RuleErrorBuilder::message(sprintf(
+            'Calling new %s() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
+            $reflection->getNativeReflection()->getShortName(),
+        ))->identifier('codeigniter.cacheHandlerInstance')->build()];
+    }
+}

tests/Fixtures/Rules/Classes/cache-handler.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) 2023 CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+use CodeIgniter\Cache\Handlers\FileHandler;
+use CodeIgniter\Cache\Handlers\RedisHandler;
+use Config\Cache;
+
+$handler1 = new FileHandler(new Cache());
+$handler2 = new RedisHandler(new Cache());
+
+$cache1 = $handler1->get('foo');
+$cache2 = $handler2->get('bar');

tests/Rules/Classes/CacheHandlerInstantiationRuleTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) 2023 CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\PHPStan\Tests\Rules\Classes;
+
+use CodeIgniter\PHPStan\Rules\Classes\CacheHandlerInstantiationRule;
+use CodeIgniter\PHPStan\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\Group;
+
+/**
+ * @internal
+ *
+ * @extends RuleTestCase<CacheHandlerInstantiationRule>
+ */
+#[Group('Integration')]
+final class CacheHandlerInstantiationRuleTest extends RuleTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    protected function getRule(): Rule
+    {
+        return new CacheHandlerInstantiationRule();
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse([__DIR__ . '/../../Fixtures/Rules/Classes/cache-handler.php'], [
+            [
+                'Calling new FileHandler() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
+                18,
+            ],
+            [
+                'Calling new RedisHandler() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
+                19,
+            ],
+        ]);
+    }
+}