💚 Upgrade php-cs-fixer, define configuration, apply changes

Author: homersimpsons

.github/workflows/continuous-integration.yml

@@ -37,11 +37,8 @@ jobs:
       - name: "Install dependencies with composer"
         run: "composer install --no-interaction --no-progress"
 
-      - name: "Run PHP-CS-Fixer on src/"
-        run: "vendor/bin/php-cs-fixer fix src/ --dry-run --stop-on-violation --format=checkstyle | cs2pr"
-
-      - name: "Run PHP-CS-Fixer on tests/"
-        run: "vendor/bin/php-cs-fixer fix tests/ --dry-run --stop-on-violation --format=checkstyle | cs2pr"
+      - name: "Run PHP-CS-Fixer"
+        run: "vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --format=checkstyle | cs2pr"
 
   require-checker:
     name: "Composer require checker"

.php-cs-fixer.dist.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+return (new Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@auto' => true,
+        '@auto:risky' => true
+    ])
+    // 💡 by default, Fixer looks for `*.php` files excluding `./vendor/` - here, you can groom this config
+    ->setFinder(
+        (new Finder())
+            // 💡 root folder to check
+            ->in([__DIR__ . '/src', __DIR__ . '/tests'])
+    // 💡 additional files, eg bin entry file
+    // ->append([__DIR__.'/bin-entry-file'])
+    // 💡 folders to exclude, if any
+    // ->exclude([/* ... */])
+    // 💡 path patterns to exclude, if any
+    // ->notPath([/* ... */])
+    // 💡 extra configs
+    // ->ignoreDotFiles(false) // true by default in v3, false in v4 or future mode
+    // ->ignoreVCS(true) // true by default
+    );

composer.json

@@ -18,7 +18,7 @@
         }
     ],
     "require" : {
-        "php": "^8.0",
+        "php": "^8.2",
         "mouf/magic-query": "^2.0",
         "mouf/schema-analyzer": "^2.0",
         "doctrine/dbal": "^3.6",
@@ -46,7 +46,7 @@
         "phpunit/phpunit": "^9.5",
         "php-coveralls/php-coveralls": "^2.1",
         "fig/log-test": "^1.2",
-        "friendsofphp/php-cs-fixer": "^3.11",
+        "friendsofphp/php-cs-fixer": "^3.95",
         "symfony/process": "^5 || ^6 || ^7",
         "thecodingmachine/tdbm-fluid-schema-builder": "^v2.0.0",
         "phpstan/phpstan": "^2.0",
@@ -73,8 +73,8 @@
         "phpstan": "php -d memory_limit=3G vendor/bin/phpstan analyse src -c phpstan.neon --no-progress -vvv",
         "require-checker": "composer-require-checker check --config-file=composer-require-checker.json",
         "test": "XDEBUG_MODE=coverage phpunit",
-        "csfix": "php-cs-fixer fix src/ && php-cs-fixer fix tests/",
-        "cscheck": "php-cs-fixer fix src/ --dry-run --stop-on-violation && php-cs-fixer fix tests/ --dry-run --stop-on-violation ",
+        "csfix": "php-cs-fixer fix",
+        "cscheck": "php-cs-fixer fix --dry-run --stop-on-violation",
         "ci": [
             "@cscheck",
             "@phpstan",

src/AbstractTDBMObject.php

@@ -258,7 +258,7 @@ protected function set(string $var, $value, ?string $tableName = null): void
      */
     protected function setRef(string $foreignKeyName, ?AbstractTDBMObject $bean, string $tableName, string $className, string $resultIteratorClass): void
     {
-        assert($bean === null || is_a($bean, $className), new TDBMInvalidArgumentException('$bean should be `null` or `' . $className . '`. `' . ($bean === null ? 'null' : get_class($bean)) . '` provided.'));
+        assert($bean === null || is_a($bean, $className), new TDBMInvalidArgumentException('$bean should be `null` or `' . $className . '`. `' . ($bean === null ? 'null' : $bean::class) . '` provided.'));
 
         if (!isset($this->dbRows[$tableName])) {
             $this->registerTable($tableName);
@@ -479,7 +479,7 @@ private function getRelationshipStorage(string $pivotTableName): \SplObjectStora
      */
     private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName): AlterableResultIterator
     {
-        $key = $tableName.'___'.$foreignKeyName;
+        $key = $tableName . '___' . $foreignKeyName;
 
         return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator();
     }
@@ -522,8 +522,8 @@ private function removeManyToOneRelationship(string $tableName, string $foreignK
      */
     protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, array $searchFilter, ?string $orderString, string $resultIteratorClass): AlterableResultIterator
     {
-        assert(is_a($resultIteratorClass, ResultIterator::class, true), new TDBMInvalidArgumentException('$resultIteratorClass should be a `'. ResultIterator::class. '`. `' . $resultIteratorClass . '` provided.'));
-        $key = $tableName.'___'.$foreignKeyName;
+        assert(is_a($resultIteratorClass, ResultIterator::class, true), new TDBMInvalidArgumentException('$resultIteratorClass should be a `' . ResultIterator::class . '`. `' . $resultIteratorClass . '` provided.'));
+        $key = $tableName . '___' . $foreignKeyName;
         $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
         if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) {
             return $alterableResultIterator;
@@ -660,7 +660,7 @@ protected static function getForeignKeys(string $tableName): ForeignKeys
 
     public function _getManyToManyRelationshipDescriptor(string $pathKey): ManyToManyRelationshipPathDescriptor
     {
-        throw new TDBMException('Could not find many to many relationship descriptor key for "'.$pathKey.'"');
+        throw new TDBMException('Could not find many to many relationship descriptor key for "' . $pathKey . '"');
     }
 
     /**

src/Configuration.php

@@ -256,7 +256,7 @@ public function getAnnotationParser(): AnnotationParser
      */
     public static function getDefaultLockFilePath(): string
     {
-        return RootProjectLocator::getRootLocationPath().'tdbm.lock.yml';
+        return RootProjectLocator::getRootLocationPath() . 'tdbm.lock.yml';
     }
 
     public function getLockFilePath(): string

src/DbRow.php

@@ -116,7 +116,7 @@ class DbRow
      * @param mixed[] $dbRow
      * @throws TDBMException
      */
-    public function __construct(AbstractTDBMObject $object, string $tableName, ForeignKeys $foreignKeys, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = [])
+    public function __construct(AbstractTDBMObject $object, string $tableName, ForeignKeys $foreignKeys, array $primaryKeys = [], TDBMService $tdbmService = null, array $dbRow = [])
     {
         $this->object = $object;
         $this->dbTableName = $tableName;
@@ -193,15 +193,15 @@ public function _dbLoadIfNotLoaded(): void
             }
             $connection = $this->tdbmService->getConnection();
 
-            list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys, $connection->getDatabasePlatform());
+            [$sql_where, $parameters] = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys, $connection->getDatabasePlatform());
 
-            $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
+            $sql = 'SELECT * FROM ' . $connection->quoteIdentifier($this->dbTableName) . ' WHERE ' . $sql_where;
             $result = $connection->executeQuery($sql, $parameters);
 
             $row = $result->fetchAssociative();
 
             if ($row === false) {
-                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \".$sql_where.\" with data \"".var_export($parameters, true)."\".");
+                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \".$sql_where.\" with data \"" . var_export($parameters, true) . "\".");
             }
 
             $this->dbRow = [];

