Merge pull request #181 from php-school/various-code-inspections

Various code improvements

Author: AydinHassan

composer.json

@@ -16,6 +16,7 @@
     ],
     "require" : {
         "php" : ">=7.2",
+        "ext-pdo": "*",
         "ext-pdo_sqlite": "*",
         "php-di/php-di": "^6.0",
         "psr/container": "^1.0",

src/Application.php

@@ -4,13 +4,18 @@
 
 namespace PhpSchool\PhpWorkshop;
 
+use DI\Container;
 use DI\ContainerBuilder;
 use PhpSchool\PhpWorkshop\Check\CheckRepository;
 use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
 use PhpSchool\PhpWorkshop\Exception\MissingArgumentException;
-use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Factory\ResultRendererFactory;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
+use RuntimeException;
+
+use function class_exists;
+use function is_file;
+use function sprintf;
 
 /**
  * This is the main application class, this takes care of bootstrapping, routing and
@@ -46,7 +51,7 @@ final class Application
     /**
      * @var string|null
      */
-    private $logo = null;
+    private $logo;
 
     /**
      * @var string
@@ -72,8 +77,8 @@ final class Application
      */
     public function __construct(string $workshopTitle, string $diConfigFile)
     {
-        if (!\is_file($diConfigFile)) {
-            throw new InvalidArgumentException(\sprintf('File "%s" was expected to exist.', $diConfigFile));
+        if (!is_file($diConfigFile)) {
+            throw new InvalidArgumentException(sprintf('File "%s" was expected to exist.', $diConfigFile));
         }
 
         $this->workshopTitle = $workshopTitle;
@@ -108,12 +113,12 @@ public function addExercise(string $exercise): void
      */
     public function addResult(string $resultClass, string $resultRendererClass): void
     {
-        if (!\class_exists($resultClass)) {
-            throw new InvalidArgumentException(\sprintf('Class "%s" does not exist', $resultClass));
+        if (!class_exists($resultClass)) {
+            throw new InvalidArgumentException(sprintf('Class "%s" does not exist', $resultClass));
         }
 
-        if (!\class_exists($resultRendererClass)) {
-            throw new InvalidArgumentException(\sprintf('Class "%s" does not exist', $resultRendererClass));
+        if (!class_exists($resultRendererClass)) {
+            throw new InvalidArgumentException(sprintf('Class "%s" does not exist', $resultRendererClass));
         }
 
         $this->results[] = [
@@ -167,7 +172,7 @@ public function run(): int
 
         foreach ($this->exercises as $exercise) {
             if (false === $container->has($exercise)) {
-                throw new \RuntimeException(
+                throw new RuntimeException(
                     sprintf('No DI config found for exercise: "%s". Register a factory.', $exercise)
                 );
             }
@@ -176,7 +181,7 @@ public function run(): int
         $checkRepository = $container->get(CheckRepository::class);
         foreach ($this->checks as $check) {
             if (false === $container->has($check)) {
-                throw new \RuntimeException(
+                throw new RuntimeException(
                     sprintf('No DI config found for check: "%s". Register a factory.', $check)
                 );
             }
@@ -206,7 +211,7 @@ public function run(): int
                     )
                 );
             return 1;
-        } catch (\RuntimeException $e) {
+        } catch (RuntimeException $e) {
             $container
                 ->get(OutputInterface::class)
                 ->printError(
@@ -221,9 +226,9 @@ public function run(): int
     }
 
     /**
-     * @return \DI\Container
+     * @return Container
      */
-    private function getContainer(): \DI\Container
+    private function getContainer(): Container
     {
         $containerBuilder = new ContainerBuilder();
         $containerBuilder->addDefinitions(

src/Check/CodeParseCheck.php

@@ -5,8 +5,6 @@
 namespace PhpSchool\PhpWorkshop\Check;
 
 use PhpParser\Error;
-use PhpParser\Node\Expr\FuncCall;
-use PhpParser\NodeTraverser;
 use PhpParser\Parser;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
@@ -66,6 +64,8 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
 
     /**
      * This check can run on any exercise type.
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool
     {

src/Check/ComposerCheck.php

@@ -4,6 +4,7 @@
 
 namespace PhpSchool\PhpWorkshop\Check;
 
+use InvalidArgumentException;
 use PhpSchool\PhpWorkshop\ComposerUtil\LockFileParser;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
@@ -35,11 +36,12 @@ public function getName(): string
      * @param ExerciseInterface $exercise The exercise to check against.
      * @param Input $input The command line arguments passed to the command.
      * @return ResultInterface The result of the check.
+     * @noinspection SpellCheckingInspection
      */
     public function check(ExerciseInterface $exercise, Input $input): ResultInterface
     {
         if (!$exercise instanceof ComposerExerciseCheck) {
-            throw new \InvalidArgumentException();
+            throw new InvalidArgumentException();
         }
 
         if (!file_exists(sprintf('%s/composer.json', dirname($input->getRequiredArgument('program'))))) {
@@ -74,6 +76,9 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
 
     /**
      * This check can run on any exercise type.
+     *
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool
     {

src/Check/DatabaseCheck.php

@@ -5,13 +5,15 @@
 namespace PhpSchool\PhpWorkshop\Check;
 
 use PDO;
+use PDOException;
 use PhpSchool\PhpWorkshop\Event\CliExecuteEvent;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\TemporaryDirectoryTrait;
 use PhpSchool\PhpWorkshop\ExerciseCheck\DatabaseExerciseCheck;
 use PhpSchool\PhpWorkshop\Result\Failure;
 use PhpSchool\PhpWorkshop\Result\Success;
+use RuntimeException;
 
 /**
  * This check sets up a database and a `PDO` object. It prepends the database DSN as a CLI argument to the student's
@@ -75,12 +77,14 @@ public function getExerciseInterface(): string
 
     /**
      * Here we attach to various events to seed, verify and inject the DSN's
-     * to the student & reference solution programs's CLI arguments.
+     * to the student & reference solution programs' CLI arguments.
+     *
+     * @param EventDispatcher $eventDispatcher
      */
     public function attach(EventDispatcher $eventDispatcher): void
     {
         if (file_exists($this->databaseDirectory)) {
-            throw new \RuntimeException(
+            throw new RuntimeException(
                 sprintf('Database directory: "%s" already exists', $this->databaseDirectory)
             );
         }
@@ -90,7 +94,7 @@ public function attach(EventDispatcher $eventDispatcher): void
         try {
             $db = new PDO($this->userDsn);
             $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
-        } catch (\PDOException $e) {
+        } catch (PDOException $e) {
             rmdir($this->databaseDirectory);
             throw $e;
         }
@@ -132,7 +136,7 @@ function (CliExecuteEvent $e) {
                 'verify.finish',
                 'run.finish'
             ],
-            function (Event $e) use ($db) {
+            function () use ($db) {
                 unset($db);
                 @unlink($this->userDatabasePath);
                 @unlink($this->solutionDatabasePath);

src/Check/FileExistsCheck.php

@@ -45,6 +45,9 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
 
     /**
      * This check can run on any exercise type.
+     *
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool
     {
@@ -57,7 +60,7 @@ public function getExerciseInterface(): string
     }
 
     /**
-     * This check must run before executing the solution becuase it may not exist.
+     * This check must run before executing the solution because it may not exist.
      */
     public function getPosition(): string
     {

src/Check/FunctionRequirementsCheck.php

@@ -4,9 +4,9 @@
 
 namespace PhpSchool\PhpWorkshop\Check;
 
+use InvalidArgumentException;
 use PhpParser\Error;
 use PhpParser\Node\Expr\FuncCall;
-use PhpParser\Node\Name;
 use PhpParser\NodeTraverser;
 use PhpParser\Parser;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
@@ -18,7 +18,6 @@
 use PhpSchool\PhpWorkshop\Result\FunctionRequirementsFailure;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 use PhpSchool\PhpWorkshop\Result\Success;
-use PhpSchool\PhpWorkshop\Utils\Collection;
 
 /**
  * This check verifies that the student's solution contains usages of some required functions
@@ -59,7 +58,7 @@ public function getName(): string
     public function check(ExerciseInterface $exercise, Input $input): ResultInterface
     {
         if (!$exercise instanceof FunctionRequirementsExerciseCheck) {
-            throw new \InvalidArgumentException();
+            throw new InvalidArgumentException();
         }
 
         $requiredFunctions  = $exercise->getRequiredFunctions();
@@ -100,6 +99,9 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
 
     /**
      * This check can run on any exercise type.
+     *
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool
     {

src/Check/ListenableCheckInterface.php

@@ -14,6 +14,8 @@ interface ListenableCheckInterface extends CheckInterface
     /**
      * Attach to events throughout the running/verifying process. Inject verifiers
      * and listeners.
+     *
+     * @param EventDispatcher $eventDispatcher
      */
     public function attach(EventDispatcher $eventDispatcher): void;
 }

src/Check/PhpLintCheck.php

@@ -47,6 +47,9 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
 
     /**
      * This check can run on any exercise type.
+     *
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool
     {

src/Check/SimpleCheckInterface.php

@@ -31,6 +31,9 @@ interface SimpleCheckInterface extends CheckInterface
 
     /**
      * Can this check run this exercise?
+     *
+     * @param ExerciseType $exerciseType
+     * @return bool
      */
     public function canRun(ExerciseType $exerciseType): bool;