refactor(app/Commands): update CommitCommand.php

- Add comments with links to related resources. - Modify tryFixMessage() method to fix JSON messages. - Add missing import statement. - Update PHPDoc annotations. - Remove unused code. - Update test dataset.
guanguans · Oct 16, 2024 · 1c412e0 · 1c412e0
1 parent ca2c1f7
commit 1c412e0
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 38 deletions.
diff --git a/app/Commands/CommitCommand.php b/app/Commands/CommitCommand.php
@@ -322,13 +322,18 @@ private function getPrompt(string $cachedDiff, string $type): string
             });
     }
 
+    /**
+     * @see https://github.com/josdejong/jsonrepair
+     * @see https://github.com/adhocore/php-json-fixer
+     */
     private function tryFixMessage(string $message): string
     {
         return (new JsonFixer())
             // ->missingValue('')
             ->silent()
             ->fix(
-                str(substr($message, (int) strpos($message, '{')))
+                str($message)
+                    ->substr((int) strpos($message, '{'))
                     // ->match('/\{.*\}/s')
                     ->replaceMatches('/[[:cntrl:]]/mu', '')
                     ->replace(

diff --git a/tests/Datasets/CommitCommandParameters.php b/tests/Datasets/CommitCommandParameters.php
@@ -0,0 +1,38 @@
+<?php
+
+/** @noinspection AnonymousFunctionStaticInspection */
+/** @noinspection JsonEncodingApiUsageInspection */
+/** @noinspection NullPointerExceptionInspection */
+/** @noinspection PhpUnhandledExceptionInspection */
+/** @noinspection PhpUnused */
+/** @noinspection PhpUnusedAliasInspection */
+/** @noinspection StaticClosureCanBeUsedInspection */
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the guanguans/ai-commit.
+ *
+ * (c) guanguans <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
+dataset('commit command parameters', [
+    [
+        /*'parameters' =>*/ [],
+    ],
+    [
+        /*'parameters' =>*/ [
+            '--dry-run' => true,
+        ],
+    ],
+    [
+        /*'parameters' =>*/ [
+            '--diff' => <<<'DIFF'
+                tests/Pest.php                        |  1 +
+                tests/Unit/ConfigManagerTest.php      |  2 +-
+                DIFF,
+        ],
+    ],
+]);
diff --git a/tests/Datasets/InvalidJsons.php b/tests/Datasets/InvalidJsons.php
@@ -18,25 +18,6 @@
  * This source file is subject to the MIT license that is bundled.
  */
 
-dataset('commit command parameters', [
-    [
-        /*'parameters' =>*/ [],
-    ],
-    [
-        /*'parameters' =>*/ [
-            '--dry-run' => true,
-        ],
-    ],
-    [
-        /*'parameters' =>*/ [
-            '--diff' => <<<'DIFF'
-                tests/Pest.php                        |  1 +
-                tests/Unit/ConfigManagerTest.php      |  2 +-
-                DIFF,
-        ],
-    ],
-]);
-
 dataset('invalid jsons', [
     [
         'json' => '',

diff --git a/tests/Datasets/InvalidMessages.php b/tests/Datasets/InvalidMessages.php
@@ -0,0 +1,31 @@
+<?php
+
+/** @noinspection AnonymousFunctionStaticInspection */
+/** @noinspection JsonEncodingApiUsageInspection */
+/** @noinspection NullPointerExceptionInspection */
+/** @noinspection PhpUnhandledExceptionInspection */
+/** @noinspection PhpUnused */
+/** @noinspection PhpUnusedAliasInspection */
+/** @noinspection StaticClosureCanBeUsedInspection */
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the guanguans/ai-commit.
+ *
+ * (c) guanguans <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
+dataset('invalid messages', [
+    [
+        'message' => <<<'MESSAGE'
+            {
+              "subject": "fix(app/Generators): update GithubCopilotCliGenerator to include binary command",
+              "body": "- Change the command array in the `resolve` function call to include `[\'binary\', \'copilot\', \'explain\', $prompt]` as the command\\n- Update the `mustRun` function
+              callback to handle output formatting\\n- Add debug statements to output the generated `$output` variable and perform a `dd()` call\\n- Return the generated `$output` variable"
+              }
+            MESSAGE,
+    ],
+]);
diff --git a/tests/Unit/Commands/CommitCommandTest.php b/tests/Unit/Commands/CommitCommandTest.php
@@ -0,0 +1,30 @@
+<?php
+
+/** @noinspection AnonymousFunctionStaticInspection */
+/** @noinspection JsonEncodingApiUsageInspection */
+/** @noinspection NullPointerExceptionInspection */
+/** @noinspection PhpUnhandledExceptionInspection */
+/** @noinspection PhpUnused */
+/** @noinspection PhpUnusedAliasInspection */
+/** @noinspection StaticClosureCanBeUsedInspection */
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the guanguans/ai-commit.
+ *
+ * (c) guanguans <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
+use App\Commands\CommitCommand;
+
+it('can try fix message', function (string $message): void {
+    expect($message)->not->toBeJson()
+        ->and(
+            (function (string $message): string {
+                return $this->tryFixMessage($message);
+            })->call(app(CommitCommand::class), $message)
+        )->toBeJson();
+})->group(__DIR__, __FILE__)->with('invalid messages');
diff --git a/tests/Unit/Generators/GeneratorTest.php b/tests/Unit/Generators/GeneratorTest.php
@@ -18,7 +18,6 @@
  * This source file is subject to the MIT license that is bundled.
  */
 
-use App\Commands\CommitCommand;
 use App\GeneratorManager;
 
 beforeEach(function (): void {
@@ -30,20 +29,3 @@
 it('can run string cmd', function (): void {
     expect($this->generator->runProcess('echo foo'))->isSuccessful()->toBeTrue();
 })->group(__DIR__, __FILE__);
-
-it('can sanitize output to JSON', function (): void {
-    $output = <<<'OUTPUT'
-        {
-          "subject": "fix(app/Generators): update GithubCopilotCliGenerator to include binary command",
-          "body": "- Change the command array in the `resolve` function call to include `[\'binary\', \'copilot\', \'explain\', $prompt]` as the command\\n- Update the `mustRun` function
-          callback to handle output formatting\\n- Add debug statements to output the generated `$output` variable and perform a `dd()` call\\n- Return the generated `$output` variable"
-          }
-        OUTPUT;
-
-    expect($output)->not->toBeJson()
-        ->and(
-            (function (string $message): string {
-                return $this->tryFixMessage($message);
-            })->call(app(CommitCommand::class), $output)
-        )->toBeJson();
-})->group(__DIR__, __FILE__);