New interface Normalizable

Spomky-Labs · Sep 28, 2021 · 3598c8c · 3598c8c
1 parent 95eb39c
commit 3598c8c
Show file tree

Hide file tree

Showing 43 changed files with 823 additions and 165 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -32,6 +32,6 @@ parameters:
             count: 1
             path: src/Tag/TimestampTag.php
         -
-            message: '#Method CBOR\\OtherObject\\NullObject\:\:getNormalizedData\(\) should return mixed but return statement is missing\.#'
+            message: '#Method CBOR\\OtherObject\\NullObject\:\:normalize\(\) should return mixed but return statement is missing\.#'
             count: 1
             path: src/OtherObject/NullObject.php
diff --git a/src/ByteStringObject.php b/src/ByteStringObject.php
@@ -13,7 +13,7 @@
 
 namespace CBOR;
 
-final class ByteStringObject extends AbstractCBORObject
+final class ByteStringObject extends AbstractCBORObject implements Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_BYTE_STRING;
 
@@ -62,11 +62,16 @@ public function getLength(): int
         return mb_strlen($this->value, '8bit');
     }
 
+    public function normalize(): string
+    {
+        return $this->value;
+    }
+
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      */
     public function getNormalizedData(bool $ignoreTags = false): string
     {
-        return $this->value;
+        return $this->normalize();
     }
 }
diff --git a/src/CBORObject.php b/src/CBORObject.php
@@ -67,7 +67,7 @@ public function getMajorType(): int;
     public function getAdditionalInformation(): int;
 
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      *
      * @return mixed|null
      */

diff --git a/src/IndefiniteLengthByteStringObject.php b/src/IndefiniteLengthByteStringObject.php
@@ -16,7 +16,7 @@
 /**
  * @final
  */
-class IndefiniteLengthByteStringObject extends AbstractCBORObject
+class IndefiniteLengthByteStringObject extends AbstractCBORObject implements Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_BYTE_STRING;
     private const ADDITIONAL_INFORMATION = self::LENGTH_INDEFINITE;
@@ -81,16 +81,21 @@ public function getLength(): int
         return $length;
     }
 
-    /**
-     * @deprecated The method will be removed on v3.0. No replacement
-     */
-    public function getNormalizedData(bool $ignoreTags = false): string
+    public function normalize(): string
     {
         $result = '';
         foreach ($this->chunks as $chunk) {
-            $result .= $chunk->getNormalizedData($ignoreTags);
+            $result .= $chunk->normalize();
         }
 
         return $result;
     }
+
+    /**
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
+     */
+    public function getNormalizedData(bool $ignoreTags = false): string
+    {
+        return $this->normalize();
+    }
 }
diff --git a/src/IndefiniteLengthListObject.php b/src/IndefiniteLengthListObject.php
@@ -23,7 +23,7 @@
  * @phpstan-implements IteratorAggregate<int, CBORObject>
  * @final
  */
-class IndefiniteLengthListObject extends AbstractCBORObject implements Countable, IteratorAggregate
+class IndefiniteLengthListObject extends AbstractCBORObject implements Countable, IteratorAggregate, Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_LIST;
     private const ADDITIONAL_INFORMATION = self::LENGTH_INDEFINITE;
@@ -55,15 +55,23 @@ public function __toString(): string
     }
 
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @return mixed[]
+     */
+    public function normalize(): array
+    {
+        return array_map(static function (CBORObject $object) {
+            return $object instanceof Normalizable ? $object->normalize() : $object;
+        }, $this->data);
+    }
+
+    /**
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      *
      * @return mixed[]
      */
     public function getNormalizedData(bool $ignoreTags = false): array
     {
-        return array_map(static function (CBORObject $item) use ($ignoreTags) {
-            return $item->getNormalizedData($ignoreTags);
-        }, $this->data);
+        return $this->normalize();
     }
 
     public function add(CBORObject $item): self

diff --git a/src/IndefiniteLengthMapObject.php b/src/IndefiniteLengthMapObject.php
@@ -16,14 +16,15 @@
 use ArrayIterator;
 use function count;
 use Countable;
+use InvalidArgumentException;
 use Iterator;
 use IteratorAggregate;
 
 /**
  * @phpstan-implements IteratorAggregate<int, MapItem>
  * @final
  */
