Refactoring hook templates

Removed the DockerConfig class and introduced the
PathInfo class to handle all path related operations.

Author: sebastianfeldmann

src/Hook/Template/Builder.php

@@ -46,57 +46,31 @@ abstract class Builder
      */
     public static function build(Config $config, Repository $repository, Resolver $resolver): Template
     {
-        $repositoryPath = self::toAbsolutePath($repository->getRoot());
-        $configPath     = self::toAbsolutePath($config->getPath());
-        $bootstrapPath  = dirname($configPath) . '/' . $config->getBootstrap();
-        $captainPath    = self::toAbsolutePath($resolver->getExecutable());
+        $pathInfo       = new PathInfo($repository->getRoot(), $config->getPath(), $resolver->getExecutable());
+        $bootstrapPath  = dirname($config->getPath()) . '/' . $config->getBootstrap();
 
         if (!file_exists($bootstrapPath)) {
             throw new RuntimeException('bootstrap file not found: \'' . $bootstrapPath . '\'');
         }
 
-        $phpPath = $config->getPhpPath();
-
         switch ($config->getRunMode()) {
             case Template::DOCKER:
                 return new Docker(
-                    new Directory($repositoryPath),
-                    new File($configPath),
-                    new File($captainPath),
-                    new Docker\Config($config->getRunExec(), $config->getRunPath())
+                    $pathInfo,
+                    $config
                 );
             case Template::PHP:
                 return new PHP(
-                    new Directory($repositoryPath),
-                    new File($configPath),
-                    new File($captainPath),
-                    $config->getBootstrap(),
-                    $resolver->isPharRelease(),
-                    $phpPath
+                    $pathInfo,
+                    $config,
+                    $resolver->isPharRelease()
                 );
             default:
                 return new Shell(
-                    new Directory($repositoryPath),
-                    new File($configPath),
-                    new File($captainPath),
-                    $config->getBootstrap(),
-                    $resolver->isPharRelease(),
-                    $phpPath
+                    $pathInfo,
+                    $config,
+                    $resolver->isPharRelease()
                 );
         }
     }
-
-    /**
-     * Make sure the given path is absolute
-     *
-     * @param  string $path
-     * @return string
-     */
-    private static function toAbsolutePath(string $path): string
-    {
-        if (Check::isAbsolutePath($path)) {
-            return $path;
-        }
-        return (string) realpath($path);
-    }
 }

src/Hook/Template/Docker.php

@@ -14,8 +14,9 @@
 namespace CaptainHook\App\Hook\Template;
 
 use CaptainHook\App\CH;
+use CaptainHook\App\Config;
 use CaptainHook\App\Hook\Template;
-use CaptainHook\App\Hook\Template\Docker\Config as DockerConfig;
+use CaptainHook\App\Hook\Template\Docker\RunConfig as DockerConfig;
 use SebastianFeldmann\Camino\Path\Directory;
 use SebastianFeldmann\Camino\Path\File;
 
