Adds support for GrumPHP and updates script installation commands in composer.json

Author: coisa

.gitignore

@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 public/
 tmp/
 vendor/

composer.json

@@ -34,6 +34,7 @@
         "friendsofphp/php-cs-fixer": "^3.94",
         "phpdocumentor/shim": "^3.9",
         "phpowermove/docblock": "^4.0",
+        "phpro/grumphp": "^2.19",
         "phpspec/prophecy-phpunit": "^2.5",
         "phpunit/phpunit": "^12.5",
         "rector/rector": "^2.3",
@@ -56,7 +57,8 @@
     "config": {
         "allow-plugins": {
             "ergebnis/composer-normalize": true,
-            "phpdocumentor/shim": true
+            "phpdocumentor/shim": true,
+            "phpro/grumphp": true
         },
         "platform": {
             "php": "8.3.0"
@@ -67,7 +69,10 @@
         "branch-alias": {
             "dev-main": "1.x-dev"
         },
-        "class": "FastForward\\DevTools\\Composer\\Plugin"
+        "class": "FastForward\\DevTools\\Composer\\Plugin",
+        "grumphp": {
+            "config-default-path": "grumphp.yml"
+        }
     },
     "scripts": {
         "dev-tools": "dev-tools",

grumphp.yml

@@ -0,0 +1,12 @@
+grumphp:
+    stop_on_failure: true
+
+    tasks:
+        composer_script:
+            script: 'dev-tools'
+            triggered_by: ['php']
+
+    testsuites:
+        git_pre_commit:
+            tasks:
+                - composer_script

src/Command/InstallScriptsCommand.php

@@ -18,18 +18,18 @@
 
 namespace FastForward\DevTools\Command;
 
-use FastForward\DevTools\Composer\ScriptsInstallerTrait;
+use Composer\Factory;
+use Composer\Json\JsonManipulator;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Filesystem\Path;
 
 /**
  * Represents the command responsible for installing development scripts into `composer.json`.
  * This class MUST NOT be overridden and SHALL rely on the `ScriptsInstallerTrait`.
  */
 final class InstallScriptsCommand extends AbstractCommand
 {
-    use ScriptsInstallerTrait;
-
     /**
      * Configures the current command.
      *
@@ -61,7 +61,38 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln('<info>Starting script installation...</info>');
 
-        $this->installScripts($this->requireComposer(), $this->getIO());
+        $file = Factory::getComposerFile();
+
+        if (! $this->filesystem->exists($file)) {
+            return self::FAILURE;
+        }
+
+        $contents = $this->filesystem->readFile($file);
+        $manipulator = new JsonManipulator($contents);
+
+        $scripts = [
+            'dev-tools' => 'dev-tools',
+            'dev-tools:fix' => 'dev-tools --fix',
+        ];
+
+        $extra = [
+            'grumphp' => [
+                'config-default-path' => Path::makeRelative(
+                    dirname(__DIR__, 2) . '/grumphp.yml',
+                    $this->getCurrentWorkingDirectory(),
+                ),
+            ],
+        ];
+
+        foreach ($scripts as $name => $command) {
+            $manipulator->addSubNode('scripts', $name, $command);
+        }
+
+        foreach ($extra as $name => $config) {
+            $manipulator->addSubNode('extra', $name, $config, true);
+        }
+
+        $this->filesystem->dumpFile($file, $manipulator->getContents());
 
         return self::SUCCESS;
     }

src/Command/ReportsCommand.php

@@ -63,18 +63,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $docsPath = $this->getAbsolutePath('public');
         $coveragePath = $this->getAbsolutePath('public/coverage');
 
+        $results = [];
+
         $output->writeln('<info>Generating API documentation on path: ' . $docsPath . '</info>');
-        $this->runCommand('docs', [
+        $results[] = $this->runCommand('docs', [
             '--target' => $docsPath,
         ], $output);
 
         $output->writeln('<info>Generating test coverage report on path: ' . $coveragePath . '</info>');
-        $this->runCommand('tests', [
+        $results[] = $this->runCommand('tests', [
             '--coverage' => $coveragePath,
         ], $output);
 
         $output->writeln('<info>Frontpage generation completed!</info>');
 
-        return self::SUCCESS;
+        return in_array(self::FAILURE, $results, true) ? self::FAILURE : self::SUCCESS;
     }
 }

src/Command/StandardsCommand.php

@@ -68,13 +68,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln('<info>Running code standards checks...</info>');
 
-        $this->runCommand('refactor', $input, $output);
-        $this->runCommand('phpdoc', $input, $output);
-        $this->runCommand('code-style', $input, $output);
-        $this->runCommand('reports', $input, $output);
+        $results = [];
+
+        $results[] = $this->runCommand('refactor', $input, $output);
+        $results[] = $this->runCommand('phpdoc', $input, $output);
+        $results[] = $this->runCommand('code-style', $input, $output);
+        $results[] = $this->runCommand('reports', $input, $output);
 
         $output->writeln('<info>All code standards checks completed!</info>');
 
-        return self::SUCCESS;
+        return in_array(self::FAILURE, $results, true) ? self::FAILURE : self::SUCCESS;
     }
 }

src/Composer/Plugin.php

@@ -20,8 +20,7 @@
 
 use Composer\Composer;
 use Composer\EventDispatcher\EventSubscriberInterface;
-use Composer\Installer\PackageEvent;
-use Composer\Installer\PackageEvents;
+use Composer\Script\Event;
 use Composer\IO\IOInterface;
 use Composer\Plugin\Capability\CommandProvider;
 use Composer\Plugin\Capable;
@@ -35,8 +34,6 @@
  */
 final class Plugin implements Capable, EventSubscriberInterface, PluginInterface
 {
-    use ScriptsInstallerTrait;
-
     /**
      * Resolves the implemented Composer capabilities structure.
      *
@@ -63,7 +60,7 @@ public function getCapabilities(): array
     public static function getSubscribedEvents(): array
     {
         return [
-            ScriptEvents::POST_INSTALL_CMD=> 'onPostInstall',
+            ScriptEvents::POST_INSTALL_CMD => 'onPostInstall',
             ScriptEvents::POST_UPDATE_CMD => 'onPostUpdate',
         ];
     }
@@ -74,13 +71,13 @@ public static function getSubscribedEvents(): array
      * This method MUST be triggered by `POST_INSTALL_CMD` and SHALL delegate
      * the actual work to the `installScripts` utility.
      *
-     * @param PackageEvent $event the package installation event context
+     * @param Event $event the Composer script event context
      *
      * @return void
      */
-    public function onPostInstall(PackageEvent $event): void
+    public function onPostInstall(Event $event): void
     {
-        $this->installScripts($event->getComposer(), $event->getIO());
+        $event->getComposer()->getEventDispatcher()->dispatchScript('install-scripts', true);
     }
 
     /**
@@ -89,13 +86,13 @@ public function onPostInstall(PackageEvent $event): void
      * This method MUST be triggered by `POST_UPDATE_CMD` and SHALL ensure
      * that all development scripts are correctly aligned in the root configuration.
      *
-     * @param PackageEvent $event the package update event context
+     * @param Event $event the Composer script event context
      *
      * @return void
      */
-    public function onPostUpdate(PackageEvent $event): void
+    public function onPostUpdate(Event $event): void
     {
-        $this->installScripts($event->getComposer(), $event->getIO());
+        $event->getComposer()->getEventDispatcher()->dispatchScript('install-scripts', true);
     }
 
     /**

src/Composer/ScriptsInstallerTrait.php

@@ -69,20 +69,23 @@ protected function getCommandHelp(): string
     public function executeWillRunDocsAndTestsCommand(): void
     {
         $docsCommand = $this->prophesize(Command::class);
-        $docsCommand->ignoreValidationErrors()
-            ->shouldBeCalled();
         $docsCommand->run(Argument::any(), Argument::any())->willReturn(ReportsCommand::SUCCESS);
+        $docsCommand->ignoreValidationErrors()->will(function () {});
 
         $testsCommand = $this->prophesize(Command::class);
-        $testsCommand->ignoreValidationErrors()
-            ->shouldBeCalled();
         $testsCommand->run(Argument::any(), Argument::any())->willReturn(ReportsCommand::SUCCESS);
+        $testsCommand->ignoreValidationErrors()->will(function () {});
 
         $this->application->find('docs')
             ->willReturn($docsCommand->reveal());
         $this->application->find('tests')
             ->willReturn($testsCommand->reveal());
 
+        $this->output->writeln('<info>Generating frontpage for Fast Forward documentation...</info>')->shouldBeCalled();
+        $this->output->writeln('<info>Generating API documentation on path: /Users/mentordosnerds/Sites/github.com/php-fast-forward/dev-tools/public</info>')->shouldBeCalled();
+        $this->output->writeln('<info>Generating test coverage report on path: /Users/mentordosnerds/Sites/github.com/php-fast-forward/dev-tools/public/coverage</info>')->shouldBeCalled();
+        $this->output->writeln('<info>Frontpage generation completed!</info>')->shouldBeCalled();
+
         self::assertSame(ReportsCommand::SUCCESS, $this->invokeExecute());
     }
 }

tests/Command/ReportsCommandTest.php

@@ -72,14 +72,16 @@ public function executeWillRunSuiteSequentially(): void
 
         foreach ($orderedCommands as $commandName) {
             $prophecy = $this->prophesize(Command::class);
-            $prophecy->ignoreValidationErrors()
-                ->shouldBeCalled();
             $prophecy->run(Argument::any(), Argument::any())->willReturn(StandardsCommand::SUCCESS);
-
+            $prophecy->ignoreValidationErrors()->will(function () {});
             $this->application->find($commandName)
                 ->willReturn($prophecy->reveal());
         }
 
+        $this->output->writeln('<info>Running code standards checks...</info>')->shouldBeCalled();
+        $this->output->writeln('<info>All code standards checks completed!</info>')->shouldBeCalled();
+        $this->output->writeln(Argument::any())->shouldBeCalled();
+
         self::assertSame(StandardsCommand::SUCCESS, $this->invokeExecute());
     }
 }