Refactor listeners to use Input object

Author: AydinHassan

src/ExerciseCheck/SelfCheck.php

@@ -2,6 +2,7 @@
 
 namespace PhpSchool\PhpWorkshop\ExerciseCheck;
 
+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 string $fileName The absolute path to the student's solution.
+     * @param Input $input The command line arguments passed to the command.
      * @return ResultInterface The result of the check.
      */
-    public function check($fileName);
+    public function check(Input $input);
 }

src/Listener/CodePatchListener.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\PhpWorkshop\CodePatcher;
 use PhpSchool\PhpWorkshop\Event\Event;
+use PhpSchool\PhpWorkshop\Input\Input;
 use RuntimeException;
 
 /**
@@ -37,7 +38,10 @@ public function __construct(CodePatcher $codePatcher)
      */
     public function patch(Event $event)
     {
-        $fileName           = $event->getParameter('fileName');
+        /** @var Input $input */
+        $input = $event->getParameter('input');
+        $fileName = $input->getArgument('program');
+
         $this->originalCode = file_get_contents($fileName);
         file_put_contents(
             $fileName,
@@ -54,6 +58,10 @@ public function revert(Event $event)
             throw new RuntimeException('Can only revert previously patched code');
         }
 
-        file_put_contents($event->getParameter('fileName'), $this->originalCode);
+        /** @var Input $input */
+        $input = $event->getParameter('input');
+        $fileName = $input->getArgument('program');
+
+        file_put_contents($fileName, $this->originalCode);
     }
 }

src/Listener/PrepareSolutionListener.php

@@ -3,7 +3,6 @@
 namespace PhpSchool\PhpWorkshop\Listener;
 
 use PhpSchool\PhpWorkshop\Event\Event;
-use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use RuntimeException;
 use Symfony\Component\Process\Process;
 

src/Listener/SelfCheckListener.php

@@ -34,7 +34,7 @@ public function __invoke(Event $event)
         $exercise = $event->getParameter('exercise');
 
         if ($exercise instanceof SelfCheck) {
-            $this->results->add($exercise->check($event->getParameter('fileName')));
+            $this->results->add($exercise->check($event->getParameter('input')));
         }
     }
 }

test/Listener/CodePatchListenerTest.php

@@ -5,6 +5,7 @@
 use PhpSchool\PhpWorkshop\CodePatcher;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Input\Input;
 use PhpSchool\PhpWorkshop\Listener\CodePatchListener;
 use PHPUnit_Framework_TestCase;
 use RuntimeException;
@@ -44,11 +45,11 @@ public function setUp()
 
     public function testRevertThrowsExceptionIfPatchNotPreviouslyCalled()
     {
-        $fileName = $this->file;
+        $input    = new Input('app', ['program' => $this->file]);
         $exercise = $this->createMock(ExerciseInterface::class);
 
         $listener   = new CodePatchListener($this->codePatcher);
-        $event      = new Event('event', compact('exercise', 'fileName'));
+        $event      = new Event('event', compact('exercise', 'input'));
 
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage('Can only revert previously patched code');
@@ -59,7 +60,7 @@ public function testPatchUpdatesCode()
     {
         file_put_contents($this->file, 'ORIGINAL CONTENT');
 
-        $fileName = $this->file;
+        $input    = new Input('app', ['program' => $this->file]);
         $exercise = $this->createMock(ExerciseInterface::class);
 
         $this->codePatcher
@@ -69,7 +70,7 @@ public function testPatchUpdatesCode()
             ->will($this->returnValue('MODIFIED CONTENT'));
 
         $listener   = new CodePatchListener($this->codePatcher);
-        $event      = new Event('event', compact('exercise', 'fileName'));
+        $event      = new Event('event', compact('exercise', 'input'));
         $listener->patch($event);
 
         $this->assertStringEqualsFile($this->file, 'MODIFIED CONTENT');
@@ -79,7 +80,7 @@ public function testRevertAfterPatch()
     {
         file_put_contents($this->file, 'ORIGINAL CONTENT');
 
-        $fileName = $this->file;
+        $input    = new Input('app', ['program' => $this->file]);
         $exercise = $this->createMock(ExerciseInterface::class);
 
         $this->codePatcher
@@ -89,7 +90,7 @@ public function testRevertAfterPatch()
             ->will($this->returnValue('MODIFIED CONTENT'));
 
         $listener   = new CodePatchListener($this->codePatcher);
-        $event      = new Event('event', compact('exercise', 'fileName'));
+        $event      = new Event('event', compact('exercise', 'input'));
         $listener->patch($event);
         $listener->revert($event);
 

test/Listener/SelfCheckListenerTest.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Input\Input;
 use PhpSchool\PhpWorkshop\Listener\SelfCheckListener;
 use PhpSchool\PhpWorkshop\Result\Success;
 use PhpSchool\PhpWorkshop\ResultAggregator;
@@ -20,13 +21,14 @@ class SelfCheckListenerTest extends PHPUnit_Framework_TestCase
     public function testSelfCheck()
     {
         $exercise = $this->createMock(SelfCheckExerciseInterface::class);
-        $event = new Event('event', ['exercise' => $exercise, 'fileName' => 'some-file.php']);
+        $input    = new Input('app', ['program' => 'some-file.php']);
+        $event    = new Event('event', compact('exercise', 'input'));
 
         $success = new Success('Success');
         $exercise
             ->expects($this->once())
             ->method('check')
-            ->with('some-file.php')
+            ->with($input)
             ->will($this->returnValue($success));
 
         $results = new ResultAggregator;
@@ -40,7 +42,8 @@ public function testSelfCheck()
     public function testExerciseWithOutSelfCheck()
     {
         $exercise = $this->createMock(ExerciseInterface::class);
-        $event = new Event('event', ['exercise' => $exercise, 'fileName' => 'some-file.php']);
+        $input    = new Input('app', ['program' => 'some-file.php']);
+        $event    = new Event('event', compact('exercise', 'input'));
 
         $results = new ResultAggregator;
         $listener = new SelfCheckListener($results);