Merge pull request #37 from Jean85/increase-static-analysis

Increase static analysis
thecodingmachine · Nov 28, 2024 · 72030d0 · 72030d0
2 parents 150031e + ca626cc
commit 72030d0
Show file tree

Hide file tree

Showing 10 changed files with 50 additions and 121 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,6 +2,9 @@ parameters:
     level: max
     paths:
         - src
+        - tests
+    excludePaths:
+        - tests/Rules/data
     ignoreErrors:
         -
             message: '#^Implementing PHPStan\\Rules\\IdentifierRuleError is not covered by backward compatibility promise\. The interface might change in a minor PHPStan version\.$#'

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-         bootstrap="tests/bootstrap.php"
+         bootstrap="vendor/autoload.php"
          colors="true"
          backupGlobals="false"
          backupStaticAttributes="false"
@@ -24,6 +24,9 @@
     <include>
       <directory suffix=".php">./src</directory>
     </include>
+    <exclude>
+      <file>src/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtension.php</file>
+    </exclude>
     <report>
       <clover outputFile="build/logs/clover.xml"/>
       <html outputDirectory="build/coverage"/>

diff --git a/src/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtension.php b/src/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtension.php
@@ -20,7 +20,7 @@ class ReplaceSafeFunctionsDynamicReturnTypeExtension implements DynamicFunctionR
 {
 
     /** @var array<string, int> */
-    private $functions = [
+    private array $functions = [
         'Safe\preg_replace' => 2,
     ];
 

diff --git a/tests/Rules/CallMethodRuleTest.php b/tests/Rules/CallMethodRuleTest.php
diff --git a/tests/Rules/UseSafeClassesRuleTest.php b/tests/Rules/UseSafeClassesRuleTest.php
@@ -2,17 +2,20 @@
 
 namespace TheCodingMachine\Safe\PHPStan\Rules;
 
+use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
-use TheCodingMachine\Safe\PHPStan\Type\Php\ReplaceSafeFunctionsDynamicReturnTypeExtension;
 
+/**
+ * @template-extends RuleTestCase<UseSafeClassesRule>
+ */
 class UseSafeClassesRuleTest extends RuleTestCase
 {
-    protected function getRule(): \PHPStan\Rules\Rule
+    protected function getRule(): Rule
     {
         return new UseSafeClassesRule();
     }
 
-    public function testDateTime()
+    public function testDateTime(): void
     {
         $this->analyse([__DIR__ . '/data/datetime.php'], [
             [

diff --git a/tests/Rules/UseSafeFunctionsRuleTest.php b/tests/Rules/UseSafeFunctionsRuleTest.php
@@ -2,17 +2,20 @@
 
 namespace TheCodingMachine\Safe\PHPStan\Rules;
 
+use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
-use TheCodingMachine\Safe\PHPStan\Type\Php\ReplaceSafeFunctionsDynamicReturnTypeExtension;
 
+/**
+ * @template-extends RuleTestCase<UseSafeFunctionsRule>
+ */
 class UseSafeFunctionsRuleTest extends RuleTestCase
 {
-    protected function getRule(): \PHPStan\Rules\Rule
+    protected function getRule(): Rule
     {
         return new UseSafeFunctionsRule();
     }
 
-    public function testCatch()
+    public function testCatch(): void
     {
         $this->analyse([__DIR__ . '/data/fopen.php'], [
             [
@@ -22,31 +25,23 @@ public function testCatch()
         ]);
     }
 
-    public function testNoCatchSafe()
+    public function testNoCatchSafe(): void
     {
         $this->analyse([__DIR__ . '/data/safe_fopen.php'], []);
     }
 
-    public function testExprCall()
+    public function testExprCall(): void
     {
         $this->analyse([__DIR__ . '/data/undirect_call.php'], []);
     }
 
-    public function testJSONDecodeNoCatchSafe()
+    public function testJSONDecodeNoCatchSafe(): void
     {
-        if (version_compare(PHP_VERSION, '7.3.0', '>=')) {
-            $this->analyse([__DIR__ . '/data/safe_json_decode_for_7.3.0.php'], []);
-        } else {
-            $this->assertTrue(true);
-        }
+        $this->analyse([__DIR__ . '/data/safe_json_decode_for_7.3.0.php'], []);
     }
 
-    public function testJSONEncodeNoCatchSafe()
+    public function testJSONEncodeNoCatchSafe(): void
     {
-        if (version_compare(PHP_VERSION, '7.3.0', '>=')) {
-            $this->analyse([__DIR__ . '/data/safe_json_encode_for_7.3.0.php'], []);
-        } else {
-            $this->assertTrue(true);
-        }
+        $this->analyse([__DIR__ . '/data/safe_json_encode_for_7.3.0.php'], []);
     }
 }
diff --git a/tests/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtensionTest.php b/tests/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtensionTest.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace TheCodingMachine\Safe\PHPStan\Type\Php;
+
+use PHPUnit\Framework\TestCase;
+
+class ReplaceSafeFunctionsDynamicReturnTypeExtensionTest extends TestCase
+{
+    public function testWithStrings(): void
+    {
+        $x = \Safe\preg_replace('/foo/', 'bar', 'baz');
+
+        $this->assertStringNotContainsString('foo', $x);
+    }
+
+    public function testWithArrays(): void
+    {
+        $x = \Safe\preg_replace(['/foo/'], ['bar'], ['baz']);
+
+        $this->assertNotContains('foo', $x);
+    }
+}
diff --git a/tests/Utils/FunctionListLoaderTest.php b/tests/Utils/FunctionListLoaderTest.php
@@ -6,10 +6,10 @@
 
 class FunctionListLoaderTest extends TestCase
 {
-
-    public function testGetFunctionList()
+    public function testGetFunctionList(): void
     {
         $functions = FunctionListLoader::getFunctionList();
         $this->assertArrayHasKey('fopen', $functions);
+        $this->assertEquals('fopen', $functions['fopen']);
     }
 }
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
diff --git a/tests/phpstan-bootstrap.php b/tests/phpstan-bootstrap.php