Begin level 6 typing

Author: AydinHassan

composer.json

@@ -35,7 +35,8 @@
         "composer/composer": "^1.2",
         "squizlabs/php_codesniffer": "^3.4",
         "symfony/phpunit-bridge": "^5.1",
-        "phpstan/phpstan": "^0.12.50"
+        "phpstan/phpstan": "^0.12.50",
+        "timeweb/phpstan-enum": "^2.2"
     },
     "autoload" : {
         "psr-4" : {
@@ -56,6 +57,6 @@
             "phpcs src --standard=PSR12 --encoding=UTF-8",
             "phpcs test --standard=PSR12 --encoding=UTF-8"
         ],
-        "static": "phpstan --ansi analyse --level 5 src"
+        "static": "phpstan --ansi analyse --level 6 src"
     }
 }

composer.lock

@@ -1,2 +1,3 @@
 parameters:
     treatPhpDocTypesAsCertain: false
+

phpstan.neon

@@ -10,6 +10,8 @@
 
 /**
  * Exercise repository, use to locate individual/all exercises by certain criteria.
+ *
+ * @implements IteratorAggregate<int, ExerciseInterface>
  */
 class ExerciseRepository implements IteratorAggregate, Countable
 {
@@ -21,7 +23,7 @@ class ExerciseRepository implements IteratorAggregate, Countable
     /**
      * Requires an array of `ExerciseInterface` instances.
      *
-     * @param ExerciseInterface[] $exercises
+     * @param array<ExerciseInterface> $exercises
      */
     public function __construct(array $exercises)
     {
@@ -34,7 +36,7 @@ public function __construct(array $exercises)
      * @param ExerciseInterface $exercise
      * @return ExerciseInterface
      */
-    private function validateExercise(ExerciseInterface $exercise)
+    private function validateExercise(ExerciseInterface $exercise): ExerciseInterface
     {
         $type = $exercise->getType();
 
@@ -50,9 +52,9 @@ private function validateExercise(ExerciseInterface $exercise)
     /**
      * Retrieve all of the exercises as an array.
      *
-     * @return ExerciseInterface[]
+     * @return array<ExerciseInterface>
      */
-    public function findAll()
+    public function findAll(): array
     {
         return $this->exercises;
     }
@@ -65,7 +67,7 @@ public function findAll()
      * @return ExerciseInterface
      * @throws InvalidArgumentException
      */
-    public function findByName($name)
+    public function findByName(string $name): ExerciseInterface
     {
         foreach ($this->exercises as $exercise) {
             if ($name === $exercise->getName()) {
@@ -79,9 +81,9 @@ public function findByName($name)
     /**
      * Get the names of each exercise as an array.
      *
-     * @return array
+     * @return array<string>
      */
-    public function getAllNames()
+    public function getAllNames(): array
     {
         return array_map(function (ExerciseInterface $exercise) {
             return $exercise->getName();
@@ -93,17 +95,17 @@ public function getAllNames()
      *
      * @return int
      */
-    public function count()
+    public function count(): int
     {
         return count($this->exercises);
     }
 
     /**
      * Allow to iterate over the repository with `foreach`.
      *
-     * @return ArrayIterator
+     * @return ArrayIterator<int, ExerciseInterface>
      */
-    public function getIterator()
+    public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->exercises);
     }

src/ExerciseRepository.php

@@ -19,7 +19,7 @@ class EventDispatcherFactory
      * @return EventDispatcher
      * @throws InvalidArgumentException
      */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container): EventDispatcher
     {
         $dispatcher = new EventDispatcher($container->get(ResultAggregator::class));
 
@@ -46,10 +46,10 @@ public function __invoke(ContainerInterface $container)
     }
 
     /**
-     * @param array $listeners
-     * @return array
+     * @param array<int, array<string, array>> $listeners
+     * @return array<int, array>
      */
-    private function mergeListenerGroups(array $listeners)
+    private function mergeListenerGroups(array $listeners): array
     {
         $listeners = new Collection($listeners);
 
@@ -78,17 +78,17 @@ private function mergeListenerGroups(array $listeners)
 
     /**
      * @param string $eventName
-     * @param array $listeners
+     * @param array<int, ContainerListenerHelper|callable> $listeners
      * @param ContainerInterface $container
      * @param EventDispatcher $dispatcher
-     * @throws \PhpSchool\PhpWorkshop\Exception\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     private function attachListeners(
-        $eventName,
+        string $eventName,
         array $listeners,
         ContainerInterface $container,
         EventDispatcher $dispatcher
-    ) {
+    ): void {
         array_walk($listeners, function ($listener) use ($eventName, $dispatcher, $container) {
             if ($listener instanceof ContainerListenerHelper) {
                 if (!$container->has($listener->getService())) {
@@ -117,7 +117,6 @@ private function attachListeners(
                 );
             }
             $dispatcher->listen($eventName, $listener);
-            return;
         });
     }
 }

src/Factory/EventDispatcherFactory.php

@@ -142,7 +142,7 @@ private function isExerciseDisabled(ExerciseInterface $exercise, UserState $user
      * @param EventDispatcher $eventDispatcher
      * @param ExerciseInterface $exercise
      */
-    private function dispatchExerciseSelectedEvent(EventDispatcher $eventDispatcher, ExerciseInterface $exercise)
+    private function dispatchExerciseSelectedEvent(EventDispatcher $eventDispatcher, ExerciseInterface $exercise): void
     {
         $eventDispatcher->dispatch(
             new Event(

src/Factory/MenuFactory.php

@@ -12,21 +12,21 @@
 class ResultRendererFactory
 {
     /**
-     * @var array
+     * @var array<class-string, class-string>
      */
     private $mappings = [];
 
     /**
-     * @var array
+     * @var array<class-string, callable>
      */
     private $factories = [];
 
     /**
-     * @param string $resultClass
-     * @param string $rendererClass
-     * @param callable $factory
+     * @param class-string $resultClass
+     * @param class-string $rendererClass
+     * @param callable|null $factory
      */
-    public function registerRenderer($resultClass, $rendererClass, callable $factory = null)
+    public function registerRenderer(string $resultClass, string $rendererClass, callable $factory = null): void
     {
         if (!$this->isImplementationNameOfClass($resultClass, ResultInterface::class)) {
             throw new InvalidArgumentException();
@@ -47,7 +47,7 @@ public function registerRenderer($resultClass, $rendererClass, callable $factory
      * @param ResultInterface $result
      * @return ResultRendererInterface
      */
-    public function create(ResultInterface $result)
+    public function create(ResultInterface $result): ResultRendererInterface
     {
         $class = get_class($result);
         if (!isset($this->mappings[$class])) {
@@ -73,7 +73,12 @@ public function create(ResultInterface $result)
         return $renderer;
     }
 
-    protected function isImplementationNameOfClass($implementationName, $className)
+    /**
+     * @param class-string $implementationName
+     * @param class-string $className
+     * @return bool
+     */
+    protected function isImplementationNameOfClass(string $implementationName, string $className): bool
     {
         return is_string($implementationName) && is_subclass_of($implementationName, $className);
     }

src/Factory/ResultRendererFactory.php

@@ -16,15 +16,15 @@ class Input
     private $appName;
 
     /**
-     * @var array
+     * @var array<string>
      */
     private $arguments = [];
 
     /**
      * @param string $appName
-     * @param array $arguments
+     * @param array<string> $arguments
      */
-    public function __construct($appName, array $arguments = [])
+    public function __construct(string $appName, array $arguments = [])
     {
         $this->appName = $appName;
         $this->arguments = $arguments;
@@ -33,7 +33,7 @@ public function __construct($appName, array $arguments = [])
     /**
      * @return string
      */
-    public function getAppName()
+    public function getAppName(): string
     {
         return $this->appName;
     }
@@ -42,7 +42,7 @@ public function getAppName()
      * @param string $name
      * @return bool
      */
-    public function hasArgument($name)
+    public function hasArgument($name): bool
     {
         return isset($this->arguments[$name]);
     }
@@ -52,7 +52,7 @@ public function hasArgument($name)
      * @return string
      * @throws InvalidArgumentException
      */
-    public function getArgument($name)
+    public function getArgument(string $name): string
     {
         if (!$this->hasArgument($name)) {
             throw new InvalidArgumentException(sprintf('Argument with name: "%s" does not exist', $name));
@@ -65,7 +65,7 @@ public function getArgument($name)
      * @param string $name
      * @param string $value
      */
-    public function setArgument($name, $value)
+    public function setArgument(string $name, string $value): void
     {
         $this->arguments[$name] = $value;
     }

src/Input/Input.php

@@ -24,7 +24,7 @@ public function __construct(UserState $userState)
     /**
      * @param Event $event
      */
-    public function __invoke(Event $event)
+    public function __invoke(Event $event): void
     {
         /** @var CommandDefinition $command */
         $command = $event->getParameter('command');

src/Listener/CheckExerciseAssignedListener.php

@@ -34,7 +34,7 @@ public function __construct(CodePatcher $codePatcher)
     /**
      * @param ExerciseRunnerEvent $event
      */
-    public function patch(ExerciseRunnerEvent $event)
+    public function patch(ExerciseRunnerEvent $event): void
     {
         $fileName = $event->getInput()->getArgument('program');
 
@@ -48,7 +48,7 @@ public function patch(ExerciseRunnerEvent $event)
     /**
      * @param ExerciseRunnerEvent $event
      */
-    public function revert(ExerciseRunnerEvent $event)
+    public function revert(ExerciseRunnerEvent $event): void
     {
         if (null === $this->originalCode) {
             throw new RuntimeException('Can only revert previously patched code');