Merge pull request #892 from hydephp/cherry-pick-base-command-changes-from-publications-feature

Cherry pick base command changes from publications feature

Author: caendesilva

packages/framework/src/Console/Commands/RebuildStaticSiteCommand.php

@@ -47,7 +47,7 @@ public function handle(): int
         try {
             $this->validate();
         } catch (Exception $exception) {
-            return $this->handleException($exception);
+            return $this->withException($exception);
         }
 
         (new RebuildService($this->path))->execute();
@@ -102,7 +102,7 @@ public function validate(): void
      *
      * @return int Error code
      */
-    public function handleException(Exception $exception): int
+    public function withException(Exception $exception): int
     {
         $this->error('Something went wrong!');
         $this->warn($exception->getMessage());

packages/framework/src/Console/Concerns/Command.php

@@ -4,14 +4,69 @@
 
 namespace Hyde\Console\Concerns;
 
+use function config;
+use Exception;
 use Hyde\Hyde;
 use LaravelZero\Framework\Commands\Command as BaseCommand;
+use function sprintf;
 
 /**
  * @see \Hyde\Framework\Testing\Feature\CommandTest
  */
 abstract class Command extends BaseCommand
 {
+    public const USER_EXIT = 130;
+
+    /**
+     * The base handle method that can be overridden by child classes.
+     *
+     * Alternatively, implement the safeHandle method in your child class
+     * to utilize the automatic exception handling provided by this method.
+     *
+     * @return int The exit code.
+     */
+    public function handle(): int
+    {
+        try {
+            return $this->safeHandle();
+        } catch (Exception $exception) {
+            return $this->handleException($exception);
+        }
+    }
+
+    /**
+     * This method can be overridden by child classes to provide automatic exception handling.
+     *
+     * Existing code can be converted simply by renaming the handle() method to safeHandle().
+     *
+     * @return int The exit code.
+     */
+    protected function safeHandle(): int
+    {
+        return Command::SUCCESS;
+    }
+
+    /**
+     * Handle an exception that occurred during command execution.
+     *
+     * @return int The exit code
+     */
+    public function handleException(Exception $exception): int
+    {
+        // When testing it might be more useful to see the full stack trace, so we have an option to actually throw the exception.
+        if (config('app.throw_on_console_exception', false)) {
+            throw $exception;
+        }
+
+        // If the exception was thrown from the same file as a command, then we don't need to show which file it was thrown from.
+        $location = str_ends_with($exception->getFile(), 'Command.php') ? '' : sprintf(' at %s:%s',
+            $exception->getFile(), $exception->getLine()
+        );
+        $this->error("Error: {$exception->getMessage()}".$location);
+
+        return Command::FAILURE;
+    }
+
     /**
      * Create a filepath that can be opened in the browser from a terminal.
      */

packages/framework/tests/Feature/CommandTest.php

@@ -8,6 +8,8 @@
 use Hyde\Console\Concerns\Command;
 use Hyde\Hyde;
 use Hyde\Testing\TestCase;
+use Mockery;
+use RuntimeException;
 use Symfony\Component\Console\Style\OutputStyle;
 
 /**
@@ -122,6 +124,46 @@ public function testIndentedLine()
         $command->setMockedOutput($output);
         $command->handle();
     }
+
+    public function testHandleCallsBaseSafeHandle()
+    {
+        $this->assertSame(0, (new TestCommand())->handle());
+    }
+
+    public function testHandleCallsChildSafeHandle()
+    {
+        $this->assertSame(1, (new SafeHandleTestCommand())->handle());
+    }
+
+    public function testSafeHandleException()
+    {
+        $command = new SafeThrowingTestCommand();
+        $output = Mockery::mock(\Illuminate\Console\OutputStyle::class);
+        $output->shouldReceive('writeln')->once()->withArgs(function (string $message) {
+            return str_starts_with($message, '<error>Error: This is a test at '.__FILE__.':');
+        });
+        $command->setOutput($output);
+
+        $code = $command->handle();
+
+        $this->assertSame(1, $code);
+    }
+
+    public function testCanEnableThrowOnException()
+    {
+        $this->throwOnConsoleException();
+        $command = new SafeThrowingTestCommand();
+
+        $output = Mockery::mock(\Illuminate\Console\OutputStyle::class);
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('This is a test');
+
+        $command->setOutput($output);
+        $code = $command->handle();
+
+        $this->assertSame(1, $code);
+    }
 }
 
 class MockableTestCommand extends Command
@@ -140,3 +182,24 @@ public function setMockedOutput($output)
         $this->output = $output;
     }
 }
+
+class TestCommand extends Command
+{
+    //
+}
+
+class SafeHandleTestCommand extends Command
+{
+    public function safeHandle(): int
+    {
+        return 1;
+    }
+}
+
+class SafeThrowingTestCommand extends Command
+{
+    public function safeHandle(): int
+    {
+        throw new RuntimeException('This is a test');
+    }
+}

packages/testing/src/TestCase.php

@@ -4,6 +4,7 @@
 
 namespace Hyde\Testing;
 
+use function config;
 use function file_get_contents;
 use Hyde\Facades\Features;
 use Hyde\Hyde;
@@ -55,4 +56,14 @@ protected function assertFileEqualsString(string $string, string $path, bool $st
             $this->assertEquals(normalize_newlines($string), normalize_newlines(file_get_contents(Hyde::path($path))));
         }
     }
+
+    /**
+     * Disable the throwing of exceptions on console commands for the duration of the test.
+     *
+     * Note that this only affects commands using the {@see \Hyde\Console\Concerns\Command::safeHandle()} method.
+     */
+    protected function throwOnConsoleException(bool $throw = true): void
+    {
+        config(['app.throw_on_console_exception' => $throw]);
+    }
 }