Merge branch 'fluffy_hedgehog' into updateToComposerPluginApi2

heiglandreas · web-flow · commit 48cb2de4fc52 · 2020-10-24T18:12:03.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Composer-Plugin for [CaptainHook](https://github.com/captainhookphp/captainhook)
 
-This is a composer-plugin that installs _CaptainHook_ and the corresponding git hooks. For more information visit its [Website](https://github.com/captainhookphp/captainhook).
+This is a composer-plugin that makes sure your team mates install the git hooks. For more information visit its [Website](https://github.com/captainhookphp/captainhook).
 
 [![Latest Stable Version](https://poser.pugx.org/captainhook/plugin-composer/v/stable.svg?v=1)](https://packagist.org/packages/captainhook/plugin-composer)
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg)](https://php.net/)
@@ -19,24 +19,24 @@ Everything else will happen automagically.
 
 ## Customize
 
-You can set a custom name for your hook configuration and a custom path to your .git directory
-if it is not located in the same directory as your *composer.json* file.
-Just add these values to your *composer.json* in the *extra* section first.
+You can set a custom name for your hook configuration.
+If you want to use the PHAR release of `CaptainHook` you can configure the path to the PHAR file.
+All extra config settings are optional and if you are using the default settings you do not have to 
+configure anything to make it work.
+ 
 ```json
 {
   "extra": {
-    "captainhook-config": "hooks.json",
-    "captainhook-git-dir": "../.git"
-  }
-  
+    "captainhook": {
+      "config": "hooks.json",
+      "exec": "tools/captainhook.phar",
+      "disable-plugin": false
+    }    
+  }  
 }
 
 ```
 
-If you want to see the installation in action have a look at this short installation video.
-
-[![Install demo](http://img.youtube.com/vi/agwTZ0jhDDs/0.jpg)](https://www.youtube.com/watch?v=agwTZ0jhDDs)
-
 ## A word of warning
 
 It is still possible to commit without invoking the hooks. 
diff --git a/composer.json b/composer.json
@@ -16,7 +16,6 @@
   "require": {
     "php": "^7.1",
     "composer-plugin-api": "^1.1|^2.0",
-    "org_heigl/trait-iterator": "^1.1",
     "captainhook/captainhook": "^5.0"
   },
   "require-dev": {
diff --git a/src/ComposerPlugin.php b/src/ComposerPlugin.php
@@ -11,13 +11,13 @@
 
 namespace CaptainHook\Plugin\Composer;
 
-use CaptainHook\App\Composer\Cmd;
 use Composer\Composer;
 use Composer\EventDispatcher\EventSubscriberInterface;
 use Composer\IO\IOInterface;
 use Composer\Plugin\PluginInterface;
 use Composer\Script\Event;
 use Composer\Script\ScriptEvents;
+use RuntimeException;
 
 /**
  * Class ComposerPlugin
@@ -28,16 +28,55 @@
  */
 class ComposerPlugin implements PluginInterface, EventSubscriberInterface
 {
+    private const COMMAND_CONFIGURE = 'configure';
+    private const COMMAND_INSTALL   = 'install';
+
+    /**
+     * Composer instance
+     *
+     * @var \Composer\Composer
+     */
+    private $composer;
+
+    /**
+     * Composer IO instance
+     *
+     * @var \Composer\IO\IOInterface
+     */
+    private $io;
+
+    /**
+     * Path to the captainhook executable
+     *
+     * @var string
+     */
+    private $executable;
+
+    /**
+     * Path to the captainhook configuration file
+     *
+     * @var string
+     */
+    private $configuration;
+
+    /**
+     * Path to the .git directory
+     *
+     * @var string
+     */
+    private $gitDirectory;
+
     /**
      * Activate the plugin
      *
      * @param  \Composer\Composer       $composer
      * @param  \Composer\IO\IOInterface $io
      * @return void
      */
-    public function activate(Composer $composer, IOInterface $io) : void
+    public function activate(Composer $composer, IOInterface $io): void
     {
-        // nothing to do here
+        $this->composer = $composer;
+        $this->io       = $io;
     }
 
     /**
@@ -75,10 +114,11 @@ public function uninstall(Composer $composer, IOInterface $io)
      *
      * @return array
      */
-    public static function getSubscribedEvents() : array
+    public static function getSubscribedEvents(): array
     {
         return [
-            ScriptEvents::POST_AUTOLOAD_DUMP => 'installHooks'
+            ScriptEvents::POST_INSTALL_CMD => 'installHooks',
+            ScriptEvents::POST_UPDATE_CMD  => 'installHooks'
          ];
     }
 
@@ -89,39 +129,184 @@ public static function getSubscribedEvents() : array
      * @return void
      * @throws \Exception
      */
-    public function installHooks(Event $event) : void
+    public function installHooks(Event $event): void
     {
-        $event->getIO()->write('CaptainHook Composer Plugin');
-        if (!$this->isCaptainHookInstalled()) {
-            // reload the autoloader to make sure CaptainHook is available
-            $vendorDir = $event->getComposer()->getConfig()->get('vendor-dir');
-            require $vendorDir . '/autoload.php';
+        $this->io->write('<info>CaptainHook Composer Plugin</info>');
+
+        if ($this->isPluginDisabled()) {
+            $this->io->write('  <comment>plugin is disabled</comment>');
+            return;
         }
 
-        if (!$this->isCaptainHookInstalled()) {
-            // if CaptainHook is still not available end the plugin execution
-            // normally this only happens if CaptainHook gets uninstalled
-            $event->getIO()->write(
-                '  <info>CaptainHook not properly installed try to run composer update</info>' . PHP_EOL .
+        $this->detectConfiguration();
+        $this->detectGitDir();
+        $this->detectCaptainExecutable();
+
+        if (!file_exists($this->executable)) {
+            $this->io->write(
+                '<comment>CaptainHook executable not found</comment>' . PHP_EOL .
                 PHP_EOL .
+                'Make sure you have installed the captainhook/captainhook package.' . PHP_EOL .
+                'If you are using the PHAR you have to configure the path to your CaptainHook executable' . PHP_EOL .
+                'using Composers \'extra\' config. e.g.' . PHP_EOL .
+                PHP_EOL . '<comment>' .
+                '    "extra": {' . PHP_EOL .
+                '        "captainhook": {' . PHP_EOL .
+                '            "exec": "tools/captainhook.phar' . PHP_EOL .
+                '        }' . PHP_EOL .
+                '    }' . PHP_EOL .
+                '</comment>' . PHP_EOL .
                 'If you are uninstalling CaptainHook, we are sad seeing you go, ' .
                 'but we would appreciate your feedback on your experience.' . PHP_EOL .
                 'Just go to https://github.com/CaptainHookPhp/captainhook/issues to leave your feedback' . PHP_EOL .
-                PHP_EOL .
-                '<comment>WARNING: Don\'t forget to deactivate the hooks in your .git/hooks directory.</comment>'
+                '<comment>WARNING: Don\'t forget to deactivate the hooks in your .git/hooks directory.</comment>' .
+                PHP_EOL
             );
             return;
         }
-        Cmd::setup($event);
+
+        $this->configure();
+        $this->install();
+    }
+
+    /**
+     * Create captainhook.json file if it does not exist
+     */
+    private function configure(): void
+    {
+        if (file_exists($this->configuration)) {
+            $this->io->write(('  <comment>Using CaptainHook config: ' . $this->configuration . '</comment>'));
+            return;
+        }
+
+        $this->runCaptainCommand(self::COMMAND_CONFIGURE);
+    }
+
+    /**
+     * Install hooks to your .git/hooks directory
+     */
+    private function install(): void
+    {
+        $this->runCaptainCommand(self::COMMAND_INSTALL);
+    }
+
+    /**
+     * Executes CaptainHook in a sub process
+     *
+     * @param string $command
+     */
+    private function runCaptainCommand(string $command): void
+    {
+        // Respect composer CLI settings
+        $ansi        = $this->io->isDecorated() ? ' --ansi' : ' --no-ansi';
+        $interaction = $this->io->isInteractive() ? '' : ' --no-interaction';
+
+        // captainhook config and repository settings
+        $configuration  = ' -c ' . escapeshellarg($this->configuration);
+        $repository     = $command === self::COMMAND_INSTALL ? ' -g ' . escapeshellarg($this->gitDirectory) : '';
+        $skip           = $command === self::COMMAND_INSTALL ? ' -s' : '';
+        $executable     = str_replace(' ', '\\ ', $this->executable);
+
+        // sub process settings
+        $cmd   = $executable . ' ' . $command . $ansi . $interaction . $skip . $configuration . $repository;
+        $pipes = [];
+        $spec  = [
+            0 => ['file', 'php://stdin', 'r'],
+            1 => ['file', 'php://stdout', 'w'],
+            2 => ['file', 'php://stderr', 'w'],
+        ];
+
+        $process = @proc_open($cmd, $spec, $pipes);
+
+        if ($this->io->isVerbose()) {
+            $this->io->write('Running process : ' . $cmd);
+        }
+        if (!is_resource($process)) {
+            throw new RuntimeException($this->pluginErrorMessage('no-process'));
+        }
+
+        // Loop on process until it exits normally.
+        do {
+            $status = proc_get_status($process);
+        } while ($status && $status['running']);
+        $exitCode = $status['exitcode'] ?? -1;
+        proc_close($process);
+        if ($exitCode !== 0) {
+            $this->io->writeError($this->pluginErrorMessage('installation process failed'));
+        }
+    }
+
+    /**
+     * Return path to the CaptainHook configuration file
+     *
+     * @return void
+     */
+    private function detectConfiguration(): void
+    {
+        $extra               = $this->composer->getPackage()->getExtra();
+        $this->configuration = getcwd() . '/' . ($extra['captainhook']['config'] ?? 'captainhook.json');
+    }
+
+    /**
+     * Search for the git repository to store the hooks in
+
+     * @return void
+     * @throws \RuntimeException
+     */
+    private function detectGitDir(): void
+    {
+        $path = getcwd();
+
+        while (file_exists($path)) {
+            $possibleGitDir = $path . '/.git';
+            if (is_dir($possibleGitDir)) {
+                $this->gitDirectory = $possibleGitDir;
+                return;
+            }
+
+            // if we checked the root directory already, break to prevent endless loop
+            if ($path === dirname($path)) {
+                break;
+            }
+
+            $path = \dirname($path);
+        }
+        throw new RuntimeException($this->pluginErrorMessage('git directory not found'));
+    }
+
+    /**
+     * Creates a nice formatted error message
+     *
+     * @param  string $reason
+     * @return string
+     */
+    private function pluginErrorMessage(string $reason): string
+    {
+        return 'Shiver me timbers! CaptainHook could not install yer git hooks! (' . $reason . ')';
+    }
+
+    /**
+     *
+     */
+    private function detectCaptainExecutable(): void
+    {
+        $extra = $this->composer->getPackage()->getExtra();
+        if (isset($extra['captainhook']['exec'])) {
+            $this->executable = $extra['captainhook']['exec'];
+            return;
+        }
+
+        $this->executable = (string) $this->composer->getConfig()->get('bin-dir') . '/captainhook';
     }
 
     /**
-     * Checks if CaptainHook is installed properly
+     * Check if the plugin is disabled
      *
      * @return bool
      */
-    private function isCaptainHookInstalled() : bool
+    private function isPluginDisabled(): bool
     {
-        return class_exists('\\CaptainHook\\App\\CH');
+        $extra = $this->composer->getPackage()->getExtra();
+        return (bool) ($extra['captainhook']['disable-plugin'] ?? false);
     }
 }
