Merge pull request #38 from ricventu/fix-phpstan

Fix PHPStan errors
spatie · Jan 27, 2025 · 9810b34 · 9810b34
2 parents 2b2c500 + 8063b2f
commit 9810b34
Show file tree

Hide file tree

Showing 19 changed files with 126 additions and 77 deletions.
diff --git a/src/PendingRouteTransformers/AddControllerUriToActions.php b/src/PendingRouteTransformers/AddControllerUriToActions.php
@@ -9,9 +9,9 @@
 class AddControllerUriToActions implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {

diff --git a/src/PendingRouteTransformers/AddDefaultRouteName.php b/src/PendingRouteTransformers/AddDefaultRouteName.php
@@ -9,16 +9,15 @@
 class AddDefaultRouteName implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
         $pendingRoutes->each(function (PendingRoute $pendingRoute) {
             $pendingRoute->actions
-                ->reject(fn (PendingRouteAction $action) => $action->name)
-                /** @phpstan-ignore-next-line */
+                ->reject(fn (PendingRouteAction $action): bool => (bool)$action->name)
                 ->each(fn (PendingRouteAction $action) => $action->name = $this->generateRouteName($action));
         });
 
@@ -27,19 +26,24 @@ public function transform(Collection $pendingRoutes): Collection
 
     protected function generateRouteName(PendingRouteAction $pendingRouteAction): string
     {
-        return collect(explode('/', $pendingRouteAction->uri))
+        /** @var array<int, non-empty-string> $segments */
+        $segments = collect(explode('/', $pendingRouteAction->uri))
             ->reject(fn (string $segment) => str_starts_with($segment, '{'))
             ->filter()
-            ->when(
-                $this->discoverMethodRouteName($pendingRouteAction),
-                fn (Collection $collection, $name) => $name != $collection->last() ? $collection->push($name) : $collection
-            )
-            ->join('.');
+            ->all();
+
+        $methodName = $this->discoverMethodRouteName($pendingRouteAction);
+
+        if ($methodName !== null && $methodName !== end($segments)) {
+            $segments[] = $methodName;
+        }
+
+        return implode('.', $segments);
     }
 
     /**
      * @param PendingRouteAction $pendingRouteAction
-     * @return string|null
+     * @return non-empty-string|null
      */
     protected function discoverMethodRouteName(PendingRouteAction $pendingRouteAction): ?string
     {

diff --git a/src/PendingRouteTransformers/HandleDoNotDiscoverAttribute.php b/src/PendingRouteTransformers/HandleDoNotDiscoverAttribute.php
@@ -10,18 +10,21 @@
 class HandleDoNotDiscoverAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
         return $pendingRoutes
-            ->reject(fn (PendingRoute $pendingRoute) => $pendingRoute->getAttribute(DoNotDiscover::class))
+            ->reject(fn (PendingRoute $pendingRoute): bool => (bool)$pendingRoute->getAttribute(DoNotDiscover::class))
             ->each(function (PendingRoute $pendingRoute) {
-                $pendingRoute->actions = $pendingRoute
+                /** @var Collection<int, PendingRouteAction> $actions */
+                $actions = $pendingRoute
                     ->actions
-                    ->reject(fn (PendingRouteAction $action) => $action->getAttribute(DoNotDiscover::class));
+                    ->reject(fn (PendingRouteAction $action): bool => (bool)$action->getAttribute(DoNotDiscover::class));
+
+                $pendingRoute->actions = $actions;
             });
     }
 }
diff --git a/src/PendingRouteTransformers/HandleDomainAttribute.php b/src/PendingRouteTransformers/HandleDomainAttribute.php
@@ -3,21 +3,30 @@
 namespace Spatie\RouteDiscovery\PendingRouteTransformers;
 
 use Illuminate\Support\Collection;
