added onSignal

Author: henzeb

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to `Laravel Console Facade` will be documented in this file
 
+## 1.7.0 - 2022-08-30
+- added `onSignal`, to allow more control over what happens on given signals.
+
 ## 1.6.0 - 2022-08-19
 - added components method to the new Components Factory of Laravel
 

README.md

@@ -63,6 +63,7 @@ class MyClass {
     {   
         Console::section('section1')->table(['header'=>'title'], [[]]);
         Console::section('section2')->withProgressBar(100, fn()=>true);
+        Console::section('section1')->components()->bulletList(['this one', 'Another one']);
         Console::section('section1')->clear();
         Console::section('section3')->info('This message was brought to you by Henzeb');
     }
@@ -133,6 +134,43 @@ Console::onExit(
 );
 ```
 
+#### onSignal
+`onSignal` uses pcntl_signal to register the callbacks. But what's different, `onsignal` will allow you to register
+multiple handlers. This gives you more granular control over what is executed on certain signals without overriding 
+existing handlers.
+
+In below scenario, all three will run when a `SIGINT` signal is given and the second will also run when a `SIGTERM` signal
+is given. The first handler returns true. This means that when all handlers are executed, an exit is given.
+```php
+Console::onSignal(
+    function () {
+        print('first handler');
+        return true;
+    },
+    SIGINT
+);
+
+Console::onSignal(
+    function () {
+        print('second handler');
+        var_dump(func_get_args());
+        return false;
+    },
+    SIGINT,
+    SIGTERM
+);
+
+Console::onSignal(
+    function () {
+        print('third handler');
+    },
+    SIGINT
+);
+```
+
+Tip: When a handler was already registered the normal way, you can use `pcntl_signal_get_handler` to pass this in to
+`onSignal`
+
 ## Testing
 
 ```bash

composer.json

@@ -7,7 +7,7 @@
         "console",
         "facade"
     ],
-    "homepage": "https://github.com/henzeb/laravel-console",
+    "homepage": "https://github.com/henzeb/laravel-console-facade",
     "license": "AGPL-3.0-only",
     "type": "library",
     "authors": [

src/Concerns/InteractsWithIO.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Henzeb\Console\Concerns;
+
+use RuntimeException;
+use Illuminate\Console\View\Components\Factory;
+use Illuminate\Console\Concerns\InteractsWithIO as IlluminateInteractsWithIO;
+
+trait InteractsWithIO
+{
+    use IlluminateInteractsWithIO;
+
+    public function components(): Factory
+    {
+        if(version_compare(app()->version(), '9.21.0', '>=')) {
+            return resolve(Factory::class, ['output' => $this->getOutput()]);
+        }
+
+        throw new RuntimeException('This version of Laravel does not support components.');
+    }
+}

src/Output/ConsoleOutput.php

@@ -4,9 +4,8 @@
 
 use Closure;
 use Illuminate\Console\OutputStyle;
+use Henzeb\Console\Concerns\InteractsWithIO;
 use Symfony\Component\Console\Input\ArrayInput;
-use Illuminate\Console\View\Components\Factory;
-use Illuminate\Console\Concerns\InteractsWithIO;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\ConsoleOutput as SymfonyConsoleOutput;
@@ -16,6 +15,7 @@ class ConsoleOutput
     use InteractsWithIO;
 
     private array $sections = [];
+    private array $onSignal = [];
     private array $onExit = [
         'always' => []
     ];
@@ -79,8 +79,25 @@ private function getSection(string $name): ConsoleSectionOutput
 
     public function onSignal(callable $onSignal, int ...$signalNumbers): void
     {
-        foreach($signalNumbers as $signalNumber) {
-            pcntl_signal($signalNumber, $onSignal);
+        foreach ($signalNumbers as $signalNumber) {
+            if (!isset($this->onSignal[$signalNumber])) {
+                pcntl_signal(
+                    $signalNumber,
+                    function () use ($signalNumber) {
+                        $shouldExit = false;
+
+                        foreach ($this->onSignal[$signalNumber] as $callable) {
+                            $shouldExit = $callable(...func_get_args()) ? true : $shouldExit;
+                        }
+
+                        if ($shouldExit) {
+                            $this->exit();
+                        }
+                    }
+                );
+            }
+
+            $this->onSignal[$signalNumber][] = Closure::fromCallable($onSignal);
         }
     }
 
@@ -91,7 +108,7 @@ public function onExit(callable $onExit, int $exitCode = null): void
 
     private function getExitMethod(): callable
     {
-        return $this->exitMethod =  $this->exitMethod ?? fn(int $exitcode) => exit($exitcode);
+        return $this->exitMethod = $this->exitMethod ?? fn(int $exitcode) => exit($exitcode);
     }
 
     public function exit(int $exitcode = 0): void
@@ -106,9 +123,4 @@ public function exit(int $exitcode = 0): void
 
         $this->getExitMethod()($exitcode);
     }
-
-    public function components(): Factory
-    {
-        return resolve(Factory::class, ['output' => $this->getOutput()]);
-    }
 }