@@ -33,47 +34,37 @@
 class Docker implements Template
 {
     /**
-     * Path to the repository root
+     * All path required for template creation
      *
-     * @var \SebastianFeldmann\Camino\Path\Directory
+     * @var \CaptainHook\App\Hook\Template\PathInfo
      */
-    private $repository;
+    private PathInfo $pathInfo;
 
     /**
-     * Path to the configuration file
+     * CaptainHook configuration
      *
-     * @var \SebastianFeldmann\Camino\Path\File
+     * @var \CaptainHook\App\Config
      */
-    private $config;
-
-    /**
-     * Docker configuration with run-command & run-path
-     *
-     * @var \CaptainHook\App\Hook\Template\Docker\Config
-     */
-    private $dockerConfig;
+    private Config $config;
 
     /**
      * Path to the CaptainHook binary script or PHAR
      *
      * @var string
      */
-    private $binaryPath;
+    private string $binaryPath;
 
     /**
      * Docker constructor
      *
-     * @param \SebastianFeldmann\Camino\Path\Directory     $repo
-     * @param \SebastianFeldmann\Camino\Path\File          $config
-     * @param \SebastianFeldmann\Camino\Path\File          $captain
-     * @param \CaptainHook\App\Hook\Template\Docker\Config $docker
+     * @param \CaptainHook\App\Hook\Template\PathInfo $pathInfo
+     * @param \CaptainHook\App\Config                 $config
      */
-    public function __construct(Directory $repo, File $config, File $captain, DockerConfig $docker)
+    public function __construct(PathInfo $pathInfo, Config $config)
     {
-        $this->repository   = $repo;
-        $this->config       = $config;
-        $this->dockerConfig = $docker;
-        $this->binaryPath   = $this->resolveBinaryPath($repo, $captain);
+        $this->pathInfo   = $pathInfo;
+        $this->config     = $config;
+        $this->binaryPath = $this->resolveBinaryPath();
     }
 
     /**
@@ -84,55 +75,48 @@ public function __construct(Directory $repo, File $config, File $captain, Docker
      */
     public function getCode(string $hook): string
     {
-        $path2Config = $this->config->getRelativePathFrom($this->repository);
+        $path2Config = $this->pathInfo->getConfigPath();
         $config      = $path2Config !== CH::CONFIG ? ' --configuration=' . escapeshellarg($path2Config) : '';
+        $bootstrap   = !empty($this->config->getBootstrap()) ? ' --bootstrap=' . $this->config->getBootstrap() : '';
 
         $lines = [
             '#!/bin/sh',
             '',
             '# installed by CaptainHook ' . CH::VERSION,
             '',
-            $this->dockerConfig->getDockerCommand() . ' ' . $this->binaryPath . ' hook:' . $hook . $config . ' "$@"'
+            $this->config->getRunExec() . ' '
+            . $this->binaryPath . ' hook:' . $hook
+            . $config
+            . $bootstrap
+            . ' "$@"'
         ];
         return implode(PHP_EOL, $lines) . PHP_EOL;
     }
 
     /**
      * Resolves the path to the captainhook binary and returns it
      *
-     * @param  \SebastianFeldmann\Camino\Path\Directory $repo       Absolute path to the git repository root
-     * @param  \SebastianFeldmann\Camino\Path\File      $executable Absolute path to the executable
      * @return string
      */
-    private function resolveBinaryPath(Directory $repo, File $executable): string
+    private function resolveBinaryPath(): string
     {
         // if a specific executable is configured use just that
-        if (!empty($this->dockerConfig->getPathToCaptainHookExecutable())) {
-            return $this->dockerConfig->getPathToCaptainHookExecutable();
+        if (!empty($this->config->getRunPath())) {
+            return $this->config->getRunPath();
         }
 
-        // check if the captainhook binary is in the repository bin directory
-        // this is only the case if we work in the captainhook repository
-        if (file_exists($repo->getPath() . '/bin/captainhook')) {
-            return './bin/captainhook';
-        }
-
-        // For docker we need to strip down the current working directory.
+        // For Docker we need to strip down the current working directory.
         // This is caused because docker will always connect to a specific working directory
         // where the absolute path will not be recognized.
         // E.g.:
         //   cwd    => /project/
         //   path   => /project/vendor/bin/captainhook
         //   docker => ./vendor/bin/captainhook
-        $pathToExecutable = $executable->getPath();
-
-        // if executable is located inside the repository use a relative path
+        // if the executable is located inside the repository we can use a relative path
         // by default this should return something like ./vendor/bin/captainhook
-        if ($executable->isChildOf($repo)) {
-            $pathToExecutable = './' . $executable->getRelativePathFrom($repo);
-        }
-
         // if the executable is not located in your git repository it will return the absolute path
-        return $pathToExecutable;
+        // which will most likely not work from within the docker container
+        // you have to use the 'run_path' config then
+        return $this->pathInfo->getExecutablePath();
     }
 }

src/Hook/Template/Docker/Config.php

@@ -13,71 +13,44 @@
 
 namespace CaptainHook\App\Hook\Template;
 
+use CaptainHook\App\Config;
 use CaptainHook\App\Hook\Template;
-use SebastianFeldmann\Camino\Path;
-use SebastianFeldmann\Camino\Path\Directory;
-use SebastianFeldmann\Camino\Path\File;
 
 abstract class Local implements Template
 {
     /**
-     * Path to the captainhook configuration
+     * All template related path information
      *
-     * @var string
+     * @var \CaptainHook\App\Hook\Template\PathInfo
      */
-    protected $configPath;
+    protected PathInfo $pathInfo;
 
     /**
-     * Original bootstrap option
+     * CaptainHook configuration
      *
-     * @var string
+     * @var \CaptainHook\App\Config
      */
-    protected $bootstrap;
-
-    /**
-     * Path to the captainhook executable
-     *
-     * @var string
-     */
-    protected $executablePath;
+    protected Config $config;
 
     /**
      * Is the executable a phar file
      *
      * @var bool
      */
-    protected $isPhar;
-
-    /**
-     * Path to the php binary
-     *
-     * @var string
-     */
-    protected $phpPath;
+    protected bool $isPhar;
 
     /**
      * Local constructor
      *
-     * @param \SebastianFeldmann\Camino\Path\Directory $repo
-     * @param \SebastianFeldmann\Camino\Path\File      $config
-     * @param \SebastianFeldmann\Camino\Path\File      $captainHook
-     * @param string                                   $bootstrap
-     * @param bool                                     $isPhar
-     * @param string                                   $phpPath
+     * @param \CaptainHook\App\Hook\Template\PathInfo $pathInfo
+     * @param \CaptainHook\App\Config                 $config
+     * @param bool                                    $isPhar
      */
-    public function __construct(
-        Directory $repo,
-        File $config,
-        File $captainHook,
-        string $bootstrap,
-        bool $isPhar,
-        string $phpPath
-    ) {
-        $this->bootstrap      = $bootstrap;
-        $this->configPath     = $this->getPathForHookTo($repo, $config);
-        $this->executablePath = $this->getPathForHookTo($repo, $captainHook);
-        $this->isPhar         = $isPhar;
-        $this->phpPath        = $phpPath;
+    public function __construct(PathInfo $pathInfo, Config $config, bool $isPhar)
+    {
+        $this->pathInfo = $pathInfo;
+        $this->config   = $config;
+        $this->isPhar   = $isPhar;
     }
 
     /**
@@ -91,15 +64,6 @@ public function getCode(string $hook): string
         return implode(PHP_EOL, $this->getHookLines($hook)) . PHP_EOL;
     }
 
-    /**
-     * Return the path to the target path from inside the .git/hooks directory f.e. __DIR__ ../../vendor
-     *
-     * @param  \SebastianFeldmann\Camino\Path\Directory $repo
-     * @param  \SebastianFeldmann\Camino\Path           $target
-     * @return string
-     */
-    abstract protected function getPathForHookTo(Directory $repo, Path $target): string;
-
     /**
      * Return the code for the git hook scripts
      *