chore(cs): use php-cs-fixer with PER2.0 standard

SamMousa · SamMousa · commit e6fbf6fbdd7c · 2025-02-24T17:14:09.000+01:00
diff --git a/composer.json b/composer.json
@@ -30,7 +30,8 @@
         "codeception/module-asserts": ">= 3.0",
         "codeception/module-filesystem": "> 3.0",
         "phpstan/phpstan": "^2",
-        "rector/rector": "^2"
+        "rector/rector": "^2",
+        "friendsofphp/php-cs-fixer": "^3.70"
     },
     "autoload":{
         "classmap": ["src/"]
diff --git a/src/Codeception/Lib/Connector/Yii2.php b/src/Codeception/Lib/Connector/Yii2.php
@@ -32,41 +32,40 @@
 use yii\web\Response as YiiResponse;
 use yii\web\User;
 
-
 /**
  * @extends Client<BrowserkitRequest, Response>
  */
 class Yii2 extends Client
 {
     use Shared\PhpSuperGlobalsConverter;
 
-    const CLEAN_METHODS = [
+    public const CLEAN_METHODS = [
         self::CLEAN_RECREATE,
         self::CLEAN_CLEAR,
         self::CLEAN_FORCE_RECREATE,
-        self::CLEAN_MANUAL
+        self::CLEAN_MANUAL,
     ];
     /**
      * Clean the response object by recreating it.
      * This might lose behaviors / event handlers / other changes that are done in the application bootstrap phase.
      */
-    const CLEAN_RECREATE = 'recreate';
+    public const CLEAN_RECREATE = 'recreate';
     /**
      * Same as recreate but will not warn when behaviors / event handlers are lost.
      */
-    const CLEAN_FORCE_RECREATE = 'force_recreate';
+    public const CLEAN_FORCE_RECREATE = 'force_recreate';
     /**
      * Clean the response object by resetting specific properties via its' `clear()` method.
      * This will keep behaviors / event handlers, but could inadvertently leave some changes intact.
      * @see \yii\web\Response::clear()
      */
-    const CLEAN_CLEAR = 'clear';
+    public const CLEAN_CLEAR = 'clear';
 
     /**
      * Do not clean the response, instead the test writer will be responsible for manually resetting the response in
      * between requests during one test
      */
-    const CLEAN_MANUAL = 'manual';
+    public const CLEAN_MANUAL = 'manual';
 
 
     /**
@@ -257,7 +256,7 @@ function ($matches) use (&$parameters): string {
                     $parameters[$key] = $matches[1] ?? '\w+';
                     return $key;
                 },
-                $template
+                $template,
             );
         }
         if ($template === null) {
@@ -327,7 +326,7 @@ public function doRequest(object $request): Response
         $queryString = parse_url($uri, PHP_URL_QUERY);
         $_SERVER['REQUEST_URI'] = $queryString === null ? $pathString : $pathString . '?' . $queryString;
         $_SERVER['REQUEST_METHOD'] = strtoupper($request->getMethod());
-        $_SERVER['QUERY_STRING'] = (string)$queryString;
+        $_SERVER['QUERY_STRING'] = (string) $queryString;
 
         parse_str($queryString ?: '', $params);
         foreach ($params as $k => $v) {
@@ -403,7 +402,7 @@ public function doRequest(object $request): Response
     protected function encodeCookies(
         YiiResponse $response,
         YiiRequest $request,
-        Security $security
+        Security $security,
     ): void {
         if ($request->enableCookieValidation) {
             $validationKey = $request->cookieValidationKey;
@@ -419,15 +418,15 @@ protected function encodeCookies(
                     : $cookie->value;
                 $value = $security->hashData(serialize($data), $validationKey);
             }
-            $expires = is_int($cookie->expire) ? (string)$cookie->expire : null;
+            $expires = is_int($cookie->expire) ? (string) $cookie->expire : null;
             $c = new Cookie(
                 $cookie->name,
                 $value,
                 $expires,
                 $cookie->path,
                 $cookie->domain,
                 $cookie->secure,
-                $cookie->httpOnly
+                $cookie->httpOnly,
             );
             $this->getCookieJar()->set($c);
         }
@@ -457,13 +456,15 @@ protected function mockMailer(array $config): array
             'class' => TestMailer::class,
             'callback' => function (BaseMessage $message): void {
                 $this->emails[] = $message;
-            }
+            },
         ];
 
         if (isset($config['components'])) {
             if (!is_array($config['components'])) {
-                throw new ModuleConfigException($this,
-                    "Yii2 config does not contain components key is not of type array");
+                throw new ModuleConfigException(
+                    $this,
+                    "Yii2 config does not contain components key is not of type array",
+                );
             }
         } else {
             $config['components'] = [];
@@ -538,12 +539,13 @@ protected function resetResponse(Application $app): void
                 || count($app->response->getBehaviors()) > 0)
             && $method === self::CLEAN_RECREATE
         ) {
-            Debug::debug(<<<TEXT
+            Debug::debug(
+                <<<TEXT
 [WARNING] You are attaching event handlers or behaviors to the response object. But the Yii2 module is configured to recreate
 the response object, this means any behaviors or events that are not attached in the component config will be lost.
 We will fall back to clearing the response. If you are certain you want to recreate it, please configure
 responseCleanMethod = 'force_recreate' in the module.
-TEXT
+TEXT,
             );
             $method = self::CLEAN_CLEAR;
         }
@@ -563,12 +565,13 @@ protected function resetRequest(Application $app): void
 
         // First check the current request object.
         if (count($request->getBehaviors()) > 0 && $method === self::CLEAN_RECREATE) {
-            Debug::debug(<<<TEXT
+            Debug::debug(
+                <<<TEXT
 [WARNING] You are attaching event handlers or behaviors to the request object. But the Yii2 module is configured to recreate
 the request object, this means any behaviors or events that are not attached in the component config will be lost.
 We will fall back to clearing the request. If you are certain you want to recreate it, please configure 
 requestCleanMethod = 'force_recreate' in the module.  
-TEXT
+TEXT,
             );
             $method = self::CLEAN_CLEAR;
         }
diff --git a/src/Codeception/Lib/Connector/Yii2/FixturesStore.php b/src/Codeception/Lib/Connector/Yii2/FixturesStore.php
@@ -16,9 +16,7 @@ class FixturesStore
      *
      * FixturesStore constructor.
      */
-    public function __construct(protected mixed $data)
-    {
-    }
+    public function __construct(protected mixed $data) {}
 
     public function fixtures(): mixed
     {
diff --git a/src/Codeception/Lib/Connector/Yii2/Logger.php b/src/Codeception/Lib/Connector/Yii2/Logger.php
@@ -38,11 +38,13 @@ public function init(): void
      */
     public function log($message, $level, $category = 'application'): void
     {
-        if (!in_array($level, [
-            self::LEVEL_INFO,
-            self::LEVEL_WARNING,
-            self::LEVEL_ERROR,
-        ], true)) {
+        if (
+            !in_array($level, [
+                self::LEVEL_INFO,
+                self::LEVEL_WARNING,
+                self::LEVEL_ERROR,
+            ], true)
+        ) {
             return;
         }
         if (str_starts_with($category, 'yii\db\Command')) {
diff --git a/src/Codeception/Lib/Connector/Yii2/TransactionForcer.php b/src/Codeception/Lib/Connector/Yii2/TransactionForcer.php
@@ -55,19 +55,21 @@ protected function connectionOpened(Connection $connection): void
          */
         if (isset($this->pdoCache[$key])) {
             $connection->pdo = $this->pdoCache[$key];
-        } elseif(isset($connection->pdo)) {
+        } elseif (isset($connection->pdo)) {
             $this->pdoCache[$key] = $connection->pdo;
         }
-        if (isset($this->dsnCache[$connection->dsn])
+        if (
+            isset($this->dsnCache[$connection->dsn])
             && $this->dsnCache[$connection->dsn] !== $key
             && !$this->ignoreCollidingDSN
         ) {
-            $this->debug(<<<TEXT
+            $this->debug(
+                <<<TEXT
 You use multiple connections to the same DSN ({$connection->dsn}) with different configuration.
 These connections will not see the same database state since we cannot share a transaction between different PDO
 instances.
 You can remove this message by adding 'ignoreCollidingDSN = true' in the module configuration.
-TEXT
+TEXT,
             );
             Debug::pause();
         }
diff --git a/src/Codeception/Module/Yii2.php b/src/Codeception/Module/Yii2.php
@@ -316,7 +316,7 @@ private function initServerGlobal(): void
             'SCRIPT_NAME' => $entryScript,
             'SERVER_NAME' => $parsedUrl['host'] ?? '',
             'SERVER_PORT' => $parsedUrl['port'] ?? '80',
-            'HTTPS' => isset($parsedUrl['scheme']) && $parsedUrl['scheme'] === 'https'
+            'HTTPS' => isset($parsedUrl['scheme']) && $parsedUrl['scheme'] === 'https',
         ]);
     }
 
@@ -329,27 +329,27 @@ protected function validateConfig(): void
         if (!isset($this->config['configFile'])) {
             throw new ModuleConfigException(
                 self::class,
-                "The application config file was not configured"
+                "The application config file was not configured",
             );
         }
         $pathToConfig = codecept_absolute_path($this->config['configFile']);
         if (!is_file($pathToConfig)) {
             throw new ModuleConfigException(
                 self::class,
-                "The application config file does not exist: " . $pathToConfig
+                "The application config file does not exist: " . $pathToConfig,
             );
         }
         $validMethods = implode(", ", Yii2Connector::CLEAN_METHODS);
         if (!in_array($this->config['responseCleanMethod'], Yii2Connector::CLEAN_METHODS, true)) {
             throw new ModuleConfigException(
                 self::class,
-                "The response clean method must be one of: " . $validMethods
+                "The response clean method must be one of: " . $validMethods,
             );
         }
         if (!in_array($this->config['requestCleanMethod'], Yii2Connector::CLEAN_METHODS, true)) {
             throw new ModuleConfigException(
                 self::class,
-                "The request clean method must be one of: " . $validMethods
+                "The request clean method must be one of: " . $validMethods,
             );
         }
     }
@@ -384,7 +384,7 @@ protected function recreateClient(): void
             'SCRIPT_NAME' => $entryScript,
             'SERVER_NAME' => $parsedUrl['host'] ?? '',
             'SERVER_PORT' => $parsedUrl['port'] ?? '80',
-            'HTTPS' => isset($parsedUrl['scheme']) && $parsedUrl['scheme'] === 'https'
+            'HTTPS' => isset($parsedUrl['scheme']) && $parsedUrl['scheme'] === 'https',
         ]);
         $this->validateConfig();
         $this->configureClient($this->config);
@@ -417,7 +417,8 @@ public function _before(TestInterface $test): void
     private function loadFixtures(object $test): void
     {
         $this->debugSection('Fixtures', 'Loading fixtures');
-        if ($this->loadedFixtures === []
+        if (
+            $this->loadedFixtures === []
             && method_exists($test, $this->config['fixturesMethod'])
         ) {
             $connectionWatcher = new ConnectionWatcher();
@@ -517,7 +518,7 @@ public function amLoggedInAs(int|string|IdentityInterface $user): void
     {
         try {
             $this->getClient()->findAndLoginUser($user);
-        } catch (ConfigurationException|RuntimeException $e) {
+        } catch (ConfigurationException | RuntimeException $e) {
             throw new ModuleException($this, $e->getMessage());
         }
     }
@@ -579,8 +580,8 @@ public function haveFixtures(array $fixtures): void
     public function grabFixtures(): array
     {
         $result = [];
-        foreach($this->loadedFixtures as $store) {
-            foreach($store->getFixtures() as $name => $fixture) {
+        foreach ($this->loadedFixtures as $store) {
+            foreach ($store->getFixtures() as $name => $fixture) {
                 $result[$name] = $fixture;
             }
         }
@@ -616,7 +617,7 @@ public function grabFixture(string $name, null|string $index = null): Fixture|\y
         return match (true) {
             $index === null => $fixture,
             $fixture instanceof \yii\test\BaseActiveFixture => $fixture->getModel($index),
-            default => throw new ModuleException($this, "Fixture $name is not an instance of ActiveFixture and can't be loaded with second parameter")
+            default => throw new ModuleException($this, "Fixture $name is not an instance of ActiveFixture and can't be loaded with second parameter"),
         };
     }
 
@@ -713,7 +714,8 @@ protected function findRecord(string $model, array $attributes = []): ActiveReco
             throw new RuntimeException("Class $model does not exist");
         }
         $rc = new ReflectionClass($model);
-        if ($rc->hasMethod('find')
+        if (
+            $rc->hasMethod('find')
             /** @phpstan-ignore-next-line */
             && ($findMethod = $rc->getMethod('find'))
             && $findMethod->isStatic()

Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,7 @@ class FixturesStore`
`16`	`16`	`*`
`17`	`17`	`* FixturesStore constructor.`
`18`	`18`	`*/`
`19`		`- public function __construct(protected mixed $data)`
`20`		`- {`
`21`		`- }`
	`19`	`+ public function __construct(protected mixed $data) {}`
`22`	`20`
`23`	`21`	`public function fixtures(): mixed`
`24`	`22`	`{`