Made library compatible with PHP 8.4

Syndesi · Syndesi · commit 3705ef015a7b · 2025-02-15T12:30:07.000+01:00
### Changes - Made library compatible with PHP 8.4, closes #8. - Update dev dependencies, related to #8. - Remove dev dependencies `roave/no-leaks` and `boesing/psalm-plugin-stringf` due to conflict with newer PHP versions, related to #8.
diff --git a/.github/workflows/ci-code-style.yml b/.github/workflows/ci-code-style.yml
@@ -18,7 +18,7 @@ jobs:
                   key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.3'
+                  php-version: '8.4'
                   tools: composer:v2
             - run: composer install --dev --ignore-platform-req=php
               shell: bash
diff --git a/.github/workflows/ci-leak-test.yml b/.github/workflows/ci-leak-test.yml
diff --git a/.github/workflows/ci-mutant-test.yml b/.github/workflows/ci-mutant-test.yml
@@ -18,7 +18,7 @@ jobs:
                   key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.3'
+                  php-version: '8.4'
                   tools: composer:v2
             - run: composer install --ignore-platform-req=php
               shell: bash
diff --git a/.github/workflows/ci-phpstan.yml b/.github/workflows/ci-phpstan.yml
@@ -18,7 +18,7 @@ jobs:
                   key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.3'
+                  php-version: '8.4'
                   tools: composer:v2
             - run: composer install --ignore-platform-req=php
               shell: bash
diff --git a/.github/workflows/ci-psalm.yml b/.github/workflows/ci-psalm.yml
@@ -18,7 +18,7 @@ jobs:
                   key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.3'
+                  php-version: '8.4'
                   tools: composer:v2
             - run: composer install --ignore-platform-req=php
               shell: bash
diff --git a/.github/workflows/ci-unit-test-coverage.yml b/.github/workflows/ci-unit-test-coverage.yml
@@ -20,7 +20,7 @@ jobs:
                   key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.3'
+                  php-version: '8.4'
                   extensions: xdebug
                   tools: composer:v2
             - run: composer install --ignore-platform-req=php
diff --git a/.github/workflows/ci-unit-test.yml b/.github/workflows/ci-unit-test.yml
@@ -12,7 +12,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php-version: ['8.1', '8.2', '8.3']
+                php-version: ['8.2', '8.3', '8.4']
         steps:
             - uses: actions/checkout@v2
             - name: Cache Composer dependencies
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+### Changed
+- Made library compatible with PHP 8.4, closes #8.
+- Update dev dependencies, related to #8.
+- Remove dev dependencies `roave/no-leaks` and `boesing/psalm-plugin-stringf` due to conflict with newer PHP versions,
+  related to #8.
diff --git a/composer.json b/composer.json
@@ -4,6 +4,7 @@
     "type": "library",
     "homepage": "https://neo4j-php.github.io/cypher-data-structures/#/",
     "license": "MIT",
