Allow shorthand usage in configuration files

Author: sebastianfeldmann

src/Runner/Action/PHP.php

@@ -19,6 +19,7 @@
 use CaptainHook\App\Hook\Constrained;
 use CaptainHook\App\Hook\EventSubscriber;
 use CaptainHook\App\Runner\Action as ActionRunner;
+use CaptainHook\App\Runner\Shorthand;
 use Error;
 use Exception;
 use RuntimeException;
@@ -40,13 +41,13 @@ class PHP implements ActionRunner
      *
      * @var string
      */
-    private $hook;
+    private string $hook;
 
     /**
      *
      * @var \CaptainHook\App\Event\Dispatcher
      */
-    private $dispatcher;
+    private Dispatcher $dispatcher;
 
     /**
      * PHP constructor.
@@ -71,7 +72,7 @@ public function __construct(string $hook, Dispatcher $dispatcher)
      */
     public function execute(Config $config, IO $io, Repository $repository, Config\Action $action): void
     {
-        $class = $action->getAction();
+        $class = $this->getActionClass($action->getAction());
 
         try {
             // if the configured action is a static php method display the captured output and exit
@@ -80,7 +81,7 @@ public function execute(Config $config, IO $io, Repository $repository, Config\A
                 return;
             }
 
-            // if not static it has to be an 'Action' so let's instantiate
+            // if not static, it has to be an 'Action' so let's instantiate
             $exe = $this->createAction($class);
             // check for any given restrictions
             if (!$this->isApplicable($exe)) {
@@ -170,4 +171,15 @@ private function isApplicable(Action $action)
         }
         return true;
     }
+
+    /**
+     * Make sure action shorthands are translated before instantiating
+     *
+     * @param  string $action
+     * @return string
+     */
+    private function getActionClass(string $action): string
+    {
+        return Shorthand::isShorthand($action) ? Shorthand::getActionClass($action) : $action;
+    }
 }

src/Runner/Condition.php

@@ -109,7 +109,7 @@ private function createCondition(Config\Condition $config): ConditionInterface
         }
 
         /** @var class-string<\CaptainHook\App\Hook\Condition> $class */
-        $class = $config->getExec();
+        $class = $this->getConditionClass($config->getExec());
         if (!class_exists($class)) {
             throw new RuntimeException('could not find condition class: ' . $class);
         }
@@ -165,4 +165,15 @@ private function isLogicCondition(Config\Condition $config): bool
     {
         return in_array(strtolower($config->getExec()), ['and', 'or']);
     }
+
+    /**
+     * Returns the condition class
+     *
+     * @param string $exec
+     * @return string
+     */
+    private function getConditionClass(string $exec): string
+    {
+        return Shorthand::isShorthand($exec) ? Shorthand::getConditionClass($exec) : $exec;
+    }
 }

src/Runner/Util.php

@@ -45,6 +45,17 @@ public static function isTypeValid(string $type): bool
      */
     public static function getExecType(string $action): string
     {
-        return substr($action, 0, 1) === '\\' ? 'php' : 'cli';
+        return self::isPHPType($action) ? 'php' : 'cli';
+    }
+
+    /**
+     * Check if the action type is PHP
+     *
+     * @param  string $action
+     * @return bool
+     */
+    private static function isPHPType(string $action): bool
+    {
+        return str_starts_with($action, '\\') || Shorthand::isShorthand($action);
     }
 }

tests/unit/Runner/Action/PHPTest.php

@@ -140,6 +140,27 @@ public function testExecuteError(): void
         $php->execute($config, $io, $repo, $action);
     }
 
+    /**
+     * Check if the action shorthand works
+     */
+    public function testExecuteByShorthand(): void
+    {
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessageMatches('/debugging/i');
+
+        $config = $this->createConfigMock();
+        $io     = $this->createIOMock();
+        $repo   = $this->createRepositoryMock();
+        $action = $this->createActionConfigMock();
+        $events = new Dispatcher($io, $config, $repo);
+        $class  = 'CaptainHook.Debug.fail';
+
+        $action->expects($this->once())->method('getAction')->willReturn($class);
+
+        $php = new PHP('pre-commit', $events);
+        $php->execute($config, $io, $repo, $action);
+    }
+
     /**
      * Tests PHP::execute
      *