Move tty logic to a central place

Author: sebastianfeldmann

src/Hook/Template/Local/Shell.php

@@ -15,12 +15,13 @@
 
 use CaptainHook\App\CH;
 use CaptainHook\App\Hook\Template;
+use CaptainHook\App\Hooks;
 use SebastianFeldmann\Camino\Path;
 use SebastianFeldmann\Camino\Path\Directory;
 use Symfony\Component\Process\PhpExecutableFinder;
 
 /**
- * Local class
+ * Shell class
  *
  * Generates the sourcecode for the php hook scripts in .git/hooks/*.
  *
@@ -31,15 +32,6 @@
  */
 class Shell extends Template\Local
 {
-    /**
-     * Does the hook allow user input
-     *
-     * @var bool[]
-     */
-    private array $allowUserInput = [
-        'prepare-commit-msg' => true
-    ];
-
     /**
      * Returns lines of code for the local src installation
      *
@@ -51,7 +43,7 @@ protected function getHookLines(string $hook): array
         $useStdIn = ' <&0';
         $useTTY   = [];
 
-        if (isset($this->allowUserInput[$hook])) {
+        if (Hooks::allowsUserInput($hook)) {
             $useStdIn = '';
             $useTTY   = [
                 'if [ -t 1 ]; then',

src/Hooks.php

@@ -51,12 +51,21 @@ final class Hooks
      *
      * @var string[]
      */
-    private static $virtualHookTriggers = [
+    private static array $virtualHookTriggers = [
         self::POST_CHECKOUT => self::POST_CHANGE,
         self::POST_MERGE    => self::POST_CHANGE,
         self::POST_REWRITE  => self::POST_CHANGE,
     ];
 
+    /**
+     * Is it necessary to give the Captain access to user input
+     *
+     * @var array<string, bool>
+     */
+    private static array $hooksAllowingUserInput = [
+        self::PREPARE_COMMIT_MSG => true,
+    ];
+
     /**
      * Returns the list of valid hooks
      *
@@ -137,6 +146,17 @@ public static function getOriginalHookArguments(string $hook): string
         return $arguments[$hook];
     }
 
+    /**
+     * Does a given hook allow for user input to be used
+     *
+     * @param  string $hook
+     * @return bool
+     */
+    public static function allowsUserInput(string $hook): bool
+    {
+        return self::$hooksAllowingUserInput[$hook] ?? false;
+    }
+
     /**
      * Tell if the given hook should trigger a virtual hook
      *

tests/unit/HooksTest.php

@@ -63,4 +63,10 @@ public function testGetVirtualHookFail(): void
         $this->expectException(Exception::class);
         Hooks::getVirtualHook('pre-commit');
     }
+
+    public function testAllowsUserInput(): void
+    {
+        $this->assertTrue(Hooks::allowsUserInput(Hooks::PREPARE_COMMIT_MSG));
+        $this->assertFalse(Hooks::allowsUserInput(Hooks::PRE_COMMIT));
+    }
 }