test: fix tests/phpstan when laravel-debugbar not installed

Author: dshafik

phpstan.neon

@@ -5,3 +5,5 @@ parameters:
         - src/
     level: 9
     treatPhpDocTypesAsCertain: false
+    excludePaths:
+        - src/Bag/DebugBar

src/Bag/BagServiceProvider.php

@@ -86,9 +86,12 @@ public function register(): void
             ]);
         }
 
-        if ($this->app->bound(LaravelDebugbar::class)) {
-            BagCollector::init();
-            $this->app->make(LaravelDebugbar::class)->addCollector(new BagCollector());
+        if (class_exists(LaravelDebugbar::class)) {
+            if ($this->app->bound(LaravelDebugbar::class)) {
+                BagCollector::init();
+                // @phpstan-ignore argument.type
+                $this->app->make(LaravelDebugbar::class)->addCollector(new BagCollector());
+            }
         }
     }
 }

src/Bag/DebugBar/Collectors/BagCollector.php

@@ -5,68 +5,82 @@
 namespace Bag\DebugBar\Collectors;
 
 use Bag\Bag;
+use DebugBar\DataCollector\DataCollectorInterface;
 use DebugBar\DataCollector\MessagesCollector;
 
-class BagCollector extends MessagesCollector
-{
-    /**
-     * @var array<string, array{bag: Bag, location: array{file: string|null, line: int|null}|false, type: string}>
-     */
-    protected static array $bags = [];
-
-    public static function add(Bag $bag): void
+if (!class_exists(MessagesCollector::class)) {
+    class BagCollector
     {
-        $location = false;
-        $trace = collect(\debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS))
-            ->firstWhere(fn ($v) =>
-                isset($v['file']) &&
-                !str_contains($v['file'], '/vendor/') &&
-                !\str_starts_with($v['function'], '__'));
-
-        $type = 'unknown';
-        if ($trace !== null) {
-            $location = ['file' => $trace['file'] ?? null, 'line' => $trace['line'] ?? null];
-            $type = $trace['function'];
+        public static function add(Bag $bag): void
+        {
+            // Do nothing
         }
 
-        self::$bags[$bag::class . '#' . \spl_object_id($bag)] = ['bag' => $bag, 'location' => $location, 'type' => $type];
+        public static function init(): void
+        {
+            // Do nothing
+        }
     }
-
-    /**
-     * @return array{messages: array<mixed>, count: int}
-     */
-    public function collect(): array
+} else {
+    class BagCollector extends MessagesCollector implements DataCollectorInterface
     {
-        $localPath = config('debugbar.local_sites_path') ?: base_path();
-        $remoteSitesPath = config('debugbar.remote_sites_path');
-        $remotePaths = array_filter(explode(',', is_string($remoteSitesPath) ? $remoteSitesPath : '')) ?: [base_path()];
+        /**
+         * @var array<string, array{bag: Bag, location: array{file: string|null, line: int|null}|false, type: string}>
+         */
+        protected static array $bags = [];
+
+        public static function add(Bag $bag): void
+        {
+            $location = false;
+            $trace = collect(\debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS))
+                ->firstWhere(fn ($v) => isset($v['file']) &&
+                    !str_contains($v['file'], '/vendor/') &&
+                    !\str_starts_with($v['function'], '__'));
 
-        $this->setXdebugReplacements(array_fill_keys($remotePaths, $localPath));
-        $editor = \config('debugbar.editor');
-        if (is_string($editor)) {
-            $this->setEditorLinkTemplate($editor);
+            $type = 'unknown';
+            if ($trace !== null) {
+                $location = ['file' => $trace['file'] ?? null, 'line' => $trace['line'] ?? null];
+                $type = $trace['function'];
+            }
+
+            self::$bags[$bag::class . '#' . \spl_object_id($bag)] = ['bag' => $bag, 'location' => $location, 'type' => $type];
         }
 
         /**
-         * @var array{bag: Bag, location: array{file: string, line: int|null}, type: string} $message
+         * @return array{messages: array<mixed>, count: int}
          */
-        foreach (self::$bags as $message) {
-            $this->addMessage($message['bag'], $message['type']);
-            $xdebugLink = $this->getXdebugLink($message['location']['file'], $message['location']['line'] ?? null);
-            $this->messages[\array_key_last($this->messages)]['xdebug_link'] = $xdebugLink;
-        }
+        public function collect(): array
+        {
+            $localPath = config('debugbar.local_sites_path') ?: base_path();
+            $remoteSitesPath = config('debugbar.remote_sites_path');
+            $remotePaths = array_filter(explode(',', is_string($remoteSitesPath) ? $remoteSitesPath : '')) ?: [base_path()];
 
-        // @phpstan-ignore return.type
-        return parent::collect();
-    }
+            $this->setXdebugReplacements(array_fill_keys($remotePaths, $localPath));
+            $editor = \config('debugbar.editor');
+            if (is_string($editor)) {
+                $this->setEditorLinkTemplate($editor);
+            }
 
-    public function getName(): string
-    {
-        return 'bags';
-    }
+            /**
+             * @var array{bag: Bag, location: array{file: string, line: int|null}, type: string} $message
+             */
+            foreach (self::$bags as $message) {
+                $this->addMessage($message['bag'], $message['type']);
+                $xdebugLink = $this->getXdebugLink($message['location']['file'], $message['location']['line'] ?? null);
+                $this->messages[\array_key_last($this->messages)]['xdebug_link'] = $xdebugLink;
+            }
 
-    public static function init(): void
-    {
-        self::$bags = [];
+            return parent::collect();
+        }
+
+        public function getName(): string
+        {
+            return 'bags';
+        }
+
+        public static function init(): void
+        {
+            self::$bags = [];
+        }
     }
 }

tests/Unit/DebugBar/Collectors/BagCollectorTest.php

@@ -3,14 +3,17 @@
 declare(strict_types=1);
 
 use Bag\DebugBar\Collectors\BagCollector;
+use DebugBar\DataCollector\MessagesCollector;
 use Illuminate\Support\Facades\Config;
 use Tests\Fixtures\Values\TestBag;
 
-covers(BagCollector::class);
-
 beforeEach(function () {
     BagCollector::init();
-});
+})->skip(!class_exists(MessagesCollector::class));
+
+if (class_exists(MessagesCollector::class)) {
+    covers(BagCollector::class);
+}
 
 test('it collects a bag', function () {
     $bag = TestBag::from([

tests/Unit/Pipelines/Pipes/DebugCollectionTest.php

@@ -5,11 +5,14 @@
 use Bag\DebugBar\Collectors\BagCollector;
 use Bag\Pipelines\Pipes\DebugCollection;
 use Bag\Pipelines\Values\BagInput;
+use DebugBar\DataCollector\MessagesCollector;
 use Illuminate\Support\Collection;
 use Tests\Fixtures\Values\TestBag;
 
 covers(DebugCollection::class);
 
+beforeEach()->skip(!class_exists(MessagesCollector::class));
+
 test('it collects bags', function () {
     $pipe = new DebugCollection();
     $input = new BagInput(TestBag::class, Collection::empty());