Added syntax sugar to configure parallel run (#19)

For more details see #19

Key changes:

* Added syntax sugar to configure parallel run for PHP CS Fixer

* [Tests] Added coverage for configuring parallel run

* [Doc] Documented parallel run configuration

* [CS] Enabled parallel run in the local Ibexa Code Style config

Author: alongosz

.php-cs-fixer.php

@@ -14,7 +14,7 @@
     ->files()->name('*.php');
 
 $configFactory = new InternalConfigFactory();
-$configFactory->withRuleSet(new Sets\Ibexa50RuleSet());
+$configFactory->runInParallel()->withRuleSet(new Sets\Ibexa50RuleSet());
 
 $config = $configFactory->buildConfig();
 $config->setFinder($finder);

README.md

@@ -43,6 +43,16 @@ $config->setFinder(
 return $config;
 ```
 
+> [!TIP]
+> You can configure a parallel run of PHP CS Fixer by either calling:
+> ```php
+> $factory->runInParallel();
+> ```
+> or
+> ```php
+> InternalConfigFactory::build(runInParallel: true)
+> ```
+
 ### Ibexa packages
 
 Create a `.php-cs-fixer.php` file in your project root directory with the following content:

src/lib/PhpCsFixer/InternalConfigFactory.php

@@ -11,6 +11,8 @@
 use Composer\InstalledVersions;
 use Ibexa\CodeStyle\PhpCsFixer\Sets\RuleSetInterface;
 use PhpCsFixer\ConfigInterface;
+use PhpCsFixer\ParallelAwareConfigInterface;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 
 /**
  * Factory for Config instance that should be used for all internal Ibexa packages.
@@ -24,6 +26,8 @@ final class InternalConfigFactory
 
     private RuleSetInterface $ruleSet;
 
+    private bool $runInParallel = false;
+
     /**
      * @param array<string, mixed> $rules
      */
@@ -46,6 +50,13 @@ public function getRuleSet(): RuleSetInterface
         return $this->ruleSet ??= $this->createRuleSetFromPackage(InstalledVersions::getRootPackage());
     }
 
+    public function runInParallel(bool $runInParallel = true): self
+    {
+        $this->runInParallel = $runInParallel;
+
+        return $this;
+    }
+
     /**
      * @param array{name: string, version: string, pretty_version?: string} $package
      */
@@ -78,11 +89,15 @@ public function buildConfig(): ConfigInterface
             $this->customRules,
         ));
 
+        if ($this->runInParallel && $config instanceof ParallelAwareConfigInterface) {
+            $config->setParallelConfig(ParallelConfigFactory::detect());
+        }
+
         return $config;
     }
 
-    public static function build(): ConfigInterface
+    public static function build(bool $runInParallel = false): ConfigInterface
     {
-        return (new self())->buildConfig();
+        return (new self())->runInParallel($runInParallel)->buildConfig();
     }
 }

tests/lib/PhpCsFixer/InternalConfigFactoryTest.php

@@ -11,6 +11,7 @@
 use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
 use Ibexa\CodeStyle\PhpCsFixer\Sets\Ibexa46RuleSet;
 use Ibexa\CodeStyle\PhpCsFixer\Sets\Ibexa50RuleSet;
+use PhpCsFixer\ParallelAwareConfigInterface;
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
 use ReflectionMethod;
@@ -40,6 +41,8 @@ protected function setUp(): void
      *
      * @param array{name: string, version: string, pretty_version?: string} $package
      * @param class-string $expectedRuleSetClass
+     *
+     * @throws \ReflectionException
      */
     public function testVersionBasedRuleSetSelection(
         array $package,
@@ -98,4 +101,39 @@ public function testWithRuleSet(): void
 
         self::assertSame($customRuleSet, $this->factory->getRuleSet());
     }
+
+    public function testRunInParallel(): void
+    {
+        // Note: sequential test instead of separate test cases on purpose
+
+        // sanity check
+        /** @var ParallelAwareConfigInterface $config */
+        $config = $this->factory->buildConfig();
+        self::assertSame(1, $config->getParallelConfig()->getMaxProcesses());
+
+        $this->factory->runInParallel();
+        /** @var ParallelAwareConfigInterface $config */
+        $config = $this->factory->buildConfig();
+        self::assertGreaterThan(1, $config->getParallelConfig()->getMaxProcesses());
+
+        // reset test
+        $this->factory->runInParallel(false);
+        /** @var ParallelAwareConfigInterface $config */
+        $config = $this->factory->buildConfig();
+        self::assertSame(1, $config->getParallelConfig()->getMaxProcesses());
+    }
+
+    public function testBuildWithoutRunInParallel(): void
+    {
+        $config = InternalConfigFactory::build();
+        self::assertInstanceOf(ParallelAwareConfigInterface::class, $config);
+        self::assertSame(1, $config->getParallelConfig()->getMaxProcesses());
+    }
+
+    public function testBuildWithRunInParallel(): void
+    {
+        $config = InternalConfigFactory::build(true);
+        self::assertInstanceOf(ParallelAwareConfigInterface::class, $config);
+        self::assertGreaterThan(1, $config->getParallelConfig()->getMaxProcesses());
+    }
 }