-class IndefiniteLengthMapObject extends AbstractCBORObject implements Countable, IteratorAggregate
+class IndefiniteLengthMapObject extends AbstractCBORObject implements Countable, IteratorAggregate, Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_MAP;
     private const ADDITIONAL_INFORMATION = self::LENGTH_INDEFINITE;
@@ -79,17 +80,30 @@ public function getIterator(): Iterator
     }
 
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
-     *
      * @return mixed[]
      */
-    public function getNormalizedData(bool $ignoreTags = false): array
+    public function normalize(): array
     {
         $result = [];
         foreach ($this->data as $object) {
-            $result[$object->getKey()->getNormalizedData($ignoreTags)] = $object->getValue()->getNormalizedData($ignoreTags);
+            $keyObject = $object->getKey();
+            if (!$keyObject instanceof Normalizable) {
+                throw new InvalidArgumentException('Invalid key. Shall be normalizable');
+            }
+            $valueObject = $object->getValue();
+            $result[$keyObject->normalize()] = $valueObject instanceof Normalizable ? $valueObject->normalize() : $object;
         }
 
         return $result;
     }
+
+    /**
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
+     *
+     * @return mixed[]
+     */
+    public function getNormalizedData(bool $ignoreTags = false): array
+    {
+        return $this->normalize();
+    }
 }
diff --git a/src/IndefiniteLengthTextStringObject.php b/src/IndefiniteLengthTextStringObject.php
@@ -16,7 +16,7 @@
 /**
  * @final
  */
-class IndefiniteLengthTextStringObject extends AbstractCBORObject
+class IndefiniteLengthTextStringObject extends AbstractCBORObject implements Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_TEXT_STRING;
     private const ADDITIONAL_INFORMATION = self::LENGTH_INDEFINITE;
@@ -81,16 +81,21 @@ public function getLength(): int
         return $length;
     }
 
-    /**
-     * @deprecated The method will be removed on v3.0. No replacement
-     */
-    public function getNormalizedData(bool $ignoreTags = false): string
+    public function normalize(): string
     {
         $result = '';
         foreach ($this->data as $object) {
-            $result .= $object->getNormalizedData($ignoreTags);
+            $result .= $object->normalize();
         }
 
         return $result;
     }
+
+    /**
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
+     */
+    public function getNormalizedData(bool $ignoreTags = false): string
+    {
+        return $this->normalize();
+    }
 }
diff --git a/src/ListObject.php b/src/ListObject.php
@@ -24,7 +24,7 @@
 /**
  * @phpstan-implements IteratorAggregate<int, CBORObject>
  */
-class ListObject extends AbstractCBORObject implements Countable, IteratorAggregate
+class ListObject extends AbstractCBORObject implements Countable, IteratorAggregate, Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_LIST;
 
@@ -93,16 +93,21 @@ public function get(int $index): CBORObject
         return $this->data[$index];
     }
 
+    public function normalize(): array
+    {
+        return array_map(static function (CBORObject $object) {
+            return $object instanceof Normalizable ? $object->normalize() : $object;
+        }, $this->data);
+    }
+
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      *
      * @return array<int|string, mixed>
      */
     public function getNormalizedData(bool $ignoreTags = false): array
     {
-        return array_map(static function (CBORObject $item) use ($ignoreTags) {
-            return $item->getNormalizedData($ignoreTags);
-        }, $this->data);
+        return $this->normalize();
     }
 
     public function count(): int

diff --git a/src/MapObject.php b/src/MapObject.php
@@ -23,7 +23,7 @@
 /**
  * @phpstan-implements IteratorAggregate<int, MapItem>
  */
-final class MapObject extends AbstractCBORObject implements Countable, IteratorAggregate
+final class MapObject extends AbstractCBORObject implements Countable, IteratorAggregate, Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_MAP;
 
@@ -97,18 +97,28 @@ public function getIterator(): Iterator
         return new ArrayIterator($this->data);
     }
 
