refactor(WithRunable): Update callable types to Closure for better type safety

guanguans · guanguans · commit 59a703f4f771 · 2025-11-30T22:21:10.000+08:00
- Change callable type hints to Closure for $pipe and $tap properties.
- Update method signatures for withPipe and withTap to accept Closure.
- Ensure type checks use instanceof for Closure instead of is_callable.

Signed-off-by: guanguans &lt;ityaozm@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -514,7 +514,7 @@ $soar->withSudoPassword('your sudo password'); // With a sudo password to run th
 
 ### Or configure sudoers
 
-> On higher versions of macOS, it is possible that the fingerprint authentication window will pop up. You can configure sudoers to run `soar` commands without a password.
+> On higher versions of macOS, it is possible that the fingerprint authentication window will pop up. You can configure sudoers to run `soar` command without password.
 
 1. Edit Configuration file of sudoers:
 
@@ -534,8 +534,8 @@ guanguans ALL=(ALL) NOPASSWD: /Users/guanguans/Documents/develop/soar-php/bin/so
 ```shell
 composer benchmark
 composer checks:required
-composer soar:example-run
-composer soar:example-serve
+composer soar:usage-example-run
+composer soar:usage-example-serve
 composer test
 ```
 
diff --git a/composer-bump b/composer-bump
@@ -213,7 +213,7 @@ class ComposerBump
                     },
                 ];
 
-                sort($dependencyVersions);
+                sort($dependencyVersions, \SORT_NUMERIC);
 
                 $package['dependency_version'] = implode(' || ', $dependencyVersions);
                 $carry[$package['name']] = $package;
diff --git a/composer.json b/composer.json
@@ -214,6 +214,7 @@
             "@php-cs-fixer:fix-dry-run-stop-on-violation",
             "@soar:check-binary",
             "@soar:dump-config",
+            "@soar:usage-example-run",
             "@pest:bail",
             "@rector:process-dry-run",
             "@phpstan:analyse"
@@ -394,7 +395,7 @@
         "rule-doc-generator:rector-validate": "@rule-doc-generator validate src/Support/Rectors/",
         "sk": "@php vendor/bin/swiss-knife --ansi -vv",
         "sk:alice-yaml-fixtures-to-php": "@sk alice-yaml-fixtures-to-php --help",
-        "sk:check-commented-code": "@sk check-commented-code examples/ src/ --line-limit=5 --skip-file=src/Soar.php",
+        "sk:check-commented-code": "@sk check-commented-code examples/ src/ --line-limit=6 --skip-file=src/Soar.php",
         "sk:check-conflicts": "@sk check-conflicts examples/ src/",
         "sk:dump-editorconfig": "@sk dump-editorconfig",
         "sk:finalize-classes": "@sk finalize-classes examples/ src/",
@@ -428,13 +429,13 @@
         ],
         "soar:dump-php-config-prototype": "Guanguans\\SoarPHP\\Support\\ComposerScripts::dumpSoarPHPConfig",
         "soar:dump-yaml-config": "Guanguans\\SoarPHP\\Support\\ComposerScripts::dumpSoarYamlConfig",
