style: implement CodeIgniterRuleCustomisationPolicy (codeigniter4#9859)

Author: paulbalandan

.php-cs-fixer.dist.php

@@ -26,7 +26,6 @@
         'ThirdParty',
         'Validation/Views',
     ])
-    ->notName('#Foobar.php$#')
     ->append([
         __FILE__,
         __DIR__ . '/.php-cs-fixer.no-header.php',
@@ -37,9 +36,7 @@
         __DIR__ . '/spark',
     ]);
 
-$overrides = [
-    'modernize_strpos' => ['modernize_stripos' => true],
-];
+$overrides = [];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.cache',

.php-cs-fixer.tests.php

@@ -11,10 +11,11 @@
  * the LICENSE file that was distributed with this source code.
  */
 
-use PhpCsFixer\ConfigInterface;
+use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
+use Utils\PhpCsFixer\CodeIgniterRuleCustomisationPolicy;
 
-/** @var ConfigInterface $config */
+/** @var Config $config */
 $config = require __DIR__ . '/.php-cs-fixer.dist.php';
 
 $finder = Finder::create()
@@ -26,16 +27,15 @@
         '_support/View/Cells/multiplier.php',
         '_support/View/Cells/colors.php',
         '_support/View/Cells/addition.php',
-        'system/Database/Live/PreparedQueryTest.php',
-    ])
-    ->notName('#Foobar.php$#');
+    ]);
 
 $overrides = [
     'phpdoc_to_return_type' => true,
     'void_return'           => true,
 ];
 
 return $config
+    ->setRuleCustomisationPolicy(new CodeIgniterRuleCustomisationPolicy())
     ->setFinder($finder)
     ->setCacheFile('build/.php-cs-fixer.tests.cache')
     ->setRules(array_merge($config->getRules(), $overrides));

tests/_support/Commands/Foobar.php

@@ -1,11 +1,20 @@
 <?php
 
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 use Config\App;
 use CodeIgniter\CLI\CLI;
 
 return [
-   'foo' => 'The command will use this as foo.',
-   'bar' => 'The command will use this as bar.',
-   'baz' => 'The baz is here.',
-   'bas' => CLI::color('bas', 'green') . (new App())->baseURL,
+    'foo' => 'The command will use this as foo.',
+    'bar' => 'The command will use this as bar.',
+    'baz' => 'The baz is here.',
+    'bas' => CLI::color('bas', 'green') . (new App())->baseURL,
 ];

tests/system/Database/Live/PreparedQueryTest.php

@@ -256,15 +256,15 @@ public function testDeallocatePreparedQueryThenTryToClose(): void
                 'name'    => 'a',
                 'email'   => '[email protected]',
                 'country' => 'x',
-            ])
+            ]),
         );
 
         $this->query->close();
 
         // Try to close a non-existing prepared statement
         $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage(
-            'Cannot call close on a non-existing prepared statement.'
+            'Cannot call close on a non-existing prepared statement.',
         );
 
         $this->query->close();
@@ -325,7 +325,7 @@ public function testHandleTransStatusMarksTransactionFailedDuringTransaction():
 
         $this->seeInDatabase($this->db->DBPrefix . 'without_auto_increment', [
             'key'   => 'test_key',
-            'value' => 'test_value'
+            'value' => 'test_value',
         ]);
 
         $this->assertFalse($this->query->execute('test_key', 'different_value'));
@@ -339,7 +339,7 @@ public function testHandleTransStatusMarksTransactionFailedDuringTransaction():
         // Verify the first insert was rolled back
         $this->dontSeeInDatabase($this->db->DBPrefix . 'without_auto_increment', [
             'key'   => 'test_key',
-            'value' => 'test_value'
+            'value' => 'test_value',
         ]);
 
         $this->db->resetTransStatus();

utils/src/PhpCsFixer/CodeIgniterRuleCustomisationPolicy.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Utils\PhpCsFixer;
+
+use PhpCsFixer\Config\RuleCustomisationPolicyInterface;
+use SplFileInfo;
+
+/**
+ * Rule customisation policy for CodeIgniter coding standard.
+ *
+ * @internal
+ */
+final class CodeIgniterRuleCustomisationPolicy implements RuleCustomisationPolicyInterface
+{
+    public function getPolicyVersionForCache(): string
+    {
+        return hash_file('sha256', __FILE__);
+    }
+
+    public function getRuleCustomisers(): array
+    {
+        $normalisedStrEndsWith = static fn (string $haystack, string $needle): bool => str_ends_with(str_replace('\\', '/', $haystack), $needle);
+
+        return [
+            'native_function_casing' => static fn (SplFileInfo $file): bool => ! $normalisedStrEndsWith(
+                $file->getPathname(),
+                '/tests/system/Database/Live/PreparedQueryTest.php',
+            ),
+            'ordered_imports' => static fn (SplFileInfo $file): bool => ! $normalisedStrEndsWith(
+                $file->getPathname(),
+                '/tests/_support/Commands/Foobar.php',
+            ),
+        ];
+    }
+}