Merge pull request #167 from php-school/phpstan

Phpstan max level + lots more type coverage

Author: AydinHassan

.github/workflows/php-workshop.yml

@@ -35,8 +35,8 @@ jobs:
       - name: Run phpcs
         run: composer cs
 
-#      - name: Run phpstan
-#        run: composer static
+      - name: Run phpstan
+        run: composer static
 
       - name: Coverage upload
         if: matrix.php == '7.4'

.scrutinizer.yml

@@ -34,7 +34,10 @@
     "require-dev": {
         "composer/composer": "^1.2",
         "squizlabs/php_codesniffer": "^3.4",
-        "symfony/phpunit-bridge": "^5.1"
+        "symfony/phpunit-bridge": "^5.1",
+        "phpstan/phpstan": "^0.12.50",
+        "phpstan/extension-installer": "^1.0",
+        "phpstan/phpstan-symfony": "^0.12.8"
     },
     "autoload" : {
         "psr-4" : {
@@ -54,6 +57,7 @@
         "cs" : [
             "phpcs src --standard=PSR12 --encoding=UTF-8",
             "phpcs test --standard=PSR12 --encoding=UTF-8"
-        ]
+        ],
+        "static": "phpstan --ansi analyse --level max src"
     }
 }

composer.json

@@ -0,0 +1,9 @@
+parameters:
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        -
+            message: '#PhpSchool\\PhpWorkshop\\ExerciseRunner\\CliRunner\:\:preserveOldArgFormat\(\) should return#'
+            path: src/ExerciseRunner/CliRunner.php
+        -
+            message: '#Call to an undefined method PhpParser\\Node\\Expr\|PhpParser\\Node\\Name\:\:__toString\(\)#'
+            path: src/Check/FunctionRequirementsCheck.php

composer.lock

@@ -22,17 +22,17 @@ final class Application
     private $workshopTitle;
 
     /**
-     * @var array
+     * @var array<class-string>
      */
     private $checks = [];
 
     /**
-     * @var ExerciseInterface[]
+     * @var array<class-string>
      */
     private $exercises = [];
 
     /**
-     * @var array
+     * @var array<array{resultClass: class-string, resultRendererClass: class-string}>
      */
     private $results = [];
 
@@ -68,7 +68,7 @@ final class Application
      * @param string $workshopTitle The workshop title - this is used throughout the application
      * @param string $diConfigFile The absolute path to the DI configuration file
      */
-    public function __construct($workshopTitle, $diConfigFile)
+    public function __construct(string $workshopTitle, string $diConfigFile)
     {
         Assertion::string($workshopTitle);
         Assertion::file($diConfigFile);
@@ -81,9 +81,9 @@ public function __construct($workshopTitle, $diConfigFile)
      * Register a custom check with the application. Exercises will only be able to use the check
      * if it has been registered here.
      *
-     * @param string $check The FQCN of the check
+     * @param class-string $check The FQCN of the check
      */
-    public function addCheck($check)
+    public function addCheck(string $check): void
     {
         $this->checks[] = $check;
     }
@@ -92,18 +92,18 @@ 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)
+    public function addExercise(string $exercise): void
     {
         $this->exercises[] = $exercise;
     }
 
     /**
-     * @param string $resultClass
-     * @param string $resultRendererClass
+     * @param class-string $resultClass
+     * @param class-string $resultRendererClass
      */
-    public function addResult($resultClass, $resultRendererClass)
+    public function addResult(string $resultClass, string $resultRendererClass): void
     {
         Assertion::classExists($resultClass);
         Assertion::classExists($resultRendererClass);
@@ -120,7 +120,7 @@ public function addResult($resultClass, $resultRendererClass)
      *
      * @param string $logo The logo
      */
-    public function setLogo($logo)
+    public function setLogo(string $logo): void
     {
         Assertion::string($logo);
         $this->logo = $logo;
@@ -132,7 +132,7 @@ public function setLogo($logo)
      *
      * @param string $colour The colour
      */
-    public function setFgColour($colour)
+    public function setFgColour(string $colour): void
     {
         Assertion::string($colour);
         $this->fgColour = $colour;
@@ -144,7 +144,7 @@ public function setFgColour($colour)
      *
      * @param string $colour The colour
      */
-    public function setBgColour($colour)
+    public function setBgColour(string $colour): void
     {
         Assertion::string($colour);
         $this->bgColour = $colour;
@@ -156,7 +156,7 @@ public function setBgColour($colour)
      *
      * @return int The exit code
      */
-    public function run()
+    public function run(): int
     {
         $container = $this->getContainer();
 
@@ -218,7 +218,7 @@ public function run()
     /**
      * @return \DI\Container
      */
-    private function getContainer()
+    private function getContainer(): \DI\Container
     {
         $containerBuilder = new ContainerBuilder();
         $containerBuilder->addDefinitions(

phpstan.neon

@@ -11,12 +11,12 @@
 class CheckRepository
 {
     /**
-     * @var CheckInterface[]
+     * @var array<CheckInterface>
      */
     private $checks = [];
 
     /**
-     * @param CheckInterface[] $checks An array of checks available to the workshop framework.
+     * @param array<CheckInterface> $checks An array of checks available to the workshop framework.
      */
     public function __construct(array $checks = [])
     {
@@ -27,6 +27,7 @@ public function __construct(array $checks = [])
 
     /**
      * Add a new check to the repository.
+     * @param CheckInterface $check
      */
     public function registerCheck(CheckInterface $check): void
     {
@@ -36,7 +37,7 @@ public function registerCheck(CheckInterface $check): void
     /**
      * Get all of the checks in the repository.
      *
-     * @return array
+     * @return array<CheckInterface>
      */
     public function getAll(): array
     {
@@ -61,6 +62,9 @@ public function getByClass(string $class): CheckInterface
 
     /**
      * Query whether a check instance exists in this repository via its class name.
+     *
+     * @param string $class
+     * @return bool
      */
     public function has(string $class): bool
     {