Add PHPStan (#274)

Add PHPStan level 6 checks in the CI and fixed the issues reported

Author: theofidry

.travis.yml

@@ -27,10 +27,11 @@ install:
 script:
   - |
     if [ "$COVERAGE" == "true" ]; then
-        make tc
-        travis_wait 30 make e2e
+      make tc
+      travis_wait 30 make e2e
     else
-        make tu
+      make tu
+      make phpstan
     fi
 
 deploy:

Makefile

@@ -25,6 +25,12 @@ cs: $(CODE_SNIFFER) $(CODE_SNIFFER_FIX)
 	$(PHPNOGC) $(CODE_SNIFFER_FIX) || true
 	$(PHPNOGC) $(CODE_SNIFFER)
 
+.PHONY: phpstan
+PHPSTAN=vendor-bin/phpstan/vendor/bin/phpstan
+phpstan:	## Runs PHPStan
+phpstan: $(PHPSTAN)
+	$(PHPNOGC) $(PHPSTAN) analyze src -l6
+
 .PHONY: build
 build:	## Build the PHAR
 BOX=bin/box
@@ -326,6 +332,10 @@ vendor-bin/code-sniffer/vendor: vendor-bin/code-sniffer/composer.lock vendor/bam
 	composer bin code-sniffer install
 	touch $@
 
+vendor-bin/phpstan/vendor: vendor-bin/phpstan/composer.lock vendor/bamarni
+	composer bin phpstan install
+	touch $@
+
 fixtures/set005/vendor: fixtures/set005/composer.lock
 	composer --working-dir=fixtures/set005 install
 	touch $@
@@ -392,6 +402,12 @@ composer.lock: composer.json
 vendor-bin/covers-validator/composer.lock: vendor-bin/covers-validator/composer.json
 	@echo covers-validator composer.lock is not up to date
 
+vendor-bin/code-sniffer/composer.lock: vendor-bin/code-sniffer/composer.json
+	@echo code-sniffer composer.lock is not up to date
+
+vendor-bin/phpstan/composer.lock: vendor-bin/phpstan/composer.json
+	@echo phpstan composer.lock is not up to date
+
 fixtures/set005/composer.lock: fixtures/set005/composer.json
 	@echo fixtures/set005/composer.lock is not up to date.
 
@@ -449,3 +465,7 @@ $(CODE_SNIFFER): vendor-bin/code-sniffer/vendor
 $(CODE_SNIFFER_FIX): vendor-bin/code-sniffer/vendor
 	composer bin code-sniffer install
 	touch $@
+
+$(PHPSTAN): vendor-bin/phpstan/vendor
+	composer bin phpstan install
+	touch $@

composer.json

@@ -40,15 +40,17 @@
     "bin": ["bin/php-scoper"],
     "autoload": {
         "files": [
-            "src/functions.php"
+            "src/functions.php",
+            "src/json.php"
         ],
         "psr-4": {
             "Humbug\\PhpScoper\\": "src/"
         }
     },
     "autoload-dev": {
         "files": [
-            "tests/functions.php"
+            "tests/functions.php",
+            "src/json.php"
         ],
         "psr-4": {
             "Humbug\\PhpScoper\\": "tests/"

phpstan.neon

@@ -0,0 +1,3 @@
+parameters:
+    excludes_analyse:
+        - src/Console/Command/AddPrefixCommand.php

src/Configuration.php

@@ -14,14 +14,14 @@
 
 namespace Humbug\PhpScoper;
 
-use Closure;
 use InvalidArgumentException;
 use Iterator;
 use RuntimeException;
 use SplFileInfo;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 use const DIRECTORY_SEPARATOR;
+use function array_key_exists;
 use function dirname;
 use function file_exists;
 use function gettype;
@@ -138,16 +138,15 @@ public static function load(string $path = null, array $paths = []): self
     }
 
     /**
-     * @param string|null        $path                        Absolute path to the configuration file loaded.
-     * @param string|null        $prefix                      The prefix applied.
-     * @param [string, string][] $filesWithContents           Array of tuple with the first argument being the file path and the second its contents
-     * @param callable[]         $patchers                    List of closures which can alter the content of the files being
-     *                                                        scoped.
-     * @param Whitelist          $whitelist                   List of classes that will not be scoped.
-     * @param Closure            $globalNamespaceWhitelisters Closure taking a class name from the global namespace as an argument and
-     *                                                        returning a boolean which if `true` means the class should be scoped
-     *                                                        (i.e. is ignored) or scoped otherwise.
-     * @param string[]           $whitelistedFiles            List of absolute paths of files to completely ignore
+     * @param string|null $path              Absolute path to the configuration file loaded.
+     * @param string|null $prefix            The prefix applied.
+     * @param string[][]  $filesWithContents Array of tuple with the first argument being the file path and the second its contents
+     * @param callable[]  $patchers          List of closures which can alter the content of the files being
+     *                                       scoped.
+     * @param Whitelist   $whitelist         List of classes that will not be scoped.
+     *                                       returning a boolean which if `true` means the class should be scoped
+     *                                       (i.e. is ignored) or scoped otherwise.
+     * @param string[]    $whitelistedFiles  List of absolute paths of files to completely ignore
      */
     private function __construct(
         ?string $path,
@@ -238,7 +237,7 @@ public function getWhitelistedFiles(): array
     private static function validateConfigKeys(array $config): void
     {
         array_map(
-            ['self', 'validateConfigKey'],
+            self::class.'::validateConfigKey',
             array_keys($config)
         );
     }
@@ -263,7 +262,7 @@ private static function validateConfigKey(string $key): void
      */
     private static function retrievePrefix(array $config): ?string
     {
-        $prefix = array_key_exists(self::PREFIX_KEYWORD, $config) ? $config[self::PREFIX_KEYWORD] : null;
+        $prefix = $config[self::PREFIX_KEYWORD] ?? null;
 
         if (null === $prefix) {
             return null;
@@ -515,7 +514,7 @@ private static function retrieveFilesFromPaths(array $paths): iterable
     /**
      * @param Iterator $files
      *
-     * @return [string, string][] Array of tuple with the first argument being the file path and the second its contents
+     * @return string[][] Array of tuple with the first argument being the file path and the second its contents
      */
     private static function retrieveFilesWithContents(Iterator $files): array
     {

src/Console/Command/BaseCommand.php

@@ -40,6 +40,7 @@ protected function configure(): void
 
     final public function changeWorkingDirectory(InputInterface $input): void
     {
+        /** @var string|null $workingDir */
         $workingDir = $input->getOption(self::WORKING_DIR_OPT);
 
         if (null === $workingDir) {

src/Console/Command/InitCommand.php

@@ -104,6 +104,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function retrieveConfig(InputInterface $input, OutputStyle $io): ?string
     {
+        /** @var string|null $configFile */
         $configFile = $input->getOption(self::CONFIG_FILE_OPT);
 
         $configFile = (null === $configFile)

src/PhpParser/NodeTraverser.php

@@ -23,6 +23,9 @@
 use PhpParser\Node\Stmt\Use_;
 use PhpParser\Node\Stmt\UseUse;
 use PhpParser\NodeTraverser as PhpParserNodeTraverser;
+use function array_slice;
+use function array_values;
+use function count;
 
 /**
  * @private
@@ -84,6 +87,13 @@ public function traverse(array $nodes): array
      */
     private function wrapInNamespace(array $nodes): array
     {
+        if ([] === $nodes) {
+            return $nodes;
+        }
+
+        $nodes = array_values($nodes);
+
+        $firstRealStatementIndex = 0;
         $realStatements = [];
 
         foreach ($nodes as $i => $node) {

src/PhpParser/NodeVisitor/Collection/NamespaceStmtCollection.php

@@ -37,8 +37,8 @@ final class NamespaceStmtCollection implements IteratorAggregate, Countable
     private $nodes = [];
 
     /**
-     * @var Name|null[] Associative array with the potentially prefixed namespace names as keys and their original name
-     *                  as value.
+     * @var (Name|null)[] Associative array with the potentially prefixed namespace names as keys and their original name
+     *                    as value.
      */
     private $mapping = [];
 
@@ -80,11 +80,9 @@ public function findNamespaceByName(string $name): ?Name
 
     public function getCurrentNamespaceName(): ?Name
     {
-        if (0 === count($this->nodes)) {
-            return null;
-        }
+        $lastNode = end($this->nodes);
 
-        return end($this->nodes)->name;
+        return false === $lastNode ? null : $lastNode->name;
     }
 
     /**

src/PhpParser/NodeVisitor/Collection/UseStmtCollection.php

@@ -85,7 +85,7 @@ public function findStatementForNode(?Name $namespaceName, Name $node): ?Name
 
         foreach ($useStatements as $use_) {
             foreach ($use_->uses as $useStatement) {
-                if (false === ($useStatement instanceof UseUse)) {
+                if (!($useStatement instanceof UseUse)) {
                     continue;
                 }