phpstan level 3

AydinHassan · AydinHassan · commit 90a42fcca1ca · 2020-10-20T22:50:21.000+01:00
diff --git a/composer.json b/composer.json
@@ -56,6 +56,6 @@
             "phpcs src --standard=PSR12 --encoding=UTF-8",
             "phpcs test --standard=PSR12 --encoding=UTF-8"
         ],
-        "static": "phpstan --ansi analyse --level 1 src"
+        "static": "phpstan --ansi analyse --level 3 src"
     }
 }
diff --git a/src/Application.php b/src/Application.php
@@ -27,7 +27,7 @@ final class Application
     private $checks = [];
 
     /**
-     * @var ExerciseInterface[]
+     * @var class-string[]
      */
     private $exercises = [];
 
@@ -92,7 +92,7 @@ public function addCheck($check)
      * Register an exercise with the application. Only exercises registered here will
      * be displayed in the exercise menu.
      *
-     * @param string $exercise The FQCN of the check
+     * @param class-string $exercise The FQCN of the check
      */
     public function addExercise($exercise)
     {
diff --git a/src/Check/DatabaseCheck.php b/src/Check/DatabaseCheck.php
@@ -37,7 +37,7 @@ class DatabaseCheck implements ListenableCheckInterface
     private $solutionDatabasePath;
 
     /**
-     * @var
+     * @var string
      */
     private $userDsn;
 
diff --git a/src/ComposerUtil/LockFileParser.php b/src/ComposerUtil/LockFileParser.php
@@ -10,7 +10,7 @@
 class LockFileParser
 {
     /**
-     * @var string
+     * @var array
      */
     private $contents;
 
@@ -25,6 +25,10 @@ public function __construct($lockFilePath)
         }
         
         $this->contents = json_decode(file_get_contents($lockFilePath), true);
+
+        if (!isset($this->contents['packages'])) {
+            throw new InvalidArgumentException(sprintf('Lock File: "%s" does not contain packages key', $lockFilePath));
+        }
     }
 
     /**
diff --git a/src/Event/ContainerListenerHelper.php b/src/Event/ContainerListenerHelper.php
@@ -18,7 +18,7 @@ class ContainerListenerHelper
     private $method;
 
     /**
-     * @param $service
+     * @param string $service
      * @param string $method
      */
     public function __construct($service, $method = '__invoke')
diff --git a/src/Event/EventInterface.php b/src/Event/EventInterface.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshop\Event;
 
+use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
+
 /**
  * An event representation.
  */
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -62,7 +62,7 @@ public static function missingImplements($object, $requiredInterface)
     }
 
     /**
-     * @param $value
+     * @param mixed $value
      * @return string
      */
     private static function stringify($value)
