Merge pull request #387 from KnpLabs/add-phpstan-level4-ci-check

Add phpstan level 4 CI check
KnpLabs · Jan 31, 2020 · 2766ff9 · 2766ff9
2 parents d7ad8d5 + 551ed01
commit 2766ff9
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 43 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,6 +1,6 @@
 * text=auto
 
-/test export-ignore
+/tests export-ignore
 /.editorconfig export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore

diff --git a/.travis.yml b/.travis.yml
@@ -31,3 +31,4 @@ install: composer update --prefer-dist
 
 script:
     - vendor/bin/phpunit
+    - composer phpstan
diff --git a/composer.json b/composer.json
@@ -1,13 +1,13 @@
 {
     "name": "knplabs/knp-snappy",
     "type": "library",
-    "description": "PHP5 library allowing thumbnail, snapshot or PDF generation from a url or a html page. Wrapper for wkhtmltopdf/wkhtmltoimage.",
+    "description": "PHP library allowing thumbnail, snapshot or PDF generation from a url or a html page. Wrapper for wkhtmltopdf/wkhtmltoimage.",
     "keywords": ["pdf", "thumbnail", "snapshot", "knplabs", "knp", "wkhtmltopdf"],
     "homepage": "http://github.com/KnpLabs/snappy",
     "license": "MIT",
     "authors": [
         {
-            "name": "KnpLabs Team",
+            "name": "KNP Labs Team",
             "homepage": "http://knplabs.com"
         },
         {
@@ -21,7 +21,9 @@
         "psr/log": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~7.4"
+        "phpunit/phpunit": "~7.4",
+        "phpstan/phpstan": "^0.12.7",
+        "phpstan/phpstan-phpunit": "^0.12.6"
     },
     "suggest": {
         "h4cc/wkhtmltopdf-amd64": "Provides wkhtmltopdf-amd64 binary for Linux-compatible machines, use version `~0.12` as dependency",
@@ -35,6 +37,14 @@
             "Knp\\Snappy\\": "src/Knp/Snappy"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "phpstan": "vendor/bin/phpstan analyse --ansi"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "1.x-dev"

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,12 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+
+parameters:
+    level: 4
+    paths:
+        - src/
+        - tests/
+    inferPrivatePropertyTypeFromConstructor: true
+    reportUnmatchedIgnoredErrors: false
+    ignoreErrors:
+        - "#^Call to an undefined static method #"
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -12,7 +12,7 @@
 >
     <testsuites>
         <testsuite name="Snappy Test Suite">
-            <directory>./test</directory>
+            <directory>./tests</directory>
         </testsuite>
     </testsuites>
 </phpunit>
diff --git a/src/Knp/Snappy/AbstractGenerator.php b/src/Knp/Snappy/AbstractGenerator.php
@@ -52,7 +52,9 @@ public function __construct($binary, array $options = [], array $env = null)
         $this->setOptions($options);
         $this->env = empty($env) ? null : $env;
 
-        register_shutdown_function([$this, 'removeTemporaryFiles']);
+        if (is_callable([$this, 'removeTemporaryFiles'])) {
+            register_shutdown_function([$this, 'removeTemporaryFiles']);
+        }
     }
 
     public function __destruct()
@@ -91,7 +93,7 @@ public function setDefaultExtension($defaultExtension)
     /**
      * Gets the default extension.
      *
-     * @return $string
+     * @return string
      */
     public function getDefaultExtension()
     {
@@ -430,7 +432,7 @@ protected function createTemporaryFile($content = null, $extension = null)
     /**
      * Removes all temporary files.
      */
-    public function removeTemporaryFiles()
+    public function removeTemporaryFiles(): void
     {
         foreach ($this->temporaryFiles as $file) {
             $this->unlink($file);
@@ -441,7 +443,7 @@ public function removeTemporaryFiles()
      * Builds the command string.
      *
      * @param string       $binary  The binary path/name
-     * @param string/array $input   Url(s) or file location(s) of the page(s) to process
+     * @param string|array $input   Url(s) or file location(s) of the page(s) to process
      * @param string       $output  File location to the image-to-be
      * @param array        $options An array of options
      *

diff --git a/src/Knp/Snappy/Pdf.php b/src/Knp/Snappy/Pdf.php
@@ -66,7 +66,7 @@ public function generate($input, $output, array $options = [], $overwrite = fals
     /**
      * Convert option content or url to file if it is needed.
      *
-     * @param $option
+     * @param mixed $option
      *
      * @return bool
      */

diff --git a/test/Knp/Snappy/ImageTest.php b/test/Knp/Snappy/ImageTest.php
diff --git a/test/Knp/Snappy/AbstractGeneratorTest.php → tests/Knp/Snappy/AbstractGeneratorTest.php b/test/Knp/Snappy/AbstractGeneratorTest.php → tests/Knp/Snappy/AbstractGeneratorTest.php
@@ -1,15 +1,16 @@
 <?php
 
-namespace Knp\Snappy;
+namespace Tests\Knp\Snappy;
 
+use Knp\Snappy\AbstractGenerator;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 
 class AbstractGeneratorTest extends TestCase
 {
     public function testAddOption()
     {
-        $media = $this->getMockForAbstractClass('Knp\Snappy\AbstractGenerator', [], '', false);
+        $media = $this->getMockForAbstractClass(AbstractGenerator::class, [], '', false);
 
         $this->assertEquals([], $media->getOptions());
 
@@ -36,13 +37,13 @@ public function testAddOption()
             $r->invokeArgs($media, ['baz', 'bat']);
             $this->fail($message);
         } catch (\InvalidArgumentException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
     public function testAddOptions()
     {
-        $media = $this->getMockForAbstractClass('Knp\Snappy\AbstractGenerator', [], '', false);
+        $media = $this->getMockForAbstractClass(AbstractGenerator::class, [], '', false);
 
         $this->assertEquals([], $media->getOptions());
 
@@ -78,7 +79,7 @@ public function testAddOptions()
             $r->invokeArgs($media, [['bak' => 'bam', 'bah' => 'bap', 'baz' => 'bat']]);
             $this->fail($message);
         } catch (\InvalidArgumentException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -117,7 +118,7 @@ public function testSetOption()
             $media->setOption('bad', 'def');
             $this->fail($message);
         } catch (\InvalidArgumentException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -157,7 +158,7 @@ public function testSetOptions()
             $media->setOptions(['foo' => 'abc', 'baz' => 'def', 'bad' => 'ghi']);
             $this->fail($message);
         } catch (\InvalidArgumentException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -493,7 +494,7 @@ public function testGetOutputFromHtmlWithHtmlArray()
 
     public function testMergeOptions()
     {
-        $media = $this->getMockForAbstractClass('Knp\Snappy\AbstractGenerator', [], '', false);
+        $media = $this->getMockForAbstractClass(AbstractGenerator::class, [], '', false);
 
         $originalOptions = ['foo' => 'bar', 'baz' => 'bat'];
 
@@ -538,7 +539,7 @@ public function testMergeOptions()
             $r->invokeArgs($media, [['foo' => 'ban', 'bad' => 'bah']]);
             $this->fail($message);
         } catch (\InvalidArgumentException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -547,7 +548,7 @@ public function testMergeOptions()
      */
     public function testBuildCommand($binary, $url, $path, $options, $expected)
     {
-        $media = $this->getMockForAbstractClass('Knp\Snappy\AbstractGenerator', [], '', false);
+        $media = $this->getMockForAbstractClass(AbstractGenerator::class, [], '', false);
 
         $r = new \ReflectionMethod($media, 'buildCommand');
         $r->setAccessible(true);
@@ -679,7 +680,7 @@ public function testCheckOutput()
 
         try {
             $r->invokeArgs($media, ['the_output_file', 'the command']);
-            $this->anything($message);
+            $this->anything();
         } catch (\RuntimeException $e) {
             $this->fail($message);
         }
@@ -712,7 +713,7 @@ public function testCheckOutputWhenTheFileDoesNotExist()
             $r->invokeArgs($media, ['the_output_file', 'the command']);
             $this->fail($message);
         } catch (\RuntimeException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -750,7 +751,7 @@ public function testCheckOutputWhenTheFileIsEmpty()
             $r->invokeArgs($media, ['the_output_file', 'the command']);
             $this->fail($message);
         } catch (\RuntimeException $e) {
-            $this->anything($message);
+            $this->anything();
         }
     }
 
@@ -767,14 +768,14 @@ public function testCheckProcessStatus()
 
         try {
             $r->invokeArgs($media, [0, '', '', 'the command']);
-            $this->anything('0 status means success');
+            $this->anything();
         } catch (\RuntimeException $e) {
             $this->fail('0 status means success');
         }
 
         try {
             $r->invokeArgs($media, [1, '', '', 'the command']);
-            $this->anything('1 status means failure, but no stderr content');
+            $this->anything();
         } catch (\RuntimeException $e) {
             $this->fail('1 status means failure, but no stderr content');
         }
@@ -792,7 +793,7 @@ public function testCheckProcessStatus()
      */
     public function testIsAssociativeArray($array, $isAssociativeArray)
     {
-        $generator = $this->getMockForAbstractClass('Knp\Snappy\AbstractGenerator', [], '', false);
+        $generator = $this->getMockForAbstractClass(AbstractGenerator::class, [], '', false);
 
         $r = new \ReflectionMethod($generator, 'isAssociativeArray');
         $r->setAccessible(true);

diff --git a/tests/Knp/Snappy/ImageTest.php b/tests/Knp/Snappy/ImageTest.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Tests\Knp\Snappy;
+
+use Knp\Snappy\Image;
+use PHPUnit\Framework\TestCase;
+
+class ImageTest extends TestCase
+{
+    public function testCreateInstance()
+    {
+        $testObject = new Image();
+        $this->assertInstanceOf(Image::class, $testObject);
+    }
+}
diff --git a/test/Knp/Snappy/PdfTest.php → tests/Knp/Snappy/PdfTest.php b/test/Knp/Snappy/PdfTest.php → tests/Knp/Snappy/PdfTest.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Knp\Snappy;
+namespace Tests\Knp\Snappy;
 
+use Knp\Snappy\Pdf;
 use PHPUnit\Framework\Error\Error;
 use PHPUnit\Framework\TestCase;
 
@@ -40,8 +41,8 @@ function ($filename) {
 
     public function testCreateInstance()
     {
-        $testObject = new \Knp\Snappy\Pdf();
-        $this->assertInstanceOf('\Knp\Snappy\Pdf', $testObject);
+        $testObject = new Pdf();
+        $this->assertInstanceOf(Pdf::class, $testObject);
     }
 
     public function testThatSomethingUsingTmpFolder()