+use Spatie\RouteDiscovery\Attributes\Route;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRoute;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRouteAction;
 
 class HandleDomainAttribute implements PendingRouteTransformer
 {
+    /**
+     * @param Collection<int, PendingRoute> $pendingRoutes
+     * @return Collection<int, PendingRoute>
+     */
     public function transform(Collection $pendingRoutes): Collection
     {
         $pendingRoutes->each(function (PendingRoute $pendingRoute) {
             $pendingRoute->actions->each(function (PendingRouteAction $action) use ($pendingRoute) {
                 if ($pendingRouteAttribute = $pendingRoute->getRouteAttribute()) {
-                    $action->domain = $pendingRouteAttribute->domain;
+                    if ($pendingRouteAttribute instanceof Route) {
+                        $action->domain = $pendingRouteAttribute->domain;
+                    }
                 }
 
                 if ($actionAttribute = $action->getRouteAttribute()) {
-                    $action->domain = $actionAttribute->domain;
+                    if ($actionAttribute instanceof Route) {
+                        $action->domain = $actionAttribute->domain;
+                    }
                 }
             });
         });

diff --git a/src/PendingRouteTransformers/HandleFullUriAttribute.php b/src/PendingRouteTransformers/HandleFullUriAttribute.php
@@ -3,15 +3,16 @@
 namespace Spatie\RouteDiscovery\PendingRouteTransformers;
 
 use Illuminate\Support\Collection;
+use Spatie\RouteDiscovery\Attributes\Route;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRoute;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRouteAction;
 
 class HandleFullUriAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
@@ -21,6 +22,7 @@ public function transform(Collection $pendingRoutes): Collection
                     return;
                 }
 
+                /** @var Route $routeAttribute */
                 if (! $routeAttributeFullUri = $routeAttribute->fullUri) {
                     return;
                 }

diff --git a/src/PendingRouteTransformers/HandleHttpMethodsAttribute.php b/src/PendingRouteTransformers/HandleHttpMethodsAttribute.php
@@ -3,15 +3,16 @@
 namespace Spatie\RouteDiscovery\PendingRouteTransformers;
 
 use Illuminate\Support\Collection;
+use Spatie\RouteDiscovery\Attributes\Route;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRoute;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRouteAction;
 
 class HandleHttpMethodsAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
@@ -21,6 +22,10 @@ public function transform(Collection $pendingRoutes): Collection
                     return;
                 }
 
+                if (! $routeAttribute instanceof Route) {
+                    return;
+                }
+
                 if (! $httpMethods = $routeAttribute->methods) {
                     return;
                 }

diff --git a/src/PendingRouteTransformers/HandleMiddlewareAttribute.php b/src/PendingRouteTransformers/HandleMiddlewareAttribute.php
@@ -3,26 +3,31 @@
 namespace Spatie\RouteDiscovery\PendingRouteTransformers;
 
 use Illuminate\Support\Collection;
+use Spatie\RouteDiscovery\Attributes\Route;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRoute;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRouteAction;
 
 class HandleMiddlewareAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
         $pendingRoutes->each(function (PendingRoute $pendingRoute) {
             $pendingRoute->actions->each(function (PendingRouteAction $action) use ($pendingRoute) {
                 if ($pendingRouteAttribute = $pendingRoute->getRouteAttribute()) {
-                    $action->addMiddleware($pendingRouteAttribute->middleware);
+                    if ($pendingRouteAttribute instanceof Route) {
+                        $action->addMiddleware($pendingRouteAttribute->middleware);
+                    }
                 }
 
                 if ($actionRouteAttribute = $action->getRouteAttribute()) {
-                    $action->addMiddleware($actionRouteAttribute->middleware);
+                    if ($actionRouteAttribute instanceof Route) {
+                        $action->addMiddleware($actionRouteAttribute->middleware);
+                    }
                 }
             });
         });

diff --git a/src/PendingRouteTransformers/HandleRouteNameAttribute.php b/src/PendingRouteTransformers/HandleRouteNameAttribute.php
@@ -3,15 +3,16 @@
 namespace Spatie\RouteDiscovery\PendingRouteTransformers;
 
 use Illuminate\Support\Collection;
+use Spatie\RouteDiscovery\Attributes\Route;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRoute;
 use Spatie\RouteDiscovery\PendingRoutes\PendingRouteAction;
 
 class HandleRouteNameAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
@@ -21,6 +22,10 @@ public function transform(Collection $pendingRoutes): Collection
                     return;
                 }
 
+                if (! $routeAttribute instanceof Route) {
+                    return;
+                }
+
                 if (! $name = $routeAttribute->name) {
                     return;
                 }

diff --git a/src/PendingRouteTransformers/HandleUriAttribute.php b/src/PendingRouteTransformers/HandleUriAttribute.php
@@ -10,9 +10,9 @@
 class HandleUriAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
@@ -22,12 +22,16 @@ public function transform(Collection $pendingRoutes): Collection
                     return;
                 }
 
-                if (! $routeAttributeUri = $routeAttribute->uri) {
+                if (! isset($routeAttribute->uri)) {
+                    return;
+                }
+
+                if (! $routeAttribute->uri) {
                     return;
                 }
 
                 $baseUri = Str::beforeLast($action->uri, '/');
-                $action->uri = $baseUri . '/' . $routeAttributeUri;
+                $action->uri = $baseUri . '/' . $routeAttribute->uri;
             });
         });
 

