Refactor Codebase to use modern PHP features using Rector (#225)

* Add void Return Type to Tests * Add void return type to package source * Update rector.php * Run Rector * Remove Dead Code * Enable Coding Style Rector
stefanzweifel · Feb 20, 2024 · 7d0db07 · 7d0db07
1 parent b560290
commit 7d0db07
Show file tree

Hide file tree

Showing 82 changed files with 258 additions and 392 deletions.
diff --git a/rector.php b/rector.php
@@ -11,7 +11,8 @@
         __DIR__ . '/tests',
     ])
     // uncomment to reach your current PHP version
-    // ->withPhpSets(php80: true)
+    ->withPhpSets(php80: true)
+    ->withPreparedSets(deadCode: true, codingStyle: true)
     ->withRules([
         AddVoidReturnTypeWhereNoReturnRector::class,
     ]);
diff --git a/src/ClassesFinder.php b/src/ClassesFinder.php
@@ -26,18 +26,17 @@ public function findAndLoadClasses(): Collection
                     if ($this->isMostLikelyPestTest($file)) {
                         return true;
                     }
+
                     require_once $file->getRealPath();
-                } catch (Exception $e) {
+                } catch (Exception) {
                     //
                 }
             });
 
         ob_end_clean();
 
         return collect(get_declared_classes())
-            ->reject(function (string $className) {
-                return Str::startsWith($className, ['SwooleLibrary']);
-            });
+            ->reject(static fn (string $className) => Str::startsWith($className, ['SwooleLibrary']));
     }
 
     /**
@@ -52,19 +51,15 @@ protected function findFilesInProjectPath(): Collection
             ->name('*.php');
 
         return collect($files)
-            ->reject(function ($file) use ($excludes) {
-                return $this->isExcluded($file, $excludes);
-            });
+            ->reject(fn ($file) => $this->isExcluded($file, $excludes));
     }
 
     /**
      * Determine if a file has been defined in the exclude configuration.
      */
     protected function isExcluded(SplFileInfo $file, Collection $excludes): bool
     {
-        return $excludes->contains(function ($exclude) use ($file) {
-            return Str::startsWith($file->getPathname(), $exclude);
-        });
+        return $excludes->contains(static fn ($exclude) => Str::startsWith($file->getPathname(), $exclude));
     }
 
     /**
@@ -102,7 +97,7 @@ protected function isMostLikelyPestTest(SplFileInfo $file): bool
             'afterAll',
         ]);
 
-        if (preg_match("/$methodNames\s*\(/", $fileContent)) {
+        if (preg_match(sprintf('/%s\s*\(/', $methodNames), $fileContent)) {
             return true;
         }
 

diff --git a/src/Classifier.php b/src/Classifier.php
@@ -91,12 +91,12 @@ public function getClassifierForClassInstance(ReflectionClass $class): Classifie
             $classifierInstance = new $classifier();
 
             if (! $this->implementsContract($classifier)) {
-                throw new Exception("Classifier {$classifier} does not implement ".ClassifierContract::class.'.');
+                throw new Exception(sprintf('Classifier %s does not implement ', $classifier).ClassifierContract::class.'.');
             }
 
             try {
                 $satisfied = $classifierInstance->satisfies($class);
-            } catch (Exception $e) {
+            } catch (Exception) {
                 $satisfied = false;
             }
 

diff --git a/src/Classifiers/ControllerClassifier.php b/src/Classifiers/ControllerClassifier.php
@@ -18,25 +18,23 @@ public function name(): string
     public function satisfies(ReflectionClass $class): bool
     {
         return collect(app(Router::class)->getRoutes())
-            ->reject(function ($route) {
+            ->reject(static function ($route) {
                 if (method_exists($route, 'getActionName')) {
                     // Laravel
                     return $route->getActionName() === 'Closure';
                 }
-
                 // Lumen
                 return data_get($route, 'action.uses') === null;
             })
-            ->map(function ($route) {
+            ->map(static function ($route) {
                 if (method_exists($route, 'getController')) {
                     // Laravel
                     try {
-                        return get_class($route->getController());
-                    } catch (Throwable $e) {
+                        return $route->getController()::class;
+                    } catch (Throwable) {
                         return;
                     }
                 }
-
                 // Lumen
                 return Str::before(data_get($route, 'action.uses'), '@');
             })

diff --git a/src/Classifiers/EventListenerClassifier.php b/src/Classifiers/EventListenerClassifier.php
@@ -23,11 +23,7 @@ public function name(): string
     public function satisfies(ReflectionClass $class): bool
     {
         return collect($this->getEvents())
-            ->map(function (array $listeners) {
-                return collect($listeners)->map(function ($closure) {
-                    return $this->getEventListener($closure);
-                })->toArray();
-            })
+            ->map(fn (array $listeners) => collect($listeners)->map(fn ($closure) => $this->getEventListener($closure))->toArray())
             ->collapse()
             ->flatten()
             ->unique()

diff --git a/src/Classifiers/MiddlewareClassifier.php b/src/Classifiers/MiddlewareClassifier.php
@@ -40,10 +40,12 @@ protected function getMiddlewares(): array
     {
         $reflection = new ReflectionProperty($this->httpKernel, 'middleware');
         $reflection->setAccessible(true);
+
         $middleware = $reflection->getValue($this->httpKernel);
 
         $reflection = new ReflectionProperty($this->httpKernel, 'routeMiddleware');
         $reflection->setAccessible(true);
+
         $routeMiddlwares = $reflection->getValue($this->httpKernel);
 
         return array_values(array_unique(array_merge($middleware, $routeMiddlwares)));
@@ -65,7 +67,7 @@ protected function getHttpKernelInstance()
     {
         try {
             return app(Kernel::class);
-        } catch (BindingResolutionException $e) {
+        } catch (BindingResolutionException) {
             // Lumen
             return app();
         }
@@ -89,7 +91,7 @@ private function getRouteMiddlewares(): array
         $router = $reflection->getValue($this->httpKernel);
 
         return collect($router->getRoutes()->getRoutes())
-            ->map(fn (Route $route) => $route->middleware())
+            ->map(static fn (Route $route) => $route->middleware())
             ->flatten()
             ->unique()
             ->toArray();

diff --git a/src/Classifiers/ObserverClassifier.php b/src/Classifiers/ObserverClassifier.php
@@ -24,22 +24,12 @@ public function name(): string
     public function satisfies(ReflectionClass $class): bool
     {
         return collect($this->getEvents())
-            ->filter(function ($_listeners, $event) {
-                return Str::startsWith($event, 'eloquent.');
-            })
-            ->map(function ($listeners) {
-                return collect($listeners)->map(function ($closure) {
-                    return $this->getEventListener($closure);
-                })->toArray();
-            })
+            ->filter(static fn ($_listeners, $event) => Str::startsWith($event, 'eloquent.'))
+            ->map(fn ($listeners) => collect($listeners)->map(fn ($closure) => $this->getEventListener($closure))->toArray())
             ->collapse()
             ->unique()
-            ->filter(function ($eventListener) {
-                return is_string($eventListener);
-            })
-            ->filter(function (string $eventListenerSignature) use ($class) {
-                return Str::contains($eventListenerSignature, $class->getName());
-            })
+            ->filter(static fn ($eventListener) => is_string($eventListener))
+            ->filter(static fn (string $eventListenerSignature) => Str::contains($eventListenerSignature, $class->getName()))
             ->count() > 0;
     }
 

diff --git a/src/Classifiers/ResourceClassifier.php b/src/Classifiers/ResourceClassifier.php
@@ -19,6 +19,7 @@ public function satisfies(ReflectionClass $class): bool
         if ($class->isSubclassOf(JsonResource::class)) {
             return true;
         }
+
         return $class->isSubclassOf(ResourceCollection::class);
     }
 

diff --git a/src/Console/StatsListCommand.php b/src/Console/StatsListCommand.php
@@ -34,37 +34,31 @@ class StatsListCommand extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return void
      */
