Merge pull request #264 from php-school/entrypoint-returns-solutionfile

getEntryPoint now returns a SolutionFile instance

Author: AydinHassan

src/ExerciseRunner/CgiRunner.php

@@ -121,7 +121,7 @@ private function checkRequest(RequestInterface $request, string $fileName): CgiR
                 new CgiExecuteEvent('cgi.verify.reference-execute.pre', $request)
             );
             $solutionResponse = $this->executePhpFile(
-                $this->exercise->getSolution()->getEntryPoint(),
+                $this->exercise->getSolution()->getEntryPoint()->getAbsolutePath(),
                 $event->getRequest(),
                 'reference'
             );

src/ExerciseRunner/CliRunner.php

@@ -205,7 +205,7 @@ private function doVerify(array $args, Input $input): CliResultInterface
             /** @var CliExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(new CliExecuteEvent('cli.verify.reference-execute.pre', $args));
             $solutionOutput = $this->executePhpFile(
-                $this->exercise->getSolution()->getEntryPoint(),
+                $this->exercise->getSolution()->getEntryPoint()->getAbsolutePath(),
                 $event->getArgs(),
                 'reference'
             );

src/Listener/CodePatchListener.php

@@ -57,7 +57,7 @@ public function patch(ExerciseRunnerEvent $event): void
 
         $exercise = $event->getExercise();
         if ($exercise instanceof ProvidesSolution) {
-            $files[] = $exercise->getSolution()->getEntryPoint();
+            $files[] = $exercise->getSolution()->getEntryPoint()->getAbsolutePath();
         }
 
         foreach (array_filter($files) as $fileName) {

src/Solution/DirectorySolution.php

@@ -16,7 +16,7 @@
 class DirectorySolution implements SolutionInterface
 {
     /**
-     * @var string
+     * @var SolutionFile
      */
     private $entryPoint;
 
@@ -72,7 +72,9 @@ public function __construct(string $directory, string $entryPoint, array $exclus
             return new SolutionFile($file, $directory);
         }, $files);
 
-        $this->entryPoint    = sprintf('%s/%s', $directory, $entryPoint);
+        $this->entryPoint = array_values(array_filter($this->files, function (SolutionFile $file) use ($entryPoint) {
+            return $file->getRelativePath() === $entryPoint;
+        }))[0];
         $this->baseDirectory = $directory;
     }
 
@@ -92,11 +94,11 @@ public static function fromDirectory(string $directory, array $exclusions = [],
 
     /**
      * Get the entry point. This is the PHP file that PHO would execute in order to run the
-     * program. This should be the absolute path.
+     * program.
      *
-     * @return string
+     * @return SolutionFile
      */
-    public function getEntryPoint(): string
+    public function getEntryPoint(): SolutionFile
     {
         return $this->entryPoint;
     }

src/Solution/SingleFileSolution.php

@@ -43,13 +43,13 @@ public static function fromFile(string $file): self
 
     /**
      * Get the entry point. This is the PHP file that php would execute in order to run the
-     * program. This should be the absolute path.
+     * program.
      *
-     * @return string
+     * @return SolutionFile
      */
-    public function getEntryPoint(): string
+    public function getEntryPoint(): SolutionFile
     {
-        return $this->file->__toString();
+        return $this->file;
     }
 
     /**

src/Solution/SolutionInterface.php

@@ -11,11 +11,11 @@ interface SolutionInterface
 {
     /**
      * Get the entry point. This is the PHP file that php would execute in order to run the
-     * program. This should be the absolute path.
+     * program.
      *
-     * @return string
+     * @return SolutionFile
      */
-    public function getEntryPoint(): string;
+    public function getEntryPoint(): SolutionFile;
 
     /**
      * Get all the files which are contained with the solution.

test/Listener/CodePatchListenerTest.php

@@ -113,7 +113,7 @@ public function testPatchesProvidedSolution(): void
         $listener->patch($event);
 
         self::assertStringEqualsFile($this->file, 'MODIFIED CONTENT');
-        self::assertStringEqualsFile($exercise->getSolution()->getEntryPoint(), 'MODIFIED CONTENT');
+        self::assertStringEqualsFile($exercise->getSolution()->getEntryPoint()->getAbsolutePath(), 'MODIFIED CONTENT');
     }
 
     public function testFileIsLoggedWhenPatches(): void