Refactor hook arguments logic into separate class

Author: sebastianfeldmann

src/Hook/Cli/Command.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * This file is part of CaptainHook
+ *
+ * (c) Sebastian Feldmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CaptainHook\App\Hook\Cli;
+
+use CaptainHook\App\Config;
+use CaptainHook\App\Console\IO;
+use CaptainHook\App\Hook\Action;
+use SebastianFeldmann\Git\Repository;
+
+/**
+ * Class Notify
+ *
+ * @package CaptainHook
+ * @author  Sebastian Feldmann <[email protected]>
+ * @link    https://github.com/captainhookphp/captainhook
+ * @since   Class available since Release 5.23.1
+ */
+class Command implements Action
+{
+    /**
+     * Executes the action
+     *
+     * @param  \CaptainHook\App\Config           $config
+     * @param  \CaptainHook\App\Console\IO       $io
+     * @param  \SebastianFeldmann\Git\Repository $repository
+     * @param  \CaptainHook\App\Config\Action    $action
+     * @return void
+     * @throws \Exception
+     */
+    public function execute(Config $config, IO $io, Repository $repository, Config\Action $action): void
+    {
+    }
+}

src/Runner/Files.php

@@ -16,6 +16,7 @@
 use CaptainHook\App\Exception;
 use CaptainHook\App\Hook\Util as HookUtil;
 use CaptainHook\App\Hooks;
+use CaptainHook\App\Runner\Hook\Arg;
 use RuntimeException;
 use SebastianFeldmann\Camino\Check;
 
@@ -44,7 +45,7 @@ abstract class Files extends RepositoryAware
     protected string $moveExistingTo = '';
 
     /**
-     * Hook that should be handled.
+     * Hook(s) that should be handled.
      *
      * @var array<int, string>
      */
@@ -81,25 +82,14 @@ public function setMoveExistingTo(string $backup): static
      */
     public function setHook(string $hook): self
     {
-        if (empty($hook)) {
-            return $this;
-        }
-
-        /** @var array<string> $hooks */
-        $hooks = explode(',', $hook);
-        $hooks = array_map('trim', $hooks);
-
-        $hooksValidationCallback = static function (string $hook): bool {
-            return !HookUtil::isInstallable($hook);
-        };
-        if (!empty(($invalidHooks = array_filter($hooks, $hooksValidationCallback)))) {
-            throw new Exception\InvalidHookName(
-                'Invalid hook name \'' . implode('\', \'', $invalidHooks) . '\''
-            );
-        }
-
-        $this->hooksToHandle = $hooks;
+        $arg = new Arg(
+            $hook,
+            static function (string $hook): bool {
+                return !HookUtil::isInstallable($hook);
+            }
+        );
 
+        $this->hooksToHandle = $arg->hooks();
         return $this;
     }
 

src/Runner/Hook/Arg.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * This file is part of CaptainHook.
+ *
+ * (c) Sebastian Feldmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CaptainHook\App\Runner\Hook;
+
+use CaptainHook\App\Exception\InvalidHookName;
+
+/**
+ * Hook argument for lots of commands
+ *
+ *  - install pre-push,pre-commit
+ *  - info commit-message
+ */
+class Arg
+{
+    /**
+     * List of hooks
+     *
+     * @var array<int, string>
+     */
+    private array $hooks = [];
+
+    /**
+     * @param  string   $hook
+     * @param  callable $hookValidation
+     * @throws \CaptainHook\App\Exception\InvalidHookName
+     */
+    public function __construct(string $hook, callable $hookValidation)
+    {
+        if (empty($hook)) {
+            return;
+        }
+
+        /** @var array<string> $hooks */
+        $hooks = explode(',', $hook);
+        $hooks = array_map('trim', $hooks);
+
+        if (!empty(($invalidHooks = array_filter($hooks, $hookValidation)))) {
+            throw new InvalidHookName(
+                'Invalid hook name \'' . implode('\', \'', $invalidHooks) . '\''
+            );
+        }
+        $this->hooks = $hooks;
+    }
+
+    /**
+     * Return the list of hooks provided as an argument
+     *
+     * @return array<int, string>
+     */
+    public function hooks(): array
+    {
+        return $this->hooks;
+    }
+}