-    public function handle()
+    public function handle(): void
     {
         $classes = app(ClassesFinder::class)->findAndLoadClasses();
 
         // Transform  Classes into ReflectionClass instances
         // Remove Classes based on the RejectionStrategy
         // Remove Classes based on the namespace
-        $reflectionClasses = $classes->map(function ($class) {
-            return new ReflectionClass($class);
-        })->reject(function (ReflectionClass $class) {
-            return app(config('stats.rejection_strategy', RejectVendorClasses::class))
-                ->shouldClassBeRejected($class);
-        })->unique(function (ReflectionClass  $class) {
-            return $class->getFileName();
-        })->reject(function (ReflectionClass $class) {
-            // Never discard anonymous database migrations
-            if (Str::contains($class->getName(), 'Migration@anonymous')) {
-                return false;
-            }
-
-            foreach (config('stats.ignored_namespaces', []) as $namespace) {
-                if (Str::startsWith($class->getNamespaceName(), $namespace)) {
-                    return true;
+        $reflectionClasses = $classes
+            ->map(static fn ($class) => new ReflectionClass($class))
+            ->reject(static fn (ReflectionClass $class) => app(config('stats.rejection_strategy', RejectVendorClasses::class))
+            ->shouldClassBeRejected($class))
+            ->unique(static fn (ReflectionClass  $class) => $class->getFileName())
+            ->reject(static function (ReflectionClass $class) {
+                // Never discard anonymous database migrations
+                if (Str::contains($class->getName(), 'Migration@anonymous')) {
+                    return false;
                 }
-            }
-
-            return false;
-        });
+                foreach (config('stats.ignored_namespaces', []) as $namespace) {
+                    if (Str::startsWith($class->getNamespaceName(), $namespace)) {
+                        return true;
+                    }
+                }
+                return false;
+            });
 
         $project = new Project($reflectionClasses);
 
@@ -84,7 +78,7 @@ private function getArrayOfComponentsToDisplay(): array
         return explode(',', $this->option('components'));
     }
 
-    private function renderOutput(Project $project)
+    private function renderOutput(Project $project): void
     {
         if ($this->option('json') === true) {
             $json = (new JsonOutput())->render(

diff --git a/src/Outputs/AsciiTableOutput.php b/src/Outputs/AsciiTableOutput.php
@@ -38,7 +38,7 @@ public function __construct(OutputStyle $output)
         $this->output = $output;
     }
 
-    public function render(Project $project, bool $isVerbose = false, array $filterByComponentName = [])
+    public function render(Project $project, bool $isVerbose = false, array $filterByComponentName = []): void
     {
         $this->isVerbose = $isVerbose;
         $this->project = $project;
@@ -52,19 +52,13 @@ public function render(Project $project, bool $isVerbose = false, array $filterB
             ->setHeaders(['Name', 'Classes', 'Methods', 'Methods/Class', 'LoC', 'LLoC', 'LLoC/Method']);
 
         // Render "Core" components
-        $this->renderComponents($table, $groupedByComponent->filter(function ($_, $key) {
-            return $key !== 'Other' && ! Str::contains($key, 'Test');
-        }));
+        $this->renderComponents($table, $groupedByComponent->filter(static fn ($_, $key) => $key !== 'Other' && ! Str::contains($key, 'Test')));
 
         // Render Test components
-        $this->renderComponents($table, $groupedByComponent->filter(function ($_, $key) {
-            return Str::contains($key, 'Test');
-        }));
+        $this->renderComponents($table, $groupedByComponent->filter(static fn ($_, $key) => Str::contains($key, 'Test')));
 
         // Render "Other" component
-        $this->renderComponents($table, $groupedByComponent->filter(function ($_, $key) {
-            return $key == 'Other';
-        }));
+        $this->renderComponents($table, $groupedByComponent->filter(static fn ($_, $key) => $key === 'Other'));
 
         $table->addRow(new TableSeparator);
         $this->addTotalRow($table);
@@ -73,7 +67,7 @@ public function render(Project $project, bool $isVerbose = false, array $filterB
         $table->render();
     }
 
-    private function renderComponents(Table $table, Collection $groupedByComponent)
+    private function renderComponents(Table $table, Collection $groupedByComponent): void
     {
         foreach ($groupedByComponent as $componentName => $classifiedClasses) {
             $component = new Component($componentName, $classifiedClasses);
@@ -86,6 +80,7 @@ private function renderComponents(Table $table, Collection $groupedByComponent)
                 foreach ($classifiedClasses as $classifiedClass) {
                     $this->addClassifiedClassTableRow($table, $classifiedClass);
                 }
+
                 $table->addRow(new TableSeparator);
             }
         }
@@ -104,7 +99,7 @@ private function addComponentTableRow(Table $table, Component $component): void
         ]);
     }
 
-    private function addClassifiedClassTableRow(Table $table, ClassifiedClass $classifiedClass)
+    private function addClassifiedClassTableRow(Table $table, ClassifiedClass $classifiedClass): void
     {
         $table->addRow([
             new TableCell(
@@ -119,7 +114,7 @@ private function addClassifiedClassTableRow(Table $table, ClassifiedClass $class
         ]);
     }
 
-    private function addTotalRow(Table $table)
+    private function addTotalRow(Table $table): void
     {
         $table->addRow([
             'name' => 'Total',
@@ -132,19 +127,19 @@ private function addTotalRow(Table $table)
         ]);
     }
 
-    private function addMetaRow(Table $table)
+    private function addMetaRow(Table $table): void
     {
         $table->setFooterTitle(implode(' • ', [
-            "Code LLoC: {$this->project->statistic()->getLogicalLinesOfCodeForApplicationCode()}",
-            "Test LLoC: {$this->project->statistic()->getLogicalLinesOfCodeForTestCode()}",
+            'Code LLoC: ' . $this->project->statistic()->getLogicalLinesOfCodeForApplicationCode(),
+            'Test LLoC: ' . $this->project->statistic()->getLogicalLinesOfCodeForTestCode(),
             'Code/Test Ratio: 1:'.$this->project->statistic()->getApplicationCodeToTestCodeRatio(),
             'Routes: '.app(NumberOfRoutes::class)->get(),
         ]));
     }
 
-    private function rightAlignNumbers(Table $table)
+    private function rightAlignNumbers(Table $table): void
     {
-        for ($i = 1; $i <= 6; $i++) {
+        for ($i = 1; $i <= 6; ++$i) {
             $table->setColumnStyle($i, (new TableStyle)->setPadType(STR_PAD_LEFT));
         }
     }