-        "soar:example-run": [
+        "soar:usage-example-run": [
             "echo 'examples/example.php:\n'",
-            "@php examples/example.php"
+            "@php examples/usage-example.php"
         ],
-        "soar:example-serve": [
+        "soar:usage-example-serve": [
             "@composer-config:disable-process-timeout",
-            "@php -S localhost:8123 examples/example.php"
+            "@php -S localhost:8123 examples/usage-example.php"
         ],
         "testbench": "@php vendor/bin/testbench --ansi",
         "testbench:build": "@testbench workbench:build",
diff --git a/examples/usage-example.php b/examples/usage-example.php
diff --git a/rector.php b/rector.php
@@ -116,6 +116,7 @@
         'PhpUndefinedClassInspection',
         'PhpUnhandledExceptionInspection',
         'PhpVoidFunctionResultUsedInspection',
+        'SqlResolve',
         'StaticClosureCanBeUsedInspection',
     ])
     ->withConfiguredRule(NewExceptionToNewAnonymousExtendsExceptionImplementsRector::class, [
diff --git a/src/Concerns/WithRunable.php b/src/Concerns/WithRunable.php
@@ -20,20 +20,20 @@
  */
 trait WithRunable
 {
-    /** @var null|callable(Process): Process */
-    protected $pipe;
+    /** @var null|\Closure(Process): Process */
+    protected ?\Closure $pipe = null;
 
-    /** @var null|callable(Process): void */
-    protected $tap;
+    /** @var null|\Closure(Process): void */
+    protected ?\Closure $tap = null;
 
-    public function withPipe(?callable $pipe): self
+    public function withPipe(?\Closure $pipe): self
     {
         $this->pipe = $pipe;
 
         return $this;
     }
 
-    public function withTap(?callable $tap): self
+    public function withTap(?\Closure $tap): self
     {
         $this->tap = $tap;
 
@@ -59,10 +59,10 @@ protected function toProcess(): Process
             ? new Process(command: ['sudo', '-S', ...$command], input: $this->getSudoPassword())
             : new Process($command);
 
-        if (\is_callable($this->tap)) {
-            ($this->tap)($process);
+        if ($this->tap instanceof \Closure) {
+            $this->tap->call($process, $process);
         }
 
-        return \is_callable($this->pipe) ? ($this->pipe)($process) : $process;
+        return $this->pipe instanceof \Closure ? ($this->pipe)->call($process, $process) : $process;
     }
 }
diff --git a/tests/ArchTest.php b/tests/ArchTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Concerns/ConcreteMagicTest.php b/tests/Concerns/ConcreteMagicTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection DebugFunctionUsageInspection */
 declare(strict_types=1);
diff --git a/tests/Concerns/ConcreteScoresTest.php b/tests/Concerns/ConcreteScoresTest.php
@@ -6,10 +6,10 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection DebugFunctionUsageInspection */
 /** @noinspection ForgottenDebugOutputInspection */
-/** @noinspection SqlResolve */
 declare(strict_types=1);
 
 /**
diff --git a/tests/Concerns/HasOptionsTest.php b/tests/Concerns/HasOptionsTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection NestedAssignmentsUsageInspection */
 declare(strict_types=1);
diff --git a/tests/Concerns/HasSoarBinaryTest.php b/tests/Concerns/HasSoarBinaryTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Concerns/HasSudoPasswordTest.php b/tests/Concerns/HasSudoPasswordTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Concerns/WithDumpableTest.php b/tests/Concerns/WithDumpableTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Concerns/WithRunableTest.php b/tests/Concerns/WithRunableTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection DebugFunctionUsageInspection */
 /** @noinspection ForgottenDebugOutputInspection */
@@ -62,7 +63,12 @@ protected function shouldApplySudoPassword(): bool
 it('can run soar process with pipe', function (): void {
     expect(Soar::make())
         ->withVersion(true)
-        ->withPipe(static fn (Process $process): Process => $process->setTimeout(3))
+        ->withPipe(function (Process $process): Process {
+            expect($this)->toBeInstanceOf(Process::class);
+            expect($this->commandline)->toBeArray();
+
+            return $process->setTimeout(3);
+        })
         ->run(static function (string $type, string $line): void {
             // dump($type, $line);
         })
@@ -72,7 +78,10 @@ protected function shouldApplySudoPassword(): bool
 it('can run soar process with tap', function (): void {
     expect(Soar::make())
         ->withVersion(true)
-        ->withTap(static function (Process $process): void {
+        ->withTap(function (Process $process): void {
+            expect($this)->toBeInstanceOf(Process::class);
+            expect($this->commandline)->toBeArray();
+
             $process->setTimeout(3);
         })
         ->run(static function (string $type, string $line): void {
diff --git a/tests/Datasets/Movies.php b/tests/Datasets/Movies.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Datasets/Queries.php b/tests/Datasets/Queries.php
@@ -6,8 +6,8 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
-/** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection SqlResolve */
+/** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
 /**
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection PhpInconsistentReturnPointsInspection */
 /** @noinspection PhpMultipleClassDeclarationsInspection */
diff --git a/tests/SoarTest.php b/tests/SoarTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Support/HelpersTest.php b/tests/Support/HelpersTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/Support/OsHelperTest.php b/tests/Support/OsHelperTest.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 declare(strict_types=1);
 
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -6,6 +6,7 @@
 /** @noinspection PhpUndefinedClassInspection */
 /** @noinspection PhpUnhandledExceptionInspection */
 /** @noinspection PhpVoidFunctionResultUsedInspection */
+/** @noinspection SqlResolve */
 /** @noinspection StaticClosureCanBeUsedInspection */
 /** @noinspection PhpMissingParentCallCommonInspection */
 declare(strict_types=1);

Original file line number	Diff line number	Diff line change
`@@ -20,20 +20,20 @@`
`20`	`20`	`*/`
`21`	`21`	`trait WithRunable`
`22`	`22`	`{`
`23`		`- /** @var null\|callable(Process): Process */`
`24`		`- protected $pipe;`
	`23`	`+ /** @var null\|\Closure(Process): Process */`
	`24`	`+ protected ?\Closure $pipe = null;`
`25`	`25`
`26`		`- /** @var null\|callable(Process): void */`
`27`		`- protected $tap;`
	`26`	`+ /** @var null\|\Closure(Process): void */`
	`27`	`+ protected ?\Closure $tap = null;`
`28`	`28`
`29`		`- public function withPipe(?callable $pipe): self`
	`29`	`+ public function withPipe(?\Closure $pipe): self`
`30`	`30`	`{`
`31`	`31`	`$this->pipe = $pipe;`
`32`	`32`
`33`	`33`	`return $this;`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function withTap(?callable $tap): self`
	`36`	`+ public function withTap(?\Closure $tap): self`
`37`	`37`	`{`
`38`	`38`	`$this->tap = $tap;`
`39`	`39`
`@@ -59,10 +59,10 @@ protected function toProcess(): Process`
`59`	`59`	`? new Process(command: ['sudo', '-S', ...$command], input: $this->getSudoPassword())`
`60`	`60`	`: new Process($command);`
`61`	`61`
`62`		`- if (\is_callable($this->tap)) {`
`63`		`- ($this->tap)($process);`
	`62`	`+ if ($this->tap instanceof \Closure) {`
	`63`	`+ $this->tap->call($process, $process);`
`64`	`64`	`}`
`65`	`65`
`66`		`- return \is_callable($this->pipe) ? ($this->pipe)($process) : $process;`
	`66`	`+ return $this->pipe instanceof \Closure ? ($this->pipe)->call($process, $process) : $process;`
`67`	`67`	`}`
`68`	`68`	`}`