chore: cherry-pick structarmed.php from 4.8 to develop and use baseline config

Author: samsonasik

structarmed-baseline.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    [
+        'rule' => 'base_classes.must_be_abstract',
+        'message' => 'Extended class [CodeIgniter\Config\BaseService] must be declared abstract or instantiated',
+        'file' => 'system/Config/BaseService.php',
+        'class' => 'CodeIgniter\Config\BaseService',
+        'layer' => 'Source',
+    ],
+    [
+        'rule' => 'base_classes.must_be_abstract',
+        'message' => 'Extended class [CodeIgniter\Debug\Toolbar\Collectors\BaseCollector] must be declared abstract or instantiated',
+        'file' => 'system/Debug/Toolbar/Collectors/BaseCollector.php',
+        'class' => 'CodeIgniter\Debug\Toolbar\Collectors\BaseCollector',
+        'layer' => 'Source',
+    ],
+];

structarmed.php

@@ -10,35 +10,39 @@
  * For the full copyright and license information, please view
  * the LICENSE file that was distributed with this source code.
  */
-use Boundwize\StructArmed\Rule\Rules\Function_\MustHaveReturnTypeFunctionRule;
+
+use Boundwize\StructArmed\Architecture;
+use Boundwize\StructArmed\Preset\Preset;
 use Boundwize\StructArmed\Preset\Presets\CodeQualityPreset;
+use Boundwize\StructArmed\Preset\Presets\Psr4Preset;
+use Boundwize\StructArmed\Rule\Rules\Class_\ExtendedClassMustBeAbstractOrInstantiatedRule;
+use Boundwize\StructArmed\Rule\Rules\Function_\MustHaveReturnTypeFunctionRule;
 use CodeIgniter\Cache\ResponseCache;
+use CodeIgniter\Database\BaseResult;
+use CodeIgniter\DataCaster\DataCaster;
+use CodeIgniter\DataConverter\DataConverter;
+use CodeIgniter\Entity\Cast\CastInterface;
+use CodeIgniter\Entity\Cast\URICast;
+use CodeIgniter\Entity\Entity;
+use CodeIgniter\Entity\Exceptions\CastException;
 use CodeIgniter\HTTP\CLIRequest;
+use CodeIgniter\HTTP\DownloadResponse;
 use CodeIgniter\HTTP\Header;
 use CodeIgniter\HTTP\IncomingRequest;
+use CodeIgniter\HTTP\RedirectResponse;
+use CodeIgniter\HTTP\Response;
 use CodeIgniter\HTTP\ResponseInterface;
-use CodeIgniter\DataCaster\DataCaster;
-use CodeIgniter\Entity\Cast\CastInterface;
-use CodeIgniter\Entity\Exceptions\CastException;
-use CodeIgniter\DataConverter\DataConverter;
-use CodeIgniter\Entity\Entity;
-use CodeIgniter\Entity\Cast\URICast;
+use CodeIgniter\HTTP\ResponseTrait;
+use CodeIgniter\HTTP\SSEResponse;
+use CodeIgniter\HTTP\StreamResponse;
 use CodeIgniter\HTTP\URI;
 use CodeIgniter\Log\Handlers\ChromeLoggerHandler;
-use CodeIgniter\Security\CheckPhpIni;
-use CodeIgniter\View\Table;
-use CodeIgniter\Database\BaseResult;
-use CodeIgniter\View\Plugins;
-use CodeIgniter\HTTP\ResponseTrait;
 use CodeIgniter\Pager\PagerInterface;
-use CodeIgniter\HTTP\Response;
-use CodeIgniter\HTTP\RedirectResponse;
-use CodeIgniter\HTTP\DownloadResponse;
+use CodeIgniter\Security\CheckPhpIni;
 use CodeIgniter\Validation\Validation;
+use CodeIgniter\View\Plugins;
 use CodeIgniter\View\RendererInterface;
