Use phpstan for static analysis

Author: fabacino

build.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="Debug functions" default="all">
 
-    <target name="all" depends="tests"/>
+    <target name="all" depends="tests,analyse"/>
 
     <target name="tests">
 	<exec
@@ -13,4 +13,17 @@
 	</exec>
     </target>
 
+    <target name="analyse">
+	<exec
+	    executable="vendor/bin/phpstan"
+	    logoutput="true"
+	    passthru="true"
+	    checkreturn="true"
+	>
+	    <arg value="analyse"/>
+	    <arg value="-c"/>
+	    <arg path="phpstan.neon"/>
+	</exec>
+    </target>
+
 </project>

composer.json

@@ -15,6 +15,9 @@
     },
     "require-dev": {
         "phing/phing": "^2.16",
+        "phpstan/phpstan": "^0.12",
+        "phpstan/phpstan-deprecation-rules": "^0.12",
+        "phpstan/phpstan-strict-rules": "^0.12",
         "phpunit/phpunit": "^8.0"
     },
     "autoload": {

composer.lock

@@ -0,0 +1,9 @@
+parameters:
+    level: 0
+    paths:
+        - src
+        - tests
+
+includes:
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon

phpstan.neon

@@ -54,7 +54,7 @@ class Debug
      *
      * @return void
      */
-    private function __construct(int $defaultFlags, LoggerInterface $Logger)
+    final private function __construct(int $defaultFlags, LoggerInterface $Logger)
     {
         $this->defaultFlags = $defaultFlags;
         $this->Logger = $Logger;

src/Debug.php

@@ -20,22 +20,22 @@ public function testPrintNumber()
     {
         $var = TestHelper::randomInt();
 
-        $this->assertEquals($var, $this->captureOutput($var));
+        self::assertEquals($var, $this->captureOutput($var));
     }
 
     public function testPrintString()
     {
         $var = TestHelper::randomString();
 
-        $this->assertEquals($var, $this->captureOutput($var));
+        self::assertEquals($var, $this->captureOutput($var));
     }
 
     public function testPrintArray()
     {
         $var = TestHelper::randomArray();
         $expected = TestHelper::makeArrayOutput($var);
 
-        $this->assertEquals($expected, $this->captureOutput($var));
+        self::assertEquals($expected, $this->captureOutput($var));
     }
 
     public function testPrintArrayNonCli()
@@ -45,7 +45,7 @@ public function testPrintArrayNonCli()
         $var = TestHelper::randomArray();
         $expected = '<pre>' . TestHelper::makeArrayOutput($var) . '</pre>';
 
-        $this->assertEquals($expected, $this->captureOutput($var));
+        self::assertEquals($expected, $this->captureOutput($var));
     }
 
     /**

tests/DbgTest.php

@@ -22,22 +22,22 @@ public function testThrowNumber()
     {
         $var = TestHelper::randomInt();
 
-        $this->assertEquals($var, $this->captureException($var));
+        self::assertEquals($var, $this->captureException($var));
     }
 
     public function testThrowString()
     {
         $var = TestHelper::randomString();
 
-        $this->assertEquals($var, $this->captureException($var));
+        self::assertEquals($var, $this->captureException($var));
     }
 
     public function testThrowArray()
     {
         $var = TestHelper::randomArray();
         $expected = TestHelper::makeArrayOutput($var);
 
-        $this->assertEquals($expected, $this->captureException($var));
+        self::assertEquals($expected, $this->captureException($var));
     }
 
     /**

tests/DbgThrowTest.php

@@ -29,7 +29,7 @@ public function testLogNumberWithLogFile()
         $var = TestHelper::randomInt();
         dbglog($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($var),
             file_get_contents($logfile)
         );
@@ -45,7 +45,7 @@ public function testLogStringWithLogFile()
         $var = TestHelper::randomString();
         dbglog($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($var),
             file_get_contents($logfile)
         );
@@ -62,7 +62,7 @@ public function testLogArrayWithLogFile()
         dbglog($var);
 
         $expected = TestHelper::makeArrayOutput($var);
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($expected),
             file_get_contents($logfile)
         );
@@ -78,7 +78,7 @@ public function testLogWithNoLogFile()
         $var = TestHelper::randomInt();
         dbglog($var);
 
-        $this->assertEmpty(file_get_contents($logfile));
+        self::assertEmpty(file_get_contents($logfile));
     }
 
     public function testLogNumberWithLogger()
@@ -91,7 +91,7 @@ public function testLogNumberWithLogger()
         $var = TestHelper::randomInt();
         dbglog($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($var),
             file_get_contents($logfile)
         );
@@ -107,7 +107,7 @@ public function testLogStringWithLogger()
         $var = TestHelper::randomString();
         dbglog($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($var),
             file_get_contents($logfile)
         );
@@ -125,7 +125,7 @@ public function testLogArrayWithLogger()
 
         $expected = TestHelper::makeArrayOutput($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($expected),
             file_get_contents($logfile)
         );
@@ -142,7 +142,7 @@ public function testLogWithLoggerAndCustomDateFormat()
         $var = TestHelper::randomInt();
         dbglog($var);
 
-        $this->assertRegExp(
+        self::assertRegExp(
             TestHelper::makePattern($var, $dateFormat),
             file_get_contents($logfile)
         );
@@ -158,6 +158,6 @@ public function testLogWithNoLogger()
         $var = TestHelper::randomInt();
         dbglog($var);
 
-        $this->assertEmpty(file_get_contents($logfile));
+        self::assertEmpty(file_get_contents($logfile));
     }
 }