Dispatch event when an exercise is selected

Author: AydinHassan

src/Exercise/AbstractExercise.php

@@ -41,7 +41,7 @@ public function getSolution()
                 sprintf(
                     '%s/../../exercises/%s/solution/solution.php',
                     dirname((new ReflectionClass(static::class))->getFileName()),
-                    $this->normaliseName($this->getName())
+                    self::normaliseName($this->getName())
                 )
             )
         );
@@ -55,7 +55,7 @@ public function getSolution()
      */
     public function getProblem()
     {
-        $name = $this->normaliseName($this->getName());
+        $name = self::normaliseName($this->getName());
         $dir  = dirname((new ReflectionClass(static::class))->getFileName());
         return sprintf('%s/../../exercises/%s/problem/problem.md', $dir, $name);
     }
@@ -74,7 +74,7 @@ public function tearDown()
      * @param string $name
      * @return string
      */
-    private function normaliseName($name)
+    public static function normaliseName($name)
     {
         return preg_replace('/[^A-Za-z\-]+/', '', str_replace(' ', '-', strtolower($name)));
     }

src/Factory/MenuFactory.php

@@ -9,6 +9,9 @@
 use PhpSchool\PhpWorkshop\Command\CreditsCommand;
 use PhpSchool\PhpWorkshop\Command\HelpCommand;
 use PhpSchool\PhpWorkshop\Command\MenuCommandInvoker;
+use PhpSchool\PhpWorkshop\Event\Event;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
+use PhpSchool\PhpWorkshop\Exercise\AbstractExercise;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\ExerciseRenderer;
 use PhpSchool\PhpWorkshop\ExerciseRepository;
@@ -34,6 +37,7 @@ public function __invoke(ContainerInterface $c)
         $userState              = $userStateSerializer->deSerialize();
         $exerciseRenderer       = $c->get(ExerciseRenderer::class);
         $workshopType           = $c->get(WorkshopType::class);
+        $eventDispatcher        = $c->get(EventDispatcher::class);
 
         $builder = (new CliMenuBuilder)
             ->addLineBreak();
@@ -48,9 +52,13 @@ public function __invoke(ContainerInterface $c)
             ->addStaticItem('Exercises')
             ->addStaticItem('---------')
             ->addItems(
-                array_map(function (ExerciseInterface $exercise) use ($exerciseRenderer, $userState, $workshopType) {
+                array_map(function (ExerciseInterface $exercise) use ($exerciseRenderer, $userState, $workshopType, $eventDispatcher) {
                     return [
                         $exercise->getName(),
+                        function (CliMenu $menu) use ($exerciseRenderer, $eventDispatcher, $exercise) {
+                            $this->dispatchExerciseSelectedEvent($eventDispatcher, $exercise);
+                            $exerciseRenderer->__invoke($menu);
+                        },
                         $exerciseRenderer,
                         $userState->completedExercise($exercise->getName()),
                         $this->isExerciseDisabled($exercise, $userState, $workshopType)
@@ -121,4 +129,20 @@ private function isExerciseDisabled(ExerciseInterface $exercise, UserState $user
         $previous = $exercise;
         return true;
     }
+
+    /**
+     * @param EventDispatcher $eventDispatcher
+     * @param ExerciseInterface $exercise
+     */
+    private function dispatchExerciseSelectedEvent(EventDispatcher $eventDispatcher, ExerciseInterface $exercise)
+    {
+        $eventDispatcher->dispatch(
+            new Event(
+                sprintf(
+                    'exercise.selected.%s',
+                    AbstractExercise::normaliseName($exercise->getName())
+                )
+            )
+        );
+    }
 }

test/Factory/MenuFactoryTest.php

@@ -6,6 +6,7 @@
 use PhpSchool\CliMenu\CliMenu;
 use PhpSchool\PhpWorkshop\Command\CreditsCommand;
 use PhpSchool\PhpWorkshop\Command\HelpCommand;
+use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\ExerciseRenderer;
 use PhpSchool\PhpWorkshop\ExerciseRepository;
@@ -53,7 +54,8 @@ public function testFactoryReturnsInstance()
             'bgColour'      => 'black',
             'fgColour'      => 'green',
             'workshopTitle' => 'TITLE',
-            WorkshopType::class => WorkshopType::STANDARD()
+            WorkshopType::class => WorkshopType::STANDARD(),
+            EventDispatcher::class => $this->createMock(EventDispatcher::class),
         ];
 
         $container