setup summarized result formatter for a smooth transition

Author: transistive

src/Databags/SummarizedResult.php

@@ -13,46 +13,40 @@
 
 namespace Laudis\Neo4j\Databags;
 
-use ArrayAccess;
-use BadMethodCallException;
-use Generator;
-use function is_iterable;
-use IteratorAggregate;
-use JsonSerializable;
-use function sprintf;
+use Laudis\Neo4j\Types\CypherList;
 
 /**
  * A result containing the values and the summary.
  *
- * @template T
+ * @template TValue
  *
- * @psalm-immutable
+ * @extends CypherList<TValue>
  *
- * @implements ArrayAccess<string, ResultSummary|T>
+ * @psalm-immutable
  */
-final class SummarizedResult implements JsonSerializable, ArrayAccess, IteratorAggregate
+final class SummarizedResult extends CypherList
 {
     private ResultSummary $summary;
-    /** @var T */
-    private $result;
 
     /**
-     * @param T $result
+     * @param iterable<mixed, TValue> $iterable
      */
-    public function __construct($result, ResultSummary $summary)
+    public function __construct(ResultSummary $summary, iterable $iterable = [])
     {
+        parent::__construct($iterable);
         $this->summary = $summary;
-        $this->result = $result;
     }
 
     /**
-     * Returns the actual result.
+     * @template Value
+     *
+     * @param iterable<mixed, Value> $iterable
      *
-     * @return T
+     * @return static<Value>
      */
-    public function getResult()
+    protected function withIterable(iterable $iterable): SummarizedResult
     {
-        return $this->result;
+        return new self($this->summary, $iterable);
     }
 
     /**
@@ -63,44 +57,14 @@ public function getSummary(): ResultSummary
         return $this->summary;
     }
 
-    public function getIterator(): Generator
-    {
-        if (is_iterable($this->result)) {
-            yield from $this->result;
-        } else {
-            yield 'summary' => $this->summary;
-            yield 'result' => $this->result;
-        }
-    }
-
     /**
-     * @return array{summary: ResultSummary, result: T}
+     * @return array{summary: ResultSummary, result: mixed}
      */
     public function jsonSerialize(): array
     {
         return [
             'summary' => $this->summary,
-            'result' => $this->result,
+            'result' => parent::jsonSerialize(),
         ];
     }
-
-    public function offsetExists($offset)
-    {
-        return array_key_exists($offset, $this->jsonSerialize());
-    }
-
-    public function offsetGet($offset)
-    {
-        return $this->jsonSerialize()[$offset];
-    }
-
-    public function offsetSet($offset, $value)
-    {
-        throw new BadMethodCallException(sprintf('%s is immutable', __CLASS__));
-    }
-
-    public function offsetUnset($offset)
-    {
-        throw new BadMethodCallException(sprintf('%s is immutable', __CLASS__));
-    }
 }

src/Formatter/OGMFormatter.php

@@ -35,7 +35,6 @@
  * @see https://neo4j.com/docs/driver-manual/current/cypher-workflow/#driver-type-mapping
  *
  * @psalm-type OGMTypes = string|int|float|bool|null|\Laudis\Neo4j\Types\Date|\Laudis\Neo4j\Types\DateTime|\Laudis\Neo4j\Types\Duration|\Laudis\Neo4j\Types\LocalDateTime|\Laudis\Neo4j\Types\LocalTime|\Laudis\Neo4j\Types\Time|\Laudis\Neo4j\Types\CypherList|\Laudis\Neo4j\Types\CypherMap|\Laudis\Neo4j\Types\Node|\Laudis\Neo4j\Types\Relationship|\Laudis\Neo4j\Types\Path|\Laudis\Neo4j\Types\Cartesian3DPoint|\Laudis\Neo4j\Types\CartesianPoint|\Laudis\Neo4j\Types\WGS84Point|\Laudis\Neo4j\Types\WGS843DPoint
- * @implements FormatterInterface<CypherList<CypherMap<OGMTypes>>>
  *
  * @psalm-type OGMResults = CypherList<CypherMap<OGMTypes>>
  *
@@ -48,6 +47,8 @@
  *
  * @psalm-import-type BoltMeta from \Laudis\Neo4j\Contracts\FormatterInterface
  *
+ * @implements FormatterInterface<CypherList<CypherMap<OGMTypes>>>
+ *
  * @psalm-immutable
  */
 final class OGMFormatter implements FormatterInterface
