Merge pull request #292 from php-school/05-09-update_events_to_use_co…

…ntext Update events to use context
php-school · May 17, 2024 · 6142580 · 6142580
2 parents 44ceb20 + 11a15f9
commit 6142580
Show file tree

Hide file tree

Showing 26 changed files with 436 additions and 350 deletions.
diff --git a/app/config.php b/app/config.php
@@ -267,7 +267,11 @@
     InitialCodeListener::class => function (ContainerInterface $c) {
         return new InitialCodeListener($c->get('currentWorkingDirectory'), $c->get(LoggerInterface::class));
     },
-    PrepareSolutionListener::class => create(),
+    PrepareSolutionListener::class => function (ContainerInterface $c) {
+        return new PrepareSolutionListener(
+            $c->get(ProcessFactory::class)
+        );
+    },
     CodePatchListener::class => function (ContainerInterface $c) {
         return new CodePatchListener(
             $c->get(CodePatcher::class),
@@ -472,21 +476,24 @@ function (CgiResult $result) use ($c) {
             ],
         ],
         'prepare-solution' => [
-            'cli.verify.start' => [
+            'cli.verify.reference-execute.pre' => [
                 containerListener(PrepareSolutionListener::class),
             ],
             'cli.run.start' => [
                 containerListener(PrepareSolutionListener::class),
             ],
-            'cgi.verify.start' => [
+            'cgi.verify.reference-execute.pre' => [
                 containerListener(PrepareSolutionListener::class),
             ],
             'cgi.run.start' => [
                 containerListener(PrepareSolutionListener::class),
             ],
         ],
         'code-patcher' => [
-            'verify.pre.execute' => [
+            'cli.verify.start' => [
+                containerListener(CodePatchListener::class, 'patch'),
+            ],
+            'cgi.verify.start' => [
                 containerListener(CodePatchListener::class, 'patch'),
             ],
             'verify.post.execute' => [

diff --git a/src/Event/CgiExecuteEvent.php b/src/Event/CgiExecuteEvent.php
@@ -5,6 +5,8 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Exercise\Scenario\CgiScenario;
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
 use PhpSchool\PhpWorkshop\Input\Input;
 use Psr\Http\Message\RequestInterface;
 
@@ -19,17 +21,17 @@ class CgiExecuteEvent extends CgiExerciseRunnerEvent
     /**
      * @param string $name The event name.
      * @param RequestInterface $request The request that will be performed.
-     * @param array<mixed> $parameters The event parameters.
+     * @param array<string, mixed> $parameters The event parameters.
      */
     public function __construct(
         string $name,
-        ExerciseInterface $exercise,
-        Input $input,
+        ExecutionContext $context,
+        CgiScenario $scenario,
         RequestInterface $request,
         array $parameters = []
     ) {
         $parameters['request'] = $request;
-        parent::__construct($name, $exercise, $input, $parameters);
+        parent::__construct($name, $context, $scenario, $parameters);
         $this->request = $request;
     }
 

diff --git a/src/Event/CgiExerciseRunnerEvent.php b/src/Event/CgiExerciseRunnerEvent.php
@@ -3,9 +3,29 @@
  namespace PhpSchool\PhpWorkshop\Event;
 
  use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+ use PhpSchool\PhpWorkshop\Exercise\Scenario\CgiScenario;
  use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
  use PhpSchool\PhpWorkshop\Input\Input;
 
 class CgiExerciseRunnerEvent extends ExerciseRunnerEvent
 {
+    private CgiScenario $scenario;
+
+    /**
+     * @param array<string, mixed> $parameters
+     */
+    public function __construct(
+        string $name,
+        ExecutionContext $context,
+        CgiScenario $scenario,
+        array $parameters = []
+    ) {
+        $this->scenario = $scenario;
+        parent::__construct($name, $context, $parameters);
+    }
+
+    public function getScenario(): CgiScenario
+    {
+        return $this->scenario;
+    }
 }
diff --git a/src/Event/CliExecuteEvent.php b/src/Event/CliExecuteEvent.php
@@ -5,8 +5,10 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Exercise\Scenario\CliScenario;
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
 use PhpSchool\PhpWorkshop\Input\Input;
-use PhpSchool\PhpWorkshop\Utils\ArrayObject;
+use PhpSchool\PhpWorkshop\Utils\Collection;
 
 /**
  * An event to represent events which occur throughout the verification and running process in
@@ -15,24 +17,24 @@
 class CliExecuteEvent extends CliExerciseRunnerEvent
 {
     /**
-     * @var ArrayObject<int, string>
+     * @var Collection<int, string>
      */
-    private ArrayObject $args;
+    private Collection $args;
 
     /**
      * @param string $name The event name.
-     * @param ArrayObject<int, string> $args The arguments that should be/have been passed to the program.
-     * @param array<mixed> $parameters The event parameters.
+     * @param Collection<int, string> $args The arguments that should be/have been passed to the program.
+     * @param array<string, mixed> $parameters The event parameters.
      */
     public function __construct(
         string $name,
-        ExerciseInterface $exercise,
-        Input $input,
-        ArrayObject $args,
+        ExecutionContext $context,
+        CliScenario $scenario,
+        Collection $args,
         array $parameters = []
     ) {
         $parameters['args'] = $args;
-        parent::__construct($name, $exercise, $input, $parameters);
+        parent::__construct($name, $context, $scenario, $parameters);
         $this->args = $args;
     }
 
@@ -59,9 +61,9 @@ public function appendArg(string $arg): void
     /**
      * Get the arguments to be passed to the program.
      *
-     * @return ArrayObject<int, string>
+     * @return Collection<int, string>
      */
-    public function getArgs(): ArrayObject
+    public function getArgs(): Collection
     {
         return $this->args;
     }

diff --git a/src/Event/CliExerciseRunnerEvent.php b/src/Event/CliExerciseRunnerEvent.php
@@ -3,9 +3,29 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Exercise\Scenario\CliScenario;
 use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
 use PhpSchool\PhpWorkshop\Input\Input;
 
 class CliExerciseRunnerEvent extends ExerciseRunnerEvent
 {
+    private CliScenario $scenario;
+
+    /**
+     * @param array<string, mixed> $parameters
+     */
+    public function __construct(
+        string $name,
+        ExecutionContext $context,
+        CliScenario $scenario,
+        array $parameters = []
+    ) {
+        $this->scenario = $scenario;
+        parent::__construct($name, $context, $parameters);
+    }
+
+    public function getScenario(): CliScenario
+    {
+        return $this->scenario;
+    }
 }
diff --git a/src/Event/EventDispatcher.php b/src/Event/EventDispatcher.php
@@ -17,10 +17,6 @@ class EventDispatcher
      * @var array<string, array<callable>>
      */
     private array $listeners = [];
-
-    /**
-     * @var ResultAggregator
-     */
     private ResultAggregator $resultAggregator;
 
     public function __construct(ResultAggregator $resultAggregator)

diff --git a/src/Event/ExerciseRunnerEvent.php b/src/Event/ExerciseRunnerEvent.php
@@ -5,52 +5,47 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
 use PhpSchool\PhpWorkshop\Input\Input;
 
 /**
  * An event which is dispatched during exercise running
  */
 class ExerciseRunnerEvent extends Event
 {
-    /**
-     * @var ExerciseInterface
-     */
-    private $exercise;
-
-    /**
-     * @var Input
-     */
-    private $input;
+    private ExecutionContext $context;
 
     /**
      * @param string $name
-     * @param ExerciseInterface $exercise
-     * @param Input $input
-     * @param array<mixed> $parameters
+     * @param array<string, mixed> $parameters
      */
-    public function __construct(string $name, ExerciseInterface $exercise, Input $input, array $parameters = [])
+    public function __construct(string $name, ExecutionContext $context, array $parameters = [])
     {
-        $parameters['input'] = $input;
-        $parameters['exercise'] = $exercise;
+        $this->context = $context;
+
+        $parameters['input'] = $context->getInput();
+        $parameters['exercise'] = $context->getExercise();
         parent::__construct($name, $parameters);
+    }
 
-        $this->exercise = $exercise;
-        $this->input = $input;
+    public function getContext(): ExecutionContext
+    {
+        return $this->context;
     }
 
     /**
      * @return Input
      */
     public function getInput(): Input
     {
-        return $this->input;
+        return $this->context->getInput();
     }
 
     /**
      * @return ExerciseInterface
      */
     public function getExercise(): ExerciseInterface
     {
-        return $this->exercise;
+        return $this->context->getExercise();
     }
 }
diff --git a/src/ExerciseCheck/SelfCheck.php b/src/ExerciseCheck/SelfCheck.php
@@ -4,6 +4,7 @@
 
 namespace PhpSchool\PhpWorkshop\ExerciseCheck;
 
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
 use PhpSchool\PhpWorkshop\Input\Input;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 
@@ -21,8 +22,8 @@ interface SelfCheck
      * The method is passed the absolute file path to the student's solution and should return a result
      * object which indicates the success or not of the check.
      *
-     * @param Input $input The command line arguments passed to the command.
+     * @param ExecutionContext $context The current execution context.
      * @return ResultInterface The result of the check.
      */
-    public function check(Input $input): ResultInterface;
+    public function check(ExecutionContext $context): ResultInterface;
 }
diff --git a/src/ExerciseDispatcher.php b/src/ExerciseDispatcher.php
@@ -117,7 +117,7 @@ public function verify(ExerciseInterface $exercise, Input $input): ResultAggrega
             $this->requireCheck($requiredCheck);
         }
 
-        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.start', $exercise, $input));
+        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.start', $context));
 
         $this->validateChecks($this->checksToRunBefore, $exercise);
         $this->validateChecks($this->checksToRunAfter, $exercise);
@@ -130,22 +130,22 @@ public function verify(ExerciseInterface $exercise, Input $input): ResultAggrega
             }
         }
 
-        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.pre.execute', $exercise, $input));
+        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.pre.execute', $context));
 
         try {
             $this->results->add($runner->verify($context));
         } finally {
-            $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.post.execute', $exercise, $input));
+            $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.post.execute', $context));
         }
 
         foreach ($this->checksToRunAfter as $check) {
             $this->results->add($check->check($context));
         }
 
-        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.post.check', $exercise, $input));
+        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.post.check', $context));
         $exercise->tearDown();
 
-        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.finish', $exercise, $input));
+        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('verify.finish', $context));
         return $this->results;
     }
 
@@ -173,14 +173,14 @@ public function run(ExerciseInterface $exercise, Input $input, OutputInterface $
             throw CouldNotRunException::fromFailure($result);
         }
 
-        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('run.start', $exercise, $input));
+        $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('run.start', $context));
 
         try {
             $exitStatus = $this->runnerManager
                 ->getRunner($exercise)
                 ->run($context, $output);
         } finally {
-            $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('run.finish', $exercise, $input));
+            $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('run.finish', $context));
         }
 
         return $exitStatus;