Fix style

guanguans · Apr 18, 2022 · 2e4cdf7 · 2e4cdf7
1 parent c7eddf2
commit 2e4cdf7
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 139 deletions.
diff --git a/src/Contracts/Output.php b/src/Contracts/Output.php
@@ -15,11 +15,9 @@
 interface Output
 {
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $requestHandled
-     * @param \Illuminate\Console\Events\CommandFinished        $requestHandled
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $requestHandled
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
      *
      * @return mixed
      */
-    public function output(Collection $scores, $requestHandled);
+    public function output(Collection $scores, $dispatcher);
 }
diff --git a/src/OutputManager.php b/src/OutputManager.php
@@ -39,18 +39,14 @@ public function offsetSet($offset, $value): void
     }
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $requestHandled
-     * @param \Illuminate\Console\Events\CommandFinished        $requestHandled
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $requestHandled
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $requestHandled)
+    public function output(Collection $scores, $dispatcher)
     {
         /* @var Output $output */
         foreach ($this->attributes as $output) {
-            event(new OutputtingEvent($output, $scores, $requestHandled));
-            $result = $output->output($scores, $requestHandled);
+            event(new OutputtingEvent($output, $scores, $dispatcher));
+            $result = $output->output($scores, $dispatcher);
             event(new OutputtedEvent($output, $scores, $result));
         }
     }

