#157 Adding tests and refactoring code

Author: pfwd

api/src/Markdown/FetcherInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace App\Markdown;
 
 interface FetcherInterface
@@ -8,4 +9,4 @@ interface FetcherInterface
      * @return string[]
      */
     public function fetch(string $source): array;
-}
+}

api/src/Markdown/GeneratorInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace App\Markdown;
 
 interface GeneratorInterface
@@ -14,4 +15,4 @@ public function generate(string $source): array;
      * @return array
      */
     public function process(array $filePaths): array;
-}
+}

api/src/Markdown/Model/ModelInterface.php

@@ -6,4 +6,4 @@ interface ModelInterface
 {
     public function getId(): int;
     public function getFilePath(): string;
-}
+}

api/src/Markdown/Model/Question.php

@@ -4,16 +4,15 @@
 
 class Question implements ModelInterface
 {
-
     public function __construct(
-        private readonly int   $id,
+        private readonly int $id,
         private readonly int $quizID,
         private readonly string $filePath,
         private readonly string $title,
         private readonly array $content,
         private readonly array $possibleAnswers,
-        private readonly array $correctAnswer)
-    {
+        private readonly array $correctAnswer
+    ) {
     }
 
     /**
@@ -72,6 +71,4 @@ public function getQuizID(): int
     {
         return $this->quizID;
     }
-
-
-}
+}

api/src/Markdown/Model/Quiz.php

@@ -4,13 +4,11 @@
 
 class Quiz
 {
-
     public function __construct(
-        private readonly int    $id,
+        private readonly int $id,
         private readonly string $name,
         private readonly string $filePath
-    )
-    {
+    ) {
     }
 
     /**
@@ -36,6 +34,4 @@ public function getFilePath()
     {
         return $this->filePath;
     }
-
-
-}
+}

api/src/Markdown/Parser/DocumentExtractor.php

@@ -16,7 +16,6 @@ class DocumentExtractor
 
     public function __construct(private readonly string $document)
     {
-
     }
 
     /**
@@ -25,12 +24,11 @@ public function __construct(private readonly string $document)
     public function extract(): void
     {
         $domDocument = new DOMDocument();
-        libxml_use_internal_errors(TRUE);
+        libxml_use_internal_errors(true);
         $domDocument->loadHTML($this->document);
         libxml_get_errors();
 
         $this->process($domDocument);
-
     }
 
     public function process(DOMNode $domNode): void
@@ -50,7 +48,6 @@ public function process(DOMNode $domNode): void
 
             // Get the question
             if (!$this->foundPossibleAnswers && !$this->foundCorrectAnswer) {
-
                 if ($node->nodeName !== 'body' && $node->nodeName !== 'html') {
                     $this->question[] = $node;
                 }
@@ -87,4 +84,4 @@ public function getCorrectAnswerNodes(): array
     {
         return $this->correctAnswer;
     }
-}
+}

api/src/Markdown/QuestionFetcher.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace App\Markdown;
 
 use Symfony\Component\Finder\Finder;
@@ -18,12 +19,10 @@ public function fetch(string $source): array
         $filenames = [];
         $finder = new Finder();
         $files = $finder->files()->in($folderPath)->notName('index.md');
-        foreach($files as $file){
+        foreach ($files as $file) {
             $filenames[] = $file->getFilename();
         }
 
         return $filenames;
     }
-
-
-}
+}

api/src/Markdown/QuestionGenerator.php

@@ -4,7 +4,6 @@
 
 use App\Markdown\Model\Question;
 
-
 class QuestionGenerator implements GeneratorInterface
 {
     public function __construct(private readonly FetcherInterface $fetcher)
@@ -75,4 +74,4 @@ public function process(array $filePaths): array
         }
         return $dataSets;
     }
-}
+}

api/src/Markdown/QuizFetcher.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace App\Markdown;
 
 class QuizFetcher implements FetcherInterface
@@ -10,18 +11,16 @@ class QuizFetcher implements FetcherInterface
     public function fetch(string $source): array
     {
         $fullPath = dirname(__DIR__) . '/..' . $source;
-        $directories = glob($fullPath . '/*' , GLOB_ONLYDIR);
-        if(!$directories){
+        $directories = glob($fullPath . '/*', GLOB_ONLYDIR);
+        if (!$directories) {
             return [];
         }
 
         $data = [];
-        foreach($directories as $directory){
-            $data[] = str_replace('/var/www/html/src/..',  '', $directory);
+        foreach ($directories as $directory) {
+            $data[] = str_replace('/var/www/html/src/..', '', $directory);
         }
 
         return $data;
     }
-
-
-}
+}

api/src/Markdown/QuizGenerator.php

@@ -1,12 +1,14 @@
 <?php
+
 namespace App\Markdown;
 
 use App\Markdown\Model\Quiz;
 
 class QuizGenerator implements GeneratorInterface
 {
     public function __construct(private readonly FetcherInterface $fetcher)
-    { }
+    {
+    }
 
     /**
      * @param string $source
@@ -34,7 +36,7 @@ public function generateNameFromFilePath(string $filePath): string
         $directoryLeaf = basename($filePath);
         $name = str_replace('_', ' ', $directoryLeaf);
         $firstSpace = strstr($name, ' ');
-        if($firstSpace) {
+        if ($firstSpace) {
             $name = ltrim($firstSpace, ' ');
         }
         return ucfirst($name);
@@ -56,4 +58,4 @@ public function process(array $filePaths): array
         }
         return $dataSets;
     }
-}
+}