Manually link to composer-bin-plugin installed commands

Otherwise there is no guarantee which version of the library the link was created for, as there might be still multiple versions installed. The plugin will link to the first one that was installed. It might not be the one we expected. i.e. rector installed phpstan in version 0.11.3 as one of its dependencies. phpstan 0.11.4 was also directly requested to be installed in a different composer-bin-plugin namespace. Since rectors phpstan was installed first, the link was pointing to the 0.11.3 version instead of 0.11.4 we expected. As a consequence no phpstan plugins could be loaded.
jakzal · Mar 23, 2019 · 618ee92 · 618ee92
1 parent 21d4f77
commit 618ee92
Show file tree

Hide file tree

Showing 12 changed files with 249 additions and 27 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -65,12 +65,15 @@ Thanks to the isolation we're less likely to run into problem with conflicting d
   "command": {
     "composer-bin-plugin": {
       "package": "behat/behat",
-      "namespace": "behat"
+      "namespace": "behat",
+      "links": {"/tools/behat": "behat"}
     }
   }
 }
 ```
 
+The `links` attribute is optional, but it's recommended for packages that provide commands.
+
 #### phar-download
 
 Downloads a phar from the given URL and puts it into the specified location.

diff --git a/resources/pre-installation.json b/resources/pre-installation.json
@@ -19,6 +19,9 @@
       "command": {
         "composer-global-install": {
           "package": "bamarni/composer-bin-plugin"
+        },
+        "sh": {
+          "command": "composer global config extra.bamarni-bin.bin-links false"
         }
       },
       "test": "composer global show bamarni/composer-bin-plugin",
@@ -37,4 +40,4 @@
       "tags": ["pre-installation"]
     }
   ]
-}
+}
diff --git a/resources/tools.json b/resources/tools.json
@@ -33,7 +33,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "bmitch/churn-php",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/churn": "churn"}
         }
       },
       "test": "churn list",
@@ -106,7 +107,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "exussum12/coverage-checker",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/diffFilter": "diffFilter"}
         }
       },
       "test": "diffFilter -v"
@@ -160,7 +162,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "brianium/paratest",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/paratest": "paratest"}
         }
       },
       "test": "paratest --version"
@@ -198,7 +201,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "akeneo/php-coupling-detector",
-          "namespace": "php-coupling-detector"
+          "namespace": "php-coupling-detector",
+          "links": {"%target-dir%/php-coupling-detector": "php-coupling-detector"}
         }
       },
       "test": "php-coupling-detector list"
@@ -278,7 +282,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "rskuipers/php-assumptions",
-          "namespace": "php-assumptions"
+          "namespace": "php-assumptions",
+          "links": {"%target-dir%/phpa": "phpa"}
         }
       },
       "test": "phpa --version",
@@ -291,7 +296,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "wapmorgan/php-code-analyzer",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/phpca": "phpca"}
         }
       },
       "test": "phpca -h"
@@ -327,7 +333,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "wapmorgan/php-code-fixer",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/phpcf": "phpcf"}
         }
       },
       "test": "phpcf -h"
@@ -405,7 +412,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "overtrue/phplint",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/phplint": "phplint"}
         }
       },
       "test": "phplint -V"
@@ -454,7 +462,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "povils/phpmnd",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/phpmnd": "phpmnd"}
         }
       },
       "test": "phpmnd -V"
@@ -479,7 +488,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "phpstan/phpstan",
-          "namespace": "phpstan"
+          "namespace": "phpstan",
+          "links": {"%target-dir%/phpstan": "phpstan"}
         }
       },
       "test": "phpstan --version",
@@ -642,7 +652,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "psecio/parse:dev-master",
-          "namespace": "psecio-parse"
+          "namespace": "psecio-parse",
+          "links": {"%target-dir%/psecio-parse": "psecio-parse"}
         }
       },
       "test": "psecio-parse --version"
@@ -654,7 +665,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "rector/rector",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/rector": "rector"}
         }
       },
       "test": "rector --version"
@@ -692,7 +704,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "symfony/phpunit-bridge",
-          "namespace": "symfony"
+          "namespace": "symfony",
+          "links": {"%target-dir%/simple-phpunit": "simple-phpunit"}
         },
         "sh": {
           "command": "simple-phpunit install"
@@ -707,7 +720,8 @@
       "command": {
         "composer-bin-plugin": {
           "package": "edsonmedina/php_testability:dev-master",
-          "namespace": "tools"
+          "namespace": "tools",
+          "links": {"%target-dir%/testability": "testability"}
         }
       },
       "test": "testability --help"

diff --git a/src/Json/Factory/ComposerBinPluginCommandFactory.php b/src/Json/Factory/ComposerBinPluginCommandFactory.php
@@ -2,15 +2,29 @@
 
 namespace Zalas\Toolbox\Json\Factory;
 
+use Zalas\Toolbox\Tool\Collection;
 use Zalas\Toolbox\Tool\Command;
 use Zalas\Toolbox\Tool\Command\ComposerBinPluginCommand;
+use Zalas\Toolbox\Tool\Command\ComposerBinPluginLinkCommand;
 
 final class ComposerBinPluginCommandFactory
 {
     public static function import(array $command): Command
     {
         Assert::requireFields(['package', 'namespace'], $command, 'ComposerBinPluginCommand');
 
-        return new ComposerBinPluginCommand($command['package'], $command['namespace']);
+        return new ComposerBinPluginCommand($command['package'], $command['namespace'], self::importLinks($command));
+    }
+
+    private static function importLinks(array $command): Collection
+    {
+        $links = $command['links'] ?? [];
+        $namespace = $command['namespace'];
+
+        return Collection::create(
+            \array_map(function (string $source, string $target) use ($namespace) {
+                return new ComposerBinPluginLinkCommand($source, $target, $namespace);
+            }, \array_values($links), \array_keys($links))
+        );
     }
 }
diff --git a/src/Tool/Command/ComposerBinPluginCommand.php b/src/Tool/Command/ComposerBinPluginCommand.php
@@ -2,22 +2,27 @@
 
 namespace Zalas\Toolbox\Tool\Command;
 
+use Zalas\Toolbox\Tool\Collection;
 use Zalas\Toolbox\Tool\Command;
 
 final class ComposerBinPluginCommand implements Command
 {
     private $package;
+
     private $namespace;
 
-    public function __construct(string $package, string $namespace)
+    private $links;
+
+    public function __construct(string $package, string $namespace, Collection $links)
     {
         $this->package = $package;
         $this->namespace = $namespace;
+        $this->links = $links;
     }
 
     public function __toString(): string
     {
-        return \sprintf('composer global bin %s require --no-suggest --prefer-dist --update-no-dev -n %s', $this->namespace, $this->package);
+        return \sprintf('composer global bin %s require --no-suggest --prefer-dist --update-no-dev -n %s%s', $this->namespace, $this->package, $this->linkCommand());
     }
 
     public function package(): string
@@ -29,4 +34,16 @@ public function namespace(): string
     {
         return $this->namespace;
     }
+
+    public function links(): Collection
+    {
+        return $this->links;
+    }
+
+    private function linkCommand(): string
+    {
+        return $this->links->reduce('', function (string $command, ComposerBinPluginLinkCommand $link) {
+            return $command.' && '.$link;
+        });
+    }
 }
diff --git a/src/Tool/Command/ComposerBinPluginLinkCommand.php b/src/Tool/Command/ComposerBinPluginLinkCommand.php
@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace Zalas\Toolbox\Tool\Command;
+
+use Zalas\Toolbox\Tool\Command;
+
+final class ComposerBinPluginLinkCommand implements Command
+{
+    private $source;
+    private $target;
+    private $namespace;
+
+    public function __construct(string $source, string $target, string $namespace)
+    {
+        $this->source = $source;
+        $this->target = $target;
+        $this->namespace = $namespace;
+    }
+
+    public function __toString(): string
+    {
+        return \sprintf(
+            'ln -sf ${COMPOSER_HOME:-"~/.composer"}/vendor-bin/%s/vendor/bin/%s %s',
+            $this->namespace,
+            $this->source,
+            $this->target
+        );
+    }
+}
diff --git a/src/Tool/Command/OptimisedComposerBinPluginCommand.php b/src/Tool/Command/OptimisedComposerBinPluginCommand.php
@@ -23,7 +23,7 @@ public function __construct(Collection $commands)
 
     public function __toString(): string
     {
-        return \implode(' && ', $this->commandsToRun($this->packagesGroupedByNamespace()));
+        return \implode(' && ', \array_merge($this->commandsToRun($this->packagesGroupedByNamespace()), $this->linksToCreate()));
     }
 
     private function packagesGroupedByNamespace(): array
@@ -44,4 +44,18 @@ private function commandsToRun(array $packagesGrouped): array
     {
         return \array_map([$this, 'commandToRun'], \array_keys($packagesGrouped), $packagesGrouped);
     }
+
+    private function linksToCreate(): array
+    {
+        return $this->commands
+            ->filter(function (ComposerBinPluginCommand $command) {
+                return !$command->links()->empty();
+            })
+            ->map(function (ComposerBinPluginCommand $command) {
+                return $command->links()->reduce('', function (string $command, ComposerBinPluginLinkCommand $link) {
+                    return !empty($command) ? $command.' && '.$link : $link;
+                });
+            })
+            ->toArray();
+    }
 }
diff --git a/tests/Json/Factory/ComposerBinPluginCommandFactoryTest.php b/tests/Json/Factory/ComposerBinPluginCommandFactoryTest.php
@@ -4,7 +4,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Zalas\Toolbox\Json\Factory\ComposerBinPluginCommandFactory;
+use Zalas\Toolbox\Tool\Collection;
 use Zalas\Toolbox\Tool\Command\ComposerBinPluginCommand;
+use Zalas\Toolbox\Tool\Command\ComposerBinPluginLinkCommand;
 
 class ComposerBinPluginCommandFactoryTest extends TestCase
 {
@@ -21,6 +23,23 @@ public function test_it_creates_a_command()
         $this->assertInstanceOf(ComposerBinPluginCommand::class, $command);
     }
 
+    public function test_it_creates_a_command_with_links_in_tools()
+    {
+        $command = ComposerBinPluginCommandFactory::import([
+            'package' => self::PACKAGE,
+            'namespace' => self::NAMESPACE,
+            'links' => ['/tools/phpstan' => 'phpstan'],
+        ]);
+
+        $this->assertInstanceOf(ComposerBinPluginCommand::class, $command);
+        $this->assertEquals(
+            Collection::create([
+                new ComposerBinPluginLinkCommand('phpstan', '/tools/phpstan', self::NAMESPACE)
+            ]),
+            $command->links()
+        );
+    }
+
     /**
      * @dataProvider provideRequiredProperties
      */

diff --git a/tests/Tool/Command/ComposerBinPluginCommandTest.php b/tests/Tool/Command/ComposerBinPluginCommandTest.php
@@ -3,8 +3,10 @@
 namespace Zalas\Toolbox\Tests\Tool\Command;
 
 use PHPUnit\Framework\TestCase;
+use Zalas\Toolbox\Tool\Collection;
 use Zalas\Toolbox\Tool\Command;
 use Zalas\Toolbox\Tool\Command\ComposerBinPluginCommand;
+use Zalas\Toolbox\Tool\Command\ComposerBinPluginLinkCommand;
 
 class ComposerBinPluginCommandTest extends TestCase
 {
@@ -18,7 +20,11 @@ class ComposerBinPluginCommandTest extends TestCase
 
     protected function setUp()
     {
-        $this->command = new ComposerBinPluginCommand(self::PACKAGE, self::NAMESPACE);
+        $this->command = new ComposerBinPluginCommand(
+            self::PACKAGE,
+            self::NAMESPACE,
+            Collection::create([])
+        );
     }
 
     public function test_it_is_a_command()
@@ -36,4 +42,21 @@ public function test_it_exposes_the_package_and_namespace()
         $this->assertSame(self::PACKAGE, $this->command->package());
         $this->assertSame(self::NAMESPACE, $this->command->namespace());
     }
+
+    public function test_it_optionally_creates_a_symlink()
+    {
+        $links =  Collection::create([
+            new ComposerBinPluginLinkCommand('phpstan', '/tools/phpstan', self::NAMESPACE)
+        ]);
+        $this->command = new ComposerBinPluginCommand(self::PACKAGE, self::NAMESPACE, $links);
+
+        $this->assertSame($links, $this->command->links());
+        $this->assertRegExp('#composer global bin tools require .*? phpstan/phpstan#', (string) $this->command);
+        $this->assertRegExp('# && ln -sf.*?phpstan /tools/phpstan#', (string) $this->command);
+    }
+
+    public function test_it_does_not_create_a_symlink_if_links_option_was_not_given()
+    {
+        $this->assertNotRegExp('#ln -s#', (string) $this->command);
+    }
 }