+    "minimum-stability": "dev",
     "authors": [
         {
             "name": "Syndesi (Sören Klein)",
@@ -30,25 +31,23 @@
         }
     },
     "require-dev": {
-        "vimeo/psalm": "^5.0",
-        "boesing/psalm-plugin-stringf": "^1.1",
-        "phpstan/phpstan": "^1.6",
-        "phpunit/php-code-coverage": "^9.2",
-        "infection/infection": "^0.27.0",
-        "friendsofphp/php-cs-fixer": "^3.8",
-        "phpunit/phpunit": "^9.5",
-        "roave/no-leaks": "^1.3",
+        "vimeo/psalm": "^6.2",
+        "phpstan/phpstan": "^2.1",
+        "phpunit/php-code-coverage": "^11",
+        "infection/infection": "^0.29.8",
+        "friendsofphp/php-cs-fixer": "^3.48",
+        "phpunit/phpunit": "^11",
         "phpbench/phpbench": "^1.2",
-        "infection/codeception-adapter": "^0.4.2"
+        "infection/codeception-adapter": "^0.4.2",
+        "thecodingmachine/safe": "v3.0.0 as v2.6"
     },
     "scripts": {
-        "test": "php vendor/phpunit/phpunit/phpunit",
+        "test": "php vendor/phpunit/phpunit/phpunit --display-phpunit-deprecations",
         "test:coverage:xml": "export XDEBUG_MODE=coverage && php ./vendor/phpunit/phpunit/phpunit --coverage-clover coverage.xml",
         "test:coverage:html": "export XDEBUG_MODE=coverage && php ./vendor/phpunit/phpunit/phpunit --coverage-html ./tmp",
         "test:mutant": "export XDEBUG_MODE=coverage && php vendor/infection/infection/bin/infection --threads=4",
-        "test:leak": "export LEAK=true && php vendor/bin/roave-no-leaks",
-        "cs:list": "php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --allow-risky=yes --dry-run ./src",
-        "cs:fix": "php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --allow-risky=yes",
+        "cs:list": "PHP_CS_FIXER_IGNORE_ENV=1 php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --allow-risky=yes --dry-run ./src",
+        "cs:fix": "PHP_CS_FIXER_IGNORE_ENV=1 php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix --allow-risky=yes",
         "psalm": "php vendor/bin/psalm --show-info=true --no-cache",
         "psalm:fix": "php vendor/bin/psalm --alter --issues=MissingReturnType,InvalidReturnType,InvalidNullableReturnType,MismatchingDocblockParamType",
         "phpstan": "vendor/bin/phpstan",
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,7 +2,6 @@ parameters:
   level: 8
   paths:
     - src
-  checkGenericClassInNonGenericObjectType: false
   ignoreErrors:
 #    - '#Method [a-zA-Z0-9\\_:()]+ should return static\([a-zA-Z0-9\\_]+\) but returns [a-zA-Z0-9\\_]+\.#'
 #    - '#Method [a-zA-Z0-9\\_]+::current\(\) should return [a-zA-Z0-9\\_]+ but returns object\.#'
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="./vendor/autoload.php">
-  <coverage>
-    <include>
-      <directory>./src</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="./vendor/autoload.php">
   <php>
     <ini name="error_reporting" value="-1"/>
     <ini name="intl.default_locale" value="en"/>
     <ini name="intl.error_level" value="0"/>
     <ini name="memory_limit" value="-1"/>
-    <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak" />
+    <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak"/>
   </php>
   <testsuites>
     <testsuite name="Test suite">
       <directory suffix="Test.php">./tests</directory>
     </testsuite>
   </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -12,4 +12,10 @@
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>
-<plugins><pluginClass class="Boesing\PsalmPluginStringf\Plugin"/></plugins></psalm>
+    <issueHandlers>
+        <ClassMustBeFinal errorLevel="suppress" />
+        <UnusedClass errorLevel="suppress" />
+        <PossiblyUnusedMethod errorLevel="suppress" />
+        <PossiblyUnusedReturnValue errorLevel="suppress" />
+    </issueHandlers>
+</psalm>
diff --git a/src/Helper/ToStringHelper.php b/src/Helper/ToStringHelper.php
@@ -233,7 +233,8 @@ public static function relationToString(RelationInterface $relation, bool $ident
         }
 
         $relationParts = [];
-        if ($type = $relation->getType()) {
+        $type = $relation->getType();
+        if (null !== $type) {
             $relationParts[] = sprintf(':%s', $type);
         }
         $properties = $relation->getProperties();
@@ -271,14 +272,15 @@ public static function nodeConstraintToString(NodeConstraintInterface $nodeConst
 
         $parts[] = 'CONSTRAINT';
 
-        if ($name = $nodeConstraint->getName()) {
+        $name = $nodeConstraint->getName();
+        if (null !== $name) {
             $parts[] = $name;
         }
 
         $parts[] = 'FOR';
 
         $for = $nodeConstraint->getFor();
-        if (!$for) {
+        if (null === $for) {
             throw new InvalidArgumentException('For can not be null');
         }
         $parts[] = sprintf("(node:%s)", $for);
@@ -292,6 +294,9 @@ public static function nodeConstraintToString(NodeConstraintInterface $nodeConst
             throw new InvalidArgumentException('At least one property is required');
         }
         if (1 === $propertyCount) {
+            /**
+             * @psalm-suppress PossiblyNullArgument
+             */
             $parts[] = sprintf("node.%s", array_shift($properties));
         }
         if ($propertyCount > 1) {
@@ -305,7 +310,7 @@ public static function nodeConstraintToString(NodeConstraintInterface $nodeConst
         $parts[] = 'IS';
 
         $type = $nodeConstraint->getType();
-        if (!$type) {
+        if (null === $type) {
             throw new InvalidArgumentException('Type can not be null');
         }
         $parts[] = $type;
@@ -325,14 +330,15 @@ public static function relationConstraintToString(RelationConstraintInterface $r
 
         $parts[] = 'CONSTRAINT';
 
-        if ($name = $relationConstraint->getName()) {
+        $name = $relationConstraint->getName();
+        if (null !== $name) {
             $parts[] = $name;
         }
 
         $parts[] = 'FOR';
 
         $for = $relationConstraint->getFor();
-        if (!$for) {
+        if (null === $for) {
             throw new InvalidArgumentException('For can not be null');
         }
         $parts[] = sprintf("()-[relation:%s]-()", $for);
@@ -346,6 +352,9 @@ public static function relationConstraintToString(RelationConstraintInterface $r
             throw new InvalidArgumentException('At least one property is required');
         }
         if (1 === $propertyCount) {
+            /**
+             * @psalm-suppress PossiblyNullArgument
+             */
             $parts[] = sprintf("relation.%s", array_shift($properties));
         }
         if ($propertyCount > 1) {
@@ -359,7 +368,7 @@ public static function relationConstraintToString(RelationConstraintInterface $r
         $parts[] = 'IS';
 
         $type = $relationConstraint->getType();
-        if (!$type) {
+        if (null === $type) {
             throw new InvalidArgumentException('Type can not be null');
         }
         $parts[] = $type;
@@ -378,20 +387,21 @@ public static function nodeIndexToString(NodeIndexInterface $nodeIndex): string
         $parts = [];
 
         $type = $nodeIndex->getType();
-        if ($type) {
+        if (null !== $type) {
             $parts[] = $type;
         }
 
         $parts[] = 'INDEX';
 
-        if ($name = $nodeIndex->getName()) {
+        $name = $nodeIndex->getName();
+        if (null !== $name) {
             $parts[] = $name;
         }
 
         $parts[] = 'FOR';
 
         $for = $nodeIndex->getFor();
-        if (!$for) {
+        if (null === $for) {
             throw new InvalidArgumentException('For can not be null');
         }
         $parts[] = sprintf("(node:%s)", $for);
@@ -424,20 +434,21 @@ public static function relationIndexToString(RelationIndexInterface $relationInd
         $parts = [];
 
         $type = $relationIndex->getType();
-        if ($type) {
+        if (null !== $type) {
             $parts[] = $type;
         }
 
         $parts[] = 'INDEX';
 
-        if ($name = $relationIndex->getName()) {
+        $name = $relationIndex->getName();
+        if (null !== $name) {
             $parts[] = $name;
         }
 
         $parts[] = 'FOR';
 
         $for = $relationIndex->getFor();
-        if (!$for) {
+        if (null === $for) {
             throw new InvalidArgumentException('For can not be null');
         }
         $parts[] = sprintf("()-[relation:%s]-()", $for);
diff --git a/src/Trait/IdentifiersTrait.php b/src/Trait/IdentifiersTrait.php
@@ -56,7 +56,7 @@ public function getIdentifier(string $identifier): mixed
     public function getIdentifiers(): array
     {
         $result = [];
-        foreach ($this->identifiers as $name => $value) {
+        foreach ($this->identifiers as $name => $_) {
             $result[$name] = $this->properties[$name];
         }
 
diff --git a/tests/Helper/ToStringHelperTest.php b/tests/Helper/ToStringHelperTest.php
@@ -4,6 +4,7 @@
 
 namespace Syndesi\CypherDataStructures\Tests\Helper;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Syndesi\CypherDataStructures\Exception\InvalidArgumentException;
 use Syndesi\CypherDataStructures\Helper\ToStringHelper;
@@ -28,7 +29,7 @@ public function testMustNameBeEscaped(): void
         $this->assertTrue(ToStringHelper::mustNameBeEscaped('abc abc'));
     }
 
-    public function escapeStringProvider(): array
+    public static function escapeStringProvider(): array
     {
         return [
             ['hello world', 'hello world'],
@@ -44,9 +45,7 @@ public function escapeStringProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider escapeStringProvider
-     */
+    #[DataProvider("escapeStringProvider")]
     public function testEscapeCharacter(string $string, string $output): void
     {
         $result = ToStringHelper::escapeString($string);
@@ -63,7 +62,7 @@ public function testInvalidEscapeCharacter(): void
         ToStringHelper::escapeString('some string', '--');
     }
 
-    public function valueToStringProvider(): array
+    public static function valueToStringProvider(): array
     {
         return [
             [null, 'null'],
@@ -83,9 +82,14 @@ public function valueToStringProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider valueToStringProvider
-     */
+    public function testIsArrayAssociate(): void
+    {
+        $this->assertFalse(ToStringHelper::isArrayAssociate([]));
+        $this->assertFalse(ToStringHelper::isArrayAssociate([1, 2, 3]));
+        $this->assertTrue(ToStringHelper::isArrayAssociate(['a' => 'b', 'c' => 'd']));
+    }
+
+    #[DataProvider("valueToStringProvider")]
     public function testValueToString($value, $string): void
     {
         $this->assertSame($string, ToStringHelper::valueToString($value));
diff --git a/tests/Trait/IdentifiersTraitTest.php b/tests/Trait/IdentifiersTraitTest.php
@@ -13,7 +13,7 @@ class IdentifiersTraitTest extends TestCase
 {
     private function getTrait(): HasIdentifiersInterface
     {
-        return new class() implements HasIdentifiersInterface {
+        return new class implements HasIdentifiersInterface {
             use IdentifiersTrait;
         };
     }
diff --git a/tests/Trait/OptionsTraitTest.php b/tests/Trait/OptionsTraitTest.php
diff --git a/tests/Trait/PropertiesTraitTest.php b/tests/Trait/PropertiesTraitTest.php
