refactor(output): replace variable name 'dispatcher' with 'outputter'

guanguans · guanguans · commit c0fec882d7c1 · 2025-05-07T19:25:15.000+08:00
- Standardize variable naming convention across all files to improve clarity.
- Update the parameter names in method signatures to reflect the new variable name.
- Modify corresponding code logic to align with the updated variable name.
- Ensure consistency in comments and docblocks to avoid ambiguity.
- Verify that the renamed variables match the context of their usage.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -508,14 +508,14 @@ use Illuminate\Support\Collection;
 interface Output
 {
     /**
-     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $outputter
      */
-    public function shouldOutput($dispatcher): bool;
+    public function shouldOutput($outputter): bool;
 
     /**
-     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $outputter
      */
-    public function output(Collection $scores, $dispatcher);
+    public function output(Collection $scores, $outputter);
 }
 ```
 
diff --git a/README.md b/README.md
@@ -508,14 +508,14 @@ use Illuminate\Support\Collection;
 interface Output
 {
     /**
-     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $outputter
      */
-    public function shouldOutput($dispatcher): bool;
+    public function shouldOutput($outputter): bool;
 
     /**
-     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $outputter
      */
-    public function output(Collection $scores, $dispatcher);
+    public function output(Collection $scores, $outputter);
 }
 ```
 
diff --git a/src/Contracts/OutputContract.php b/src/Contracts/OutputContract.php
@@ -19,7 +19,7 @@
 
 interface OutputContract
 {
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool;
+    public function shouldOutput(CommandFinished|Response $outputter): bool;
 
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed;
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed;
 }
diff --git a/src/Events/OutputtingEvent.php b/src/Events/OutputtingEvent.php
@@ -23,6 +23,6 @@ class OutputtingEvent
     public function __construct(
         public OutputContract $output,
         public Collection $scores,
-        public CommandFinished|Response $dispatcher
+        public CommandFinished|Response $outputter
     ) {}
 }