diff --git a/src/PendingRouteTransformers/HandleUrisOfNestedControllers.php b/src/PendingRouteTransformers/HandleUrisOfNestedControllers.php
@@ -35,6 +35,7 @@ public function transform(Collection $pendingRoutes): Collection
 
             $childrenNodes->each(function (PendingRoute $childNode) use ($parentPendingRoute, $parentAction) {
                 $childNode->actions->each(function (PendingRouteAction $action) use ($parentPendingRoute, $parentAction) {
+                    /** @var Collection<int, ReflectionParameter> $paramsToRemove */
                     $paramsToRemove = $action->modelParameters()
                         ->filter(
                             fn (ReflectionParameter $parameter) => $parentAction

diff --git a/src/PendingRouteTransformers/HandleWheresAttribute.php b/src/PendingRouteTransformers/HandleWheresAttribute.php
@@ -10,20 +10,24 @@
 class HandleWheresAttribute implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {
         $pendingRoutes->each(function (PendingRoute $pendingRoute) {
             $pendingRoute->actions->each(function (PendingRouteAction $action) use ($pendingRoute) {
                 if ($pendingRouteWhereAttribute = $pendingRoute->getAttribute(Where::class)) {
-                    $action->addWhere($pendingRouteWhereAttribute);
+                    if ($pendingRouteWhereAttribute instanceof Where) {
+                        $action->addWhere($pendingRouteWhereAttribute);
+                    }
                 }
 
                 if ($actionWhereAttribute = $action->getAttribute(Where::class)) {
-                    $action->addWhere($actionWhereAttribute);
+                    if ($actionWhereAttribute instanceof Where) {
+                        $action->addWhere($actionWhereAttribute);
+                    }
                 }
             });
         });

diff --git a/src/PendingRouteTransformers/MoveRoutesStartingWithParametersLast.php b/src/PendingRouteTransformers/MoveRoutesStartingWithParametersLast.php
@@ -9,9 +9,9 @@
 class MoveRoutesStartingWithParametersLast implements PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {

diff --git a/src/PendingRouteTransformers/PendingRouteTransformer.php b/src/PendingRouteTransformers/PendingRouteTransformer.php
@@ -8,9 +8,8 @@
 interface PendingRouteTransformer
 {
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
-     *
-     * @return Collection<PendingRoute>
+     * @param Collection<int, PendingRoute> $pendingRoutes
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection;
 }
diff --git a/src/PendingRouteTransformers/RejectDefaultControllerMethodRoutes.php b/src/PendingRouteTransformers/RejectDefaultControllerMethodRoutes.php
@@ -21,9 +21,9 @@ class RejectDefaultControllerMethodRoutes implements PendingRouteTransformer
     ];
 
     /**
-     * @param Collection<PendingRoute> $pendingRoutes
+     * @param Collection<int, PendingRoute> $pendingRoutes
      *
-     * @return Collection<PendingRoute>
+     * @return Collection<int, PendingRoute>
      */
     public function transform(Collection $pendingRoutes): Collection
     {

diff --git a/src/PendingRoutes/PendingRoute.php b/src/PendingRoutes/PendingRoute.php
@@ -14,10 +14,10 @@ class PendingRoute
 {
     /**
      * @param SplFileInfo $fileInfo
-     * @param ReflectionClass $class
+     * @param ReflectionClass<object> $class
      * @param string $uri
      * @param string $fullyQualifiedClassName
-     * @param Collection<PendingRouteAction> $actions
+     * @param Collection<int, PendingRouteAction> $actions
      */
     public function __construct(
         public SplFileInfo $fileInfo,
@@ -45,7 +45,7 @@ public function childNamespace(): string
         return $this->namespace() . '\\' . $this->shortControllerName();
     }
 
-    public function getRouteAttribute(): ?Route
+    public function getRouteAttribute(): ?DiscoveryAttribute
     {
         return $this->getAttribute(Route::class);
     }
@@ -55,7 +55,7 @@ public function getRouteAttribute(): ?Route
      *
      * @param class-string<TDiscoveryAttribute> $attributeClass
      *
-     * @return ?TDiscoveryAttribute
+     * @return DiscoveryAttribute|null
      */
     public function getAttribute(string $attributeClass): ?DiscoveryAttribute
     {