Added testing of PHP code samples (PHPStan, CS-Fixer, Deptrac)

Author: mnocon

.gitignore

@@ -13,3 +13,4 @@ yarn.lock
 docs/css/*.map
 .deptrac.cache
 .phpunit.result.cache
+code_samples/_inline_php/

.php-cs-fixer-factory.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
+
+$configFactory = new InternalConfigFactory();
+$configFactory->withRules([
+    'header_comment' => false,
+]);
+
+return $configFactory;

.php-cs-fixer-inline.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+/**
+ * PHP-CS-Fixer configuration for auto-generated inline snippets in code_samples/_inline_php/.
+ *
+ * Builds on top of the main .php-cs-fixer.php configuration with additional
+ * rule overrides:
+ * - psr_autoloading is disabled: snippet files are named line_N.php and do not
+ *   correspond to any class, so the filename≠class-name rule does not apply.
+ */
+$configFactory = require __DIR__ . '/.php-cs-fixer-factory.php';
+
+$configFactory->withRules([
+    'psr_autoloading' => false,
+    'AdamWojs/phpdoc_force_fqcn_fixer' => false,
+]);
+
+return $configFactory
+    ->buildConfig()
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__ . '/code_samples/_inline_php')
+            ->files()->name('*.php')
+    );

.php-cs-fixer.php

@@ -6,12 +6,7 @@
  */
 declare(strict_types=1);
 
-use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
-
-$configFactory = new InternalConfigFactory();
-$configFactory->withRules([
-    'header_comment' => false,
-]);
+$configFactory = require __DIR__ . '/.php-cs-fixer-factory.php';
 
 return $configFactory
     ->buildConfig()
@@ -23,5 +18,6 @@
                     __DIR__ . '/tests',
                 ], 'is_dir')
             )
+            ->exclude('_inline_php') // handled separately by .php-cs-fixer-inline.php
             ->files()->name('*.php')
     );

composer.json

@@ -101,11 +101,25 @@
         "ibexa/fastly": "~5.0.x-dev"
     },
     "scripts": {
-        "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
-        "check-cs": "@fix-cs --dry-run",
-        "phpstan": "phpstan analyse",
-        "deptrac": "deptrac analyse",
-        "check-rector": "rector process --dry-run --ansi",
+        "fix-cs": [
+            "php tools/extract-inline-php.php",
+            "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
+            "php-cs-fixer fix --config=.php-cs-fixer-inline.php -v --show-progress=dots",
+            "php tools/sync-inline-php-to-markdown.php"
+        ],
+        "check-cs": [
+            "php tools/extract-inline-php.php",
+            "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots --dry-run",
+            "php-cs-fixer fix --config=.php-cs-fixer-inline.php -v --show-progress=dots --dry-run"
+        ],
+        "phpstan": "php tools/extract-inline-php.php && phpstan analyse",
+        "deptrac": "php tools/extract-inline-php.php && deptrac analyse",
+        "fix-rector": [
+            "php tools/extract-inline-php.php",
+            "rector process --ansi",
+            "php tools/sync-inline-php-to-markdown.php"
+        ],
+        "check-rector": "php tools/extract-inline-php.php && rector process --dry-run --ansi",
         "check-yaml": "phpunit --group yaml",
         "phpunit": "phpunit --exclude-group=yaml",
         "yaml-update-baseline": "php tests/generate-yaml-baseline.php"
@@ -115,6 +129,7 @@
         "check-cs": "Run code style checker for all files",
         "phpstan": "Run static code analysis",
         "deptrac": "Run Deptrac architecture testing",
+        "fix-rector": "Automatically applies Rector refactoring to code samples and syncs back to Markdown",
         "check-rector": "Check for code refactoring opportunities",
         "check-yaml": "Run PHPUnit tests (YAML validation)",
         "yaml-update-baseline": "Regenerate tests/yaml-validation-baseline.yaml from current failures"

phpstan-baseline.neon

@@ -678,18 +678,6 @@ parameters:
 			count: 1
 			path: code_samples/tutorials/page_tutorial_starting_point/src/QueryType/MenuQueryType.php
 
-		-
-			message: '#^Instantiated class App\\Notifications\\MyNotification not found\.$#'
-			identifier: class.notFound
-			count: 1
-			path: code_samples/user_management/notifications/notification_send.php
-
-		-
-			message: '#^Parameter \#1 \$notification of class Ibexa\\Contracts\\Notifications\\Value\\Notification\\SymfonyNotificationAdapter constructor expects Symfony\\Component\\Notifier\\Notification\\Notification, App\\Notifications\\MyNotification given\.$#'
-			identifier: argument.type
-			count: 1
-			path: code_samples/user_management/notifications/notification_send.php
-
 		-
 			message: '#^Parameter \#2 \$email of method Ibexa\\Contracts\\OAuth2Client\\Repository\\OAuth2UserService\:\:newOAuth2UserCreateStruct\(\) expects string, string\|null given\.$#'
 			identifier: argument.type