Refactor violation handling and improve GitLab output.

Unified violation instantiation and assertion logic in tests, replacing mock-based violations with direct object creation. Simplified JSON output comparisons using `assertSame` with string literals. Updated `GitlabPrinter` to use relative paths for better clarity in output.

Author: raffaelecarelle

src/CLI/Printer/GitlabPrinter.php

@@ -4,6 +4,7 @@
 namespace Arkitect\CLI\Printer;
 
 use Arkitect\Rules\Violation;
+use Symfony\Component\Filesystem\Path;
 
 class GitlabPrinter implements Printer
 {
@@ -25,7 +26,7 @@ public function print(array $violationsCollection): string
                 $errorClassGrouped[$class][$key]['check_name'] = $class.'.'.$this->toKebabCase($violation->getError());
                 $errorClassGrouped[$class][$key]['fingerprint'] = hash('sha256', $errorClassGrouped[$class][$key]['check_name']);
                 $errorClassGrouped[$class][$key]['severity'] = 'major'; // Todo enable severity on violation
-                $errorClassGrouped[$class][$key]['location']['path'] = $this->getPathFromFqcn($fqcn);
+                $errorClassGrouped[$class][$key]['location']['path'] = Path::makeRelative($this->getPathFromFqcn($fqcn), getcwd());
 
                 if (null !== $violation->getLine()) {
                     $errorClassGrouped[$class][$key]['lines']['begin'] = $violation->getLine();

src/CLI/Printer/PrinterFactory.php

@@ -8,9 +8,9 @@ final class PrinterFactory
     public function create(string $format): Printer
     {
         switch ($format) {
-            case 'gitlab':
+            case Printer::FORMAT_GITLAB:
                 return new GitlabPrinter();
-            case 'json':
+            case Printer::FORMAT_JSON:
                 return new JsonPrinter();
             default:
                 return new TextPrinter();

tests/E2E/Cli/CheckCommandTest.php

@@ -207,18 +207,10 @@ public function test_gitlab_format_output(): void
 
         $this->assertJson($display);
 
-        $decodedResult = json_decode($display, true);
-
-        $this->assertIsString($display, 'Result should be a string');
-        $this->assertJson($display, 'Result should be a valid JSON string');
-        $this->assertCount(1, $decodedResult, 'Result should contain two violations');
-
-        $this->assertSame('should have a name that matches *Controller because all controllers should be end name with Controller', $decodedResult[0]['description']);
-        $this->assertSame('App\Controller\Foo.should-have-a-name-that-matches-controller-because-all-controllers-should-be-end-name-with-controller', $decodedResult[0]['check_name']);
-        $this->assertSame(hash('sha256', 'App\Controller\Foo.should-have-a-name-that-matches-controller-because-all-controllers-should-be-end-name-with-controller'), $decodedResult[0]['fingerprint']);
-        $this->assertSame('major', $decodedResult[0]['severity']);
-        $this->assertSame(getcwd().'/tests/E2E/_fixtures/mvc/Controller/Foo.php', $decodedResult[0]['location']['path']);
-        $this->assertSame(1, $decodedResult[0]['lines']['begin']);
+        self::assertSame(<<<JSON
+        [{"description":"should have a name that matches *Controller because all controllers should be end name with Controller","check_name":"App\\\\Controller\\\\Foo.should-have-a-name-that-matches-controller-because-all-controllers-should-be-end-name-with-controller","fingerprint":"1e960c3f49b5ec63ece40321072ef2bd0bc33ad11b7be326f304255d277dc860","severity":"major","location":{"path":"tests\/E2E\/_fixtures\/mvc\/Controller\/Foo.php"},"lines":{"begin":1}}]
+
+        JSON, $display);
     }
 
     public function test_gitlab_format_output_no_errors(): void

tests/Unit/CLI/Printer/GitlabPrinterTest.php

@@ -6,6 +6,8 @@
 use Arkitect\CLI\Printer\GitlabPrinter;
 use Arkitect\Rules\Violation;
 use PHPUnit\Framework\TestCase;
+use Some\AnotherExampleClass;
+use Some\ExampleClass;
 
 class GitlabPrinterTest extends TestCase
 {
@@ -15,15 +17,8 @@ class GitlabPrinterTest extends TestCase
      */
     public function test_print_with_violations(): void
     {
-        $violation1 = $this->createMock(Violation::class);
-        $violation1->method('getFqcn')->willReturn('Some\\ExampleClass');
-        $violation1->method('getError')->willReturn('Some error message');
-        $violation1->method('getLine')->willReturn(42);
-
-        $violation2 = $this->createMock(Violation::class);
-        $violation2->method('getFqcn')->willReturn('Another\\ExampleClass');
-        $violation2->method('getError')->willReturn('Another error message');
-        $violation2->method('getLine')->willReturn(null);
+        $violation1 = new Violation(ExampleClass::class, 'Some error message', 42);
+        $violation2 = new Violation(AnotherExampleClass::class, 'Another error message', null);
 
         $violationsCollection = [
             'RuleA' => [$violation1],
@@ -33,25 +28,10 @@ public function test_print_with_violations(): void
         $printer = new GitlabPrinter();
 
         $result = $printer->print($violationsCollection);
-        $decodedResult = json_decode($result, true);
-
-        $this->assertIsString($result, 'Result should be a string');
-        $this->assertJson($result, 'Result should be a valid JSON string');
-        $this->assertCount(2, $decodedResult, 'Result should contain two violations');
-
-        $this->assertSame('Some error message', $decodedResult[0]['description']);
-        $this->assertSame('RuleA.some-error-message', $decodedResult[0]['check_name']);
-        $this->assertSame(hash('sha256', 'RuleA.some-error-message'), $decodedResult[0]['fingerprint']);
-        $this->assertSame('major', $decodedResult[0]['severity']);
-        $this->assertSame(__DIR__.'/GitlabPrinterTest.php', $decodedResult[0]['location']['path']);
-        $this->assertSame(42, $decodedResult[0]['lines']['begin']);
 
-        $this->assertSame('Another error message', $decodedResult[1]['description']);
-        $this->assertSame('RuleB.another-error-message', $decodedResult[1]['check_name']);
-        $this->assertSame(hash('sha256', 'RuleB.another-error-message'), $decodedResult[1]['fingerprint']);
-        $this->assertSame('major', $decodedResult[1]['severity']);
-        $this->assertSame(__DIR__.'/GitlabPrinterTest.php', $decodedResult[1]['location']['path']);
-        $this->assertSame(1, $decodedResult[1]['lines']['begin']);
+        self::assertSame(<<<JSON
+        [{"description":"Some error message","check_name":"RuleA.some-error-message","fingerprint":"7ddcfd42f5f2af3d00864ef959a0327f508cb5227aedca96d919d681a5dcde4a","severity":"major","location":{"path":"tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php"},"lines":{"begin":42}},{"description":"Another error message","check_name":"RuleB.another-error-message","fingerprint":"800c2ceafbf4023e401200186ecabdfe59891c5d6670e86571e3c50339df07dc","severity":"major","location":{"path":"tests\/Unit\/CLI\/Printer\/GitlabPrinterTest.php"},"lines":{"begin":1}}]
+        JSON, $result);
     }
 
     /**
@@ -80,8 +60,6 @@ class ExampleClass
 {
 }
 
-namespace Another;
-
-class ExampleClass
+class AnotherExampleClass
 {
 }