diff --git a/src/Outputs/ClockworkOutput.php b/src/Outputs/ClockworkOutput.php
@@ -15,14 +15,11 @@
 class ClockworkOutput extends Output
 {
     /**
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $event)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($event)) {
+        if (! function_exists('clock')) {
             return;
         }
 
@@ -31,9 +28,4 @@ public function output(Collection $scores, $event)
             clock()->warning($score['Summary'], $score);
         });
     }
-
-    protected function shouldOutput($event): bool
-    {
-        return function_exists('clock');
-    }
 }
diff --git a/src/Outputs/Concerns/OutputCondition.php b/src/Outputs/Concerns/OutputCondition.php
@@ -11,75 +11,47 @@
 namespace Guanguans\LaravelSoar\Outputs\Concerns;
 
 use Illuminate\Console\Events\CommandFinished;
-use Illuminate\Foundation\Http\Events\RequestHandled;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Response;
 use Illuminate\Support\Str;
 
 trait OutputCondition
 {
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $event
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
      */
-    protected function isEvent($event): bool
+    protected function isCommandFinished($dispatcher): bool
     {
-        return $event instanceof CommandFinished ||
-               $event instanceof RequestHandled;
+        return $dispatcher instanceof CommandFinished;
     }
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $event
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
      */
-    protected function isCommandFinishedEvent($event): bool
+    protected function isResponse($dispatcher): bool
     {
-        return $event instanceof CommandFinished;
+        return $dispatcher instanceof Response;
     }
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $event
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
      */
-    protected function isRequestHandledEvent($event): bool
+    protected function isHtmlResponse($dispatcher): bool
     {
-        return $event instanceof RequestHandled;
+        return $dispatcher instanceof Response &&
+               Str::contains($dispatcher->headers->get('Content-Type'), 'text/html') &&
+               ! $this->isJsonResponse($dispatcher);
     }
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Response        $response
-     * @param \Illuminate\Console\Events\CommandFinished        $response
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $response
+     * @param \Illuminate\Console\Events\CommandFinished|\Symfony\Component\HttpFoundation\Response $dispatcher
      */
-    protected function isResponse($response): bool
+    protected function isJsonResponse($dispatcher): bool
     {
-        return $response instanceof Response;
-    }
-
-    /**
-     * @param \Illuminate\Http\Response     $response
-     * @param \Illuminate\Http\JsonResponse $response
-     */
-    protected function isHtmlResponse($response): bool
-    {
-        return $response instanceof Response &&
-               Str::contains($response->headers->get('Content-Type'), 'text/html') &&
-               ! $this->isJsonResponse($response);
-    }
-
-    /**
-     * @param \Illuminate\Http\Response     $response
-     * @param \Illuminate\Http\JsonResponse $response
-     */
-    protected function isJsonResponse($response): bool
-    {
-        return $response instanceof JsonResponse &&
-               Str::contains($response->headers->get('Content-Type'), 'application/json') &&
-               transform($response, function (JsonResponse $response) {
-                   if ('' === ($content = $response->getContent())) {
+        return $dispatcher instanceof JsonResponse &&
+               Str::contains($dispatcher->headers->get('Content-Type'), 'application/json') &&
+               transform($dispatcher, function (JsonResponse $dispatcher) {
+                   if ('' === ($content = $dispatcher->getContent())) {
                        return false;
                    }
 

diff --git a/src/Outputs/ConsoleOutput.php b/src/Outputs/ConsoleOutput.php
@@ -15,18 +15,16 @@
 class ConsoleOutput extends Output
 {
     /**
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $requestHandled
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $requestHandled)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($requestHandled)) {
+        if (! $this->isHtmlResponse($dispatcher)) {
             return;
         }
 
         $js = $this->transformToJs($scores);
-        $content = $requestHandled->getContent();
+        $content = $dispatcher->getContent();
 
         // Try to put the widget at the end, directly before the </body>
         $pos = strripos($content, '</body>');
@@ -37,13 +35,8 @@ public function output(Collection $scores, $requestHandled)
         }
 
         // Update the new content and reset the content length
-        $requestHandled->setContent($content);
-        $requestHandled->headers->remove('Content-Length');
-    }
-
-    protected function shouldOutput($requestHandled): bool
-    {
-        return $this->isHtmlResponse($requestHandled);
+        $dispatcher->setContent($content);
+        $dispatcher->headers->remove('Content-Length');
     }
 
     protected function transformToJs(Collection $scores): string

diff --git a/src/Outputs/DebugBarOutput.php b/src/Outputs/DebugBarOutput.php
@@ -27,13 +27,11 @@ class DebugBarOutput extends Output
     private static $outputted = false;
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Response $response
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $response)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($response)) {
+        if (! $this->shouldOutput($dispatcher)) {
             return;
         }
 
@@ -52,9 +50,9 @@ public static function isOutputted(): bool
         return self::$outputted;
     }
 
-    protected function shouldOutput($response): bool
+    protected function shouldOutput($dispatcher): bool
     {
-        return $this->isResponse($response) &&
+        return $this->isHtmlResponse($dispatcher) &&
                class_exists('Barryvdh\Debugbar\Facade') &&
                \Barryvdh\Debugbar\Facade::isEnabled();
     }

diff --git a/src/Outputs/DumpOutput.php b/src/Outputs/DumpOutput.php
@@ -15,25 +15,13 @@
 class DumpOutput extends Output
 {
     /**
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $event)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($event)) {
-            return;
-        }
-
         $scores->each(function (array $score) {
             unset($score['Basic']);
             dump($score);
         });
     }
-
-    protected function shouldOutput($event): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Outputs/JsonOutput.php b/src/Outputs/JsonOutput.php
@@ -16,13 +16,11 @@
 class JsonOutput extends Output
 {
     /**
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $requestHandled
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $requestHandled)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($requestHandled)) {
+        if (! $this->isJsonResponse($dispatcher)) {
             return;
         }
 
@@ -32,14 +30,9 @@ public function output(Collection $scores, $requestHandled)
             return $score;
         });
 
-        $data = Arr::wrap($requestHandled->getData(true)) and $data['soar_scores'] = $scores;
+        $data = Arr::wrap($dispatcher->getData(true)) and $data['soar_scores'] = $scores;
         // Update the new content and reset the content length
-        $requestHandled->setData($data);
-        $requestHandled->headers->remove('Content-Length');
-    }
-
-    protected function shouldOutput($requestHandled): bool
-    {
-        return $this->isJsonResponse($requestHandled);
+        $dispatcher->setData($data);
+        $dispatcher->headers->remove('Content-Length');
     }
 }
diff --git a/src/Outputs/LogOutput.php b/src/Outputs/LogOutput.php
@@ -26,25 +26,13 @@ public function __construct($channel = 'daily')
     }
 
     /**
-     * @param \Illuminate\Console\Events\CommandFinished        $event
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $event
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
     public function output(Collection $scores, $event)
     {
-        if (! $this->shouldOutput($event)) {
-            return;
-        }
-
         $scores->each(function (array $score) {
             unset($score['Basic']);
             Log::channel($this->channel)->warning($score['Summary'].PHP_EOL.to_pretty_json($score));
         });
     }
-
-    protected function shouldOutput($event): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Outputs/SoarBarOutput.php b/src/Outputs/SoarBarOutput.php
@@ -32,13 +32,11 @@ public function __construct(SoarBar $debugBar)
     }
 
     /**
-     * @param \Illuminate\Foundation\Http\Events\RequestHandled $requestHandled
-     *
-     * @return mixed
+     * {@inheritdoc}
      */
-    public function output(Collection $scores, $requestHandled)
+    public function output(Collection $scores, $dispatcher)
     {
-        if (! $this->shouldOutput($requestHandled)) {
+        if (! $this->shouldOutput($dispatcher)) {
             return;
         }
 
@@ -48,7 +46,7 @@ public function output(Collection $scores, $requestHandled)
             $this->debugBar['scores']->addMessage($score['Summary'].PHP_EOL.to_pretty_json($score), 'warning', false);
         });
 
-        $content = $requestHandled->getContent();
+        $content = $dispatcher->getContent();
         $head = $this->renderer->renderHead();
         $widget = $this->renderer->render();
 
@@ -70,13 +68,13 @@ public function output(Collection $scores, $requestHandled)
         }
 
         // Update the new content and reset the content length
-        $requestHandled->setContent($content);
-        $requestHandled->headers->remove('Content-Length');
+        $dispatcher->setContent($content);
+        $dispatcher->headers->remove('Content-Length');
     }
 
-    protected function shouldOutput($requestHandled): bool
+    protected function shouldOutput($dispatcher): bool
     {
-        return ! DebugBarOutput::isOutputted()
-            && $this->isHtmlResponse($requestHandled);
+        return ! DebugBarOutput::isOutputted() &&
+               $this->isHtmlResponse($dispatcher);
     }
 }