refactor: update rector, psalm and add strict types (#159)

* refactor: update rector, psalm and add strict types

* fix randomly failing tests

Author: michalsn

.php-cs-fixer.dist.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use CodeIgniter\CodingStandard\CodeIgniter4;
 use Nexus\CsConfig\Factory;
 use PhpCsFixer\Finder;
@@ -20,8 +22,8 @@
     ]);
 
 $overrides = [
-    // 'declare_strict_types' => true,
-    // 'void_return'          => true,
+    'declare_strict_types' => true,
+    'void_return'          => true,
 ];
 
 $options = [

UPGRADING.md

@@ -1,5 +1,11 @@
 # Upgrade Guide
 
+## Version 2.2.0 to 2.3.0
+
+* The minimum required version of CodeIgniter is now `4.3` and PHP `8.2`.
+* All source files now declare `strict_types=1`.
+* `BaseHandler` methods `set()`, `forget()`, `flush()`, and `persistPendingProperties()` now have `void` return types. Any custom handler extending `BaseHandler` must update its method signatures to include `: void`.
+
 ## Version 1 to 2
 ***
 

composer.json

@@ -21,7 +21,7 @@
     },
     "require-dev": {
         "codeigniter4/devkit": "^1.3",
-        "codeigniter4/framework": "^4.2.3"
+        "codeigniter4/framework": "^4.3"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

docs/limitations.md

@@ -10,9 +10,9 @@ The following are known limitations of the library:
 2. **Deferred writes (`deferWrites => true`)**: All settings are batched and written to storage at the end of the request
    (during the `post_system` event). This minimizes the number of database queries and file writes, improving performance.
    However, there are important considerations:
-   - Write operations will not appear in CodeIgniter's Debug Toolbar, since the `post_system` event executes after toolbar data collection.
-   - If the request terminates early (fatal error, `exit()`, etc.) before `post_system`, pending writes are lost.
-   - Write failures are logged but handled silently - no exceptions are thrown back to the calling code.
+    - Write operations will not appear in CodeIgniter's Debug Toolbar, since the `post_system` event executes after toolbar data collection.
+    - If the request terminates early (fatal error, `exit()`, etc.) before `post_system`, pending writes are lost.
+    - Write failures are logged but handled silently - no exceptions are thrown back to the calling code.
 
 3. **First-level property access only**: You can only access the first level of a config property directly. In most config classes
    this is not an issue, since properties are simple values. However, some config files (like `Database`) contain properties that

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    phpVersion="8.1"
+    phpVersion="8.2"
     errorLevel="7"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

rector.php

@@ -42,7 +42,13 @@
 use Rector\ValueObject\PhpVersion;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->sets([SetList::DEAD_CODE, LevelSetList::UP_TO_PHP_74, PHPUnitSetList::PHPUNIT_80]);
+    $rectorConfig->sets([
+        SetList::DEAD_CODE,
+        LevelSetList::UP_TO_PHP_82,
+        PHPUnitSetList::PHPUNIT_CODE_QUALITY,
+        PHPUnitSetList::PHPUNIT_100,
+    ]);
+
     $rectorConfig->parallel();
     // The paths to refactor (can also be supplied with CLI arguments)
     $rectorConfig->paths([
@@ -65,7 +71,7 @@
     }
 
     // Set the target version for refactoring
-    $rectorConfig->phpVersion(PhpVersion::PHP_74);
+    $rectorConfig->phpVersion(PhpVersion::PHP_82);
 
     // Auto-import fully qualified class names
     $rectorConfig->importNames();

src/Commands/ClearSettings.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CodeIgniter\Settings\Commands;
 
 use CodeIgniter\CLI\BaseCommand;
@@ -12,7 +14,7 @@ class ClearSettings extends BaseCommand
     protected $name        = 'settings:clear';
     protected $description = 'Clears all settings from persistent storage.';
 
-    public function run(array $params)
+    public function run(array $params): void
     {
         $config   = config('Settings');
         $handlers = $this->getHandlerNames($config);

src/Config/Services.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CodeIgniter\Settings\Config;
 
 use CodeIgniter\Config\BaseService;

src/Config/Settings.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CodeIgniter\Settings\Config;
 
 use CodeIgniter\Config\BaseConfig;

src/Database/Migrations/2021-07-04-041948_CreateSettingsTable.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CodeIgniter\Settings\Database\Migrations;
 
 use CodeIgniter\Database\Forge;
@@ -8,7 +10,7 @@
 
 class CreateSettingsTable extends Migration
 {
-    private Settings $config;
+    private readonly Settings $config;
 
     public function __construct(?Forge $forge = null)
     {
@@ -18,7 +20,7 @@ public function __construct(?Forge $forge = null)
         parent::__construct($forge);
     }
 
-    public function up()
+    public function up(): void
     {
         $this->forge->addField('id');
         $this->forge->addField([
@@ -51,7 +53,7 @@ public function up()
         $this->forge->createTable($this->config->database['table'], true);
     }
 
-    public function down()
+    public function down(): void
     {
         $this->forge->dropTable($this->config->database['table']);
     }