[command] Add README metadata during composer sync (#57)

composer.json

@@ -12,6 +12,7 @@
         "ecs",
         "fast-forward"
     ],
+    "readme": "README.md",
     "authors": [
         {
             "name": "Felipe Sayão Lobato Abreu",

src/Console/Command/UpdateComposerJsonCommand.php

@@ -22,6 +22,7 @@
 use Composer\Command\BaseCommand;
 use Composer\Factory;
 use Composer\Json\JsonManipulator;
+use FastForward\DevTools\Composer\Json\ComposerJsonInterface;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use Symfony\Component\Config\FileLocatorInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -45,10 +46,12 @@ final class UpdateComposerJsonCommand extends BaseCommand
     /**
      * Creates a new UpdateComposerJsonCommand instance.
      *
+     * @param ComposerJsonInterface $composer the composer.json metadata accessor
      * @param FilesystemInterface $filesystem the filesystem used to read and write composer.json
      * @param FileLocatorInterface $fileLocator the locator used to resolve packaged configuration files
      */
     public function __construct(
+        private readonly ComposerJsonInterface $composer,
         private readonly FilesystemInterface $filesystem,
         private readonly FileLocatorInterface $fileLocator,
     ) {
@@ -95,6 +98,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $manipulator->addSubNode('scripts', $name, $command);
         }
 
+        if ('' === $this->composer->getReadme() && $this->filesystem->exists('README.md', \dirname($file))) {
+            $manipulator->addProperty('readme', 'README.md');
+        }
+
         $manipulator->addSubNode('extra', 'grumphp', [
             'config-default-path' => Path::makeRelative($grumphpConfig, getcwd()),
         ], true);

tests/Console/Command/UpdateComposerJsonCommandTest.php

@@ -19,6 +19,7 @@
 
 namespace FastForward\DevTools\Tests\Console\Command;
 
+use FastForward\DevTools\Composer\Json\ComposerJsonInterface;
 use FastForward\DevTools\Console\Command\UpdateComposerJsonCommand;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -32,13 +33,17 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+use function Safe\json_decode;
+
 #[CoversClass(UpdateComposerJsonCommand::class)]
 final class UpdateComposerJsonCommandTest extends TestCase
 {
     use ProphecyTrait;
 
     private ObjectProphecy $filesystem;
 
+    private ObjectProphecy $composer;
+
     private ObjectProphecy $fileLocator;
 
     private ObjectProphecy $input;
@@ -52,12 +57,17 @@ final class UpdateComposerJsonCommandTest extends TestCase
      */
     protected function setUp(): void
     {
+        $this->composer = $this->prophesize(ComposerJsonInterface::class);
         $this->filesystem = $this->prophesize(FilesystemInterface::class);
         $this->fileLocator = $this->prophesize(FileLocatorInterface::class);
         $this->input = $this->prophesize(InputInterface::class);
         $this->output = $this->prophesize(OutputInterface::class);
 
-        $this->command = new UpdateComposerJsonCommand($this->filesystem->reveal(), $this->fileLocator->reveal());
+        $this->command = new UpdateComposerJsonCommand(
+            $this->composer->reveal(),
+            $this->filesystem->reveal(),
+            $this->fileLocator->reveal(),
+        );
     }
 
     /**
@@ -89,6 +99,10 @@ public function executeWillUpdateComposerJsonScriptsAndExtraConfiguration(): voi
             ->willReturn(true);
         $this->filesystem->readFile('/app/composer.json')
             ->willReturn('{"name":"example/package"}');
+        $this->composer->getReadme()
+            ->willReturn('');
+        $this->filesystem->exists('README.md', '/app')
+            ->willReturn(false);
         $this->fileLocator->locate('grumphp.yml', Argument::type('string'))
             ->willReturn('/app/vendor/fast-forward/dev-tools/grumphp.yml');
         $this->filesystem->dumpFile(
@@ -100,6 +114,96 @@ public function executeWillUpdateComposerJsonScriptsAndExtraConfiguration(): voi
         self::assertSame(UpdateComposerJsonCommand::SUCCESS, $this->executeCommand());
     }
 
+    /**
+     * @return void
+     */
+    #[Test]
+    public function executeWillAddReadmeMetadataWhenReadmeExistsAndComposerJsonDoesNotDeclareReadme(): void
+    {
+        $this->input->getOption('file')
+            ->willReturn('/app/composer.json');
+        $this->filesystem->exists('/app/composer.json')
+            ->willReturn(true);
+        $this->filesystem->readFile('/app/composer.json')
+            ->willReturn('{"name":"example/package"}');
+        $this->composer->getReadme()
+            ->willReturn('');
+        $this->filesystem->exists('README.md', '/app')
+            ->willReturn(true);
+        $this->fileLocator->locate('grumphp.yml', Argument::type('string'))
+            ->willReturn('/app/vendor/fast-forward/dev-tools/grumphp.yml');
+        $this->filesystem->dumpFile(
+            '/app/composer.json',
+            Argument::that(static function (string $contents): bool {
+                $composerJson = json_decode($contents, true);
+
+                return 'README.md' === $composerJson['readme'];
+            }),
+        )->shouldBeCalledOnce();
+
+        self::assertSame(UpdateComposerJsonCommand::SUCCESS, $this->executeCommand());
+    }
+
+    /**
+     * @return void
+     */
+    #[Test]
+    public function executeWillPreserveExistingReadmeMetadata(): void
+    {
+        $this->input->getOption('file')
+            ->willReturn('/app/composer.json');
+        $this->filesystem->exists('/app/composer.json')
+            ->willReturn(true);
+        $this->filesystem->readFile('/app/composer.json')
+            ->willReturn('{"name":"example/package","readme":"docs/readme.md"}');
+        $this->composer->getReadme()
+            ->willReturn('docs/readme.md');
+        $this->filesystem->exists('README.md', '/app')
+            ->shouldNotBeCalled();
+        $this->fileLocator->locate('grumphp.yml', Argument::type('string'))
+            ->willReturn('/app/vendor/fast-forward/dev-tools/grumphp.yml');
+        $this->filesystem->dumpFile(
+            '/app/composer.json',
+            Argument::that(static function (string $contents): bool {
+                $composerJson = json_decode($contents, true);
+
+                return 'docs/readme.md' === $composerJson['readme'];
+            }),
+        )->shouldBeCalledOnce();
+
+        self::assertSame(UpdateComposerJsonCommand::SUCCESS, $this->executeCommand());
+    }
+
+    /**
+     * @return void
+     */
+    #[Test]
+    public function executeWillSkipReadmeMetadataWhenReadmeDoesNotExist(): void
+    {
+        $this->input->getOption('file')
+            ->willReturn('/app/composer.json');
+        $this->filesystem->exists('/app/composer.json')
+            ->willReturn(true);
+        $this->filesystem->readFile('/app/composer.json')
+            ->willReturn('{"name":"example/package"}');
+        $this->composer->getReadme()
+            ->willReturn('');
+        $this->filesystem->exists('README.md', '/app')
+            ->willReturn(false);
+        $this->fileLocator->locate('grumphp.yml', Argument::type('string'))
+            ->willReturn('/app/vendor/fast-forward/dev-tools/grumphp.yml');
+        $this->filesystem->dumpFile(
+            '/app/composer.json',
+            Argument::that(static function (string $contents): bool {
+                $composerJson = json_decode($contents, true);
+
+                return ! \array_key_exists('readme', $composerJson);
+            }),
+        )->shouldBeCalledOnce();
+
+        self::assertSame(UpdateComposerJsonCommand::SUCCESS, $this->executeCommand());
+    }
+
     /**
      * @return int
      */