Replaced Generator with iterator. Renamed map to dictionary in unpacker.

Author: stefanak-michal

src/PackStream/IPacker.php

@@ -2,8 +2,6 @@
 
 namespace Bolt\PackStream;
 
-use Generator;
-
 /**
  * Interface IPacker
  *
@@ -16,7 +14,7 @@ interface IPacker
     /**
      * @param $signature
      * @param mixed ...$params
-     * @return Generator
+     * @return iterable
      */
-    public function pack($signature, ...$params): Generator;
+    public function pack($signature, ...$params): iterable;
 }

src/PackStream/v1/Packer.php

@@ -5,7 +5,6 @@
 use Bolt\PackStream\IPacker;
 use Bolt\error\PackException;
 use Bolt\PackStream\{IPackListGenerator, IPackDictionaryGenerator};
-use Generator;
 use Bolt\structures\{
     IStructure,
     Date,
@@ -52,10 +51,10 @@ class Packer implements IPacker
      * Pack message with parameters
      * @param $signature
      * @param mixed ...$params
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    public function pack($signature, ...$params): Generator
+    public function pack($signature, ...$params): iterable
     {
         $this->littleEndian = unpack('S', "\x01\x00")[1] === 1;
 
@@ -91,9 +90,10 @@ public function pack($signature, ...$params): Generator
 
     /**
      * @param mixed $param
+     * @return iterable
      * @throws PackException
      */
-    private function p($param): Generator
+    private function p($param): iterable
     {
         switch (gettype($param)) {
             case 'integer':
@@ -139,10 +139,10 @@ private function p($param): Generator
 
     /**
      * @param string $str
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packString(string $str): Generator
+    private function packString(string $str): iterable
     {
         $length = mb_strlen($str, '8bit');
 
@@ -161,20 +161,20 @@ private function packString(string $str): Generator
 
     /**
      * @param float $value
-     * @return Generator
+     * @return iterable
      */
-    private function packFloat(float $value): Generator
+    private function packFloat(float $value): iterable
     {
         $packed = pack('d', $value);
         yield chr(0xC1) . ($this->littleEndian ? strrev($packed) : $packed);
     }
 
     /**
      * @param int $value
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packInteger(int $value): Generator
+    private function packInteger(int $value): iterable
     {
         if ($value >= -16 && $value <= 127) { //TINY_INT
             yield pack('c', $value);
@@ -196,10 +196,10 @@ private function packInteger(int $value): Generator
 
     /**
      * @param array|IPackDictionaryGenerator $param
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packDictionary($param): Generator
+    private function packDictionary($param): iterable
     {
         $size = is_array($param) ? count($param) : $param->count();
 
@@ -223,10 +223,10 @@ private function packDictionary($param): Generator
 
     /**
      * @param array|IPackListGenerator $param
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packList($param): Generator
+    private function packList($param): iterable
     {
         $size = is_array($param) ? count($param) : $param->count();
 
@@ -249,10 +249,10 @@ private function packList($param): Generator
 
     /**
      * @param IStructure $structure
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packStructure(IStructure $structure): Generator
+    private function packStructure(IStructure $structure): iterable
     {
         $arr = $this->structuresLt[get_class($structure)] ?? null;
         if ($arr === null) {
@@ -268,10 +268,10 @@ private function packStructure(IStructure $structure): Generator
 
     /**
      * @param Bytes $bytes
-     * @return Generator
+     * @return iterable
      * @throws PackException
      */
-    private function packByteArray(Bytes $bytes): Generator
+    private function packByteArray(Bytes $bytes): iterable
     {
         $size = count($bytes);
         if ($size < self::MEDIUM) {

src/PackStream/v1/Unpacker.php

@@ -37,9 +37,9 @@ class Unpacker implements IUnpacker
     private int $signature;
 
     private array $structuresLt = [
-        0x4E => [Node::class, 'unpackInteger', 'unpackList', 'unpackMap'],
-        0x52 => [Relationship::class, 'unpackInteger', 'unpackInteger', 'unpackInteger', 'unpackString', 'unpackMap'],
-        0x72 => [UnboundRelationship::class, 'unpackInteger', 'unpackString', 'unpackMap'],
+        0x4E => [Node::class, 'unpackInteger', 'unpackList', 'unpackDictionary'],
+        0x52 => [Relationship::class, 'unpackInteger', 'unpackInteger', 'unpackInteger', 'unpackString', 'unpackDictionary'],
+        0x72 => [UnboundRelationship::class, 'unpackInteger', 'unpackString', 'unpackDictionary'],
         0x50 => [Path::class, 'unpackList', 'unpackList', 'unpackList'],
         0x44 => [Date::class, 'unpackInteger'],
         0x54 => [Time::class, 'unpackInteger', 'unpackInteger'],
@@ -123,7 +123,7 @@ private function u()
         if ($output !== null) {
             return $output;
         }
-        $output = $this->unpackMap($marker);
+        $output = $this->unpackDictionary($marker);
         if ($output !== null) {
             return $output;
         }
@@ -194,15 +194,15 @@ private function unpackSpecificStructure(string $class, string ...$methods): ISt
      * @return array|null
      * @throws UnpackException
      */
-    private function unpackMap(int $marker): ?array
+    private function unpackDictionary(int $marker): ?array
     {
-        if ($marker >> 4 == 0b1010) { //TINY_MAP
+        if ($marker >> 4 == 0b1010) { //TINY_DICT
             $size = 0b10100000 ^ $marker;
-        } elseif ($marker == 0xD8) { //MAP_8
+        } elseif ($marker == 0xD8) { //DICT_8
             $size = (int)unpack('C', $this->next(1))[1];
-        } elseif ($marker == 0xD9) { //MAP_16
+        } elseif ($marker == 0xD9) { //DICT_16
             $size = (int)unpack('n', $this->next(2))[1];
-        } elseif ($marker == 0xDA) { //MAP_32
+        } elseif ($marker == 0xDA) { //DICT_32
             $size = (int)unpack('N', $this->next(4))[1];
         } else {
             return null;

src/protocol/AProtocol.php

@@ -2,7 +2,6 @@
 
 namespace Bolt\protocol;
 
-use Generator;
 use Bolt\PackStream\{IPacker, IUnpacker};
 use Bolt\connection\IConnection;
 use Exception;
@@ -40,7 +39,7 @@ public function __construct(IPacker $packer, IUnpacker $unpacker, IConnection $c
 
     /**
      * Write to connection
-     * @param Generator $generator
+     * @param iterable $generator
      * @throws Exception
      */
     protected function write(iterable $generator)