feat: enhance rule engine documentation with detailed PHPDoc comments and descriptions

.github/workflows/phpcpd.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.3'
+          php-version: '8.1'
           tools: phpcpd
           extensions: dom, mbstring
           coverage: none

.github/workflows/phpcsfixer.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.3'
+          php-version: '8.1'
           extensions: json, tokenizer
           coverage: none
         env:

.github/workflows/phpstan.yml

@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['8.3', '8.4']
+        php-versions: ['8.1']
 
     steps:
       - name: Checkout

.github/workflows/phpunit.yml

@@ -25,7 +25,7 @@ jobs:
     if: (! contains(github.event.head_commit.message, '[ci skip]'))
     strategy:
       matrix:
-        php-versions: ['8.3', '8.4']
+        php-versions: ['8.1']
 
     steps:
       - name: Checkout
@@ -65,7 +65,7 @@ jobs:
           TERM: xterm-256color
           TACHYCARDIA_MONITOR_GA: enabled
 
-      - if: matrix.php-versions == '8.3'
+      - if: matrix.php-versions == '8.1'
         name: Run Coveralls
         continue-on-error: true
         run: |

.github/workflows/psalm.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.3'
+          php-version: '8.1'
           tools: phpstan, phpunit
           extensions: intl, json, mbstring, xml
           coverage: none

.github/workflows/rector.yml

@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['8.3', '8.4']
+        php-versions: ['8.1']
 
     steps:
       - name: Checkout

composer-unused.php

@@ -7,9 +7,6 @@
 use ComposerUnused\ComposerUnused\Configuration\PatternFilter;
 use Webmozart\Glob\Glob;
 
-return static fn (Configuration $config): Configuration => $config
+return static fn (Configuration $config): Configuration => $config;
     // ->addNamedFilter(NamedFilter::fromString('symfony/config'))
-    // ->addPatternFilter(PatternFilter::fromString('/symfony-.*/'))
-    ->setAdditionalFilesFor('codeigniter4/framework', [
-        ...Glob::glob(__DIR__ . '/vendor/codeigniter4/framework/system/Helpers/*.php'),
-    ]);
+    // ->addPatternFilter(PatternFilter::fromString('/symfony-.*/'));

composer.json

@@ -25,7 +25,8 @@
   ],
   "homepage": "https://github.com/maniaba/rule-engine",
   "require": {
-    "php": "^8.1"
+    "php": "^8.1",
+    "symfony/polyfill-php83": "^1.32"
   },
   "require-dev": {
     "icanhazstring/composer-unused": "dev-main",

infection.json.dist

@@ -0,0 +1,13 @@
+{
+	"source": {
+		"directories": [
+			"src/"
+		]
+	},
+	"logs": {
+		"text": "build/infection.log"
+	},
+	"mutators": {
+		"@default": true
+	}
+}

phpstan-baseline.neon

@@ -0,0 +1,19 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Parameter \#2 \$action of method Maniaba\\RuleEngine\\Factories\\ActionFactory\:\:registerAction\(\) expects class\-string\<Maniaba\\RuleEngine\\Actions\\ActionInterface\>\|\(Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface\)\: mixed\)\|Maniaba\\RuleEngine\\Actions\\ActionInterface, Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface, mixed, mixed\=\)\: string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: tests/Factories/ActionFactoryTest.php
+
+		-
+			message: '#^Parameter \#2 \$action of method Maniaba\\RuleEngine\\Factories\\ActionFactory\:\:registerAction\(\) expects class\-string\<Maniaba\\RuleEngine\\Actions\\ActionInterface\>\|\(Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface\)\: mixed\)\|Maniaba\\RuleEngine\\Actions\\ActionInterface, Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface, string, int\)\: non\-falsy\-string given\.$#'
+			identifier: argument.type
+			count: 3
+			path: tests/Factories/ActionFactoryTest.php
+
+		-
+			message: '#^Parameter \#2 \$action of method Maniaba\\RuleEngine\\Factories\\ActionFactory\:\:registerAction\(\) expects class\-string\<Maniaba\\RuleEngine\\Actions\\ActionInterface\>\|\(Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface\)\: mixed\)\|Maniaba\\RuleEngine\\Actions\\ActionInterface, Closure\(Maniaba\\RuleEngine\\Context\\ContextInterface, string, int\=\)\: non\-falsy\-string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: tests/Factories/ActionFactoryTest.php

phpstan.neon.dist

@@ -5,17 +5,10 @@ parameters:
 		- src/
 		- tests/
 	bootstrapFiles:
-		- vendor/codeigniter4/framework/system/Test/bootstrap.php
 	excludePaths:
 	universalObjectCratesClasses:
-		- CodeIgniter\Entity
-		- CodeIgniter\Entity\Entity
-		- Faker\Generator
 	scanDirectories:
-		- vendor/codeigniter4/framework/system/Helpers
 	dynamicConstantNames:
-		- APP_NAMESPACE
-		- CI_DEBUG
 		- ENVIRONMENT
 	strictRules:
 		allRules: false
@@ -24,3 +17,4 @@ parameters:
 		matchingInheritedMethodNames: true
 	treatPhpDocTypesAsCertain: false
 includes:
+    - phpstan-baseline.neon

phpunit.xml.dist

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
-    bootstrap="vendor/codeigniter4/framework/system/Test/bootstrap.php"
     backupGlobals="false"
     beStrictAboutOutputDuringTests="true"
     colors="true"

psalm.xml

@@ -9,7 +9,6 @@
     cacheDirectory="build/psalm/"
     findUnusedBaselineEntry="true"
     findUnusedCode="false"
-    errorBaseline="psalm-baseline.xml"
 >
     <projectFiles>
         <directory name="src/" />
@@ -18,4 +17,8 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <issueHandlers>
+        <MissingOverrideAttribute errorLevel="suppress" />
+    </issueHandlers>
 </psalm>