fixed all typing errors and simplified maps and lists

Author: transistive

.github/workflows/static-analysis.yml

@@ -7,24 +7,33 @@ on:
   pull_request:
     branches:
       - main
-
 jobs:
   php-cs-fixer:
     name: "Lint & Analyse"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+
+      # Setup the correct PHP version globally
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3.16'
+
       - name: Cache Composer dependencies
         uses: actions/cache@v2
         with:
           path: /tmp/composer-cache
           key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+
       - uses: php-actions/composer@v6
         with:
           progress: yes
-          php_version: 8.3
+          php_version: 8.3.16
           version: 2
+
       - name: "PHP-CS-Fixer"
         run: vendor/bin/php-cs-fixer fix --dry-run
+
       - name: "PSalm"
         run: vendor/bin/psalm --show-info=true

.github/workflows/unit-test.yml

@@ -14,7 +14,7 @@ jobs:
     name: "Running Unit Tests"
     strategy:
         matrix:
-            php: ['8.1', '8.2', '8.3']
+            php: ['8.1.31', '8.2.27', '8.3.16']
 
     steps:
       - uses: actions/checkout@v2

composer.json

@@ -48,9 +48,9 @@
         "nyholm/psr7": "^1.3",
         "nyholm/psr7-server": "^1.0",
         "kriswallsmith/buzz": "^1.2",
-        "vimeo/psalm": "^5.0",
+        "vimeo/psalm": "^6.5",
         "friendsofphp/php-cs-fixer": "3.68.5",
-        "psalm/plugin-phpunit": "^0.18",
+        "psalm/plugin-phpunit": "^0.19",
         "monolog/monolog": "^2.2",
         "symfony/uid": "^5.0",
         "symfony/var-dumper": "^5.0",

psalm.xml

@@ -30,18 +30,6 @@
                 <directory name="src"/>
             </errorLevel>
         </UnusedForeachValue>
-        <DeprecatedClass>
-            <errorLevel type="suppress">
-                <directory name="tests"/>
-                <directory name="src"/>
-            </errorLevel>
-        </DeprecatedClass>
-        <DeprecatedInterface>
-            <errorLevel type="suppress">
-                <directory name="tests"/>
-                <directory name="src"/>
-            </errorLevel>
-        </DeprecatedInterface>
         <MissingConstructor>
             <errorLevel type="suppress">
                 <directory name="tests"/>

src/Bolt/BoltResult.php

@@ -26,7 +26,7 @@
 /**
  * @psalm-import-type BoltCypherStats from SummarizedResultFormatter
  *
- * @implements Iterator<int, list>
+ * @implements Iterator<int, list<mixed>>
  */
 final class BoltResult implements Iterator
 {
@@ -71,7 +71,7 @@ public function getIt(): Generator
     }
 
     /**
-     * @return Generator<int, list>
+     * @return Generator<int, list<mixed>>
      */
     public function iterator(): Generator
     {
@@ -113,10 +113,15 @@ private function fetchResults(): void
     }
 
     /**
-     * @return list
+     * @psalm-suppress InvalidNullableReturnType
+     *
+     * @return list<mixed>
      */
     public function current(): array
     {
+        /**
+         * @psalm-suppress NullableReturnStatement
+         */
         return $this->getIt()->current();
     }
 

src/Bolt/BoltUnmanagedTransaction.php

@@ -55,6 +55,8 @@ public function __construct(
     }
 
     /**
+     * @param iterable<Statement> $statements
+     *
      * @throws ClientException|Throwable
      *
      * @return CypherList<SummarizedResult>
@@ -155,6 +157,8 @@ public function runStatement(Statement $statement): SummarizedResult
     }
 
     /**
+     * @param iterable<Statement> $statements
+     *
      * @throws Throwable
      *
      * @return CypherList<SummarizedResult>

src/Bolt/Session.php

@@ -60,6 +60,8 @@ public function __construct(
     }
 
     /**
+     * @param iterable<Statement> $statements
+     *
      * @return CypherList<SummarizedResult>
      */
     public function runStatements(iterable $statements, ?TransactionConfiguration $config = null): CypherList
@@ -120,6 +122,9 @@ public function transaction(callable $tsxHandler, ?TransactionConfiguration $con
         return $this->writeTransaction($tsxHandler, $config);
     }
 
