refactor(DebugBarOutput): Improve class handling for Laravel Debugbar

- Replace direct class references with a method to determine the class.
- Simplify the output method's return type to object.
- Comment out unnecessary assertions for better flexibility.
- Update test case to use the new method for class resolution.

Author: guanguans

composer-dependency-analyser.php

@@ -1,5 +1,7 @@
 <?php
 
+/** @noinspection PhpUndefinedClassInspection */
+/** @noinspection PhpUndefinedNamespaceInspection */
 declare(strict_types=1);
 
 /**
@@ -11,6 +13,8 @@
  * @see https://github.com/guanguans/laravel-soar
  */
 
+use Fruitcake\LaravelDebugbar\LaravelDebugbar;
+use Fruitcake\LaravelDebugbar\ServiceProvider;
 use ShipMonk\ComposerDependencyAnalyser\Config\Configuration;
 use ShipMonk\ComposerDependencyAnalyser\Config\ErrorType;
 
@@ -31,6 +35,10 @@
         ],
         [ErrorType::SHADOW_DEPENDENCY]
     )
+    ->ignoreUnknownClasses([
+        LaravelDebugbar::class,
+        ServiceProvider::class,
+    ])
     ->ignoreErrorsOnPackages(
         [
             'nesbot/carbon',
@@ -42,7 +50,7 @@
         [ErrorType::SHADOW_DEPENDENCY]
     )
     ->ignoreErrorsOnPackageAndPath(
-        'barryvdh/laravel-debugbar',
+        'fruitcake/laravel-debugbar',
         __DIR__.'/src/Outputs/DebugBarOutput.php',
         [ErrorType::DEV_DEPENDENCY_IN_PROD]
     )

composer.json

@@ -69,6 +69,7 @@
         "ergebnis/php-cs-fixer-config": "^6.59",
         "ergebnis/phpstan-rules": "^2.13",
         "ergebnis/rector-rules": "^1.9",
+        "fruitcake/laravel-debugbar": "^3.16 || ^4.0",
         "guanguans/php-cs-fixer-custom-fixers": "^1.1",
         "guanguans/phpstan-rules": "^1.0",
         "guanguans/rector-rules": "^1.6",
@@ -124,6 +125,7 @@
     "suggest": {
         "barryvdh/laravel-debugbar": "Output SQL scores to Laravel DebugBar.",
         "buggregator/trap": "Output SQL scores to Trap.",
+        "fruitcake/laravel-debugbar": "Output SQL scores to Laravel DebugBar.",
         "itsgoingd/clockwork": "Output SQL scores to Clockwork.",
         "laradumps/laradumps": "Output SQL scores to Laradumps.",
         "laravel/telescope": "Output SQL scores to Telescope.",
@@ -301,7 +303,7 @@
             "$PHP82 vendor/bin/grumphp run --ansi -vv"
         ],
         "jack": "@php vendor/bin/jack",
-        "jack:breakpoint": "@jack breakpoint --limit=10",
+        "jack:breakpoint": "@jack breakpoint --limit=11",
         "jack:breakpoint-dev": "@jack:breakpoint --dev",
         "jack:open-versions": "@jack open-versions --limit=99",
         "jack:open-versions-dev": "@jack:open-versions --dev",

phpstan.neon.dist

@@ -177,6 +177,9 @@ parameters:
         - '#^Call to an undefined static method Guanguans\\LaravelSoar\\Facades\\Soar\:\:get.*\(\)\.$#'
         - '#^Call to method label\(\) on an unknown class Spatie\\.*\\Ray\.$#'
         - '#^Function clock not found\.$#'
+        -
+            identifier: class.notFound
+            path: src/Outputs/DebugBarOutput.php
         -
             identifier: symplify.explicitInterfaceSuffixName
             path: src/Contracts/

src/Outputs/DebugBarOutput.php

@@ -1,5 +1,8 @@
 <?php
 
+/** @noinspection PhpUndefinedClassInspection */
+/** @noinspection PhpUndefinedNamespaceInspection */
+
 declare(strict_types=1);
 
 /**
@@ -14,6 +17,7 @@
 namespace Guanguans\LaravelSoar\Outputs;
 
 use Barryvdh\Debugbar\LaravelDebugbar;
+use Barryvdh\Debugbar\ServiceProvider;
 use DebugBar\DataCollector\MessagesCollector;
 use Illuminate\Console\Events\CommandFinished;
 use Illuminate\Support\Collection;
@@ -31,9 +35,9 @@ public function __construct(
      */
     public function shouldOutput(CommandFinished|Response $outputter): bool
     {
-        return class_exists(LaravelDebugbar::class)
-            && app()->has(LaravelDebugbar::class)
-            // && resolve(LaravelDebugbar::class)->isEnabled()
+        return class_exists($this->laravelDebugbarClass())
+            && app()->has($this->laravelDebugbarClass())
+            // && resolve($this->laravelDebugbarClass())->isEnabled()
             && $this->isHtmlResponse($outputter);
     }
 
@@ -43,11 +47,13 @@ public function shouldOutput(CommandFinished|Response $outputter): bool
      *
      * @noinspection PhpPossiblePolymorphicInvocationInspection
      */
-    public function output(Collection $scores, CommandFinished|Response $outputter): LaravelDebugbar
+    public function output(Collection $scores, CommandFinished|Response $outputter): \Fruitcake\LaravelDebugbar\LaravelDebugbar|LaravelDebugbar
     {
-        $debugBar = resolve(LaravelDebugbar::class);
-
-        \assert($debugBar instanceof LaravelDebugbar);
+        $debugBar = resolve($this->laravelDebugbarClass());
+        \assert(
+            $debugBar instanceof \Fruitcake\LaravelDebugbar\LaravelDebugbar
+            || $debugBar instanceof LaravelDebugbar
+        );
 
         if (!$debugBar->hasCollector($this->name)) {
             $debugBar->addCollector(new MessagesCollector($this->name));
@@ -56,9 +62,31 @@ public function output(Collection $scores, CommandFinished|Response $outputter):
         $scores->each(fn (array $score) => $debugBar->getCollector($this->name)->addMessage(
             $this->hydrateScore($score),
             $this->label,
-            false
+            // false
         ));
 
         return $debugBar;
     }
+
+    /**
+     * @api
+     *
+     * @return class-string<\Fruitcake\LaravelDebugbar\ServiceProvider|ServiceProvider>
+     */
+    public static function laravelDebugbarServiceProviderClass(): string
+    {
+        return class_exists($class = \Fruitcake\LaravelDebugbar\ServiceProvider::class)
+            ? $class // @codeCoverageIgnore
+            : ServiceProvider::class;
+    }
+
+    /**
+     * @return class-string<\Fruitcake\LaravelDebugbar\LaravelDebugbar|LaravelDebugbar>
+     */
+    private function laravelDebugbarClass(): string
+    {
+        return class_exists($class = \Fruitcake\LaravelDebugbar\LaravelDebugbar::class)
+            ? $class // @codeCoverageIgnore
+            : LaravelDebugbar::class;
+    }
 }

testbench.yaml

@@ -2,7 +2,8 @@ laravel: '@testbench'
 
 providers:
   - Workbench\App\Providers\WorkbenchServiceProvider
-  - Barryvdh\Debugbar\ServiceProvider
+  # - Barryvdh\Debugbar\ServiceProvider
+  # - Fruitcake\LaravelDebugbar\ServiceProvider
   - Clockwork\Support\Laravel\ClockworkServiceProvider
   - Guanguans\LaravelSoar\SoarServiceProvider
   - LaraDumps\LaraDumps\LaraDumpsServiceProvider

tests/TestCase.php

@@ -25,6 +25,7 @@
 namespace Guanguans\LaravelSoarTests;
 
 use Guanguans\LaravelSoar\Facades\Soar;
+use Guanguans\LaravelSoar\Outputs\DebugBarOutput;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Foundation\Testing\Concerns\InteractsWithViews;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
@@ -68,6 +69,14 @@ protected function getPackageAliases(mixed $app): array
         ];
     }
 
+    protected function getPackageProviders(mixed $app): array
+    {
+        return [
+            ...parent::getPackageProviders($app),
+            DebugBarOutput::laravelDebugbarServiceProviderClass(),
+        ];
+    }
+
     protected function defineEnvironment(mixed $app): void
     {
         tap($app->make(Repository::class), function (Repository $repository): void {