src/Output/ConsoleSectionOutput.php

@@ -4,7 +4,8 @@
 
 use Closure;
 use Generator;
-use Illuminate\Console\Concerns\InteractsWithIO;
+
+use Henzeb\Console\Concerns\InteractsWithIO;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Formatter\OutputFormatterInterface;

tests/Unit/Console/Output/ConsoleOutputTest.php

@@ -205,6 +205,135 @@ public function testShouldCallWhenStatusCodeDoesMatch()
         $this->assertTrue($actual);
     }
 
+    public function testOnSignal()
+    {
+        $var = null;
+        $output = new ConsoleOutput();
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var = func_get_args();
+            },
+            SIGINT
+        );
+        pcntl_signal_get_handler(SIGINT)(
+            0,
+            [
+                "signo" => 2,
+                "errno" => 0,
+                "code" => 0,
+            ]
+        );
+
+        $this->assertEquals($var, [
+            0,
+            [
+                "signo" => 2,
+                "errno" => 0,
+                "code" => 0,
+            ]
+        ]);
+    }
+
+    public function testOnSignalMultipleSignals()
+    {
+        $var = 0;
+        $output = new ConsoleOutput();
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 1;
+            },
+            SIGINT,
+            SIGTERM
+        );
+        pcntl_signal_get_handler(SIGINT)();
+        pcntl_signal_get_handler(SIGTERM)();
+
+        $this->assertEquals(2, $var);
+    }
+
+    public function testOnSignalMultipleHandlers()
+    {
+        $var = 0;
+        $output = new ConsoleOutput();
+
+        $this->mockExit($output, function () use (&$var) {
+            $var += 4;
+        });
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 1;
+            },
+            SIGINT
+        );
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 2;
+            },
+            SIGINT
+        );
+        pcntl_signal_get_handler(SIGINT)();
+
+        $this->assertEquals(3, $var);
+    }
+
+    public function testOnSignalMultipleHandlersExit()
+    {
+        $var = 0;
+        $output = new ConsoleOutput();
+        $this->mockExit($output, function () use (&$var) {
+            $var += 4;
+        });
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 1;
+                return true;
+            },
+            SIGINT
+        );
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 2;
+            },
+            SIGINT
+        );
+        pcntl_signal_get_handler(SIGINT)();
+
+        $this->assertEquals(7, $var);
+    }
+
+    public function testOnSignalMultipleHandlersExitWithOneReturningFalse()
+    {
+        $var = 0;
+        $output = new ConsoleOutput();
+        $this->mockExit($output, function () use (&$var) {
+            $var += 4;
+        });
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 1;
+                return true;
+            },
+            SIGINT
+        );
+
+        $output->onSignal(
+            function () use (&$var) {
+                $var += 2;
+                return false;
+            },
+            SIGINT
+        );
+        pcntl_signal_get_handler(SIGINT)();
+
+        $this->assertEquals(7, $var);
+    }
+
     public function testShouldReturnComponentsFactory(): void
     {
         $output = new ConsoleOutput();

tests/Unit/Console/Output/ConsoleSectionOutputTest.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Console\Output\Output;
 use Henzeb\Console\Output\ConsoleSectionOutput;
 use Symfony\Component\Console\Input\ArrayInput;
+use Illuminate\Console\View\Components\Factory;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Formatter\OutputFormatter;
@@ -177,4 +178,29 @@ protected function providesVerbosityLevels(): array
             [OutputInterface::VERBOSITY_QUIET],
         ];
     }
+
+    public function testShouldReturnComponentsFactory(): void
+    {
+
+        $output = new \Henzeb\Console\Output\ConsoleOutput();
+
+        $expectedOutput = $output->getOutput();
+
+        $output = $output->section('test');
+
+        app()->bind(Factory::class, function ($app, $args) {
+            return new class($args['output']) extends Factory {
+
+            };
+        });
+        $resolved = resolve(Factory::class, ['output' => $expectedOutput]);
+
+        $this->assertEquals(get_class($resolved), get_class($output->components()));
+
+        $actualOutput = Closure::bind(function () {
+            return $this->output;
+        }, $resolved, Factory::class)();
+
+        $this->assertTrue($expectedOutput === $actualOutput);
+    }
 }