feat: stringable coder

Author: petrknap

README.md

@@ -7,8 +7,8 @@ See the examples below for more information, or check out [`Encoder`](./src/Enco
 namespace PetrKnap\Binary;
 
 $data = base64_decode('hmlpFnFwbchsoQARSibVpfbWVfuwAHLbGxjFl9eC8fiGaWkWcXBtyGyhABFKJtWl9tZV+7AActsbGMWX14Lx+A==');
-$encoded = Binary::encode($data)->checksum()->zlib()->base64(urlSafe: true)->getData();
-$decoded = Binary::decode($encoded)->base64()->zlib()->checksum()->getData();
+$encoded = Binary::encode($data)->checksum()->zlib()->base64(urlSafe: true)->data;
+$decoded = Binary::decode($encoded)->base64()->zlib()->checksum()->data;
 
 printf('Data was coded into `%s` %s.', $encoded, $decoded === $data ? 'successfully' : 'unsuccessfully');
 ```

src/Coder.php

@@ -5,6 +5,7 @@
 namespace PetrKnap\Binary;
 
 use PetrKnap\Shorts\Exception;
+use Stringable;
 
 /**
  * @internal please use subclass
@@ -13,10 +14,13 @@
  *
  * @implements CoderInterface<Exception\CouldNotProcessData>
  */
-abstract class Coder implements CoderInterface
+abstract class Coder implements CoderInterface, Stringable
 {
-    public function __construct(
-        protected readonly string $data = '',
+    /**
+     * @param string $data may contain binary data
+     */
+    final public function __construct(
+        public readonly string $data = '',
     ) {
     }
 
@@ -25,7 +29,18 @@ public function withData(string $data): static
         return static::create($this, $data);
     }
 
-    public function getData(): string
+    /**
+     * @deprecated use readonly property {@see self::$data}
+     */
+    final public function getData(): string
+    {
+        return $this->data;
+    }
+
+    /**
+     * @note this is just a helper, this class is not supposed to implement {@see BinariableInterface}
+     */
+    public function __toString(): string
     {
         return $this->data;
     }

tests/DecoderTest.php

@@ -12,31 +12,31 @@ public function testDecodesBase64(): void
     {
         self::assertSame(
             Coder\Base64Test::getDecodedData(),
-            (new Decoder(Coder\Base64Test::getEncodedData()))->base64()->getData(),
+            (new Decoder(Coder\Base64Test::getEncodedData()))->base64()->data,
         );
     }
 
     public function testDecodesChecksum(): void
     {
         self::assertSame(
             Coder\ChecksumTest::getDecodedData(),
-            (new Decoder(Coder\ChecksumTest::getEncodedData()))->checksum()->getData(),
+            (new Decoder(Coder\ChecksumTest::getEncodedData()))->checksum()->data,
         );
     }
 
     public function testDecodesHex(): void
     {
         self::assertSame(
             Coder\HexTest::getDecodedData(),
-            (new Decoder(Coder\HexTest::getEncodedData()))->hex()->getData(),
+            (new Decoder(Coder\HexTest::getEncodedData()))->hex()->data,
         );
     }
 
     public function testDecodesZlib(): void
     {
         self::assertSame(
             Coder\ZlibTest::getDecodedData(),
-            (new Decoder(Coder\ZlibTest::getEncodedData()))->zlib()->getData(),
+            (new Decoder(Coder\ZlibTest::getEncodedData()))->zlib()->data,
         );
     }
 }

tests/EncoderTest.php

@@ -12,31 +12,31 @@ public function testEncodesBase64(): void
     {
         self::assertSame(
             Coder\Base64Test::getEncodedData(),
-            (new Encoder(Coder\Base64Test::getDecodedData()))->base64()->getData(),
+            (new Encoder(Coder\Base64Test::getDecodedData()))->base64()->data,
         );
     }
 
     public function testEncodesChecksum(): void
     {
         self::assertSame(
             Coder\ChecksumTest::getEncodedData(),
-            (new Encoder(Coder\ChecksumTest::getDecodedData()))->checksum()->getData(),
+            (new Encoder(Coder\ChecksumTest::getDecodedData()))->checksum()->data,
         );
     }
 
     public function testEncodesHex(): void
     {
         self::assertSame(
             Coder\HexTest::getEncodedData(),
-            (new Encoder(Coder\HexTest::getDecodedData()))->hex()->getData(),
+            (new Encoder(Coder\HexTest::getDecodedData()))->hex()->data,
         );
     }
 
     public function testEncodesZlib(): void
     {
         self::assertSame(
             Coder\ZlibTest::getEncodedData(),
-            (new Encoder(Coder\ZlibTest::getDecodedData()))->zlib()->getData(),
+            (new Encoder(Coder\ZlibTest::getDecodedData()))->zlib()->data,
         );
     }
 }