Merge pull request #4 from petrknap/serializer

Implemented `IgbinarySerializer`

Author: petrknap

composer.json

@@ -36,13 +36,13 @@
   "license": "LGPL-3.0-or-later",
   "name": "petrknap/binary",
   "require": {
+    "petrknap/shorts": "^1.4",
     "php": ">=8.1"
   },
   "require-dev": {
     "ext-mbstring": "*",
     "ext-zlib": "*",
     "nunomaduro/phpinsights": "^2.11",
-    "petrknap/shorts": "^1.3",
     "phpstan/phpstan": "^1.10",
     "phpunit/phpunit": "^10.5",
     "squizlabs/php_codesniffer": "^3.7"
@@ -61,6 +61,7 @@
     ]
   },
   "suggest": {
+    "ext-igbinary": "Required to serialize data via igbinary",
     "ext-mbstring": "Required to check checksum",
     "ext-zlib": "Required to compress data"
   }

src/IgbinarySerializer.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\Binary;
+
+use PetrKnap\Shorts\Exception\MissingRequirement;
+use PetrKnap\Shorts\HasRequirements;
+
+/**
+ * @link https://www.php.net/manual/en/book.igbinary.php
+ */
+final class IgbinarySerializer extends Serializer implements HasRequirements
+{
+    public function __construct(EncoderInterface $encoder, DecoderInterface $decoder)
+    {
+        self::checkRequirements();
+        parent::__construct($encoder, $decoder);
+    }
+
+    protected function doSerialize(mixed $serializable): string
+    {
+        $serialized = igbinary_serialize($serializable);
+        if ($serialized === null) {
+            throw new Exception\CouldNotSerializeData($this, $serializable);
+        }
+        return $serialized;
+    }
+
+    protected function doUnserialize(string $serialized): mixed
+    {
+        $serializable = igbinary_unserialize($serialized);
+        if ($serializable === false) {
+            throw new Exception\CouldNotUnserializeData($this, $serialized);
+        }
+        return $serializable;
+    }
+
+    public static function checkRequirements(): void
+    {
+        $functions = [
+            'igbinary_serialize',
+            'igbinary_unserialize',
+        ];
+        foreach ($functions as $function) {
+            if (!function_exists($function)) {
+                throw new MissingRequirement(self::class, 'function', $function);
+            }
+        }
+    }
+}

tests/IgbinarySerializerTest.php

@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+
+namespace PetrKnap\Binary;
+
+use PetrKnap\Shorts\Exception\MissingRequirement;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @todo add php-igbinary to Dockerfile
+ * @todo add ext-igbinary to composer.json#require-dev
+ */
+final class IgbinarySerializerTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        try {
+            IgbinarySerializer::checkRequirements();
+        } catch (MissingRequirement $reason) {
+            self::markTestSkipped($reason->getMessage());
+        }
+    }
+
+    public function testSerializesData(): void
+    {
+        SerializerTest::doTestSerializesData(
+            new IgbinarySerializer(
+                new Encoder(),
+                new Decoder(),
+            ),
+        );
+    }
+}

tests/SerializerTest.php

@@ -13,7 +13,7 @@ final class SerializerTest extends TestCase
     private SerializerInterface&MockObject $internalSerializer;
     private Serializer $serializer;
 
-    public function setUp(): void
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -44,7 +44,7 @@ protected function doUnserialize(string $serialized): mixed
         };
     }
 
-    public function testSerializesData(): void
+    public static function doTestSerializesData(SerializerInterface $serializer): void
     {
         $data = new stdClass();
         $data->array = [];
@@ -53,10 +53,6 @@ public function testSerializesData(): void
         $data->int = 0;
         $data->null = null;
         $data->string = '';
-        $serializer = new Serializer(
-            new Encoder(),
-            new Decoder(),
-        );
 
         self::assertEquals(
             $data,
@@ -68,6 +64,16 @@ public function testSerializesData(): void
         );
     }
 
+    public function testSerializesData(): void
+    {
+        self::doTestSerializesData(
+            new Serializer(
+                new Encoder(),
+                new Decoder(),
+            ),
+        );
+    }
+
     public function testCallsDoSerializeAndUsesEncoder(): void
     {
         $serializable = (string) 0b01;