use default php-cs-config file and binary if it exists

Author: jrushlow

src/Util/TemplateLinter.php

@@ -22,20 +22,11 @@
 final class TemplateLinter
 {
     public function __construct(
-        private ?string $binaryPath = null,
-        private ?string $configPath = null,
+        private ?string $phpCsFixerBinaryPath = null,
+        private ?string $phpCsFixerConfigPath = null,
     ) {
-        if (null === $this->binaryPath) {
-            $this->binaryPath = \dirname(__DIR__).'/Bin/php-cs-fixer-v3.13.0.phar';
-        }
-
-        if (null === $this->configPath) {
-            $this->configPath = \dirname(__DIR__).'/Resources/config/php-cs-fixer.config.php';
-        }
-
-        if (!file_exists($this->binaryPath) || !file_exists($this->configPath)) {
-            throw new RuntimeCommandException('Either the config or binary for PHP_CS_FIXER does not exist.');
-        }
+        $this->setConfig();
+        $this->setBinary();
     }
 
     public function lintPhpTemplate(string|array $templateFilePath): void
@@ -45,8 +36,55 @@ public function lintPhpTemplate(string|array $templateFilePath): void
         }
 
         foreach ($templateFilePath as $filePath) {
-            $process = Process::fromShellCommandline(sprintf('php %s --config=%s --using-cache=no fix %s', $this->binaryPath, $this->configPath, $filePath));
+            $process = Process::fromShellCommandline(sprintf('php %s --config=%s --using-cache=no fix %s', $this->phpCsFixerBinaryPath, $this->phpCsFixerConfigPath, $filePath));
             $process->run();
         }
     }
+
+    private function setBinary(): void
+    {
+        if (null !== $this->phpCsFixerBinaryPath) {
+            $this->checkPathExists($this->phpCsFixerBinaryPath, false);
+
+            return;
+        }
+
+        $defaultBinaryPath = 'bin/php-cs-fixer';
+
+        if (file_exists($defaultBinaryPath)) {
+            $this->phpCsFixerBinaryPath = $defaultBinaryPath;
+
+            return;
+        }
+
+        $this->phpCsFixerBinaryPath = \dirname(__DIR__).'/Bin/php-cs-fixer-v3.13.0.phar';
+    }
+
+    private function setConfig(): void
+    {
+        if (null !== $this->phpCsFixerConfigPath) {
+            $this->checkPathExists($this->phpCsFixerConfigPath, true);
+
+            return;
+        }
+
+        $defaultConfigPath = '.php-cs-fixer.dist.php';
+
+        if (file_exists($defaultConfigPath)) {
+            $this->phpCsFixerConfigPath = $defaultConfigPath;
+
+            return;
+        }
+
+        $this->phpCsFixerConfigPath = \dirname(__DIR__).'/Resources/config/php-cs-fixer.config.php';
+    }
+
+    private function checkPathExists(string $path, bool $isConfigPath): void
+    {
+        if (file_exists($path)) {
+            return;
+        }
+
+        throw new RuntimeCommandException(sprintf('The %s provided: %s does not exist.', $isConfigPath ? 'MAKER_PHP_CS_FIXER_CONFIG_PATH' : 'MAKER_PHP_CS_FIXER_BINARY_PATH', $path));
+    }
 }

tests/Maker/TemplateLinterTest.php

@@ -52,5 +52,28 @@ public function getTestDetails(): \Generator
                 self::assertStringContainsString('Linted by custom php-cs-config', $generatedTemplate);
             }),
         ];
+
+        yield 'lints_templates_with_flex_generated_config_file' => [$this->createMakerTest()
+            ->addExtraDependencies('friendsofphp/php-cs-fixer')
+            ->run(function (MakerTestRunner $runner) {
+                $runner->replaceInFile(
+                    '.php-cs-fixer.dist.php',
+                    '\'@Symfony\' => true,',
+                    <<< 'EOT'
+                        '@Symfony' => true,
+                        'header_comment' => [
+                            'header' => 'Linted with stock php-cs-config',
+                        ],
+                        EOT
+                );
+
+                // Voter class name
+                $runner->runMaker(['FooBar']);
+
+                $generatedTemplate = file_get_contents($runner->getPath('src/Security/Voter/FooBarVoter.php'));
+
+                self::assertStringContainsString('Linted with stock php-cs-config', $generatedTemplate);
+            }),
+        ];
     }
 }

tests/Util/TemplateLinterTest.php

@@ -13,47 +13,23 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\MakerBundle\Util\TemplateLinter;
-use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * @author Jesse Rushlow <[email protected]>
  */
 class TemplateLinterTest extends TestCase
 {
-    public function testLinterFixesPhpFile(): void
+    public function testExceptionBinaryPathDoesntExist(): void
     {
-        $linter = new TemplateLinter();
+        $this->expectExceptionMessage('The MAKER_PHP_CS_FIXER_BINARY_PATH provided: /some/bad/path does not exist.');
 
-        $fixture = $this->copySourceToTemp('TemplateLinterController.php');
-
-        $linter->lintPhpTemplate($fixture);
-
-        self::assertFileEquals(__DIR__.'/fixtures/template_linter/ExpectedTemplateLinterController.php', $fixture);
-    }
-
-    /** @dataProvider pathProvider */
-    public function testLinterThrowsExceptionIfBinaryOrArgumentDoNotExist(string $binaryPath, string $configPath): void
-    {
-        $this->expectExceptionMessage('Either the config or binary for PHP_CS_FIXER does not exist.');
-
-        new TemplateLinter($binaryPath, $configPath);
+        new TemplateLinter(phpCsFixerBinaryPath: '/some/bad/path');
     }
 
-    public function pathProvider(): \Generator
+    public function testExceptionThrownIfConfigPathDoesntExist(): void
     {
-        yield 'Binary Path Wrong' => ['/bad/path', \dirname(__DIR__, 2).'/src/Resources/config/php-cs-fixer.config.php'];
-        yield 'Config Path Wrong' => [\dirname(__DIR__, 2).'/src/Bin/php-cs-fixer-v3.13.0.phar', '/bad/path'];
-        yield 'Both Paths Wrong' => ['/bad/path', '/bad/path'];
-    }
-
-    private function copySourceToTemp(string $sourceFileName): string
-    {
-        $file = new Filesystem();
-        $sourcePath = __DIR__.'/fixtures/source/';
-        $tmpLocation = \dirname(__DIR__).'/tmp/cache/linter-test/';
-
-        $file->copy($sourcePath.$sourceFileName, $tmpLocation.$sourceFileName);
+        $this->expectExceptionMessage('The MAKER_PHP_CS_FIXER_CONFIG_PATH provided: /bad/config/path does not exist.');
 
-        return $tmpLocation.$sourceFileName;
+        new TemplateLinter(phpCsFixerConfigPath: '/bad/config/path');
     }
 }