Enhance project configuration and add new files for improved coding s… (#243)

* Enhance project configuration and add new files for improved coding standards and testing

* Add PHPStan baseline errors for improved code quality checks

* Add CI/CD workflows for PHP with Docker support

* Add CI/CD workflows for PHP with Docker support

Author: Spomky

.ci-tools/deptrac.yaml

@@ -0,0 +1,15 @@
+parameters:
+  paths:
+    - '../src'
+  layers:
+    - name: 'OTP'
+      collectors:
+        - type: 'classLike'
+          value: '^OTPHP\\'
+    - name: 'Vendors'
+      collectors:
+        - { type: 'classLike', value: '^ParagonIE\\' }
+        - { type: 'classLike', value: '^Psr\\Clock\\' }
+  ruleset:
+    OTP:
+      - Vendors

ecs.php .ci-tools/ecs.phpecs.php renamed to .ci-tools/ecs.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-use PhpCsFixer\Fixer\Alias\MbStrFunctionsFixer;
 use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
 use PhpCsFixer\Fixer\ClassNotation\ProtectedToPrivateFixer;
 use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
@@ -26,11 +25,13 @@
 use PhpCsFixer\Fixer\Strict\StrictComparisonFixer;
 use PhpCsFixer\Fixer\Strict\StrictParamFixer;
 use PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer;
-use PhpCsFixer\Fixer\Whitespace\CompactNullableTypehintFixer;
+use PhpCsFixer\Fixer\Whitespace\MethodChainingIndentationFixer;
+use Symplify\CodingStandard\Fixer\Spacing\MethodChainingNewlineFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
 return static function (ECSConfig $config): void {
+    $header = '';
     $config->import(SetList::PSR_12);
     $config->import(SetList::CLEAN_CODE);
     $config->import(SetList::DOCTRINE_ANNOTATIONS);
@@ -52,11 +53,9 @@
     $config->rule(ProtectedToPrivateFixer::class);
     $config->rule(DeclareStrictTypesFixer::class);
     $config->rule(NativeConstantInvocationFixer::class);
-    $config->rule(MbStrFunctionsFixer::class);
     $config->rule(LinebreakAfterOpeningTagFixer::class);
     $config->rule(CombineConsecutiveIssetsFixer::class);
     $config->rule(CombineConsecutiveUnsetsFixer::class);
-    $config->rule(CompactNullableTypehintFixer::class);
     $config->rule(NoSuperfluousElseifFixer::class);
     $config->rule(NoSuperfluousPhpdocTagsFixer::class);
     $config->rule(PhpdocTrimConsecutiveBlankLineSeparationFixer::class);
@@ -72,7 +71,7 @@
         'strict' => true,
     ]);
     $config->ruleWithConfiguration(HeaderCommentFixer::class, [
-        'header' => '',
+        'header' => $header,
     ]);
     $config->ruleWithConfiguration(AlignMultilineCommentFixer::class, [
         'comment_type' => 'all_multiline',
@@ -86,7 +85,18 @@
         'import_functions' => true,
     ]);
 
+    $config->skip([
+        PhpUnitTestClassRequiresCoversFixer::class,
+        MethodChainingIndentationFixer::class => [__DIR__ . '/src/Resources/config'],
+        MethodChainingNewlineFixer::class => [__DIR__ . '/src/Resources/config'],
+    ]);
+
     $config->parallel();
-    $config->paths([__DIR__]);
-    $config->skip([__DIR__ . '/vendor', PhpUnitTestClassRequiresCoversFixer::class]);
+    $config->paths([
+        __DIR__ . '/../src',
+        __DIR__ . '/../tests',
+        __DIR__ . '/../castor.php',
+        __DIR__ . '/ecs.php',
+        __DIR__ . '/rector.php',
+    ]);
 };

infection.json.dist .ci-tools/infection.json.distinfection.json.dist renamed to .ci-tools/infection.json.dist

@@ -4,11 +4,17 @@
             "src"
         ]
     },
+    "timeout": 3,
     "logs": {
-        "text": "infection.log"
+        "text": "infection.txt"
     },
     "mutators": {
         "@default": true,
+        "global-ignoreSourceCodeByRegex": [
+            "\\$this->logger.*",
+            "\\$this->cache->save.*",
+            "parent::build(\\$container);"
+        ],
         "MBString": {
             "settings": {
                 "mb_substr": false,

.ci-tools/phpbench.json

@@ -0,0 +1,24 @@
+{
+    "runner.bootstrap": "../vendor/bootstrap.php",
+    "runner.path": "../performance",
+    "runner.progress": "dots",
+    "runner.time_unit": "microseconds",
+    "runner.retry_threshold": 10,
+    "report.generators": {
+        "full": {
+            "extends": "aggregate",
+            "cols": ["benchmark", "subject", "set", "revs", "its", "mem_peak", "best", "mode", "mean", "worst", "stdev", "rstdev"]
+        },
+        "simple": {
+            "extends": "aggregate",
+            "cols": ["benchmark", "subject", "set", "best", "mean", "worst"]
+        }
+    },
+    "report.outputs": {
+        "all": {
+            "renderer": "html",
+            "file": "report.html",
+            "title": "Jose Performance Test Suite"
+        }
+    }
+}