-    /**
-     * @deprecated The method will be removed on v3.0. No replacement
-     *
-     * @return array<int|string, mixed>
-     */
-    public function getNormalizedData(bool $ignoreTags = false): array
+    public function normalize(): array
     {
         $result = [];
         foreach ($this->data as $object) {
-            $result[$object->getKey()->getNormalizedData($ignoreTags)] = $object->getValue()->getNormalizedData($ignoreTags);
+            $keyObject = $object->getKey();
+            if (!$keyObject instanceof Normalizable) {
+                throw new InvalidArgumentException('Invalid key. Shall be normalizable');
+            }
+            $valueObject = $object->getValue();
+            $result[$keyObject->normalize()] = $valueObject instanceof Normalizable ? $valueObject->normalize() : $object;
         }
 
         return $result;
     }
+
+    /**
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
+     *
+     * @return array<int|string, mixed>
+     */
+    public function getNormalizedData(bool $ignoreTags = false): array
+    {
+        return $this->normalize();
+    }
 }
diff --git a/src/NegativeIntegerObject.php b/src/NegativeIntegerObject.php
@@ -19,7 +19,7 @@
 /**
  * @final
  */
-class NegativeIntegerObject extends AbstractCBORObject
+class NegativeIntegerObject extends AbstractCBORObject implements Normalizable
 {
     private const MAJOR_TYPE = self::MAJOR_TYPE_NEGATIVE_INTEGER;
 
@@ -73,12 +73,17 @@ public function getValue(): string
         return $minusOne->minus($result)->toBase(10);
     }
 
+    public function normalize(): string
+    {
+        return $this->getValue();
+    }
+
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      */
     public function getNormalizedData(bool $ignoreTags = false): string
     {
-        return $this->getValue();
+        return $this->normalize();
     }
 
     private static function createBigInteger(BigInteger $integer): self

diff --git a/src/Normalizable.php b/src/Normalizable.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018-2020 Spomky-Labs
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license.  See the LICENSE file for details.
+ */
+
+namespace CBOR;
+
+interface Normalizable
+{
+    /**
+     * @return mixed|null
+     */
+    public function normalize();
+}
diff --git a/src/OtherObject/BreakObject.php b/src/OtherObject/BreakObject.php
@@ -38,7 +38,7 @@ public static function createFromLoadedData(int $additionalInformation, ?string
     }
 
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      */
     public function getNormalizedData(bool $ignoreTags = false): bool
     {

diff --git a/src/OtherObject/DoublePrecisionFloatObject.php b/src/OtherObject/DoublePrecisionFloatObject.php
@@ -14,11 +14,12 @@
 namespace CBOR\OtherObject;
 
 use Brick\Math\BigInteger;
+use CBOR\Normalizable;
 use CBOR\OtherObject as Base;
 use CBOR\Utils;
 use InvalidArgumentException;
 
-final class DoublePrecisionFloatObject extends Base
+final class DoublePrecisionFloatObject extends Base implements Normalizable
 {
     public static function supportedAdditionalInformation(): array
     {
@@ -40,20 +41,28 @@ public static function create(string $value): self
     }
 
     /**
-     * @deprecated The method will be removed on v3.0. No replacement
+     * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
      */
     public function getNormalizedData(bool $ignoreTags = false)
     {
-        $exp = $this->getExponent();
-        $mant = $this->getMantissa();
+        return $this->normalize();
+    }
+
+    /**
+     * @return float|int
+     */
+    public function normalize()
+    {
+        $exponent = $this->getExponent();
+        $mantissa = $this->getMantissa();
         $sign = $this->getSign();
 
-        if (0 === $exp) {
-            $val = $mant * 2 ** (-(1022 + 52));
-        } elseif (0b11111111111 !== $exp) {
-            $val = ($mant + (1 << 52)) * 2 ** ($exp - (1023 + 52));
+        if (0 === $exponent) {
+            $val = $mantissa * 2 ** (-(1022 + 52));
+        } elseif (0b11111111111 !== $exponent) {
+            $val = ($mantissa + (1 << 52)) * 2 ** ($exponent - (1023 + 52));
         } else {
-            $val = 0 === $mant ? INF : NAN;
+            $val = 0 === $mantissa ? INF : NAN;
         }
 
         return $sign * $val;
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         /**
-         * @deprecated The method will be removed on v3.0. No replacement
+         * @deprecated The method will be removed on v3.0. Please use CBOR\Normalizable interface
          */
         public function getNormalizedData(bool $ignoreTags = false): bool
         {
@@ Expand Down @@