diff --git a/src/OutputManager.php b/src/OutputManager.php
@@ -26,33 +26,33 @@
 
 class OutputManager extends Fluent implements OutputContract
 {
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
         $exclusions = config('soar.exclusions', []);
 
-        if ($dispatcher instanceof CommandFinished) {
-            return !Str::is($exclusions, $dispatcher->command);
+        if ($outputter instanceof CommandFinished) {
+            return !Str::is($exclusions, $outputter->command);
         }
 
         return !Request::is($exclusions) && !Request::routeIs($exclusions);
     }
 
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed
     {
-        if (!$this->shouldOutput($dispatcher)) {
+        if (!$this->shouldOutput($outputter)) {
             return null;
         }
 
         foreach ($this->attributes as $output) {
             \assert($output instanceof OutputContract);
 
-            if (!$output->shouldOutput($dispatcher)) {
+            if (!$output->shouldOutput($outputter)) {
                 continue;
             }
 
             $output instanceof SanitizerContract and $scores = $output->sanitize($scores);
-            event(new OutputtingEvent($output, $scores, $dispatcher));
-            $result = $output->output($scores, $dispatcher);
+            event(new OutputtingEvent($output, $scores, $outputter));
+            $result = $output->output($scores, $outputter);
             event(new OutputtedEvent($output, $scores, $result));
         }
 
diff --git a/src/Outputs/AbstractOutput.php b/src/Outputs/AbstractOutput.php
@@ -27,7 +27,7 @@ abstract class AbstractOutput implements OutputContract, SanitizerContract
     use ScoresHydrator;
     use ScoresSanitizer;
 
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
         return true;
     }
diff --git a/src/Outputs/ClockworkOutput.php b/src/Outputs/ClockworkOutput.php
@@ -22,12 +22,12 @@ class ClockworkOutput extends AbstractOutput
     /**
      * @noinspection PhpMissingParentCallCommonInspection
      */
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
         return \function_exists('clock');
     }
 
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed
     {
         return clock(...$scores);
     }
diff --git a/src/Outputs/Concerns/OutputConditions.php b/src/Outputs/Concerns/OutputConditions.php
@@ -21,25 +21,25 @@
 
 trait OutputConditions
 {
-    protected function isCommandFinished(CommandFinished|Response $dispatcher): bool
+    protected function isCommandFinished(CommandFinished|Response $outputter): bool
     {
-        return $dispatcher instanceof CommandFinished;
+        return $outputter instanceof CommandFinished;
     }
 
-    protected function isHtmlResponse(CommandFinished|Response $dispatcher): bool
+    protected function isHtmlResponse(CommandFinished|Response $outputter): bool
     {
-        return $dispatcher instanceof Response
-            && false !== $dispatcher->getContent()
-            && str($dispatcher->headers->get('Content-Type'))->contains('text/html')
-            && !$this->isJsonResponse($dispatcher);
+        return $outputter instanceof Response
+            && false !== $outputter->getContent()
+            && str($outputter->headers->get('Content-Type'))->contains('text/html')
+            && !$this->isJsonResponse($outputter);
     }
 
-    protected function isJsonResponse(CommandFinished|Response $dispatcher): bool
+    protected function isJsonResponse(CommandFinished|Response $outputter): bool
     {
-        return $dispatcher instanceof JsonResponse
-            && false !== $dispatcher->getContent()
-            && str($dispatcher->headers->get('Content-Type'))->contains('application/json')
-            && transform($dispatcher, static function (JsonResponse $jsonResponse): bool {
+        return $outputter instanceof JsonResponse
+            && false !== $outputter->getContent()
+            && str($outputter->headers->get('Content-Type'))->contains('application/json')
+            && transform($outputter, static function (JsonResponse $jsonResponse): bool {
                 if ('' === ($content = $jsonResponse->getContent())) {
                     return false;
                 }
diff --git a/src/Outputs/ConsoleOutput.php b/src/Outputs/ConsoleOutput.php
@@ -24,32 +24,32 @@ public function __construct(protected string $method = 'warn') {}
     /**
      * @noinspection PhpMissingParentCallCommonInspection
      */
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
-        return $this->isHtmlResponse($dispatcher);
+        return $this->isHtmlResponse($outputter);
     }
 
     /**
      * @noinspection PhpMixedReturnTypeCanBeReducedInspection
      *
      * @throws \JsonException
      */
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed
     {
-        \assert($dispatcher instanceof Response);
+        \assert($outputter instanceof Response);
 
         $js = $this->toJavaScript($scores);
-        $content = $dispatcher->getContent();
+        $content = $outputter->getContent();
 
         // Try to put the widget at the end, directly before the </body>
         $pos = strripos($content, '</body>');
         $content = false !== $pos ? substr($content, 0, $pos).$js.substr($content, $pos) : $content.$js;
 
         // Update the new content and reset the content length
-        $dispatcher->setContent($content);
-        $dispatcher->headers->remove('Content-Length');
+        $outputter->setContent($content);
+        $outputter->headers->remove('Content-Length');
 
-        return $dispatcher;
+        return $outputter;
     }
 
     /**
diff --git a/src/Outputs/DebugBarOutput.php b/src/Outputs/DebugBarOutput.php
@@ -29,12 +29,12 @@ public function __construct(
     /**
      * @noinspection PhpMissingParentCallCommonInspection
      */
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
         // app(LaravelDebugbar::class)->isEnabled()
         return class_exists(LaravelDebugbar::class)
             && app()->has(LaravelDebugbar::class)
-            && $this->isHtmlResponse($dispatcher);
+            && $this->isHtmlResponse($outputter);
     }
 
     /**
@@ -43,7 +43,7 @@ public function shouldOutput(CommandFinished|Response $dispatcher): bool
      * @throws \DebugBar\DebugBarException
      * @throws \JsonException
      */
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): LaravelDebugbar
+    public function output(Collection $scores, CommandFinished|Response $outputter): LaravelDebugbar
     {
         $debugBar = resolve(LaravelDebugbar::class);
 
diff --git a/src/Outputs/DumpOutput.php b/src/Outputs/DumpOutput.php
@@ -26,7 +26,7 @@ public function __construct(private bool $exit = false) {}
      * @noinspection ClosureToArrowFunctionInspection
      * @noinspection DebugFunctionUsageInspection
      */
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed
     {
         return $this->exit ? dd(...$scores) : dump(...$scores);
     }
diff --git a/src/Outputs/JsonOutput.php b/src/Outputs/JsonOutput.php
@@ -26,26 +26,26 @@ public function __construct(protected string $key = 'soar_scores') {}
     /**
      * @noinspection PhpMissingParentCallCommonInspection
      */
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
-        return $this->isJsonResponse($dispatcher);
+        return $this->isJsonResponse($outputter);
     }
 
     /**
      * @throws \JsonException
      */
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): JsonResponse
+    public function output(Collection $scores, CommandFinished|Response $outputter): JsonResponse
     {
-        \assert($dispatcher instanceof JsonResponse);
+        \assert($outputter instanceof JsonResponse);
 
-        // $data = Arr::wrap($dispatcher->getData(true));
-        $data = Arr::wrap(json_decode($dispatcher->getContent(), true, 512, \JSON_THROW_ON_ERROR));
+        // $data = Arr::wrap($outputter->getData(true));
+        $data = Arr::wrap(json_decode($outputter->getContent(), true, 512, \JSON_THROW_ON_ERROR));
         Arr::set($data, $this->key, $scores);
 
         // Update the new content and reset the content length
-        $dispatcher->setData($data);
-        $dispatcher->headers->remove('Content-Length');
+        $outputter->setData($data);
+        $outputter->headers->remove('Content-Length');
 
-        return $dispatcher;
+        return $outputter;
     }
 }
diff --git a/src/Outputs/LogOutput.php b/src/Outputs/LogOutput.php
@@ -28,13 +28,13 @@ public function __construct(
     /**
      * @throws \JsonException
      */
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): CommandFinished|Response
+    public function output(Collection $scores, CommandFinished|Response $outputter): CommandFinished|Response
     {
         $scores->each(fn (array $score) => Log::channel($this->channel)->log(
             $this->level,
             $this->hydrateScore($score)
         ));
 
-        return $dispatcher;
+        return $outputter;
     }
 }
diff --git a/src/Outputs/RayOutput.php b/src/Outputs/RayOutput.php
@@ -24,12 +24,12 @@ public function __construct(protected string $label = 'Soar Scores') {}
     /**
      * @noinspection PhpMissingParentCallCommonInspection
      */
-    public function shouldOutput(CommandFinished|Response $dispatcher): bool
+    public function shouldOutput(CommandFinished|Response $outputter): bool
     {
         return \function_exists('ray');
     }
 
-    public function output(Collection $scores, CommandFinished|Response $dispatcher): mixed
+    public function output(Collection $scores, CommandFinished|Response $outputter): mixed
     {
         return ray(...$scores)->label($this->label);
     }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`
`20`	`20`	`interface OutputContract`
`21`	`21`	`{`
`22`		`- public function shouldOutput(CommandFinished\|Response $dispatcher): bool;`
	`22`	`+ public function shouldOutput(CommandFinished\|Response $outputter): bool;`
`23`	`23`
`24`		`- public function output(Collection $scores, CommandFinished\|Response $dispatcher): mixed;`
	`24`	`+ public function output(Collection $scores, CommandFinished\|Response $outputter): mixed;`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,6 @@ class OutputtingEvent`
`23`	`23`	`public function __construct(`
`24`	`24`	`public OutputContract $output,`
`25`	`25`	`public Collection $scores,`
`26`		`- public CommandFinished\|Response $dispatcher`
	`26`	`+ public CommandFinished\|Response $outputter`
`27`	`27`	`) {}`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,33 +26,33 @@`
`26`	`26`
`27`	`27`	`class OutputManager extends Fluent implements OutputContract`
`28`	`28`	`{`
`29`		`- public function shouldOutput(CommandFinished\|Response $dispatcher): bool`
	`29`	`+ public function shouldOutput(CommandFinished\|Response $outputter): bool`
`30`	`30`	`{`
`31`	`31`	`$exclusions = config('soar.exclusions', []);`
`32`	`32`
`33`		`- if ($dispatcher instanceof CommandFinished) {`
`34`		`- return !Str::is($exclusions, $dispatcher->command);`
	`33`	`+ if ($outputter instanceof CommandFinished) {`
	`34`	`+ return !Str::is($exclusions, $outputter->command);`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`return !Request::is($exclusions) && !Request::routeIs($exclusions);`
`38`	`38`	`}`
`39`	`39`
`40`		`- public function output(Collection $scores, CommandFinished\|Response $dispatcher): mixed`
	`40`	`+ public function output(Collection $scores, CommandFinished\|Response $outputter): mixed`
`41`	`41`	`{`
`42`		`- if (!$this->shouldOutput($dispatcher)) {`
	`42`	`+ if (!$this->shouldOutput($outputter)) {`
`43`	`43`	`return null;`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`foreach ($this->attributes as $output) {`
`47`	`47`	`\assert($output instanceof OutputContract);`
`48`	`48`
`49`		`- if (!$output->shouldOutput($dispatcher)) {`
	`49`	`+ if (!$output->shouldOutput($outputter)) {`
`50`	`50`	`continue;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`$output instanceof SanitizerContract and $scores = $output->sanitize($scores);`
`54`		`- event(new OutputtingEvent($output, $scores, $dispatcher));`
`55`		`- $result = $output->output($scores, $dispatcher);`
	`54`	`+ event(new OutputtingEvent($output, $scores, $outputter));`
	`55`	`+ $result = $output->output($scores, $outputter);`
`56`	`56`	`event(new OutputtedEvent($output, $scores, $result));`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ abstract class AbstractOutput implements OutputContract, SanitizerContract`
`27`	`27`	`use ScoresHydrator;`
`28`	`28`	`use ScoresSanitizer;`
`29`	`29`
`30`		`- public function shouldOutput(CommandFinished\|Response $dispatcher): bool`
	`30`	`+ public function shouldOutput(CommandFinished\|Response $outputter): bool`
`31`	`31`	`{`
`32`	`32`	`return true;`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,12 @@ class ClockworkOutput extends AbstractOutput`
`22`	`22`	`/**`
`23`	`23`	`* @noinspection PhpMissingParentCallCommonInspection`
`24`	`24`	`*/`
`25`		`- public function shouldOutput(CommandFinished\|Response $dispatcher): bool`
	`25`	`+ public function shouldOutput(CommandFinished\|Response $outputter): bool`
`26`	`26`	`{`
`27`	`27`	`return \function_exists('clock');`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function output(Collection $scores, CommandFinished\|Response $dispatcher): mixed`
	`30`	`+ public function output(Collection $scores, CommandFinished\|Response $outputter): mixed`
`31`	`31`	`{`
`32`	`32`	`return clock(...$scores);`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,25 +21,25 @@`
`21`	`21`
`22`	`22`	`trait OutputConditions`
`23`	`23`	`{`
`24`		`- protected function isCommandFinished(CommandFinished\|Response $dispatcher): bool`
	`24`	`+ protected function isCommandFinished(CommandFinished\|Response $outputter): bool`
`25`	`25`	`{`
`26`		`- return $dispatcher instanceof CommandFinished;`
	`26`	`+ return $outputter instanceof CommandFinished;`
`27`	`27`	`}`
`28`	`28`
`29`		`- protected function isHtmlResponse(CommandFinished\|Response $dispatcher): bool`
	`29`	`+ protected function isHtmlResponse(CommandFinished\|Response $outputter): bool`
`30`	`30`	`{`
`31`		`- return $dispatcher instanceof Response`
`32`		`- && false !== $dispatcher->getContent()`
`33`		`- && str($dispatcher->headers->get('Content-Type'))->contains('text/html')`
`34`		`- && !$this->isJsonResponse($dispatcher);`
	`31`	`+ return $outputter instanceof Response`
	`32`	`+ && false !== $outputter->getContent()`
	`33`	`+ && str($outputter->headers->get('Content-Type'))->contains('text/html')`
	`34`	`+ && !$this->isJsonResponse($outputter);`
`35`	`35`	`}`
`36`	`36`
`37`		`- protected function isJsonResponse(CommandFinished\|Response $dispatcher): bool`
	`37`	`+ protected function isJsonResponse(CommandFinished\|Response $outputter): bool`
`38`	`38`	`{`
`39`		`- return $dispatcher instanceof JsonResponse`
`40`		`- && false !== $dispatcher->getContent()`
`41`		`- && str($dispatcher->headers->get('Content-Type'))->contains('application/json')`
`42`		`- && transform($dispatcher, static function (JsonResponse $jsonResponse): bool {`
	`39`	`+ return $outputter instanceof JsonResponse`
	`40`	`+ && false !== $outputter->getContent()`
	`41`	`+ && str($outputter->headers->get('Content-Type'))->contains('application/json')`
	`42`	`+ && transform($outputter, static function (JsonResponse $jsonResponse): bool {`
`43`	`43`	`if ('' === ($content = $jsonResponse->getContent())) {`
`44`	`44`	`return false;`
`45`	`45`	`}`