Add phpstan

Author: steevanb

.circleci/config.yml

@@ -27,10 +27,10 @@ jobs:
         steps:
             - checkout
             - restore_cache:
-                  key: vendor-{{ checksum "composer.json" }}-{{ checksum "composer.lock" }}
+                key: vendor-{{ checksum "composer.json" }}-{{ checksum "composer.lock" }}
             - run:
-                  name: composer-require-checker
-                  command: bin/composerRequireChecker
+                name: composer-require-checker
+                command: bin/composerRequireChecker
 
     phpcs:
         docker:
@@ -39,8 +39,8 @@ jobs:
         steps:
             - checkout
             - run:
-                  name: phpcs
-                  command: bin/phpcs
+                name: phpcs
+                command: bin/phpcs
 
     phpcf:
         docker:
@@ -49,8 +49,20 @@ jobs:
         steps:
             - checkout
             - run:
-                  name: phpcf
-                  command: bin/phpcf
+                name: phpcf
+                command: bin/phpcf
+
+    phpstan:
+        docker:
+            - image: php:7.4-cli-alpine3.10
+        working_directory: /app
+        steps:
+            - checkout
+            - restore_cache:
+                key: vendor-{{ checksum "composer.json" }}-{{ checksum "composer.lock" }}
+            - run:
+                name: phpstan
+                command: bin/phpstan
 
 workflows:
     version: '2.1'
@@ -60,5 +72,8 @@ workflows:
             - phpcf
             - composer
             - composerRequireChecker:
-                  requires:
-                      - composer
+                requires:
+                    - composer
+            - phpstan:
+                requires:
+                    - composer

bin/phpstan

@@ -0,0 +1,18 @@
+#!/usr/bin/env sh
+
+set -eu
+
+readonly ROOT_DIRECTORY=$(realpath $(dirname $(realpath $0))/..)
+
+if [ $(which docker || false) ]; then
+    docker run \
+        --rm \
+        -it \
+        -v ${ROOT_DIRECTORY}:/app \
+        -w /app \
+        php:7.4-cli-alpine3.10 \
+        bin/phpstan
+else
+    php bin/console --all-commands cache:warmup
+    php -d memory_limit=512M /app/vendor/bin/phpstan analyse --ansi
+fi

composer.json

@@ -32,7 +32,8 @@
         "twig/twig": "3.0.*"
     },
     "require-dev": {
-        "phpstan/phpstan": "0.11.*",
+        "phpstan/phpstan": "0.12.*",
+        "phpstan/phpstan-symfony": "0.12.*",
         "steevanb/php-backtrace": "2.0.*",
         "symfony/var-dumper": "4.4.*"
     },

composer.lock

@@ -0,0 +1,11 @@
+parameters:
+    level: 5
+    paths:
+        - src/
+    inferPrivatePropertyTypeFromConstructor: true
+    symfony:
+        container_xml_path: /app/var/cache/dev/srcApp_KernelDevDebugContainer.xml
+    excludes_analyse:
+        - src/Version.php
+includes:
+    - /app/vendor/phpstan/phpstan-symfony/extension.neon

phpstan.neon

@@ -182,6 +182,7 @@ protected function writeFileFromTemplate(
             );
     }
 
+    /** @return $this */
     protected function filePutContent(string $filename, string $content, bool $rmPathPrefix = true): self
     {
         $fileExists = file_exists($filename);
@@ -197,6 +198,7 @@ protected function filePutContent(string $filename, string $content, bool $rmPat
         return $this;
     }
 
+    /** @return $this */
     protected function createDirectory(string $directory): self
     {
         if (is_dir($directory) === false) {
@@ -207,6 +209,7 @@ protected function createDirectory(string $directory): self
         return $this;
     }
 
+    /** @return $this */
     protected function removeDirectory(string $directory): self
     {
         if (is_dir($directory)) {
@@ -217,6 +220,7 @@ protected function removeDirectory(string $directory): self
         return $this;
     }
 
+    /** @return $this */
     protected function removeFile(string $file, bool $rmPrefix = true): self
     {
         if (is_file($file)) {

src/Command/AbstractCommand.php

@@ -6,7 +6,6 @@
 
 trait GetBodyFromUrl
 {
-    /** @return $this */
     protected function getBodyFromUrl(string $url, bool $assertIs200 = true): ?string
     {
         $curl = curl_init();

src/Command/Behavior/GetBodyFromUrl.php

@@ -120,7 +120,7 @@ protected function defineVhostVariables(
             throw new \Exception('Error while reading ' . $vhostFilePath . '.');
         }
 
-        $content = str_replace('____PORT____', BenchmarkUrlService::getNginxPort(), $content);
+        $content = str_replace('____PORT____', (string) BenchmarkUrlService::getNginxPort(), $content);
         $content = str_replace('____HOST____', $host, $content);
 
         $sourceCodePath = realpath($sourceCodePath);

src/Command/Nginx/Vhost/AbstractNginxVhostCreateCommand.php

@@ -48,6 +48,7 @@ protected function doExecute(): int
         return 0;
     }
 
+    /** @return $this */
     protected function validatePhpVersion(PhpVersion $phpVersion): self
     {
         foreach (BenchmarkConfigurationService::getAvailable($phpVersion) as $benchmarkConfiguration) {
@@ -70,6 +71,7 @@ protected function validatePhpVersion(PhpVersion $phpVersion): self
         return $this;
     }
 
+    /** @return $this */
     protected function afterHttpCodeValidated(
         PhpVersion $phpVersion,
         BenchmarkConfiguration $benchmarkConfiguration,
@@ -78,6 +80,7 @@ protected function afterHttpCodeValidated(
         return $this;
     }
 
+    /** @return $this */
     protected function initBenchmark(PhpVersion $phpVersion, BenchmarkConfiguration $benchmarkConfiguration): self
     {
         return $this->runCommand(

src/Command/Validate/Benchmark/AbstractValidateBenchmarkUrlCommand.php

@@ -35,7 +35,7 @@ protected function afterHttpCodeValidated(
         BenchmarkConfiguration $benchmarkConfiguration,
         ?string $body
     ): self {
-        if (is_string($body) === false || strlen($body) === false) {
+        if (is_string($body) === false || strlen($body) === 0) {
             throw new \Exception('phpinfo() should not output an empty string.');
         }