Merge pull request #247 from neo4j-php/feat/remove-formatter

feat!: Remove formatter
feat!: Simplify Cypher list and Map

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

.php-cs-fixer.dist.php

@@ -63,7 +63,6 @@
         MultilineCommentOpeningClosingAloneFixer::name() => true,
         MultilinePromotedPropertiesFixer::name() => true,
         PhpUnitAssertArgumentsOrderFixer::name() => true,
-        PhpdocNoSuperfluousParamFixer::name() => true,
         PhpdocParamOrderFixer::name() => true,
         StringableInterfaceFixer::name() => true,
     ])

README.md

@@ -308,21 +308,16 @@ composer require nyholm/psr7 nyholm/psr7-server kriswallsmith/buzz
 
 ## Result formats/hydration
 
-In order to make the results of the bolt protocol and the http uniform, the driver provides result formatters (aka hydrators). The client is configurable with these formatters. You can even implement your own.
+In order to make the results of the bolt protocol and the http uniform, the driver provides and summarizes the results.
 
-The default formatter is the `\Laudis\Neo4j\Formatters\OGMFormatter`, which is explained extensively in [the result format section](#accessing-the-results).
+The default formatter is the `\Laudis\Neo4j\Formatters\SummarizedResultFormatter`, which is explained extensively in [the result format section](#accessing-the-results).
 
-The driver provides three formatters by default, which are all found in the Formatter namespace:
- - `\Laudis\Neo4j\Formatter\BasicFormatter` which erases all the Cypher types and simply returns every value in the resulting map as a [scalar](https://www.php.net/manual/en/function.is-scalar.php), null or array value.
- - `\Laudis\Neo4j\Formatter\OGMFormatter` which maps the cypher types to php types as explained [here](#accessing-the-results).
- - `\Laudis\Neo4j\Formatter\SummarizedResultFormatter` which decorates any formatter and adds an extensive result summary.
+`\Laudis\Neo4j\Formatter\SummarizedResultFormatter` adds an extensive result summary.
 
 The client builder provides an easy way to change the formatter:
 
 ```php
-$client = \Laudis\Neo4j\ClientBuilder::create()
-    ->withFormatter(\Laudis\Neo4j\Formatter\SummarizedResultFormatter::create())
-    ->build();
+$client = \Laudis\Neo4j\ClientBuilder::create()->build();
 
 /**
  * The client will now return a result, decorated with a summary.
@@ -339,8 +334,6 @@ $summary = $summarisedResult->getSummary();
 $result = $summarisedResult->getResult();
 ```
 
-In order to use a custom formatter, implement the `Laudis\Neo4j\Contracts\FormatterInterface` and provide it when using the client builder.
-
 ## Concepts
 
 The driver API described [here](https://neo4j.com/docs/driver-manual/current/) is the main target of the driver. Because of this, the client is nothing more than a driver manager. The driver creates sessions. A session runs queries through a transaction.

composer.json

@@ -48,9 +48,9 @@
         "nyholm/psr7": "^1.3",
         "nyholm/psr7-server": "^1.0",
         "kriswallsmith/buzz": "^1.2",
-        "vimeo/psalm": "^5.0",
-        "friendsofphp/php-cs-fixer": "3.15.0",
-        "psalm/plugin-phpunit": "^0.18",
+        "vimeo/psalm": "^6.5",
+        "friendsofphp/php-cs-fixer": "3.68.5",
+        "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/Authentication/BasicAuth.php

@@ -38,7 +38,8 @@ public function __construct(
         private readonly string $username,
         private readonly string $password,
         private readonly ?Neo4jLogger $logger,
-    ) {}
+    ) {
+    }
 
     /**
      * @throws Exception

src/Authentication/KerberosAuth.php

@@ -40,11 +40,13 @@ final class KerberosAuth implements AuthenticateInterface
     public function __construct(
         private readonly string $token,
         private readonly ?Neo4jLogger $logger,
-    ) {}
+    ) {
+    }
 
     public function authenticateHttp(RequestInterface $request, UriInterface $uri, string $userAgent): RequestInterface
     {
         $this->logger?->log(LogLevel::DEBUG, 'Authenticating using KerberosAuth');
+
         /**
          * @psalm-suppress ImpureMethodCall Request is a pure object:
          *

src/Authentication/NoAuth.php

@@ -38,12 +38,14 @@ final class NoAuth implements AuthenticateInterface
      * @pure
      */
     public function __construct(
-        private readonly ?Neo4jLogger $logger
-    ) {}
+        private readonly ?Neo4jLogger $logger,
+    ) {
+    }
 
     public function authenticateHttp(RequestInterface $request, UriInterface $uri, string $userAgent): RequestInterface
     {
         $this->logger?->log(LogLevel::DEBUG, 'Authentication disabled');
+
         /**
          * @psalm-suppress ImpureMethodCall Request is a pure object:
          *

src/Authentication/OpenIDConnectAuth.php

@@ -36,12 +36,14 @@ final class OpenIDConnectAuth implements AuthenticateInterface
      */
     public function __construct(
         private readonly string $token,
-        private readonly ?Neo4jLogger $logger
-    ) {}
+        private readonly ?Neo4jLogger $logger,
+    ) {
+    }
 
     public function authenticateHttp(RequestInterface $request, UriInterface $uri, string $userAgent): RequestInterface
     {
         $this->logger?->log(LogLevel::DEBUG, 'Authenticating using OpenIDConnectAuth');
+
         /**
          * @psalm-suppress ImpureMethodCall Request is a pure object:
          *

src/Basic/Client.php

@@ -18,19 +18,13 @@
 use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Types\CypherList;
-use Laudis\Neo4j\Types\CypherMap;
 
-/**
- * @implements ClientInterface<SummarizedResult<CypherMap>>
- */
 final class Client implements ClientInterface
 {
-    /**
-     * @param ClientInterface<SummarizedResult<CypherMap>> $client
-     */
     public function __construct(
-        private readonly ClientInterface $client
-    ) {}
+        private readonly ClientInterface $client,
+    ) {
+    }
 
     public function run(string $statement, iterable $parameters = [], ?string $alias = null): SummarizedResult
     {

src/Basic/Driver.php

@@ -17,25 +17,19 @@
 use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Databags\DriverConfiguration;
 use Laudis\Neo4j\Databags\SessionConfiguration;
-use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\DriverFactory;
 use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
-use Laudis\Neo4j\Types\CypherMap;
 use Psr\Http\Message\UriInterface;
 
-/**
- * @implements DriverInterface<SummarizedResult<CypherMap>>
- */
 final class Driver implements DriverInterface
 {
     /**
-     * @param DriverInterface<SummarizedResult<CypherMap>> $driver
-     *
      * @psalm-external-mutation-free
      */
     public function __construct(
-        private readonly DriverInterface $driver
-    ) {}
+        private readonly DriverInterface $driver,
+    ) {
+    }
 
     /**
      * @psalm-mutation-free
@@ -52,7 +46,6 @@ public function verifyConnectivity(?SessionConfiguration $config = null): bool
 
     public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null): self
     {
-        /** @var DriverInterface<SummarizedResult<CypherMap>> */
         $driver = DriverFactory::create($uri, $configuration, $authenticate, SummarizedResultFormatter::create());
 
         return new self($driver);

src/Basic/Session.php

@@ -19,42 +19,31 @@
 use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Types\CypherList;
-use Laudis\Neo4j\Types\CypherMap;
 
-/**
- * @implements SessionInterface<SummarizedResult<CypherMap>>
- */
 final class Session implements SessionInterface
 {
-    /**
-     * @param SessionInterface<SummarizedResult<CypherMap>> $session
-     */
     public function __construct(
-        private readonly SessionInterface $session
-    ) {}
+        private readonly SessionInterface $session,
+    ) {
+    }
 
     /**
      * @param iterable<Statement> $statements
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @return CypherList<SummarizedResult>
      */
     public function runStatements(iterable $statements, ?TransactionConfiguration $config = null): CypherList
     {
         return $this->session->runStatements($statements, $config);
     }
 
-    /**
-     * @return SummarizedResult<CypherMap>
-     */
     public function runStatement(Statement $statement, ?TransactionConfiguration $config = null): SummarizedResult
     {
         return $this->session->runStatement($statement, $config);
     }
 
     /**
      * @param iterable<string, mixed> $parameters
-     *
-     * @return SummarizedResult<CypherMap>
      */
     public function run(string $statement, iterable $parameters = [], ?TransactionConfiguration $config = null): SummarizedResult
     {

src/Basic/UnmanagedTransaction.php

@@ -17,33 +17,22 @@
 use Laudis\Neo4j\Databags\Statement;
 use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\Types\CypherList;
-use Laudis\Neo4j\Types\CypherMap;
 
-/**
- * @implements UnmanagedTransactionInterface<SummarizedResult<CypherMap>>
- */
 final class UnmanagedTransaction implements UnmanagedTransactionInterface
 {
-    /**
-     * @param UnmanagedTransactionInterface<SummarizedResult<CypherMap>> $tsx
-     */
     public function __construct(
-        private readonly UnmanagedTransactionInterface $tsx
-    ) {}
+        private readonly UnmanagedTransactionInterface $tsx,
+    ) {
+    }
 
     /**
      * @param iterable<string, mixed> $parameters
-     *
-     * @return SummarizedResult<CypherMap>
      */
     public function run(string $statement, iterable $parameters = []): SummarizedResult
     {
         return $this->tsx->run($statement, $parameters);
     }
 
-    /**
-     * @return SummarizedResult<CypherMap>
-     */
     public function runStatement(Statement $statement): SummarizedResult
     {
         return $this->tsx->runStatement($statement);
@@ -52,7 +41,7 @@ public function runStatement(Statement $statement): SummarizedResult
     /**
      * @param iterable<Statement> $statements
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @return CypherList<SummarizedResult>
      */
     public function runStatements(iterable $statements): CypherList
     {
@@ -62,7 +51,7 @@ public function runStatements(iterable $statements): CypherList
     /**
      * @param iterable<Statement> $statements
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @return CypherList<SummarizedResult>
      */
     public function commit(iterable $statements = []): CypherList
     {