phpstan level max

phpstan.neon.dist

@@ -1,3 +1,3 @@
 parameters:
-    level: 5
+    level: max
     paths: [src]

src/AstRunner/AstParser/NikicPhpParser/AstClassReferenceResolver.php

@@ -19,11 +19,11 @@ class AstClassReferenceResolver extends NodeVisitorAbstract
     /** @var AstClassReference */
     private $currentClassReference;
 
-    /** @var ClassDependencyResolver[] */
+    /** @var iterable|ClassDependencyResolver[] */
     private $classDependencyResolvers;
 
     /**
-     * @param ClassDependencyResolver[] $classDependencyResolvers
+     * @param iterable|ClassDependencyResolver[] $classDependencyResolvers
      */
     public function __construct(AstFileReference $fileReference, iterable $classDependencyResolvers)
     {

src/AstRunner/AstParser/NikicPhpParser/NikicPhpParser.php

@@ -32,10 +32,13 @@ class NikicPhpParser implements AstParser
     private $cache;
 
     /**
-     * @var ClassDependencyResolver[]
+     * @var iterable|ClassDependencyResolver[]
      */
     private $classDependencyResolvers;
 
+    /**
+     * @param iterable|ClassDependencyResolver[] $classDependencyResolvers
+     */
     public function __construct(
         FileParser $fileParser,
         AstFileReferenceCache $cache,

src/ClassNameLayerResolver.php

@@ -31,6 +31,7 @@ public function __construct(
      */
     public function getLayersByClassName(string $className): array
     {
+        /** @var array<string, bool> $layers */
         $layers = [];
 
         if (!$astClassReference = $this->astMap->getClassReferenceByClassName($className)) {
@@ -52,7 +53,10 @@ public function getLayersByClassName(string $className): array
             }
         }
 
-        return array_keys($layers);
+        /** @var string[] $layerNames */
+        $layerNames = array_keys($layers);
+
+        return $layerNames;
     }
 
     public function getLayers(): array

src/Configuration/Exception/FileCannotBeReadException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SensioLabs\Deptrac\Configuration\Exception;
+
+final class FileCannotBeReadException extends \RuntimeException
+{
+    public static function fromFilename(string $filename): self
+    {
+        return new self(sprintf(
+            'File "%s" cannot be read.',
+            $filename
+        ));
+    }
+}

src/Configuration/Exception/FileDoesNotExistsException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SensioLabs\Deptrac\Configuration\Exception;
+
+final class FileDoesNotExistsException extends \RuntimeException
+{
+    public static function fromFilename(string $filename): self
+    {
+        return new self(sprintf(
+            'File "%s" does not exist. Run "deptrac init" to create one.',
+            $filename
+        ));
+    }
+}

src/Configuration/Exception/FileExistsException.php

@@ -4,6 +4,6 @@
 
 namespace SensioLabs\Deptrac\Configuration\Exception;
 
-final class FileExistsException extends \Exception
+final class FileExistsException extends \RuntimeException
 {
 }

src/Configuration/Loader.php

@@ -5,26 +5,31 @@
 namespace SensioLabs\Deptrac\Configuration;
 
 use SensioLabs\Deptrac\Configuration\Exception\FileCannotBeParsedAsYamlException;
-use SensioLabs\Deptrac\Configuration\Exception\MissingFileException;
+use SensioLabs\Deptrac\Configuration\Exception\FileDoesNotExistsException;
+use SensioLabs\Deptrac\Configuration\Exception\FileCannotBeReadException;
 use SensioLabs\Deptrac\Configuration\Exception\ParsedYamlIsNotAnArrayException;
 use Symfony\Component\Yaml\Exception\ParseException;
 use Symfony\Component\Yaml\Yaml;
 
 class Loader
 {
     /**
-     * @throws MissingFileException
+     * @throws FileDoesNotExistsException
      * @throws FileCannotBeParsedAsYamlException
      * @throws ParsedYamlIsNotAnArrayException
      */
     public function load(string $file): Configuration
     {
-        if (!file_exists($file)) {
-            throw new MissingFileException();
+        if (!is_file($file)) {
+            throw FileDoesNotExistsException::fromFilename($file);
+        }
+
+        if (false === ($content = file_get_contents($file))) {
+            throw FileCannotBeReadException::fromFilename($file);
         }
 
         try {
-            $data = Yaml::parse(file_get_contents($file));
+            $data = Yaml::parse($content);
         } catch (ParseException $exception) {
             throw FileCannotBeParsedAsYamlException::fromFilename($file);
         }

src/Console/Command/AnalyzeCommand.php

@@ -5,8 +5,8 @@
 namespace SensioLabs\Deptrac\Console\Command;
 
 use SensioLabs\Deptrac\Analyser;
-use SensioLabs\Deptrac\Configuration\Exception\MissingFileException;
 use SensioLabs\Deptrac\Configuration\Loader as ConfigurationLoader;
+use SensioLabs\Deptrac\Console\Command\Exception\SingleDepfileIsRequiredException;
 use SensioLabs\Deptrac\OutputFormatterFactory;
 use SensioLabs\Deptrac\Subscriber\ConsoleSubscriber;
 use SensioLabs\Deptrac\Subscriber\ProgressSubscriber;
@@ -57,14 +57,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->printBanner($output);
         }
 
-        try {
-            $configuration = $this->configurationLoader->load($input->getArgument('depfile'));
-        } catch (MissingFileException $e) {
-            $this->printConfigMissingError($output, $input->getArgument('depfile'));
-
-            return 1;
+        $file = $input->getArgument('depfile');
+        if (!is_string($file)) {
+            throw SingleDepfileIsRequiredException::fromArgument($file);
         }
 
+        $configuration = $this->configurationLoader->load($file);
+
         $this->dispatcher->addSubscriber(new ConsoleSubscriber($output));
 
         if (!$input->getOption('no-progress')) {
@@ -96,11 +95,6 @@ protected function printBanner(OutputInterface $output): void
         $output->writeln("\n<comment>deptrac is alpha, not production ready.\nplease help us and report feedback / bugs.</comment>\n");
     }
 
-    protected function printConfigMissingError(OutputInterface $output, string $file): void
-    {
-        $output->writeln(sprintf('depfile "%s" not found, run "deptrac init" to create one.', $file));
-    }
-
     protected function printCollectViolations(OutputInterface $output): void
     {
         if ($output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {

src/Console/Command/Exception/SingleDepfileIsRequiredException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SensioLabs\Deptrac\Console\Command\Exception;
+
+final class SingleDepfileIsRequiredException extends \RuntimeException
+{
+    public static function fromArgument($argument): self
+    {
+        return new self(sprintf(
+            'Please specify a path to a depfile. Got "%s".',
+            gettype($argument)
+        ));
+    }
+}

tests/Configuration/Exception/FileCannotBeReadExceptionTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\SensioLabs\Deptrac\Configuration\Exception;
+
+use PHPUnit\Framework\TestCase;
+use SensioLabs\Deptrac\Configuration\Exception\FileCannotBeReadException;
+
+/**
+ * @covers \SensioLabs\Deptrac\Configuration\Exception\FileCannotBeReadException
+ */
+final class FileCannotBeReadExceptionTest extends TestCase
+{
+    public function testIsRuntimeException(): void
+    {
+        $exception = new FileCannotBeReadException();
+
+        self::assertInstanceOf(\RuntimeException::class, $exception);
+    }
+
+    public function testFromFilenameReturnsException(): void
+    {
+        $filename = __FILE__;
+
+        $exception = FileCannotBeReadException::fromFilename($filename);
+
+        $message = sprintf(
+            'File "%s" cannot be read.',
+            $filename
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}

tests/Configuration/Exception/FileDoesNotExistsExceptionTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\SensioLabs\Deptrac\Configuration\Exception;
+
+use PHPUnit\Framework\TestCase;
+use SensioLabs\Deptrac\Configuration\Exception\FileDoesNotExistsException;
+
+/**
+ * @covers \SensioLabs\Deptrac\Configuration\Exception\FileDoesNotExistsException
+ */
+final class FileDoesNotExistsExceptionTest extends TestCase
+{
+    public function testIsRuntimeException(): void
+    {
+        $exception = new FileDoesNotExistsException();
+
+        self::assertInstanceOf(\RuntimeException::class, $exception);
+    }
+
+    public function testFromFilenameReturnsException(): void
+    {
+        $filename = __FILE__;
+
+        $exception = FileDoesNotExistsException::fromFilename($filename);
+
+        $message = sprintf(
+            'File "%s" does not exist. Run "deptrac init" to create one.',
+            $filename
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}

tests/Configuration/LoaderTest.php

@@ -6,7 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use SensioLabs\Deptrac\Configuration\Exception\FileCannotBeParsedAsYamlException;
-use SensioLabs\Deptrac\Configuration\Exception\MissingFileException;
+use SensioLabs\Deptrac\Configuration\Exception\FileDoesNotExistsException;
 use SensioLabs\Deptrac\Configuration\Exception\ParsedYamlIsNotAnArrayException;
 use SensioLabs\Deptrac\Configuration\Loader;
 
@@ -15,13 +15,13 @@
  */
 final class LoaderTest extends TestCase
 {
-    public function testLoadThrowsMissingFileExceptionWhenFileDoesNotExist(): void
+    public function testLoadThrowsFileDoesNotExistsExceptionWhenFileDoesNotExist(): void
     {
         $file = __DIR__.'/../../examples/non-existent-file.yml';
 
         $loader = new Loader();
 
-        self::expectException(MissingFileException::class);
+        $this->expectException(FileDoesNotExistsException::class);
 
         $loader->load($file);
     }
@@ -32,7 +32,7 @@ public function testLoadThrowsFileCannotBeParsedAsYamlExceptionWhenFileDoesNotCo
 
         $loader = new Loader();
 
-        self::expectException(FileCannotBeParsedAsYamlException::class);
+        $this->expectException(FileCannotBeParsedAsYamlException::class);
 
         $loader->load($file);
     }
@@ -43,7 +43,7 @@ public function testLoadThrowsParsedYamlIsNotAnArrayExceptionWhenFileDoesNotCont
 
         $loader = new Loader();
 
-        self::expectException(ParsedYamlIsNotAnArrayException::class);
+        $this->expectException(ParsedYamlIsNotAnArrayException::class);
 
         $loader->load($file);
     }

tests/Console/Command/Exception/SingleDepfileIsRequiredExceptionTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\SensioLabs\Deptrac\Console\Command\Exception;
+
+use PHPUnit\Framework\TestCase;
+use SensioLabs\Deptrac\Console\Command\Exception\SingleDepfileIsRequiredException;
+
+/**
+ * @covers \SensioLabs\Deptrac\Console\Command\Exception\SingleDepfileIsRequiredException
+ */
+final class SingleDepfileIsRequiredExceptionTest extends TestCase
+{
+    public function testIsRuntimeException(): void
+    {
+        $exception = new SingleDepfileIsRequiredException();
+
+        self::assertInstanceOf(\RuntimeException::class, $exception);
+    }
+
+    public function testFromFilenameReturnsException(): void
+    {
+        $argument = [];
+
+        $exception = SingleDepfileIsRequiredException::fromArgument($argument);
+
+        $message = sprintf(
+            'Please specify a path to a depfile. Got "%s".',
+            gettype($argument)
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}