-use Boundwize\StructArmed\Architecture;
-use Boundwize\StructArmed\Preset\Preset;
-use Boundwize\StructArmed\Preset\Presets\Psr4Preset;
+use CodeIgniter\View\Table;
 
 return Architecture::define()
     ->skip([
@@ -56,6 +60,8 @@
     ->layer('Helpers', __DIR__ . '/system/Helpers')
     ->rule('helpers.functions_must_have_return_type', new MustHaveReturnTypeFunctionRule('Helpers'))
 
+    ->rule('base_classes.must_be_abstract', new ExtendedClassMustBeAbstractOrInstantiatedRule('Source', '/^CodeIgniter\\\\.*Base.*$/'))
+
     // Resolve CodeIgniter layers from class names because several layers share directories.
     ->layerPattern('API', '/^CodeIgniter\\\\API\\\\.*$/')
     ->layerPattern('Cache', '/^CodeIgniter\\\\Cache\\\\.*$/')
@@ -72,11 +78,13 @@
     ->layerPattern('Filters', '/^CodeIgniter\\\\Filters\\\\Filter.*$/')
     ->layerPattern('Format', '/^CodeIgniter\\\\Format\\\\.*$/')
     ->layerPattern('Honeypot', '/^CodeIgniter\\\\.*Honeypot.*$/')
+    ->layerPattern('Input', '/^CodeIgniter\\\\Input\\\\.*$/')
     ->layerPattern('URI', '/^CodeIgniter\\\\HTTP\\\\URI$/')
     ->layerPattern('HTTP', '/^CodeIgniter\\\\HTTP\\\\.*$/', '/(Exception|URI)/')
     ->layerPattern('I18n', '/^CodeIgniter\\\\I18n\\\\.*$/')
     ->layerPattern('Images', '/^CodeIgniter\\\\Images\\\\.*$/')
     ->layerPattern('Language', '/^CodeIgniter\\\\Language\\\\.*$/')
+    ->layerPattern('Lock', '/^CodeIgniter\\\\Lock\\\\.*$/')
     ->layerPattern('Log', '/^CodeIgniter\\\\Log\\\\.*$/')
     ->layerPattern('Model', '/^CodeIgniter\\\\.*Model$/')
     ->layerPattern('Modules', '/^CodeIgniter\\\\Modules\\\\.*$/')
@@ -96,26 +104,28 @@
         'Controller'    => ['HTTP', 'Validation'],
         'Cookie'        => ['I18n'],
         'Database'      => ['Entity', 'Events', 'I18n'],
-        'DataCaster'    => ['I18n', 'URI', 'Database'],
+        'DataCaster'    => ['I18n', 'URI', 'Database', 'Encryption'],
         'DataConverter' => ['DataCaster'],
         'Email'         => ['I18n', 'Events'],
         'Entity'        => ['DataCaster', 'I18n'],
         'Files'         => ['I18n'],
         'Filters'       => ['HTTP'],
         'Honeypot'      => ['Filters', 'HTTP'],
-        'HTTP'          => ['Cookie', 'Files', 'I18n', 'Security', 'URI'],
+        'HTTP'          => ['Cookie', 'Files', 'I18n', 'Input', 'Security', 'URI'],
+        'Input'         => ['I18n'],
         'Images'        => ['Files', 'I18n'],
+        'Lock'          => ['Cache'],
         'Model'         => ['Database', 'DataCaster', 'DataConverter', 'Entity', 'I18n', 'Pager', 'Validation'],
         'Pager'         => ['URI', 'View'],
         'Publisher'     => ['Files', 'URI'],
         // +API = API + its allowed layers; +Controller = Controller + its allowed layers
-        'RESTful'       => ['+API', '+Controller'],
-        'Router'        => ['HTTP', 'I18n'],
-        'Security'      => ['Cookie', 'HTTP', 'I18n', 'Session'],
-        'Session'       => ['Cookie', 'Database', 'HTTP', 'I18n'],
-        'Throttle'      => ['Cache', 'I18n'],
-        'Validation'    => ['Database', 'HTTP', 'Helpers'],
-        'View'          => ['Cache'],
+        'RESTful'    => ['+API', '+Controller'],
+        'Router'     => ['HTTP', 'I18n'],
+        'Security'   => ['Cookie', 'HTTP', 'I18n', 'Session'],
+        'Session'    => ['Cookie', 'Database', 'HTTP', 'I18n'],
+        'Throttle'   => ['Cache', 'I18n'],
+        'Validation' => ['Database', 'HTTP', 'Helpers', 'I18n', 'Input'],
+        'View'       => ['Cache'],
     ])
     ->skipPathsForRuleset(['*test*'])
     // Skip violations for class-specific dependencies.
@@ -129,7 +139,7 @@
         CastInterface::class,
         CastException::class,
     ])
-    ->skipClassViolation(\CodeIgniter\DataCaster\Exceptions\CastException::class, [
+    ->skipClassViolation(CodeIgniter\DataCaster\Exceptions\CastException::class, [
         CastException::class,
     ])
     ->skipClassViolation(DataConverter::class, [
@@ -157,4 +167,8 @@
     ->skipClassViolation(Response::class, [PagerInterface::class])
     ->skipClassViolation(RedirectResponse::class, [PagerInterface::class])
     ->skipClassViolation(DownloadResponse::class, [PagerInterface::class])
-    ->skipClassViolation(Validation::class, [RendererInterface::class]);
+    ->skipClassViolation(SSEResponse::class, [PagerInterface::class])
+    ->skipClassViolation(StreamResponse::class, [PagerInterface::class])
+    ->skipClassViolation(Validation::class, [RendererInterface::class])
+
+    ->baseline(__DIR__ . '/structarmed-baseline.php');