diff --git a/src/ExerciseDispatcher.php b/src/ExerciseDispatcher.php
@@ -193,7 +193,7 @@ public function run(ExerciseInterface $exercise, Input $input, OutputInterface $
     }
 
     /**
-     * @param CheckInterface[] $checks
+     * @param SimpleCheckInterface[] $checks
      * @param ExerciseInterface $exercise
      * @throws CheckNotApplicableException
      * @throws ExerciseNotConfiguredException
diff --git a/src/ExerciseRunner/CgiRunner.php b/src/ExerciseRunner/CgiRunner.php
@@ -124,6 +124,7 @@ public function getRequiredChecks()
     private function checkRequest(RequestInterface $request, $fileName)
     {
         try {
+            /** @var CgiExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(
                 new CgiExecuteEvent('cgi.verify.reference-execute.pre', $request)
             );
@@ -138,6 +139,7 @@ private function checkRequest(RequestInterface $request, $fileName)
         }
 
         try {
+            /** @var CgiExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(new CgiExecuteEvent('cgi.verify.student-execute.pre', $request));
             $userResponse = $this->executePhpFile($fileName, $event->getRequest(), 'student');
         } catch (CodeExecutionException $e) {
@@ -284,6 +286,7 @@ public function run(Input $input, OutputInterface $output)
         $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('cgi.run.start', $this->exercise, $input));
         $success = true;
         foreach ($this->exercise->getRequests() as $i => $request) {
+            /** @var CgiExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(
                 new CgiExecuteEvent('cgi.run.student-execute.pre', $request)
             );
diff --git a/src/ExerciseRunner/CliRunner.php b/src/ExerciseRunner/CliRunner.php
@@ -178,6 +178,7 @@ private function doVerify(array $args, Input $input)
         $args = new ArrayObject($args);
 
         try {
+            /** @var CliExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(new CliExecuteEvent('cli.verify.reference-execute.pre', $args));
             $solutionOutput = $this->executePhpFile(
                 $this->exercise->getSolution()->getEntryPoint(),
@@ -190,6 +191,7 @@ private function doVerify(array $args, Input $input)
         }
 
         try {
+            /** @var CliExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(new CliExecuteEvent('cli.verify.student-execute.pre', $args));
             $userOutput = $this->executePhpFile($input->getArgument('program'), $event->getArgs(), 'student');
         } catch (CodeExecutionException $e) {
diff --git a/src/Factory/EventDispatcherFactory.php b/src/Factory/EventDispatcherFactory.php
@@ -14,7 +14,6 @@
  */
 class EventDispatcherFactory
 {
-
     /**
      * @param ContainerInterface $container
      * @return EventDispatcher
@@ -98,7 +97,7 @@ private function attachListeners(
                     );
                 }
 
-                return $dispatcher->listen($eventName, function (...$args) use ($container, $listener) {
+                $dispatcher->listen($eventName, function (...$args) use ($container, $listener) {
                     $service = $container->get($listener->getService());
 
                     if (!method_exists($service, $listener->getMethod())) {
@@ -109,15 +108,16 @@ private function attachListeners(
 
                     $service->{$listener->getMethod()}(...$args);
                 });
+                return;
             }
 
             if (!is_callable($listener)) {
                 throw new InvalidArgumentException(
                     sprintf('Listener must be a callable or a container entry for a callable service.')
                 );
             }
-
-            return $dispatcher->listen($eventName, $listener);
+            $dispatcher->listen($eventName, $listener);
+            return;
         });
     }
 }
diff --git a/src/Input/Input.php b/src/Input/Input.php
@@ -21,8 +21,7 @@ class Input
     private $arguments = [];
 
     /**
-     * Input constructor.
-     * @param $appName
+     * @param string $appName
      * @param array $arguments
      */
     public function __construct($appName, array $arguments = [])
diff --git a/src/Listener/PrepareSolutionListener.php b/src/Listener/PrepareSolutionListener.php
@@ -3,6 +3,7 @@
 namespace PhpSchool\PhpWorkshop\Listener;
 
 use PhpSchool\PhpWorkshop\Event\ExerciseRunnerEvent;
+use PhpSchool\PhpWorkshop\Exercise\ProvidesSolution;
 use RuntimeException;
 use Symfony\Component\Process\Process;
 
@@ -28,7 +29,13 @@ class PrepareSolutionListener
      */
     public function __invoke(ExerciseRunnerEvent $event)
     {
-        $solution = $event->getExercise()->getSolution();
+        $exercise = $event->getExercise();
+
+        if (!$exercise instanceof ProvidesSolution) {
+            return;
+        }
+
+        $solution = $exercise->getSolution();
 
         if ($solution->hasComposerFile()) {
             //prepare composer deps
diff --git a/src/NodeVisitor/FunctionVisitor.php b/src/NodeVisitor/FunctionVisitor.php
@@ -42,6 +42,7 @@ public function __construct(array $requiredFunctions, array $bannedFunctions)
 
     /**
      * @param Node $node
+     * @return null
      */
     public function leaveNode(Node $node)
     {
@@ -55,6 +56,8 @@ public function leaveNode(Node $node)
                 $this->bannedUsages[] = $node;
             }
         }
+
+        return null;
     }
 
     /**
diff --git a/src/Output/OutputInterface.php b/src/Output/OutputInterface.php
@@ -45,8 +45,6 @@ public function emptyLine();
 
     /**
      * Write a line break.
-     *
-     * @return string
      */
     public function lineBreak();
 
diff --git a/src/Output/StdOutput.php b/src/Output/StdOutput.php
@@ -92,8 +92,6 @@ public function emptyLine()
 
     /**
      * Write a line break.
-     *
-     * @return string
      */
     public function lineBreak()
     {
diff --git a/src/Result/Cgi/CgiResult.php b/src/Result/Cgi/CgiResult.php
@@ -18,7 +18,7 @@ class CgiResult implements ResultGroupInterface, IteratorAggregate
     private $name = 'CGI Program Runner';
 
     /**
-     * @var array
+     * @var ResultInterface[]
      */
     private $results = [];
 
@@ -65,7 +65,7 @@ public function isSuccessful()
     }
 
     /**
-     * @return ResultInterface
+     * @return ResultInterface[]
      */
     public function getResults()
     {
diff --git a/src/Result/Cli/CliResult.php b/src/Result/Cli/CliResult.php
@@ -18,7 +18,7 @@ class CliResult implements ResultGroupInterface, IteratorAggregate
     private $name = 'CLI Program Runner';
 
     /**
-     * @var array
+     * @var ResultInterface[]
      */
     private $results = [];
 
@@ -65,7 +65,7 @@ public function isSuccessful()
     }
 
     /**
-     * @return ResultInterface
+     * @return ResultInterface[]
      */
     public function getResults()
     {
diff --git a/src/ResultRenderer/ComparisonFailureRenderer.php b/src/ResultRenderer/ComparisonFailureRenderer.php
@@ -11,7 +11,7 @@
 class ComparisonFailureRenderer implements ResultRendererInterface
 {
     /**
-     * @var RequestFailure
+     * @var ComparisonFailure
      */
     private $result;
 
diff --git a/src/ResultRenderer/ResultsRenderer.php b/src/ResultRenderer/ResultsRenderer.php
@@ -228,7 +228,7 @@ public function center($string)
 
     /**
      * @param OutputInterface $output
-     * @param $string
+     * @param string $string
      * @param array $style
      */
     private function fullWidthBlock(OutputInterface $output, $string, array $style)
diff --git a/src/Utils/ArrayObject.php b/src/Utils/ArrayObject.php
@@ -22,7 +22,7 @@ class ArrayObject implements IteratorAggregate, Countable
      *
      * @param array $array
      */
-    public function __construct(array $array = [])
+    final public function __construct(array $array = [])
     {
         $this->array = $array;
     }
@@ -32,19 +32,19 @@ public function __construct(array $array = [])
      * to construct a new instance of `ArrayObject`.
      *
      * @param callable $callback
-     * @return self
+     * @return static
      */
     public function map(callable $callback)
     {
-        return new self(array_map($callback, $this->array));
+        return new static(array_map($callback, $this->array));
     }
 
     /**
      * Run a callable over each item in the array and flatten the results by one level returning a new instance of
      * `ArrayObject` with the flattened items.
      *
      * @param callable $callback
-     * @return self
+     * @return static
      */
     public function flatMap(callable $callback)
     {
@@ -55,7 +55,7 @@ public function flatMap(callable $callback)
      * Collapse an array of arrays into a single array returning a new instance of `ArrayObject`
      * with the collapsed items.
      *
-     * @return self
+     * @return static
      */
     public function collapse()
     {
@@ -69,7 +69,7 @@ public function collapse()
             $results = array_merge($results, $item);
         }
 
-        return new self($results);
+        return new static($results);
     }
 
     /**
@@ -85,11 +85,11 @@ public function reduce(callable $callback, $initial = null)
     }
 
     /**
-     * @return self
+     * @return static
      */
     public function keys()
     {
-        return new self(array_keys($this->array));
+        return new static(array_keys($this->array));
     }
 
     /**
@@ -107,22 +107,22 @@ public function implode($glue)
      * Add a new item on to the beginning of the collection. A new instance is returned.
      *
      * @param mixed $value
-     * @return self
+     * @return static
      */
     public function prepend($value)
     {
-        return new self(array_merge([$value], $this->array));
+        return new static(array_merge([$value], $this->array));
     }
 
     /**
      * Add a new item to the end of the collection. A new instance is returned.
      *
      * @param mixed $value
-     * @return self
+     * @return static
      */
     public function append($value)
     {
-        return new self(array_merge($this->array, [$value]));
+        return new static(array_merge($this->array, [$value]));
     }
 
     /**
@@ -146,13 +146,13 @@ public function get($key, $default = null)
      *
      * @param mixed $key
      * @param mixed $value
-     * @return self
+     * @return static
      */
     public function set($key, $value)
     {
         $items = $this->array;
         $items[$key] = $value;
-        return new self($items);
+        return new static($items);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,6 @@`
`56`	`56`	`"phpcs src --standard=PSR12 --encoding=UTF-8",`
`57`	`57`	`"phpcs test --standard=PSR12 --encoding=UTF-8"`
`58`	`58`	`],`
`59`		`- "static": "phpstan --ansi analyse --level 1 src"`
	`59`	`+ "static": "phpstan --ansi analyse --level 3 src"`
`60`	`60`	`}`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class LockFileParser`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`		`- * @var string`
	`13`	`+ * @var array`
`14`	`14`	`*/`
`15`	`15`	`private $contents;`
`16`	`16`
`@@ -25,6 +25,10 @@ public function __construct($lockFilePath)`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`$this->contents = json_decode(file_get_contents($lockFilePath), true);`
	`28`	`+`
	`29`	`+ if (!isset($this->contents['packages'])) {`
	`30`	`+ throw new InvalidArgumentException(sprintf('Lock File: "%s" does not contain packages key', $lockFilePath));`
	`31`	`+ }`
`28`	`32`	`}`
`29`	`33`
`30`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public static function missingImplements($object, $requiredInterface)`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * @param $value`
	`65`	`+ * @param mixed $value`
`66`	`66`	`* @return string`
`67`	`67`	`*/`
`68`	`68`	`private static function stringify($value)`
Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ public function run(ExerciseInterface $exercise, Input $input, OutputInterface $`
`193`	`193`	`}`
`194`	`194`
`195`	`195`	`/**`
`196`		`- * @param CheckInterface[] $checks`
	`196`	`+ * @param SimpleCheckInterface[] $checks`
`197`	`197`	`* @param ExerciseInterface $exercise`
`198`	`198`	`* @throws CheckNotApplicableException`
`199`	`199`	`* @throws ExerciseNotConfiguredException`