Add FrameworkExceptionInstantiationRule

Author: paulbalandan

README.md

@@ -13,6 +13,7 @@ This extension provides the following features:
 * Provides precise return types for `service()` and `single_service()` 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.
+* Disallows instantiating `FrameworkException` classes using `new`.
 
 ## Installation
 

extension.neon

@@ -50,3 +50,4 @@ conditionalTags:
 
 rules:
   - CodeIgniter\PHPStan\Rules\Classes\CacheHandlerInstantiationRule
+  - CodeIgniter\PHPStan\Rules\Classes\FrameworkExceptionInstantiationRule

src/Rules/Classes/FrameworkExceptionInstantiationRule.php

@@ -0,0 +1,60 @@
+<?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\Exceptions\FrameworkException;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\ObjectType;
+
+/**
+ * @implements Rule<Node\Expr\New_>
+ */
+final class FrameworkExceptionInstantiationRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Expr\New_::class;
+    }
+
+    /**
+     * @param Node\Expr\New_ $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $class = $node->class;
+
+        if (! $class instanceof Node\Name) {
+            return [];
+        }
+
+        $objectType = new ObjectType($class->toString());
+
+        if (! (new ObjectType(FrameworkException::class))->isSuperTypeOf($objectType)->yes()) {
+            return [];
+        }
+
+        if ($objectType->getClassReflection() === null) {
+            throw new ShouldNotHappenException();
+        }
+
+        return [RuleErrorBuilder::message(sprintf(
+            'Instantiating %s using new is not allowed. Use one of its named constructors instead.',
+            $objectType->getClassReflection()->getNativeReflection()->getShortName()
+        ))->identifier('codeigniter.frameworkExceptionInstance')->build()];
+    }
+}

tests/Fixtures/Rules/Classes/framework-exception.php

@@ -0,0 +1,20 @@
+<?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\Exceptions\FrameworkException;
+use CodeIgniter\View\Exceptions\ViewException;
+
+$e1 = new FrameworkException('Hello.');
+$e2 = new ViewException('Hi!');
+$e3 = new RuntimeException('Thanks.');
+$e4 = new \CodeIgniter\HTTP\Exceptions\HTTPException('Nice');

tests/Rules/Classes/FrameworkExceptionInstantiationRuleTest.php

@@ -0,0 +1,53 @@
+<?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\FrameworkExceptionInstantiationRule;
+use CodeIgniter\PHPStan\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\Group;
+
+/**
+ * @internal
+ * @extends RuleTestCase<FrameworkExceptionInstantiationRule>
+ */
+#[Group('integration')]
+final class FrameworkExceptionInstantiationRuleTest extends RuleTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    protected function getRule(): Rule
+    {
+        return new FrameworkExceptionInstantiationRule();
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse([__DIR__ . '/../../Fixtures/Rules/Classes/framework-exception.php'], [
+            [
+                'Instantiating FrameworkException using new is not allowed. Use one of its named constructors instead.',
+                17,
+            ],
+            [
+                'Instantiating ViewException using new is not allowed. Use one of its named constructors instead.',
+                18,
+            ],
+            [
+                'Instantiating HTTPException using new is not allowed. Use one of its named constructors instead.',
+                20,
+            ],
+        ]);
+    }
+}