src/EmptyInnerResultIterator.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace TheCodingMachine\TDBM;
 
 use Iterator;
@@ -91,7 +93,7 @@ public function offsetExists($offset): bool
      */
     public function offsetGet($offset): mixed
     {
-        throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
+        throw new TDBMInvalidOffsetException('Offset "' . $offset . '" does not exist in result set.');
     }
 
     /**

src/EmptyResultIterator.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace TheCodingMachine\TDBM;
 
 class EmptyResultIterator extends ResultIterator

src/InnerResultArray.php

@@ -90,15 +90,15 @@ public function offsetGet($offset): mixed
     private function toIndex($offset): void
     {
         if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) {
-            throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.');
+            throw new TDBMInvalidOffsetException('Trying to access result set using offset "' . $offset . '". An offset must be a positive integer.');
         }
         if ($this->result === null) {
             $this->executeQuery();
         }
         while (!isset($this->results[$offset])) {
             $this->next();
             if ($this->current === null) {
-                throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
+                throw new TDBMInvalidOffsetException('Offset "' . $offset . '" does not exist in result set.');
             }
         }
     }

src/InnerResultIterator.php

@@ -113,7 +113,7 @@ protected function executeQuery(): void
     {
         $sql = $this->getQuery();
 
-        $this->logger->debug('Running SQL request: '.$sql);
+        $this->logger->debug('Running SQL request: ' . $sql);
 
         $this->result = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters, DbalUtils::generateTypes($this->parameters));
 
@@ -146,9 +146,9 @@ public function count(): int
      */
     private function getRowCountViaSqlQuery(): int
     {
-        $countSql = 'SELECT COUNT(1) FROM ('.$this->getQuery().') c';
+        $countSql = 'SELECT COUNT(1) FROM (' . $this->getQuery() . ') c';
 
-        $this->logger->debug('Running count SQL request: '.$countSql);
+        $this->logger->debug('Running count SQL request: ' . $countSql);
 
         $this->count = (int) $this->tdbmService->getConnection()->fetchOne($countSql, $this->parameters, DbalUtils::generateTypes($this->parameters));
         return $this->count;
@@ -216,7 +216,7 @@ public function next(): void
             foreach ($beansData as $beanData) {
                 // Let's find the bean class name associated to the bean.
 
-                list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData);
+                [$actualClassName, $mainBeanTableName, $tablesUsed] = $this->tdbmService->_getClassNameFromBeanData($beanData);
 
                 // @TODO (gua) this is a weird hack to be able to force a TDBMObject...
                 // `$this->className` could be used to override `$actualClassName`