Add autoload_paths option

This provides the possibility to add autoload files from coding standards installed by a phpcq plugin and they would be available for PHPCS without defining them in a phpcs configuration file.

This enhances DX as they do not need to know internals of the PHPCQ plugin storage

Author: dmolineus

src/phpcs.php

@@ -41,26 +41,32 @@ public function describeConfiguration(PluginConfigurationBuilderInterface $confi
         $configOptionsBuilder
             ->describeStringListOption(
                 'standard_paths',
-                'Setting the installed standard paths as relative path to the project root dir.'
+                'Setting the installed standard paths as relative path to the project root dir.',
             )
             ->isRequired()
             ->withDefaultValue([]);
         $configOptionsBuilder
             ->describeBoolOption(
                 'fix',
-                'If given, the source will be fixed automatically with phpcbf'
+                'If given, the source will be fixed automatically with phpcbf',
             )
             ->isRequired()
             ->withDefaultValue(false);
         $configOptionsBuilder
             ->describeStringListOption(
                 'excluded',
-                'List of excluded paths.'
+                'List of excluded paths.',
             );
         $configOptionsBuilder
             ->describeStringListOption(
                 'excluded_sniffs',
-                'List of excluded sniffs.'
+                'List of excluded sniffs.',
+            );
+
+        $configOptionsBuilder
+            ->describeStringListOption(
+                'autoload_paths',
+                'List of files to autoload relative to project directory',
             );
     }
 
@@ -127,7 +133,7 @@ private function buildArguments(
                 function ($path) use ($projectPath): string {
                     return realpath($projectPath . '/' . $path);
                 },
-                $standardPaths
+                $standardPaths,
             ));
         }
 
@@ -137,6 +143,33 @@ function ($path) use ($projectPath): string {
             $arguments[] = '--report-file=' . $tempFile;
         }
 
+        if ($config->has('autoload_paths')) {
+            $template = <<<'PHP'
+<?php 
+declare(strict_types=1);
+
+foreach (%s as $path) {
+    require_once $path;
+}
+PHP;
+            $tmpFile = $environment->getUniqueTempFile($this, 'phpcs.bootstrap.php');
+            $paths   = array_unique(
+                array_map(
+                    function (string $path) use ($environment): string {
+                        $file = $environment->getProjectConfiguration()->getProjectRootPath() . '/' . $path;
+                        if (! file_exists($file)) {
+                            throw new RuntimeException('Autoload file does not exist: ' . $file);
+                        }
+
+                        return $environment->getProjectConfiguration()->getProjectRootPath() . '/' . $path;
+                    },
+                    $config->getStringList('autoload_paths')
+                ),
+            );
+            file_put_contents($tmpFile, sprintf($template, var_export($paths, true)));
+            $arguments[] = '--bootstrap=' . $tmpFile;
+        }
+
         return array_merge($arguments, $config->getStringList('directories'));
     }
 
@@ -149,14 +182,14 @@ public function describeExecTask(
             'phpcs',
             'PHP CodeSniffer by Squiz (http://www.squiz.net)',
             $definitionBuilder,
-            $environment
+            $environment,
         );
         $this->describeApplication(
             'phpcbf',
             'PHP Code Beautifier and Fixer',
             $definitionBuilder,
             $environment,
-            'fix'
+            'fix',
         );
     }
 

tests/PhpcsPluginTest.php

@@ -8,8 +8,14 @@
 use Phpcq\PluginApi\Version10\Configuration\PluginConfigurationInterface;
 use Phpcq\PluginApi\Version10\DiagnosticsPluginInterface;
 use Phpcq\PluginApi\Version10\EnvironmentInterface;
+use Phpcq\PluginApi\Version10\ProjectConfigInterface;
+use Phpcq\PluginApi\Version10\Task\TaskInterface;
 use PHPUnit\Framework\TestCase;
 
+use function dirname;
+use function sys_get_temp_dir;
+use function tempnam;
+
 /**
  * @coversNothing
  */
@@ -42,7 +48,39 @@ public function testPluginCreatesDiagnosticTasks(): void
 
         $this->instantiate()->createDiagnosticTasks($config, $environment);
 
-        // We assume it worked out as the plugin did execute correctly.
-        $this->addToAssertionCount(1);
+        foreach ($this->instantiate()->createDiagnosticTasks($config, $environment) as $task) {
+            $this->assertInstanceOf(TaskInterface::class, $task);
+        }
+    }
+
+    public function testConfigureAutoloadPaths(): void
+    {
+        $config = $this->getMockForAbstractClass(PluginConfigurationInterface::class);
+        $config->method('has')->willReturnCallback(static function (string $key) {
+            if ($key === 'autoload_paths') {
+                return true;
+            }
+
+            return false;
+        });
+
+        $config->method('getStringList')->willReturnCallback(static function (string $key): array {
+            if ($key === 'autoload_paths') {
+                return ['autoload.php'];
+            }
+
+            return [];
+        });
+
+        $configuration = $this->getMockForAbstractClass(ProjectConfigInterface::class);
+        $configuration->method('getProjectRootPath')->willReturn(__DIR__ . '/fixtures');
+
+        $environment = $this->getMockForAbstractClass(EnvironmentInterface::class);
+        $environment->method('getUniqueTempFile')->willReturn(tempnam(sys_get_temp_dir(), 'phpcq-phpcs'));
+        $environment->method('getProjectConfiguration')->willReturn($configuration);
+
+        foreach ($this->instantiate()->createDiagnosticTasks($config, $environment) as $task) {
+            $this->assertInstanceOf(TaskInterface::class, $task);
+        }
     }
 }

tests/fixtures/autoload.php

@@ -0,0 +1,3 @@
+<?php
+
+declare(strict_types=1);