Merge pull request #285 from php-school/05-05-seperate_listeners_and_…

…checks Seperate listeners and checks
php-school · May 17, 2024 · b206fce · b206fce
2 parents 88d8200 + 234fde1
commit b206fce
Show file tree

Hide file tree

Showing 14 changed files with 115 additions and 65 deletions.
diff --git a/src/Exercise/AbstractExercise.php b/src/Exercise/AbstractExercise.php
@@ -4,6 +4,8 @@
 
 namespace PhpSchool\PhpWorkshop\Exercise;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 use PhpSchool\PhpWorkshop\Solution\SingleFileSolution;
 use PhpSchool\PhpWorkshop\Solution\SolutionInterface;
@@ -78,12 +80,14 @@ public static function normaliseName(string $name): string
     }
 
     /**
-     * This method is implemented as empty by default, if you want to add additional checks or listen
-     * to events, you should override this method.
-     *
-     * @param ExerciseDispatcher $dispatcher
+     * @return list<class-string>
      */
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
     }
 }
diff --git a/src/Exercise/ExerciseInterface.php b/src/Exercise/ExerciseInterface.php
@@ -4,6 +4,7 @@
 
 namespace PhpSchool\PhpWorkshop\Exercise;
 
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 
 /**
@@ -34,14 +35,16 @@ public function getType(): ExerciseType;
     public function getProblem(): string;
 
     /**
-     * This is where the exercise specifies the extra checks it may require. It is also
-     * possible to grab the event dispatcher from the exercise dispatcher and listen to any
-     * events. This method is automatically invoked just before verifying/running an student's solution
-     * to an exercise.
+     * Subscribe to events triggered throughout the verification process
+     */
+    public function defineListeners(EventDispatcher $dispatcher): void;
+
+    /**
+     * This is where the exercise specifies the extra checks it may require.
      *
-     * @param ExerciseDispatcher $dispatcher
+     * @return array<class-string>
      */
-    public function configure(ExerciseDispatcher $dispatcher): void;
+    public function getRequiredChecks(): array;
 
     /**
      * A short description of the exercise.

diff --git a/src/ExerciseDispatcher.php b/src/ExerciseDispatcher.php
@@ -129,11 +129,11 @@ public function requireCheck(string $requiredCheck): void
      */
     public function verify(ExerciseInterface $exercise, Input $input): ResultAggregator
     {
-        $exercise->configure($this);
-
         $runner = $this->runnerManager->getRunner($exercise);
 
-        foreach ($runner->getRequiredChecks() as $requiredCheck) {
+        $exercise->defineListeners($this->eventDispatcher);
+
+        foreach ([...$runner->getRequiredChecks(), ...$exercise->getRequiredChecks()] as $requiredCheck) {
             $this->requireCheck($requiredCheck);
         }
 
@@ -181,7 +181,7 @@ public function verify(ExerciseInterface $exercise, Input $input): ResultAggrega
      */
     public function run(ExerciseInterface $exercise, Input $input, OutputInterface $output): bool
     {
-        $exercise->configure($this);
+        $exercise->defineListeners($this->eventDispatcher);
 
         /** @var PhpLintCheck $lint */
         $lint = $this->checkRepository->getByClass(PhpLintCheck::class);

diff --git a/test/Asset/CgiExerciseImpl.php b/test/Asset/CgiExerciseImpl.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\CgiExercise;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
@@ -62,7 +64,12 @@ public function getType(): ExerciseType
         return ExerciseType::CGI();
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
     }
 }
diff --git a/test/Asset/CliExerciseImpl.php b/test/Asset/CliExerciseImpl.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\CliExercise;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
@@ -66,7 +68,12 @@ public function getType(): ExerciseType
         return ExerciseType::CLI();
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
     }
 }
diff --git a/test/Asset/CliExerciseMissingInterface.php b/test/Asset/CliExerciseMissingInterface.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\AbstractExercise;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
@@ -31,4 +33,9 @@ public function getType(): ExerciseType
     {
         return ExerciseType::CLI();
     }
+
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
 }
diff --git a/test/Asset/ComposerExercise.php b/test/Asset/ComposerExercise.php
@@ -3,6 +3,7 @@
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
 use PhpSchool\PhpWorkshop\Check\ComposerCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\ExerciseCheck\ComposerExerciseCheck;
@@ -53,8 +54,12 @@ public function getType(): ExerciseType
         return ExerciseType::CLI();
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getRequiredChecks(): array
+    {
+        return [ComposerCheck::class];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
-        $dispatcher->requireCheck(ComposerCheck::class);
     }
 }
diff --git a/test/Asset/ExerciseWithInitialCode.php b/test/Asset/ExerciseWithInitialCode.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\Exercise\ProvidesInitialCode;
@@ -41,13 +43,17 @@ public function getType(): ExerciseType
         // TODO: Implement getType() method.
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getInitialCode(): SolutionInterface
     {
-        // TODO: Implement configure() method.
+        return SingleFileSolution::fromFile(__DIR__ . '/initial-code/init-solution.php');
     }
 
-    public function getInitialCode(): SolutionInterface
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
-        return SingleFileSolution::fromFile(__DIR__ . '/initial-code/init-solution.php');
     }
 }
