refactor(CommitCommand): Simplify message generation process

ityaozm@gmail.com · ityaozm@gmail.com · commit b5407d354ef9 · 2024-11-19T15:46:17.000+08:00
- Streamline commit message generation by utilizing collections.
- Ensure git installation check and cached diff retrieval are performed before generating messages.
- Improve code readability and maintainability by removing redundant steps.
diff --git a/app/Commands/CommitCommand.php b/app/Commands/CommitCommand.php
@@ -13,7 +13,7 @@
 namespace App\Commands;
 
 use App\ConfigManager;
-use App\Exceptions\TaskException;
+use App\Exceptions\RuntimeException;
 use App\GeneratorManager;
 use App\Support\JsonFixer;
 use Illuminate\Console\Scheduling\Schedule;
@@ -59,92 +59,94 @@ public function __construct(GeneratorManager $generatorManager)
 
     /**
      * @psalm-suppress InvalidArgument
+     *
+     * @throws \Exception
      */
     public function handle(): void
     {
-        // Ensure git is installed and the current directory is a git repository.
-        $this->createProcess(['git', 'rev-parse', '--is-inside-work-tree'])->mustRun();
-
-        $cachedDiff = $this->option('diff') ?: $this->createProcess($this->diffCommand())->mustRun()->getOutput();
-        if ('' === $cachedDiff) {
-            throw new TaskException('There are no cached files to commit. Try running `git add` to cache some files.');
-        }
-
-        $type = $this->choice(
-            'Please choice commit type',
-            $types = $this->configManager->get('types'),
-            array_key_first($types)
-        );
-
-        $message = retry(
-            $this->option('retry-times'),
-            function ($attempts) use ($cachedDiff, $type): string {
-                if ($attempts > 1) {
-                    $this->output->note('retrying...');
+        collect()
+            ->tap(function () use (&$message): void {
+                // Ensure git is installed and the current directory is a git repository.
+                $this->createProcess(['git', 'rev-parse', '--is-inside-work-tree'])->mustRun();
+
+                $cachedDiff = $this->option('diff') ?: $this->createProcess($this->diffCommand())->mustRun()->getOutput();
+                if (empty($cachedDiff)) {
+                    throw new RuntimeException('There are no cached files to commit. Try running `git add` to cache some files.');
                 }
 
-                $originalMessage = $this->generatorManager
-                    ->driver($this->option('generator'))
-                    ->generate($this->promptFor($cachedDiff, $type));
-                $message = $this->tryFixMessage($originalMessage);
-                if (! str($message)->jsonValidate()) {
-                    throw new TaskException(sprintf(
-                        'The generated commit message(%s) is an invalid JSON.',
-                        var_export($originalMessage, true)
-                    ));
-                }
+                $type = $this->choice(
+                    'Please choice commit type',
+                    $types = $this->configManager->get('types'),
+                    array_key_first($types)
+                );
+
+                $message = retry(
+                    $this->option('retry-times'),
+                    function ($attempts) use ($cachedDiff, $type): string {
+                        if ($attempts > 1) {
+                            $this->output->note('retrying...');
+                        }
+
+                        $originalMessage = $this->generatorManager
+                            ->driver($this->option('generator'))
+                            ->generate($this->promptFor($cachedDiff, $type));
+                        $message = $this->tryFixMessage($originalMessage);
+                        if (! str($message)->jsonValidate()) {
+                            throw new RuntimeException(sprintf(
+                                'The generated commit message(%s) is an invalid JSON.',
+                                var_export($originalMessage, true)
+                            ));
+                        }
+
+                        return $message;
+                    },
+                    $this->option('retry-sleep'),
+                    $this->configManager->get('retry.when')
+                );
+            })
+            ->tap(function () use (&$message): void {
+                $message = collect(json_decode($message, true, 512, JSON_THROW_ON_ERROR | JSON_PARTIAL_OUTPUT_ON_ERROR))
+                    ->map(static function ($content) {
+                        if (\is_array($content)) {
+                            return collect($content)
+                                ->transform(static function (string $line): string {
+                                    return (string) str($line)->trim(" \t\n\r\x0B")->start('- ');
+                                })
+                                ->implode(PHP_EOL);
+                        }
+
+                        return $content;
+                    })
+                    ->tap(function (Collection $message): void {
+                        $message = $message->put('', '')->sortKeysUsing(static function (string $a, string $b): int {
+                            $rules = ['subject', '', 'body'];
+
+                            return array_search($a, $rules, true) <=> array_search($b, $rules, true);
+                        });
+                        // $this->table($message->keys()->all(), [$message->all()]);
+                        $this->output->horizontalTable($message->keys()->all(), [$message->all()]);
+                    })
+                    ->tap(function (): void {
+                        if (! $this->confirm('Do you want to commit this message?', true)) {
+                            $this->output->note('regenerating...');
+                            $this->handle();
+                        }
+                    });
+            })
+            ->tap(function () use ($message): void {
+                if ($this->option('dry-run')) {
+                    $this->info($this->hydrateMessage($message));
 
-                return $message;
-            },
-            $this->option('retry-sleep'),
-            $this->configManager->get('retry.when')
-        );
-        // $this->task('1. Generating commit message', function () use (&$message): void {
-        // }, 'generating...'.PHP_EOL);
-
-        $message = collect(json_decode($message, true, 512, JSON_THROW_ON_ERROR | JSON_PARTIAL_OUTPUT_ON_ERROR))
-            ->map(static function ($content) {
-                if (\is_array($content)) {
-                    return collect($content)
-                        ->transform(static function (string $line): string {
-                            return (string) str($line)->trim(" \t\n\r\x0B")->start('- ');
-                        })
-                        ->implode(PHP_EOL);
+                    return;
                 }
 
-                return $content;
-            })
-            ->tap(function (Collection $message): void {
-                $message = $message->put('', '')->sortKeysUsing(static function (string $a, string $b): int {
-                    $rules = ['subject', '', 'body'];
-
-                    return array_search($a, $rules, true) <=> array_search($b, $rules, true);
-                });
-                // $this->table($message->keys()->all(), [$message->all()]);
-                $this->output->horizontalTable($message->keys()->all(), [$message->all()]);
+                tap($this->createProcess($this->commitCommandFor($message)), function (Process $process): void {
+                    $this->shouldEdit() and $process->setTty(true);
+                })->setTimeout(null)->mustRun();
             })
             ->tap(function (): void {
-                if (! $this->confirm('Do you want to commit this message?', true)) {
-                    $this->output->note('regenerating...');
-                    $this->handle();
-                }
+                $this->output->success('Successfully generated and committed message.');
             });
-        // $this->task(PHP_EOL.'2. Confirming commit message', function () use (&$message): void {
-        // }, 'confirming...'.PHP_EOL);
-
-        if ($this->option('dry-run')) {
-            $this->info($this->hydrateMessage($message));
-
-            return;
-        }
-
-        tap($this->createProcess($this->commitCommandFor($message)), function (Process $process): void {
-            $this->shouldEdit() and $process->setTty(true);
-        })->setTimeout(null)->mustRun();
-        // $this->task(PHP_EOL.'3. Committing message', function (): void {
-        // }, 'committing...'.PHP_EOL);
-
-        $this->output->success('Successfully generated and committed message.');
     }
 
     public function schedule(Schedule $schedule): void
@@ -384,6 +386,8 @@ private function hydrateMessage(Collection $message): string
      * @param null|mixed $input
      *
      * @noinspection CallableParameterUseCaseInTypeContextInspection
+     * @noinspection PhpSameParameterValueInspection
+     * @noinspection MissingParameterTypeDeclarationInspection
      */
     private function createProcess(
         array $command,
@@ -392,12 +396,10 @@ private function createProcess(
         $input = null,
         ?float $timeout = 60
     ): Process {
-        if (null === $cwd) {
-            $cwd = $this->argument('path');
-        }
+        null === $cwd and $cwd = $this->argument('path');
 
         return tap(new Process($command, $cwd, $env, $input, $timeout), function (Process $process): void {
-            if ($this->option('verbose')) {
+            if ($this->output->isDebug()) {
                 $this->output->note($process->getCommandLine());
             }
         });
diff --git a/config/ai-commit.php b/config/ai-commit.php
@@ -39,7 +39,7 @@
         'times' => 3,
         'sleep' => 200,
         'when' => static function (Exception $exception): bool {
-            return $exception instanceof App\Exceptions\TaskException;
+            return $exception instanceof App\Exceptions\RuntimeException;
         },
     ],
 
diff --git a/tests/Feature/CommitCommandTest.php b/tests/Feature/CommitCommandTest.php
@@ -19,7 +19,7 @@
  */
 
 use App\Commands\CommitCommand;
-use App\Exceptions\TaskException;
+use App\Exceptions\RuntimeException;
 use GuzzleHttp\Promise\PromiseInterface;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Str;
@@ -33,7 +33,7 @@
     expect($createProcess->call(app(CommitCommand::class)))->toBeInstanceOf(Process::class);
 })->group(__DIR__, __FILE__)->skip();
 
-it('will throw TaskException(not a git repository)', function (): void {
+it('will throw RuntimeException(not a git repository)', function (): void {
     $this->artisan(CommitCommand::class, [
         'path' => $this->app->basePath('../'),
         '--config' => config_path('ai-commit.php'),
@@ -42,7 +42,7 @@
     ->group(__DIR__, __FILE__)
     ->throws(ProcessFailedException::class, 'fatal: ');
 
-it('will throw TaskException(no cached files to commit)', function (): void {
+it('will throw RuntimeException(no cached files to commit)', function (): void {
     // 重置暂存区
     Process::fromShellCommandline('git reset', repository_path())->mustRun();
 
@@ -51,11 +51,11 @@
         '--generator' => 'openai',
     ]);
 })
-    ->depends('it will throw TaskException(not a git repository)')
+    ->depends('it will throw RuntimeException(not a git repository)')
     ->group(__DIR__, __FILE__)
-    ->throws(TaskException::class, 'There are no cached files to commit. Try running `git add` to cache some files.');
+    ->throws(RuntimeException::class, 'There are no cached files to commit. Try running `git add` to cache some files.');
 
-it('will throw TaskException(The generated commit message is an invalid JSON)', function (): void {
+it('will throw RuntimeException(The generated commit message is an invalid JSON)', function (): void {
     // 添加文件到暂存区
     file_put_contents(repository_path('playground.random'), Str::random());
     Process::fromShellCommandline('git rm -rf --cached repository/', fixtures_path())->mustRun();
@@ -91,9 +91,9 @@
         // ->expectsChoice('Please choice commit type', array_key_first($types = config('ai-commit.types')), $types)
         ->expectsQuestion('Please choice commit type', array_key_first(config('ai-commit.types')));
 })
-    ->depends('it will throw TaskException(no cached files to commit)')
+    ->depends('it will throw RuntimeException(no cached files to commit)')
     ->group(__DIR__, __FILE__)
-    ->throws(TaskException::class, 'The generated commit message(');
+    ->throws(RuntimeException::class, 'The generated commit message(');
 
 it('can generate and commit message', function (array $parameters): void {
     // 添加文件到暂存区
@@ -132,7 +132,7 @@
         ->assertSuccessful();
 })
     ->with('commit command parameters')
-    ->depends('it will throw TaskException(The generated commit message is an invalid JSON)')
+    ->depends('it will throw RuntimeException(The generated commit message is an invalid JSON)')
     ->group(__DIR__, __FILE__);
 
 afterAll(static function (): void {