+    /**
+     * @param iterable<Statement> $statements
+     */
     public function beginTransaction(?iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface
     {
         $this->getLogger()?->log(LogLevel::INFO, 'Beginning transaction', ['statements' => $statements, 'config' => $config]);

src/Common/DriverSetupManager.php

@@ -81,8 +81,9 @@ public function withSetup(DriverSetup $setup, ?string $alias = null, ?int $prior
 
         $setups = $this->driverSetups;
 
-        /** @var SplPriorityQueue<int, DriverSetup> */
-        $setups[$alias] ??= new SplPriorityQueue();
+        /** @var SplPriorityQueue<int, DriverSetup> $splPriorityQueue */
+        $splPriorityQueue = new SplPriorityQueue();
+        $setups[$alias] ??= $splPriorityQueue;
         /** @psalm-suppress ImpureMethodCall */
         $setups[$alias]->insert($setup, $priority ?? 0);
 

src/Common/TransactionHelper.php

@@ -13,10 +13,10 @@
 
 namespace Laudis\Neo4j\Common;
 
+use Laudis\Neo4j\Contracts\CypherSequence;
 use Laudis\Neo4j\Contracts\TransactionInterface;
 use Laudis\Neo4j\Contracts\UnmanagedTransactionInterface;
 use Laudis\Neo4j\Exception\Neo4jException;
-use Laudis\Neo4j\Types\AbstractCypherSequence;
 
 final class TransactionHelper
 {
@@ -55,7 +55,7 @@ public static function retry(callable $tsxFactory, callable $tsxHandler)
 
     private static function triggerLazyResult(mixed $tbr): void
     {
-        if ($tbr instanceof AbstractCypherSequence) {
+        if ($tbr instanceof CypherSequence) {
             $tbr->preload();
         }
     }

src/Contracts/CypherSequence.php

@@ -0,0 +1,204 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Contracts;
+
+use Countable;
+use Iterator;
+use JsonSerializable;
+use Laudis\Neo4j\Types\CypherList;
+use Laudis\Neo4j\Types\CypherMap;
+use Laudis\Neo4j\Types\Map;
+
+/**
+ * Abstract immutable sequence with basic functional methods.
+ *
+ * @template TValue
+ */
+interface CypherSequence extends Countable, JsonSerializable
+{
+    /**
+     * Copies the sequence.
+     *
+     * @return self<TValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function copy(): self;
+
+    /**
+     * Returns whether the sequence is empty.
+     *
+     * @psalm-suppress UnusedForeachValue
+     */
+    public function isEmpty(): bool;
+
+    /**
+     * Creates a new sequence by merging this one with the provided iterable. When the iterable is not a list, the provided values will override the existing items in case of a key collision.
+     *
+     * @template NewValue
+     *
+     * @param iterable<mixed, NewValue> $values
+     *
+     * @return self<TValue|NewValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function merge(iterable $values): self;
+
+    /**
+     * Checks if the sequence contains the given key.
+     */
+    public function hasKey(string|int $key): bool;
+
+    /**
+     * Checks if the sequence contains the given value. The equality check is strict.
+     */
+    public function hasValue(mixed $value): bool;
+
+    /**
+     * Creates a filtered the sequence with the provided callback.
+     *
+     * @param callable(TValue, array-key):bool $callback
+     *
+     * @return self<TValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function filter(callable $callback): self;
+
+    /**
+     * Maps the values of this sequence to a new one with the provided callback.
+     *
+     * @template ReturnType
+     *
+     * @param callable(TValue, array-key):ReturnType $callback
+     *
+     * @return self<ReturnType>
+     *
+     * @psalm-mutation-free
+     */
+    public function map(callable $callback): self;
+
+    /**
+     * Reduces this sequence with the given callback.
+     *
+     * @template TInitial
+     *
+     * @param TInitial|null                                       $initial
+     * @param callable(TInitial|null, TValue, array-key):TInitial $callback
+     *
+     * @return TInitial
+     */
+    public function reduce(callable $callback, mixed $initial = null): mixed;
+
+    /**
+     * Finds the position of the value within the sequence.
+     *
+     * @return false|array-key returns the key of the value if it is found, false otherwise
+     */
+    public function find(mixed $value): false|string|int;
+
+    /**
+     * Creates a reversed sequence.
+     *
+     * @return self<TValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function reversed(): self;
+
+    /**
+     * Slices a new sequence starting from the given offset with a certain length.
+     * If the length is null it will slice the entire remainder starting from the offset.
+     *
+     * @return self<TValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function slice(int $offset, ?int $length = null): self;
+
+    /**
+     * Creates a sorted sequence. If the comparator is null it will use natural ordering.
+     *
+     * @param (callable(TValue, TValue):int)|null $comparator
+     *
+     * @return self<TValue>
+     *
+     * @psalm-mutation-free
+     */
+    public function sorted(?callable $comparator = null): self;
+
+    /**
+     * Creates a list from the arrays and objects in the sequence whose values corresponding with the provided key.
+     *
+     * @return CypherList<mixed>
+     *
+     * @psalm-mutation-free
+     */
+    public function pluck(string|int $key): CypherList;
+
+    /**
+     * Uses the values found at the provided key as the key for the new Map.
+     *
+     * @return CypherMap<mixed>
+     *
+     * @psalm-mutation-free
+     */
+    public function keyBy(string|int $key): CypherMap;
+
+    /**
+     * Joins the values within the sequence together with the provided glue. If the glue is null, it will be an empty string.
+     */
+    public function join(?string $glue = null): string;
+
+    /**
+     * Iterates over the sequence and applies the callable.
+     *
+     * @param callable(TValue, array-key):void $callable
+     *
+     * @return self<TValue>
+     */
+    public function each(callable $callable): self;
+
+    /**
+     * Returns the sequence as an array.
+     *
+     * @return array<array-key, TValue>
+     */
+    public function toArray(): array;
+
+    /**
+     * Returns the sequence as an array.
+     *
+     * @return array<array-key, TValue|array>
+     */
+    public function toRecursiveArray(): array;
+
+    /**
+     * @return Iterator<array-key, TValue>
+     */
+    public function getGenerator(): Iterator;
+
+    /**
+     * @return self<TValue>
+     */
+    public function withCacheLimit(int $cacheLimit): self;
+
+    /**
+     * Preload the lazy evaluation.
+     */
+    public function preload(): void;
+
+    public function __serialize(): array;
+}