Prepare for multiple versions of PublicCode object. (#20)

Fix #4.

Author: bfabio

README.md

@@ -69,15 +69,24 @@ $parser = new Parser();
 
 $publicCode = $parser->parseFile('/path/to/publiccode.yml');
 
-$name = $publicCode->getName();
-$url = $publicCode->getUrl();
-$landingUrl = $publicCode->getLandingUrl();
+if ($publicCode instanceof PublicCodeV0) {
+    $name = $publicCode->getName();
+    $url = $publicCode->getUrl();
+    $landingUrl = $publicCode->getLandingUrl();
 
-$descriptionIt = $publicCode->getDescription('it');
-$descriptionEn = $publicCode->getDescription('en');
-$allDescriptions = $publicCode->getAllDescriptions();
+    $descriptionIt = $publicCode->getDescription('it');
+    $descriptionEn = $publicCode->getDescription('en');
+    $allDescriptions = $publicCode->getAllDescriptions();
 
-$platforms = $publicCode->getPlatforms(); // ['web', 'android', 'ios', etc.]
+    $platforms = $publicCode->getPlatforms(); // ['web', 'android', 'ios', etc.]
+}
+
+/* In the future, when v1 will be released */
+/*
+else if ($publicCode instanceof PublicCodeV1) {
+    ...
+}
+*/
 ```
 
 ### Advanced config

phpstan.neon.dist

@@ -5,4 +5,4 @@ parameters:
         - tests
     excludePaths:
         - vendor
-        - src/PublicCode.php # TODO: re-enable it after a proper typed mapping with the Go struct
+        - src/PublicCodeV0.php # TODO: re-enable it after a proper typed mapping with the Go struct

src/Parser.php

@@ -44,11 +44,11 @@ public function __destruct()
      * Parse publiccode.yml content
      *
      * @param string $content YAML content
-     * @return PublicCode
+     * @return PublicCodeV0
      * @throws ParserException
      * @throws ValidationException
      */
-    public function parse(string $content): PublicCode
+    public function parse(string $content): PublicCodeV0
     {
         /** @phpstan-ignore-next-line */
         $result = $this->ffi->ParseString($this->handle, $content);
@@ -64,11 +64,11 @@ public function parse(string $content): PublicCode
      * Parse a publiccode.yml file
      *
      * @param string $filePath Path to publiccode.yml
-     * @return PublicCode
+     * @return PublicCodeV0
      * @throws ParserException
      * @throws ValidationException
      */
-    public function parseFile(string $filePath): PublicCode
+    public function parseFile(string $filePath): PublicCodeV0
     {
         /** @phpstan-ignore-next-line */
         $result = $this->ffi->ParseFile($this->handle, $filePath);
@@ -172,11 +172,11 @@ private function findLibrary(): string
      * Process FFI result and convert to PublicCode object
      *
      * @param mixed $result FFI ParseResult pointer
-     * @return PublicCode
+     * @return PublicCodeV0
      * @throws ValidationException
      * @throws ParserException
      */
-    private function processResult($result): PublicCode
+    private function processResult($result): PublicCodeV0
     {
         if ($result->ErrorCount > 0) {
             /** @var list<non-empty-string> */
@@ -219,6 +219,6 @@ private function processResult($result): PublicCode
             throw new ParserException('Failed to decode JSON data: ' . json_last_error_msg());
         }
 
-        return new PublicCode($data);
+        return new PublicCodeV0($data);
     }
 }

src/PublicCode.php renamed to src/PublicCodeV0.php

@@ -6,7 +6,7 @@
 
 use JsonSerializable;
 
-class PublicCode implements JsonSerializable
+class PublicCodeV0 implements JsonSerializable
 {
     private array $data;
 

tests/ParserTest.php

@@ -5,6 +5,7 @@
 namespace Bfabio\PublicCodeParser\Tests;
 
 use Bfabio\PublicCodeParser\Parser;
+use Bfabio\PublicCodeParser\PublicCodeV0;
 use PHPUnit\Framework\TestCase;
 
 class ParserTest extends TestCase
@@ -26,6 +27,13 @@ protected function setUp(): void
         $this->yaml = $content;
     }
 
+    public function testPublicCodeType(): void
+    {
+        $publicCode = $this->parser->parse($this->yaml);
+
+        $this->assertInstanceOf(PublicCodeV0::class, $publicCode);
+    }
+
     public function testPublicCodeAccessors(): void
     {
         $publicCode = $this->parser->parse($this->yaml);