diff --git a/test/Asset/FileComparisonExercise.php b/test/Asset/FileComparisonExercise.php
@@ -3,6 +3,8 @@
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
 use PhpSchool\PhpWorkshop\Check\ComposerCheck;
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\ExerciseCheck\FileComparisonExerciseCheck;
@@ -66,13 +68,17 @@ public function getType(): ExerciseType
         return ExerciseType::CLI();
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getFilesToCompare(): array
     {
-        $dispatcher->requireCheck(ComposerCheck::class);
+        return $this->files;
     }
 
-    public function getFilesToCompare(): array
+    public function getRequiredChecks(): array
+    {
+        return [FileComparisonCheck::class];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
-        return $this->files;
     }
 }
diff --git a/test/Asset/FunctionRequirementsExercise.php b/test/Asset/FunctionRequirementsExercise.php
@@ -3,6 +3,9 @@
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
 use PhpSchool\PhpWorkshop\Check\ComposerCheck;
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Check\FunctionRequirementsCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\ExerciseCheck\FunctionRequirementsExerciseCheck;
@@ -45,11 +48,6 @@ public function getType(): ExerciseType
         return ExerciseType::CLI();
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
-    {
-        $dispatcher->requireCheck(ComposerCheck::class);
-    }
-
     /**
      * @return string[]
      */
@@ -65,4 +63,13 @@ public function getBannedFunctions(): array
     {
         return ['file'];
     }
+
+    public function getRequiredChecks(): array
+    {
+        return [FunctionRequirementsCheck::class];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
+    {
+    }
 }
diff --git a/test/Asset/PatchableExercise.php b/test/Asset/PatchableExercise.php
@@ -2,6 +2,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\Exercise\SubmissionPatchable;
@@ -45,8 +47,12 @@ public function getType(): ExerciseType
         // TODO: Implement getType() method.
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
     {
-        // TODO: Implement configure() method.
     }
 }
diff --git a/test/Asset/ProvidesSolutionExercise.php b/test/Asset/ProvidesSolutionExercise.php
@@ -4,6 +4,8 @@
 
 namespace PhpSchool\PhpWorkshopTest\Asset;
 
+use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\Exercise\ProvidesSolution;
@@ -28,11 +30,6 @@ public function getProblem(): string
         // TODO: Implement getProblem() method.
     }
 
-    public function configure(ExerciseDispatcher $dispatcher): void
-    {
-        // TODO: Implement configure() method.
-    }
-
     public function getDescription(): string
     {
         // TODO: Implement getDescription() method.
@@ -47,4 +44,13 @@ public function getSolution(): SolutionInterface
     {
         return SingleFileSolution::fromFile(__DIR__ . '/provided-solution/solution.php');
     }
+
+    public function getRequiredChecks(): array
+    {
+        return [];
+    }
+
+    public function defineListeners(EventDispatcher $dispatcher): void
+    {
+    }
 }
diff --git a/test/Check/DatabaseCheckTest.php b/test/Check/DatabaseCheckTest.php
@@ -131,10 +131,8 @@ public function testIfPDOThrowsExceptionItCleansUp(): void
 
         $this->exercise
             ->expects($this->once())
-            ->method('configure')
-            ->willReturnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireCheck(DatabaseCheck::class);
-            });
+            ->method('getRequiredChecks')
+            ->willReturn([DatabaseCheck::class]);
 
         $this->exercise
             ->expects($this->once())
@@ -172,10 +170,8 @@ public function testSuccessIsReturnedIfDatabaseVerificationPassed(): void
 
         $this->exercise
             ->expects($this->once())
-            ->method('configure')
-            ->willReturnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireCheck(DatabaseCheck::class);
-            });
+            ->method('getRequiredChecks')
+            ->willReturn([DatabaseCheck::class]);
 
         $this->exercise
             ->expects($this->once())
@@ -207,13 +203,6 @@ public function testRunExercise(): void
             ->method('getArgs')
             ->willReturn([]);
 
-        $this->exercise
-            ->expects($this->once())
-            ->method('configure')
-            ->willReturnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireCheck(DatabaseCheck::class);
-            });
-
         $this->checkRepository->registerCheck($this->check);
 
         $results            = new ResultAggregator();
@@ -248,10 +237,8 @@ public function testFailureIsReturnedIfDatabaseVerificationFails(): void
 
         $this->exercise
             ->expects($this->once())
-            ->method('configure')
-            ->willReturnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireCheck(DatabaseCheck::class);
-            });
+            ->method('getRequiredChecks')
+            ->willReturn([DatabaseCheck::class]);
 
         $this->exercise
             ->expects($this->once())
@@ -296,10 +283,8 @@ public function testAlteringDatabaseInSolutionDoesNotEffectDatabaseInUserSolutio
 
         $this->exercise
             ->expects($this->once())
-            ->method('configure')
-            ->willReturnCallback(function (ExerciseDispatcher $dispatcher) {
-                $dispatcher->requireCheck(DatabaseCheck::class);
-            });
+            ->method('getRequiredChecks')
+            ->willReturn([DatabaseCheck::class]);
 
         $this->exercise
             ->expects($this->once())