Add CommandInterface & deprecate passing a command not implementing it

Author: jmsche

CHANGELOG.md

@@ -4,6 +4,8 @@
 * Add `getLastCommit()` method
 * Improve tests & fix them locally
 * Increase PHPStan level to 7
+* Deprecate passing a command class that does not implement `Leapt\GitWrapper\CommandInterface`
+* Throw an exception if passing a command class that does not have a `run()` method
 
 1.2.0
 -----

composer.json

@@ -18,6 +18,7 @@
     ],
     "require": {
         "php": "^8.0",
+        "symfony/deprecation-contracts": "^3.0",
         "symfony/process": "^5.2 || ^6.0 || ^7.0"
     },
     "require-dev": {

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$commandClass of static method Leapt\\\\GitWrapper\\\\Repository\\:\\:createCommand\\(\\) expects class\\-string, string given\\.$#"
+			count: 3
+			path: src/Repository.php

phpstan.neon

@@ -1,3 +1,6 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
     paths:
         - src

src/Command.php

@@ -7,7 +7,7 @@
 use Leapt\GitWrapper\Exception\GitRuntimeException;
 use Symfony\Component\Process\Process;
 
-class Command
+class Command implements CommandInterface
 {
     private string $commandString;
 

src/CommandInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Leapt\GitWrapper;
+
+interface CommandInterface
+{
+    public function run(): string;
+}

src/Repository.php

@@ -53,7 +53,7 @@ public static function create(string $directory, bool $debug = false, array $opt
     {
         $options = array_merge(self::DEFAULT_OPTIONS, $options);
         $commandString = $options['git_executable'] . ' init';
-        $command = new $options['command_class']($directory, $commandString, $debug);
+        $command = self::createCommand($options['command_class'], $directory, $commandString, $debug);
         \assert(method_exists($command, 'run'));
         $command->run();
 
@@ -69,7 +69,7 @@ public static function cloneUrl(string $url, string $directory, bool $debug = fa
     {
         $options = array_merge(self::DEFAULT_OPTIONS, $options);
         $commandString = $options['git_executable'] . ' clone ' . escapeshellarg($url) . ' ' . escapeshellarg($directory);
-        $command = new $options['command_class'](getcwd(), $commandString, $debug);
+        $command = self::createCommand($options['command_class'], (string) getcwd(), $commandString, $debug);
         \assert(method_exists($command, 'run'));
         $command->run();
 
@@ -157,7 +157,7 @@ public function git(string $commandString): string
         $commandString = preg_replace('/^git\s/', '', $commandString);
         $commandString = $this->options['git_executable'] . ' ' . $commandString;
 
-        $command = new $this->options['command_class']($this->directory, $commandString, $this->debug);
+        $command = self::createCommand($this->options['command_class'], $this->directory, $commandString, $this->debug);
         \assert(method_exists($command, 'run'));
 
         return $command->run();
@@ -168,6 +168,22 @@ public function getDirectory(): string
         return $this->directory;
     }
 
+    /**
+     * @param class-string $commandClass
+     */
+    public static function createCommand(string $commandClass, string $directory, string $commandString, bool $debug): object
+    {
+        if (!\in_array(CommandInterface::class, class_implements($commandClass), true)) {
+            trigger_deprecation('leapt/git-wrapper', '1.3', 'Passing a Command class that does not implement "%s" is deprecated.', CommandInterface::class);
+
+            if (!method_exists($commandClass, 'run')) {
+                throw new \RuntimeException(sprintf('The Command class must implement a "public function run(): string" method, the "%s" class does not.', $commandClass));
+            }
+        }
+
+        return new $commandClass($directory, $commandString, $debug);
+    }
+
     /**
      * Convert a formatted log string into an array.
      *

tests/Fixtures/CommandThatDoesNotHaveRunMethod.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Leapt\GitWrapper\Tests\Fixtures;
+
+final class CommandThatDoesNotHaveRunMethod
+{
+}

tests/Fixtures/CommandThatDoesNotImplementInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Leapt\GitWrapper\Tests\Fixtures;
+
+final class CommandThatDoesNotImplementInterface
+{
+    public function run(): string
+    {
+        return '';
+    }
+}

tests/RepositoryTest.php

@@ -8,6 +8,8 @@
 use Leapt\GitWrapper\Exception\GitRuntimeException;
 use Leapt\GitWrapper\Exception\InvalidGitRepositoryDirectoryException;
 use Leapt\GitWrapper\Repository;
+use Leapt\GitWrapper\Tests\Fixtures\CommandThatDoesNotHaveRunMethod;
+use Leapt\GitWrapper\Tests\Fixtures\CommandThatDoesNotImplementInterface;
 use PHPUnit\Framework\TestCase;
 
 final class RepositoryTest extends TestCase
@@ -170,6 +172,27 @@ public function testInitializeInvalidDirectoryMustFail(): void
         new Repository($directory);
     }
 
+    public function testCreateCommandThrowsExceptionIfDoesNotHaveRunMethod(): void
+    {
+        self::expectException(\RuntimeException::class);
+        Repository::createCommand(CommandThatDoesNotHaveRunMethod::class, 'test', 'test', false);
+    }
+
+    public function testCreateCommandThrowsDeprecationIfCommandClassDoesNotImplementInterface(): void
+    {
+        set_error_handler(
+            static function ($errno, $errstr) {
+                restore_error_handler();
+                throw new \Exception($errstr, $errno);
+            },
+            \E_ALL,
+        );
+
+        self::expectException(\Exception::class);
+        self::expectExceptionMessage('Passing a Command class that does not implement "Leapt\GitWrapper\CommandInterface" is deprecated.');
+        Repository::createCommand(CommandThatDoesNotImplementInterface::class, 'test', 'test', false);
+    }
+
     /**
      * @param array<string, string> $options
      */