@@ -97,9 +98,6 @@ public function formatBoltResult(array $meta, array $results, ConnectionInterfac
         return new CypherList($tbr);
     }
 
-    /**
-     * @throws Exception
-     */
     public function formatHttpResult(ResponseInterface $response, array $body, ConnectionInterface $connection, float $resultsAvailableAfter, float $resultsConsumedAfter, iterable $statements): CypherList
     {
         /** @var list<CypherList<CypherMap<OGMTypes>>> $tbr */

src/Formatter/SummarizedResultFormatter.php

@@ -24,72 +24,48 @@
 use Laudis\Neo4j\Databags\SummaryCounters;
 use Laudis\Neo4j\Enum\QueryTypeEnum;
 use Laudis\Neo4j\Types\CypherList;
+use Laudis\Neo4j\Types\CypherMap;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use UnexpectedValueException;
 
 /**
  * Decorates the result of the provided format with an extensive summary.
  *
- * @template T
- *
  * @psalm-import-type CypherResponseSet from \Laudis\Neo4j\Contracts\FormatterInterface
  * @psalm-import-type CypherResponse from \Laudis\Neo4j\Contracts\FormatterInterface
  * @psalm-import-type BoltCypherStats from \Laudis\Neo4j\Contracts\FormatterInterface
  * @psalm-import-type OGMResults from \Laudis\Neo4j\Formatter\OGMFormatter
+ * @psalm-import-type OGMTypes from \Laudis\Neo4j\Formatter\OGMFormatter
  *
- * @implements FormatterInterface<SummarizedResult<T>>
+ * @implements FormatterInterface<SummarizedResult<CypherMap<OGMTypes>>>
  *
  * @psalm-immutable
  */
 final class SummarizedResultFormatter implements FormatterInterface
 {
-    /** @var FormatterInterface<T> */
-    private FormatterInterface $formatter;
+    private OGMFormatter $formatter;
 
     /**
-     * Creates a new instance of itself by decorating an OGMFormatter.
-     *
-     * @return self<OGMResults>
-     *
      * @pure
      */
     public static function create(): self
     {
-        return self::createWithFormatter(OGMFormatter::create());
+        return new self(OGMFormatter::create());
     }
 
-    /**
-     * @template U
-     *
-     * Creates a new summarized result formatter by decorating the given formatter.
-     *
-     * @param FormatterInterface<U> $formatter
-     *
-     * @return self<U>
-     *
-     * @pure
-     */
-    public static function createWithFormatter(FormatterInterface $formatter): self
-    {
-        return new self($formatter);
-    }
-
-    /**
-     * @param FormatterInterface<T> $formatter
-     */
-    public function __construct(FormatterInterface $formatter)
+    public function __construct(OGMFormatter $formatter)
     {
         $this->formatter = $formatter;
     }
 
     /**
-     * @param CypherResponse $response
-     * @param T              $results
+     * @param CypherResponse                  $response
+     * @param CypherList<CypherMap<OGMTypes>> $results
      *
-     * @return SummarizedResult<T>
+     * @return SummarizedResult<CypherMap<OGMTypes>>
      */
-    public function formatHttpStats(array $response, ConnectionInterface $connection, Statement $statement, float $resultAvailableAfter, float $resultConsumedAfter, $results): SummarizedResult
+    public function formatHttpStats(array $response, ConnectionInterface $connection, Statement $statement, float $resultAvailableAfter, float $resultConsumedAfter, CypherList $results): SummarizedResult
     {
         if (!isset($response['stats'])) {
             throw new UnexpectedValueException('No stats found in the response set');
@@ -129,7 +105,7 @@ public function formatHttpStats(array $response, ConnectionInterface $connection
             )
         );
 
-        return new SummarizedResult($results, $summary);
+        return new SummarizedResult($summary, $results->toArray());
     }
 
     /**
@@ -196,12 +172,12 @@ public function formatBoltResult(array $meta, array $results, ConnectionInterfac
         );
         $formattedResult = $this->formatter->formatBoltResult($meta, $results, $connection, $resultAvailableAfter, $resultConsumedAfter, $statement);
 
-        return new SummarizedResult($formattedResult, $summary);
+        return new SummarizedResult($summary, $formattedResult->toArray());
     }
 
     public function formatHttpResult(ResponseInterface $response, array $body, ConnectionInterface $connection, float $resultsAvailableAfter, float $resultsConsumedAfter, iterable $statements): CypherList
     {
-        /** @var list<SummarizedResult<T>> */
+        /** @var list<SummarizedResult<CypherMap<OGMTypes>>> */
         $tbr = [];
 
         $toDecorate = $this->formatter->formatHttpResult($response, $body, $connection, $resultsAvailableAfter, $resultsConsumedAfter, $statements);

src/Types/AbstractCypherSequence.php

@@ -29,18 +29,20 @@
  * @extends AbstractCypherObject<TKey, TValue>
  *
  * @psalm-immutable
- *
- * @psalm-suppress UnsafeInstantiation
  */
 abstract class AbstractCypherSequence extends AbstractCypherObject implements Countable
 {
     /** @var array<TKey, TValue> */
     protected array $sequence = [];
 
     /**
-     * @param iterable<TKey, TValue> $iterable
+     * @template Value
+     *
+     * @param iterable<Value> $iterable
+     *
+     * @return static<Value, array-key>
      */
-    abstract public function __construct(iterable $iterable);
+    abstract protected function withIterable(iterable $iterable): AbstractCypherSequence;
 
     final public function count(): int
     {
@@ -57,7 +59,7 @@ final public function copy(): self
         // Make sure the sequence is actually copied by reassigning it.
         $map = $this->sequence;
 
-        return new static($map);
+        return $this->withIterable($map);
     }
 
     /**
@@ -124,7 +126,7 @@ final public function filter(callable $callback): self
             }
         }
 
-        return new static($tbr);
+        return $this->withIterable($tbr);
     }
 
     /**
@@ -144,7 +146,7 @@ final public function map(callable $callback): self
             $tbr[$key] = $callback($value, $key);
         }
 
-        return new static($tbr);
+        return $this->withIterable($tbr);
     }
 
     /**

src/Types/ArrayList.php

@@ -32,15 +32,13 @@
  * @extends AbstractCypherSequence<TValue, int>
  *
  * @psalm-immutable
- *
- * @psalm-suppress UnsafeGenericInstantiation
  */
 class ArrayList extends AbstractCypherSequence
 {
     /**
      * @param iterable<mixed, TValue> $iterable
      */
-    final public function __construct(iterable $iterable = [])
+    public function __construct(iterable $iterable = [])
     {
         if ($iterable instanceof self) {
             /** @psalm-suppress InvalidPropertyAssignmentValue */
@@ -53,6 +51,19 @@ final public function __construct(iterable $iterable = [])
         }
     }
 
+    /**
+     * @template Value
+     *
+     * @param iterable<mixed, Value> $iterable
+     *
+     * @return static<Value>
+     */
+    protected function withIterable(iterable $iterable): ArrayList
+    {
+        /** @psalm-suppress UnsafeInstantiation */
+        return new static($iterable);
+    }
+
     /**
      * Returns the first element in the sequence.
      *
@@ -94,23 +105,23 @@ public function merge($values): ArrayList
             $tbr[] = $value;
         }
 
-        return new static($tbr);
+        return $this->withIterable($tbr);
     }
 
     /**
      * @return static<TValue>
      */
     public function reversed(): ArrayList
     {
-        return new static(array_reverse($this->sequence));
+        return $this->withIterable(array_reverse($this->sequence));
     }
 
     /**
      * @return static<TValue>
      */
     public function slice(int $offset, int $length = null): ArrayList
     {
-        return new static(array_slice($this->sequence, $offset, $length));
+        return $this->withIterable(array_slice($this->sequence, $offset, $length));
     }
 
     /**
@@ -128,7 +139,7 @@ public function sorted(callable $comparator = null): ArrayList
             usort($tbr, $comparator);
         }
 
-        return new static($tbr);
+        return $this->withIterable($tbr);
     }
 
     /**
@@ -251,13 +262,12 @@ public function getAsArrayList(int $key): ArrayList
      *
      * @param iterable<Value> $iterable
      *
-     * @return static<Value>
+     * @return self<Value>
      *
      * @pure
      */
     public static function fromIterable(iterable $iterable): ArrayList
     {
-        /** @psalm-suppress UnsafeGenericInstantiation */
-        return new static($iterable);
+        return new self($iterable);
     }
 }