#157 Adding tests and refactoring code

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;
     }
-}
+}

api/tests/unit/config/fixtures/data_fixtures/AppFixturesTest.php

@@ -27,8 +27,8 @@ protected function setUp(): void
             ->onlyMethods(['flush', 'persist'])
             ->getMockForAbstractClass();
         $this->objectManager = $objectManager;
-        
-        $appFixtures = new AppFixtures;
+
+        $appFixtures = new AppFixtures();
         $appFixtures = $this->invokeProperty($appFixtures, 'objectManager', $objectManager);
         $this->appFixtures = $appFixtures;
     }
@@ -69,7 +69,7 @@ public function testCreateQuestions()
     {
         $html = require dirname(__DIR__) . '/../../../../config/fixtures/quizzes_old/html-quiz/quiz.php';
 
-        $quiz = new Quiz;
+        $quiz = new Quiz();
         $quiz->setTitle('Test title');
         $quiz->setSlug('test-slug');
 
@@ -85,7 +85,7 @@ public function testCreateQuestions()
     public function testCreateAnswers()
     {
         $question1 = require dirname(__DIR__) . '/../../../../config/fixtures/quizzes_old/html-quiz/questions/question_1.php';
-        $question = new Question;
+        $question = new Question();
         $question->setContent('Test content');
 
         $createdAnswers = $this->appFixtures->createAnswers($question1[0]['answers'], $question);
@@ -131,7 +131,7 @@ public function testCreateQuiz()
 
     public function testCreateQuestion()
     {
-        $quiz = new Quiz;
+        $quiz = new Quiz();
         $quiz = $this->invokeProperty($quiz, 'id', 10);
 
         $data = [
@@ -148,7 +148,7 @@ public function testCreateQuestion()
 
     public function testCreateAnswer()
     {
-        $question = new Question;
+        $question = new Question();
         $question = $this->invokeProperty($question, 'id', 10);
 
         $data = [
@@ -165,4 +165,4 @@ public function testCreateAnswer()
         self::assertEquals(3, $result->getDisplayOrder());
         self::assertEquals(false, $result->getIsCorrect());
     }
-}
+}

api/tests/unit/src/Markdown/Parser/CorrectAnswerExtractorTest.php

@@ -33,6 +33,4 @@ public function testAnswerValue()
 
         self::assertSame('Answer: 5', trim($questionNodes[4]->nodeValue));
     }
-
-
 }

api/tests/unit/src/Markdown/Parser/PossibleAnswerExtractorTest.php

@@ -58,7 +58,7 @@ public function testLastPossibleAnswerValue()
         $parser = new DocumentExtractor($this->document);
         $parser->extract();
         $nodes = $parser->getPossibleAnswerNodes();
-        $lastIndex = count($nodes) -1;
+        $lastIndex = count($nodes) - 1;
 
         self::assertSame('[ ] 5', $nodes[$lastIndex]->nodeValue);
     }
@@ -68,7 +68,7 @@ public function testLastPossibleAnswerElement()
         $parser = new DocumentExtractor($this->document);
         $parser->extract();
         $nodes = $parser->getPossibleAnswerNodes();
-        $lastIndex = count($nodes) -1;
+        $lastIndex = count($nodes) - 1;
 
         self::assertSame('li', $nodes[$lastIndex]->nodeName);
     }

api/tests/unit/src/Markdown/Parser/QuestionExtractorTest.php

@@ -40,7 +40,7 @@ public function testLastQuestionElement()
         $parser = new DocumentExtractor($this->document);
         $parser->extract();
         $questionNodes = $parser->getQuestionNodes();
-        $count = count($questionNodes) -1;
+        $count = count($questionNodes) - 1;
 
         self::assertSame('code', $questionNodes[$count]->nodeName);
     }
@@ -50,7 +50,7 @@ public function testLastQuestionValue()
         $parser = new DocumentExtractor($this->document);
         $parser->extract();
         $questionNodes = $parser->getQuestionNodes();
-        $count = count($questionNodes) -1;
+        $count = count($questionNodes) - 1;
 
         self::assertSame('<?php echo "hello world";', $questionNodes[$count]->nodeValue);
     }

api/tests/unit/src/Markdown/QuestionFetcherTest.php

@@ -15,7 +15,5 @@ public function testFetchQuestion()
         $expected = '1_1_padding_properties.md';
 
         self::assertContains($expected, $data);
-
     }
-
 }

api/tests/unit/src/Markdown/QuestionGeneratorTest.php

@@ -60,5 +60,4 @@ public function testGeneratedTitle()
 
         self::assertSame('Style override', $question2->getTitle());
     }
-
 }

api/tests/unit/src/Markdown/QuestionIDGeneratorTest.php

@@ -39,5 +39,4 @@ public function testGetQuestionIDWithIncorrectValueType()
         $questionID = $generator->getIDFromFilePath('1_two.md', false);
         self::assertFalse($questionID);
     }
-
 }

api/tests/unit/src/Markdown/QuestionQuizIDGeneratorTest.php

@@ -39,5 +39,4 @@ public function testGetQuestionIDWithIncorrectValueType()
         $ID = $generator->getIDFromFilePath('one_2.md');
         self::assertFalse($ID);
     }
-
 }

api/tests/unit/src/Markdown/QuestionTitleGeneratorTest.php

@@ -23,5 +23,4 @@ public function testGetQuestionTitleWithNoTitleValue()
         $title = $generator->getTitleFromFilePath('1.md');
         self::assertFalse($title);
     }
-
 }

api/tests/unit/src/Markdown/QuizFetcherTest.php

@@ -31,7 +31,5 @@ public function testFetchQuizzes()
         $expected = '/config/fixtures/quizzes/1_CSS_Quiz';
 
         self::assertContains($expected, $data);
-
     }
-
 }

api/tests/unit/src/Markdown/QuizGeneratorTest.php

@@ -12,7 +12,6 @@
 
 class QuizGeneratorTest extends TestCase
 {
-
     public function testGenerateIDFromFilePath()
     {
 //        $document = '<p>This is a test</p><p>This is another test</p>';
@@ -22,5 +21,4 @@ public function testGenerateIDFromFilePath()
 //        $id = $generator->generateIDFromFilePath($filePath);
         self::assertSame(1, 1);
     }
-
 }