Refactor CacheHandlerInstantiationRule

Author: paulbalandan

docs/rules.md

@@ -4,6 +4,15 @@ All rules of this extension is summarised below:
 
 ## Classes
 
+### CacheHandlerInstantiationRule
+
+**Class:** `CodeIgniter\PHPStan\Rules\Classes\CacheHandlerInstantiationRule`<br/>
+Fixable: No
+
+Simply instantiating cache handlers using `new` is incomplete. The public `initialize()` method
+needs to be called on the instance so that the required initializations are done. This is usually
+achieved by using `CacheFactory::getHandler()` or using the `cache()` function.
+
 ### FrameworkExceptionInstantiationRule
 
 **Class:** `CodeIgniter\PHPStan\Rules\Classes\FrameworkExceptionInstantiationRule`<br/>

src/Rules/Classes/CacheHandlerInstantiationRule.php

@@ -59,10 +59,10 @@ public function processNode(Node $node, Scope $scope): array
 
         return [
             RuleErrorBuilder::message(sprintf(
-                'Calling new %s() directly is incomplete to get the cache instance.',
-                $reflection->getNativeReflection()->getShortName(),
+                'Instantiating "%s" using new is incomplete to get a fully configured cache instance.',
+                $reflection->getName(),
             ))
-                ->tip('Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.')
+                ->tip('Use "CacheFactory::getHandler()" or the "cache()" function instead.')
                 ->identifier('codeigniter.cacheHandlerInstance')
                 ->build(),
         ];

tests/Rules/Classes/CacheHandlerInstantiationRuleTest.php

@@ -14,7 +14,7 @@
 namespace CodeIgniter\PHPStan\Tests\Rules\Classes;
 
 use CodeIgniter\PHPStan\Rules\Classes\CacheHandlerInstantiationRule;
-use CodeIgniter\PHPStan\Tests\AdditionalConfigFilesTrait;
+use CodeIgniter\PHPStan\Tests\AdditionalConfigFilesProvider;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\Group;
@@ -24,10 +24,10 @@
  *
  * @extends RuleTestCase<CacheHandlerInstantiationRule>
  */
-#[Group('Integration')]
+#[Group('static-analysis')]
 final class CacheHandlerInstantiationRuleTest extends RuleTestCase
 {
-    use AdditionalConfigFilesTrait;
+    use AdditionalConfigFilesProvider;
 
     protected function getRule(): Rule
     {
@@ -36,16 +36,16 @@ protected function getRule(): Rule
 
     public function testRule(): void
     {
-        $this->analyse([__DIR__ . '/data/cache-handler.php'], [
+        $this->analyse([__DIR__ . '/../../data/rules/cache-handler.php'], [
             [
-                'Calling new FileHandler() directly is incomplete to get the cache instance.',
+                'Instantiating "CodeIgniter\Cache\Handlers\FileHandler" using new is incomplete to get a fully configured cache instance.',
                 19,
-                'Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.',
+                'Use "CacheFactory::getHandler()" or the "cache()" function instead.',
             ],
             [
-                'Calling new RedisHandler() directly is incomplete to get the cache instance.',
+                'Instantiating "CodeIgniter\Cache\Handlers\RedisHandler" using new is incomplete to get a fully configured cache instance.',
                 20,
-                'Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.',
+                'Use "CacheFactory::getHandler()" or the "cache()" function instead.',
             ],
         ]);
     }

…sts/Rules/Classes/data/cache-handler.php tests/data/rules/cache-handler.phptests/Rules/Classes/data/cache-handler.php renamed to tests/data/rules/cache-handler.php tests/Rules/Classes/data/cache-handler.php renamed to tests/data/rules/cache-handler.php

@@ -18,7 +18,7 @@
 
 $handler1 = new FileHandler(new Cache());
 $handler2 = new RedisHandler(new Cache());
-$handler3 = new MockCache();
+$handler3 = new MockCache(); // This should not trigger the rule as it's a mock class used in tests.
 
 $cache1 = $handler1->get('foo');
 $cache2 = $handler2->get('bar');